Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.cyberneko.html.filters

Class DefaultFilter

Implemented Interfaces:
XMLComponent, XMLDocumentFilter, HTMLComponent
Known Direct Subclasses:
ElementRemover, Identity, NamespaceBinder, Purifier, Writer
public class DefaultFilter
extends java.lang.Object
implements XMLDocumentFilter, HTMLComponent
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.
Version:
$Id: DefaultFilter.java,v 1.7 2005/02/14 03:56:54 andyc Exp $
Author:
Andy Clark

Field Summary

protected XMLDocumentHandler
fDocumentHandler
Document handler.
protected XMLDocumentSource
fDocumentSource
Document source.

Method Summary

void
characters(XMLString text, Augmentations augs)
Characters.
void
comment(XMLString text, Augmentations augs)
Comment.
void
doctypeDecl(String root, String publicId, String systemId, Augmentations augs)
Doctype declaration.
void
emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
Empty element.
void
endCDATA(Augmentations augs)
End CDATA section.
void
endDocument(Augmentations augs)
End document.
void
endElement(QName element, Augmentations augs)
End element.
void
endGeneralEntity(String name, Augmentations augs)
End general entity.
void
endPrefixMapping(String prefix, Augmentations augs)
End prefix mapping.
XMLDocumentHandler
getDocumentHandler()
Returns the document handler.
XMLDocumentSource
getDocumentSource()
Returns the document source.
Boolean
getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
Object
getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
String[]
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component.
String[]
getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component.
void
ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
protected static String[]
merge(String[] array1, String[] array2)
Utility method for merging string arrays for recognized features and recognized properties.
void
processingInstruction(String target, XMLString data, Augmentations augs)
Processing instruction.
void
reset(XMLComponentManager componentManager)
Resets the component.
void
setDocumentHandler(XMLDocumentHandler handler)
Sets the document handler.
void
setDocumentSource(XMLDocumentSource source)
Sets the document source.
void
setFeature(String featureId, boolean state)
Sets the state of a feature.
void
setProperty(String propertyId, Object value)
Sets the value of a property.
void
startCDATA(Augmentations augs)
Start CDATA section.
void
startDocument(XMLLocator locator, String encoding, Augmentations augs)
Start document.
void
startDocument(XMLLocator locator, String encoding, NamespaceContext nscontext, Augmentations augs)
Start document.
void
startElement(QName element, XMLAttributes attributes, Augmentations augs)
Start element.
void
startGeneralEntity(String name, XMLResourceIdentifier id, String encoding, Augmentations augs)
Start general entity.
void
startPrefixMapping(String prefix, String uri, Augmentations augs)
Start prefix mapping.
void
textDecl(String version, String encoding, Augmentations augs)
Text declaration.
void
xmlDecl(String version, String encoding, String standalone, Augmentations augs)
XML declaration.

Field Details

fDocumentHandler

protected XMLDocumentHandler fDocumentHandler
Document handler.

fDocumentSource

protected XMLDocumentSource fDocumentSource
Document source.

Method Details

characters

public void characters(XMLString text,
                       Augmentations augs)
            throws XNIException
Characters.

comment

public void comment(XMLString text,
                    Augmentations augs)
            throws XNIException
Comment.

doctypeDecl

public void doctypeDecl(String root,
                        String publicId,
                        String systemId,
                        Augmentations augs)
            throws XNIException
Doctype declaration.

emptyElement

public void emptyElement(QName element,
                         XMLAttributes attributes,
                         Augmentations augs)
            throws XNIException
Empty element.

endCDATA

public void endCDATA(Augmentations augs)
            throws XNIException
End CDATA section.

endDocument

public void endDocument(Augmentations augs)
            throws XNIException
End document.

endElement

public void endElement(QName element,
                       Augmentations augs)
            throws XNIException
End element.

endGeneralEntity

public void endGeneralEntity(String name,
                             Augmentations augs)
            throws XNIException
End general entity.

endPrefixMapping

public void endPrefixMapping(String prefix,
                             Augmentations augs)
            throws XNIException
End prefix mapping.

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()
Returns the document handler.

getDocumentSource

public XMLDocumentSource getDocumentSource()
Returns the document source.

getFeatureDefault

public Boolean getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
Specified by:
getFeatureDefault in interface HTMLComponent

getPropertyDefault

public Object getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
Specified by:
getPropertyDefault in interface HTMLComponent

getRecognizedFeatures

public String[] getRecognizedFeatures()
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.

getRecognizedProperties

public String[] getRecognizedProperties()
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.

ignorableWhitespace

public void ignorableWhitespace(XMLString text,
                                Augmentations augs)
            throws XNIException
Ignorable whitespace.

merge

protected static String[] merge(String[] array1,
                                String[] array2)
Utility method for merging string arrays for recognized features and recognized properties.

processingInstruction

public void processingInstruction(String target,
                                  XMLString data,
                                  Augmentations augs)
            throws XNIException
Processing instruction.

reset

public void reset(XMLComponentManager componentManager)
            throws XMLConfigurationException
Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
Parameters:
componentManager - The component manager.

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler handler)
Sets the document handler.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)
Sets the document source.

setFeature

public void setFeature(String featureId,
                       boolean state)
            throws XMLConfigurationException
Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

Note: Components should silently ignore features that do not affect the operation of the component.

Parameters:
featureId - The feature identifier.
state - The state of the feature.

setProperty

public void setProperty(String propertyId,
                        Object value)
            throws XMLConfigurationException
Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

Note: Components should silently ignore properties that do not affect the operation of the component.

Parameters:
propertyId - The property identifier.
value - The value of the property.

startCDATA

public void startCDATA(Augmentations augs)
            throws XNIException
Start CDATA section.

startDocument

public void startDocument(XMLLocator locator,
                          String encoding,
                          Augmentations augs)
            throws XNIException
Start document.

startDocument

public void startDocument(XMLLocator locator,
                          String encoding,
                          NamespaceContext nscontext,
                          Augmentations augs)
            throws XNIException
Start document.

startElement

public void startElement(QName element,
                         XMLAttributes attributes,
                         Augmentations augs)
            throws XNIException
Start element.

startGeneralEntity

public void startGeneralEntity(String name,
                               XMLResourceIdentifier id,
                               String encoding,
                               Augmentations augs)
            throws XNIException
Start general entity.

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri,
                               Augmentations augs)
            throws XNIException
Start prefix mapping.

textDecl

public void textDecl(String version,
                     String encoding,
                     Augmentations augs)
            throws XNIException
Text declaration.

xmlDecl

public void xmlDecl(String version,
                    String encoding,
                    String standalone,
                    Augmentations augs)
            throws XNIException
XML declaration.

Overview Package Class Use Tree Index Deprecated About
(C) Copyright 2002-2005, Andy Clark. All rights reserved.