XMLFilterImpl

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.

See Also

• XMLFilter
• XMLReader
• EntityResolver
• DTDHandler
• ContentHandler
• ErrorHandler

Public Constructor Summary

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

Public 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(String systemId) Parse a document.
void	parse(InputSource input) 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	setDTDHandler(DTDHandler handler) Set the DTD event handler.
void	setDocumentLocator(Locator locator) Filter a new document locator event.
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.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface org.xml.sax.XMLFilter

abstract XMLReader	getParent() Get the parent reader.
abstract void	setParent(XMLReader parent) Set the parent reader.

From interface org.xml.sax.EntityResolver

abstract InputSource

resolveEntity(String publicId, String systemId) Allow the application to resolve external entities.

From interface org.xml.sax.DTDHandler

abstract void	notationDecl(String name, String publicId, String systemId) Receive notification of a notation declaration event.
abstract void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName) Receive notification of an unparsed entity declaration event.

From interface org.xml.sax.ContentHandler

abstract void	characters(char[] ch, int start, int length) Receive notification of character data.
abstract void	endDocument() Receive notification of the end of a document.
abstract void	endElement(String uri, String localName, String qName) Receive notification of the end of an element.
abstract void	endPrefixMapping(String prefix) End the scope of a prefix-URI mapping.
abstract void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
abstract void	processingInstruction(String target, String data) Receive notification of a processing instruction.
abstract void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
abstract void	skippedEntity(String name) Receive notification of a skipped entity.
abstract void	startDocument() Receive notification of the beginning of a document.
abstract void	startElement(String uri, String localName, String qName, Attributes atts) Receive notification of the beginning of an element.
abstract void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.

From interface org.xml.sax.ErrorHandler

abstract void	error(SAXParseException exception) Receive notification of a recoverable error.
abstract void	fatalError(SAXParseException exception) Receive notification of a non-recoverable error.
abstract void	warning(SAXParseException exception) Receive notification of a warning.

From interface org.xml.sax.XMLReader

abstract ContentHandler	getContentHandler() Return the current content handler.
abstract DTDHandler	getDTDHandler() Return the current DTD handler.
abstract EntityResolver	getEntityResolver() Return the current entity resolver.
abstract ErrorHandler	getErrorHandler() Return the current error handler.
abstract boolean	getFeature(String name) Look up the value of a feature flag.
abstract Object	getProperty(String name) Look up the value of a property.
abstract void	parse(InputSource input) Parse an XML document.
abstract void	parse(String systemId) Parse an XML document from a system identifier (URI).
abstract void	setContentHandler(ContentHandler handler) Allow an application to register a content event handler.
abstract void	setDTDHandler(DTDHandler handler) Allow an application to register a DTD event handler.
abstract void	setEntityResolver(EntityResolver resolver) Allow an application to register an entity resolver.
abstract void	setErrorHandler(ErrorHandler handler) Allow an application to register an error event handler.
abstract void	setFeature(String name, boolean value) Set the value of a feature flag.
abstract void	setProperty(String name, Object value) Set the value of a property.

Public Constructors

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(String, boolean)
• XMLReader.setProperty(String, Object)
• setParent(XMLReader)

public XMLFilterImpl (XMLReader parent)

Construct an XML filter with the specified parent.

Parameters

parent	the XML reader from which this filter receives its events.

See Also

• setParent(XMLReader)
• getParent()

Public Methods

public void characters (char[] ch, int start, int length)

Filter a character data event.

Parameters

ch	An array of characters.
start	The starting position in the array.
length	The number of characters to use from the array.

Throws

SAXException	The client may throw an exception during processing.

public void endDocument ()

Filter an end document event.

Throws

SAXException	The client may throw an exception during processing.

public void endElement (String uri, String localName, String qName)

Filter an end element event.

Parameters

uri	The element's Namespace URI, or the empty string.
localName	The element's local name, or the empty string.
qName	The element's qualified (prefixed) name, or the empty string.

Throws

SAXException	The client may throw an exception during processing.

public void endPrefixMapping (String prefix)

Filter an end Namespace prefix mapping event.

Parameters

prefix	The Namespace prefix.

Throws

SAXException	The client may throw an exception during processing.

public void error (SAXParseException e)

Filter an error event.

Parameters

e	The error as an exception.

Throws

SAXException	The client may throw an exception during processing.

public void fatalError (SAXParseException e)

Filter a fatal error event.

Parameters

e	The error as an exception.

Throws

SAXException	The client may throw an exception during processing.

public ContentHandler getContentHandler ()

Get the content event handler.

Returns

• The current content handler, or null if none was set.

public DTDHandler getDTDHandler ()

Get the current DTD event handler.

Returns

• The current DTD handler, or null if none was set.

public EntityResolver getEntityResolver ()

Get the current entity resolver.

Returns

• The current entity resolver, or null if none was set.

public ErrorHandler getErrorHandler ()

Get the current error event handler.

Returns

• The current error handler, or null if none was set.

public boolean getFeature (String name)

Look up the value of a feature.

This will always fail if the parent is null.

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.

public XMLReader getParent ()

Get the parent reader.

Returns

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

See Also

• setParent(XMLReader)

public Object getProperty (String name)

Look up the value of a property.

Parameters

name	The property name.

Returns

• The current value of the property.

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 determine its value at this time.

public void ignorableWhitespace (char[] ch, int start, int length)

Filter an ignorable whitespace event.

Parameters

ch	An array of characters.
start	The starting position in the array.
length	The number of characters to use from the array.

Throws

SAXException	The client may throw an exception during processing.

public void notationDecl (String name, String publicId, String systemId)

Filter a notation declaration event.

Parameters

name	The notation name.
publicId	The notation's public identifier, or null.
systemId	The notation's system identifier, or null.

Throws

SAXException	The client may throw an exception during processing.

public void parse (String systemId)

Parse a document.

Parameters

systemId	The system identifier as a fully-qualified URI.

Throws

SAXException	Any SAX exception, possibly wrapping another exception.
IOException	An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

public void parse (InputSource input)

Parse a document.

Parameters

input	The input source for the document entity.

Throws

SAXException	Any SAX exception, possibly wrapping another exception.
IOException	An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

public void processingInstruction (String target, String data)

Filter a processing instruction event.

Parameters

target	The processing instruction target.
data	The text following the target.

Throws

SAXException	The client may throw an exception during processing.

public InputSource resolveEntity (String publicId, String systemId)

Filter an external entity resolution.

Parameters

publicId	The entity's public identifier, or null.
systemId	The entity's system identifier.

Returns

• A new InputSource or null for the default.

Throws

SAXException	The client may throw an exception during processing.
IOException	The client may throw an I/O-related exception while obtaining the new InputSource.

public void setContentHandler (ContentHandler handler)

Set the content event handler.

Parameters

handler	the new content handler

public void setDTDHandler (DTDHandler handler)

Set the DTD event handler.

Parameters

handler	the new DTD handler

public void setDocumentLocator (Locator locator)

Filter a new document locator event.

Parameters

locator	The document locator.

public void setEntityResolver (EntityResolver resolver)

Set the entity resolver.

Parameters

resolver	The new entity resolver.

public void setErrorHandler (ErrorHandler handler)

Set the error event handler.

Parameters

handler	the new error handler

public void setFeature (String name, boolean value)

Set the value of a feature.

This will always fail if the parent is null.

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.

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.

Parameters

parent	The parent XML reader.

See Also

• getParent()

public void setProperty (String name, Object value)

Set the value of a property.

This will always fail if the parent is null.

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.

public void skippedEntity (String name)

Filter a skipped entity event.

Parameters

name	The name of the skipped entity.

Throws

SAXException	The client may throw an exception during processing.

public void startDocument ()

Filter a start document event.

Throws

SAXException	The client may throw an exception during processing.

public void startElement (String uri, String localName, String qName, Attributes atts)

Filter a start element event.

Parameters

uri	The element's Namespace URI, or the empty string.
localName	The element's local name, or the empty string.
qName	The element's qualified (prefixed) name, or the empty string.
atts	The element's attributes.

Throws

SAXException	The client may throw an exception during processing.

public void startPrefixMapping (String prefix, String uri)

Filter a start Namespace prefix mapping event.

Parameters

prefix	The Namespace prefix.
uri	The Namespace URI.

Throws

SAXException	The client may throw an exception during processing.

public void unparsedEntityDecl (String name, String publicId, String systemId, String notationName)

Filter an unparsed entity declaration event.

Parameters

name	The entity name.
publicId	The entity's public identifier, or null.
systemId	The entity's system identifier, or null.
notationName	The name of the associated notation.

Throws

SAXException	The client may throw an exception during processing.

public void warning (SAXParseException e)

Filter a warning event.

Parameters

e	The warning as an exception.

Throws

SAXException	The client may throw an exception during processing.