/*******************************************************************************
* Copyright (c) 2006, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.dynamic;
import java.util.Map;
import org.eclipse.help.ITocContribution;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.UAElement;
/*
* A handler that ensures that specified attributes are there for certain nodes,
* or removes the node and logs an error. Also logs warnings for deprecated elements.
*/
public class ValidationHandler extends ProcessorHandler {
private Map requiredAttributes;
private Map deprecatedElements;
/*
* Creates a new validator that looks for the given mapping of
* element names to required attribute names.
*/
public ValidationHandler(Map requiredAttributes) {
this(requiredAttributes, null);
}
/*
* Creates a new validator that looks for the given mapping of
* element names to required attribute names, as well as a mapping
* of deprecated element names to suggested new element names.
*/
public ValidationHandler(Map requiredAttributes, Map deprecatedElements) {
this.requiredAttributes = requiredAttributes;
this.deprecatedElements = deprecatedElements;
}
public short handle(UAElement element, String id) {
if (deprecatedElements != null) {
String suggestion = (String)deprecatedElements.get(element.element.getNodeName());
if (suggestion != null) {
String msg = "The \"" + element.element.getNodeName() + "\" element is deprecated in \"" + id + "\"; use \"" + suggestion + "\" instead."; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
HelpPlugin.logWarning(msg);
}
}
String[] attributes = (String[])requiredAttributes.get(element.element.getNodeName());
if (attributes != null) {
for (int i=0;i<attributes.length;++i) {
if (element.getAttribute(attributes[i]) == null) {
String msg = "Required attribute \"" + attributes[i] + "\" missing from \"" + element.element.getNodeName() + "\" element"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
if (id != null) {
msg += " in \"" + id + '"'; //$NON-NLS-1$
}
UAElement parent = element.getParentElement();
if (parent != null && !(parent instanceof ITocContribution)) {
msg += " (skipping element)"; //$NON-NLS-1$
parent.removeChild(element);
HelpPlugin.logError(msg);
return HANDLED_SKIP;
}
else {
throw new IllegalArgumentException(msg);
}
}
}
}
return UNHANDLED;
}
}