org.xml.sax.helpers
Class XMLFilterImpl

java.lang.Object   
  org.xml.sax.helpers.XMLFilterImpl

All Implemented Interfaces:

ContentHandler , DTDHandler , EntityResolver , ErrorHandler , XMLFilter , XMLReader

public class XMLFilterImpl
extends Object   
implements XMLFilter   , EntityResolver   , DTDHandler   , ContentHandler   , ErrorHandler   

Base class for deriving an XML filter.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This class is designed to sit between an XMLReader and the client application's event handlers. By default, it does nothing but pass requests up to the reader and events on to the handlers unmodified, but subclasses can override specific methods to modify the event stream or the configuration requests as they pass through.

Since:

SAX 2.0

See Also:

XMLFilter , XMLReader , EntityResolver , DTDHandler , ContentHandler , ErrorHandler

Constructor Summary

XMLFilterImpl ()
Construct an empty XML filter, with no parent.

XMLFilterImpl (XMLReader parent)
Construct an XML filter with the specified parent.

Method Summary

void	characters (char[] ch, int start, int length) Filter a character data event.
void	endDocument () Filter an end document event.
void	endElement (String uri, String localName, String qName) Filter an end element event.
void	endPrefixMapping (String prefix) Filter an end Namespace prefix mapping event.
void	error (SAXParseException e) Filter an error event.
void	fatalError (SAXParseException e) Filter a fatal error event.
ContentHandler	getContentHandler () Get the content event handler.
DTDHandler	getDTDHandler () Get the current DTD event handler.
EntityResolver	getEntityResolver () Get the current entity resolver.
ErrorHandler	getErrorHandler () Get the current error event handler.
boolean	getFeature (String name) Look up the value of a feature.
XMLReader	getParent () Get the parent reader.
Object	getProperty (String name) Look up the value of a property.
void	ignorableWhitespace (char[] ch, int start, int length) Filter an ignorable whitespace event.
void	notationDecl (String name, String publicId, String systemId) Filter a notation declaration event.
void	parse (InputSource input) Parse a document.
void	parse (String systemId) Parse a document.
void	processingInstruction (String target, String data) Filter a processing instruction event.
InputSource	resolveEntity (String publicId, String systemId) Filter an external entity resolution.
void	setContentHandler (ContentHandler handler) Set the content event handler.
void	setDocumentLocator (Locator locator) Filter a new document locator event.
void	setDTDHandler (DTDHandler handler) Set the DTD event handler.
void	setEntityResolver (EntityResolver resolver) Set the entity resolver.
void	setErrorHandler (ErrorHandler handler) Set the error event handler.
void	setFeature (String name, boolean value) Set the value of a feature.
void	setParent (XMLReader parent) Set the parent reader.
void	setProperty (String name, Object value) Set the value of a property.
void	skippedEntity (String name) Filter a skipped entity event.
void	startDocument () Filter a start document event.
void	startElement (String uri, String localName, String qName, Attributes atts) Filter a start element event.
void	startPrefixMapping (String prefix, String uri) Filter a start Namespace prefix mapping event.
void	unparsedEntityDecl (String name, String publicId, String systemId, String notationName) Filter an unparsed entity declaration event.
void	warning (SAXParseException e) Filter a warning event.

Methods inherited from class java.lang.Object

clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

Constructor Detail

XMLFilterImpl

public XMLFilterImpl()

Construct an empty XML filter, with no parent.

This filter will have no parent: you must assign a parent before you start a parse or do any configuration with setFeature or setProperty, unless you use this as a pure event consumer rather than as an XMLReader .

See Also:

XMLReader.setFeature(java.lang.String, boolean) , XMLReader.setProperty(java.lang.String, java.lang.Object) , setParent(org.xml.sax.XMLReader)

XMLFilterImpl

public XMLFilterImpl(XMLReader    parent)

Construct an XML filter with the specified parent.

See Also:

setParent(org.xml.sax.XMLReader) , getParent()

Method Detail

setParent

public void setParent(XMLReader    parent)

Set the parent reader.

This is the XMLReader from which this filter will obtain its events and to which it will pass its configuration requests. The parent may itself be another filter.

If there is no parent reader set, any attempt to parse or to set or get a feature or property will fail.

Specified by:

setParent in interface XMLFilter

Parameters:

parent - The parent XML reader.

See Also:

getParent()

getParent

public XMLReader    getParent()

Get the parent reader.

Specified by:

getParent in interface XMLFilter

Returns:

The parent XML reader, or null if none is set.

See Also:

setParent(org.xml.sax.XMLReader)

setFeature

public void setFeature(String    name,
                       boolean value)
                throws SAXNotRecognizedException   ,
                       SAXNotSupportedException   

Set the value of a feature.

This will always fail if the parent is null.

Specified by:

setFeature in interface XMLReader

Parameters:

name - The feature name.

value - The requested feature value.

Throws:

SAXNotRecognizedException - If the feature value can't be assigned or retrieved from the parent.

SAXNotSupportedException - When the parent recognizes the feature name but cannot set the requested value.

See Also:

XMLReader.getFeature(java.lang.String)

getFeature

public boolean getFeature(String    name)
                   throws SAXNotRecognizedException   ,
                          SAXNotSupportedException   

Look up the value of a feature.

This will always fail if the parent is null.

Specified by:

getFeature in interface XMLReader

Parameters:

name - The feature name.

Returns:

The current value of the feature.

Throws:

SAXNotRecognizedException - If the feature value can't be assigned or retrieved from the parent.

SAXNotSupportedException - When the parent recognizes the feature name but cannot determine its value at this time.

See Also:

XMLReader.setFeature(java.lang.String, boolean)

setProperty

public void setProperty(String    name,
                        Object    value)
                 throws SAXNotRecognizedException   ,
                        SAXNotSupportedException   

Set the value of a property.

This will always fail if the parent is null.

Specified by:

setProperty in interface XMLReader

Parameters:

name - The property name.

value - The requested property value.

Throws:

SAXNotRecognizedException - If the property value can't be assigned or retrieved from the parent.

SAXNotSupportedException - When the parent recognizes the property name but cannot set the requested value.

getProperty

public