/*
* Copyright 2002-2009 Andy Clark, Marc Guillemot
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.googlecode.html.filters;
import com.googlecode.html.HTMLComponent;
import com.googlecode.html.xercesbridge.XercesBridge;
import org.apache.xerces.xni.*;
import org.apache.xerces.xni.parser.XMLComponentManager;
import org.apache.xerces.xni.parser.XMLConfigurationException;
import org.apache.xerces.xni.parser.XMLDocumentFilter;
import org.apache.xerces.xni.parser.XMLDocumentSource;
/**
* This class implements a filter that simply passes document events to the next handler. It can be
* used as a base class to simplify the development of new document filters.
*
* @author Andy Clark
* @version $Id: DefaultFilter.java,v 1.7 2005/02/14 03:56:54 andyc Exp $
*/
public class DefaultFilter implements XMLDocumentFilter, HTMLComponent {
//
// Data
//
/**
* Utility method for merging string arrays for recognized features and recognized properties.
*/
protected static String[] merge(String[] array1, String[] array2) {
// shortcut merge
if (array1 == array2) {
return array1;
}
if (array1 == null) {
return array2;
}
if (array2 == null) {
return array1;
}
// full merge
String[] array3 = new String[array1.length + array2.length];
System.arraycopy(array1, 0, array3, 0, array1.length);
System.arraycopy(array2, 0, array3, array1.length, array2.length);
return array3;
} // merge(String[],String[]):String[]
/**
* Document handler.
*/
protected XMLDocumentHandler fDocumentHandler;
//
// XMLDocumentSource methods
//
/**
* Document source.
*/
protected XMLDocumentSource fDocumentSource;
// @since Xerces 2.1.0
/**
* Characters.
*/
public void characters(XMLString text, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.characters(text, augs);
}
} // characters(XMLString,Augmentations)
/**
* Comment.
*/
public void comment(XMLString text, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.comment(text, augs);
}
} // comment(XMLString,Augmentations)
/**
* Doctype declaration.
*/
public void doctypeDecl(String root, String publicId, String systemId, Augmentations augs)
throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.doctypeDecl(root, publicId, systemId, augs);
}
} // doctypeDecl(String,String,String,Augmentations)
//
// XMLDocumentHandler methods
//
// since Xerces-J 2.2.0
/**
* Empty element.
*/
public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.emptyElement(element, attributes, augs);
}
} // emptyElement(QName,XMLAttributes,Augmentations)
// old methods
/**
* End CDATA section.
*/
public void endCDATA(Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.endCDATA(augs);
}
} // endCDATA(Augmentations)
/**
* End document.
*/
public void endDocument(Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.endDocument(augs);
}
} // endDocument(Augmentations)
/**
* End element.
*/
public void endElement(QName element, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.endElement(element, augs);
}
} // endElement(QName,Augmentations)
/**
* End general entity.
*/
public void endGeneralEntity(String name, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.endGeneralEntity(name, augs);
}
} // endGeneralEntity(String,Augmentations)
/**
* End prefix mapping.
*/
public void endPrefixMapping(String prefix, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
XercesBridge.getInstance().XMLDocumentHandler_endPrefixMapping(fDocumentHandler, prefix,
augs);
}
} // endPrefixMapping(String,Augmentations)
/**
* Returns the document handler.
*/
public XMLDocumentHandler getDocumentHandler() {
return fDocumentHandler;
} // getDocumentHandler():XMLDocumentHandler
/**
* Returns the document source.
*/
public XMLDocumentSource getDocumentSource() {
return fDocumentSource;
} // getDocumentSource():XMLDocumentSource
/**
* Returns the default state for a feature, or null if this component does not want to report a
* default value for this feature.
*/
public Boolean getFeatureDefault(String featureId) {
return null;
} // getFeatureDefault(String):Boolean
/**
* Returns the default state for a property, or null if this component does not want to report a
* default value for this property.
*/
public Object getPropertyDefault(String propertyId) {
return null;
} // getPropertyDefault(String):Object
/**
* Returns a list of feature identifiers that are recognized by this component. This method may
* return null if no features are recognized by this component.
*/
public String[] getRecognizedFeatures() {
return null;
} // getRecognizedFeatures():String[]
/**
* Returns a list of property identifiers that are recognized by this component. This method may
* return null if no properties are recognized by this component.
*/
public String[] getRecognizedProperties() {
return null;
} // getRecognizedProperties():String[]
/**
* Ignorable whitespace.
*/
public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.ignorableWhitespace(text, augs);
}
} // ignorableWhitespace(XMLString,Augmentations)
/**
* Processing instruction.
*/
public void processingInstruction(String target, XMLString data, Augmentations augs)
throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.processingInstruction(target, data, augs);
}
} // processingInstruction(String,XMLString,Augmentations)
/**
* Resets the component. The component can query the component manager about any features and
* properties that affect the operation of the component.
*
* @param componentManager The component manager.
* @throws XNIException Thrown by component on initialization error.
*/
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException {
} // reset(XMLComponentManager)
/**
* Sets the document handler.
*/
public void setDocumentHandler(XMLDocumentHandler handler) {
fDocumentHandler = handler;
} // setDocumentHandler(XMLDocumentHandler)
// removed since Xerces-J 2.3.0
/**
* Sets the document source.
*/
public void setDocumentSource(XMLDocumentSource source) {
fDocumentSource = source;
} // setDocumentSource(XMLDocumentSource)
/**
* Sets the state of a feature. This method is called by the component manager any time after
* reset when a feature changes state.
* <p>
* <strong>Note:</strong> Components should silently ignore features that do not affect the
* operation of the component.
*
* @param featureId The feature identifier.
* @param state The state of the feature.
* @throws XMLConfigurationException Thrown for configuration error. In general, components
* should only throw this exception if it is <strong>really</strong> a critical error.
*/
public void setFeature(String featureId, boolean state) throws XMLConfigurationException {
} // setFeature(String,boolean)
/**
* Sets the value of a property. This method is called by the component manager any time after
* reset when a property changes value.
* <p>
* <strong>Note:</strong> Components should silently ignore properties that do not affect the
* operation of the component.
*
* @param propertyId The property identifier.
* @param value The value of the property.
* @throws XMLConfigurationException Thrown for configuration error. In general, components
* should only throw this exception if it is <strong>really</strong> a critical error.
*/
public void setProperty(String propertyId, Object value) throws XMLConfigurationException {
} // setProperty(String,Object)
//
// HTMLComponent methods
//
/**
* Start CDATA section.
*/
public void startCDATA(Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.startCDATA(augs);
}
} // startCDATA(Augmentations)
/**
* Start document.
*/
public void startDocument(XMLLocator locator, String encoding, Augmentations augs)
throws XNIException {
startDocument(locator, encoding, null, augs);
} // startDocument(XMLLocator,String,Augmentations)
/**
* Start document.
*/
public void startDocument(XMLLocator locator, String encoding, NamespaceContext nscontext,
Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
XercesBridge.getInstance().XMLDocumentHandler_startDocument(fDocumentHandler, locator,
encoding, nscontext, augs);
}
} // startDocument(XMLLocator,String,Augmentations)
/**
* Start element.
*/
public void startElement(QName element, XMLAttributes attributes, Augmentations augs)
throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.startElement(element, attributes, augs);
}
} // startElement(QName,XMLAttributes,Augmentations)
/**
* Start general entity.
*/
public void startGeneralEntity(String name, XMLResourceIdentifier id, String encoding,
Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.startGeneralEntity(name, id, encoding, augs);
}
} // startGeneralEntity(String,XMLResourceIdentifier,String,Augmentations)
/**
* Start prefix mapping.
*/
public void startPrefixMapping(String prefix, String uri, Augmentations augs)
throws XNIException {
if (fDocumentHandler != null) {
XercesBridge.getInstance().XMLDocumentHandler_startPrefixMapping(fDocumentHandler, prefix,
uri, augs);
}
} // startPrefixMapping(String,String,Augmentations)
/**
* Text declaration.
*/
public void textDecl(String version, String encoding, Augmentations augs) throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.textDecl(version, encoding, augs);
}
} // textDecl(String,String,Augmentations)
//
// Protected static methods
//
/**
* XML declaration.
*/
public void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
throws XNIException {
if (fDocumentHandler != null) {
fDocumentHandler.xmlDecl(version, encoding, standalone, augs);
}
} // xmlDecl(String,String,String,Augmentations)
} // class DefaultFilter