org.xml.sax.helpers
public class XMLFilterImpl extends Object implements XMLFilter, EntityResolver, DTDHandler, ContentHandler, ErrorHandler
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 {@link org.xml.sax.XMLReader 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
Version: 2.0.1 (sax2r2)
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.
|
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 {@link XMLReader}.
See Also: XMLReader XMLReader XMLFilterImpl
See Also: XMLFilterImpl XMLFilterImpl
Parameters: ch An array of characters. start The starting position in the array. length The number of characters to use from the array.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
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: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: prefix The Namespace prefix.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: e The error as an exception.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: e The error as an exception.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Returns: The current content handler, or null if none was set.
Returns: The current DTD handler, or null if none was set.
Returns: The current entity resolver, or null if none was set.
Returns: The current error handler, or null if none was set.
This will always fail if the parent is null.
Parameters: name The feature name.
Returns: The current value of the feature.
Throws: org.xml.sax.SAXNotRecognizedException If the feature value can't be assigned or retrieved from the parent. org.xml.sax.SAXNotSupportedException When the parent recognizes the feature name but cannot determine its value at this time.
Returns: The parent XML reader, or null if none is set.
See Also: XMLFilterImpl
Parameters: name The property name.
Returns: The current value of the property.
Throws: org.xml.sax.SAXNotRecognizedException If the property value can't be assigned or retrieved from the parent. org.xml.sax.SAXNotSupportedException When the parent recognizes the property name but cannot determine its value at this time.
Parameters: ch An array of characters. start The starting position in the array. length The number of characters to use from the array.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: name The notation name. publicId The notation's public identifier, or null. systemId The notation's system identifier, or null.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: input The input source for the document entity.
Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. java.io.IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
Parameters: systemId The system identifier as a fully-qualified URI.
Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. java.io.IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
Parameters: target The processing instruction target. data The text following the target.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
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: org.xml.sax.SAXException The client may throw an exception during processing. java.io.IOException The client may throw an I/O-related exception while obtaining the new InputSource.
Parameters: resolver The new content handler.
Parameters: locator The document locator.
Parameters: resolver The new DTD handler.
Parameters: resolver The new entity resolver.
Parameters: handle The new error handler.
This will always fail if the parent is null.
Parameters: name The feature name. value The requested feature value.
Throws: org.xml.sax.SAXNotRecognizedException If the feature value can't be assigned or retrieved from the parent. org.xml.sax.SAXNotSupportedException When the parent recognizes the feature name but cannot set the requested value.
This is the {@link org.xml.sax.XMLReader 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: XMLFilterImpl
This will always fail if the parent is null.
Parameters: name The property name. value The requested property value.
Throws: org.xml.sax.SAXNotRecognizedException If the property value can't be assigned or retrieved from the parent. org.xml.sax.SAXNotSupportedException When the parent recognizes the property name but cannot set the requested value.
Parameters: name The name of the skipped entity.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
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: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: prefix The Namespace prefix. uri The Namespace URI.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
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: org.xml.sax.SAXException The client may throw an exception during processing.
Parameters: e The warning as an exception.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.