XMLFilter

public interface XMLFilter
implements XMLReader

org.xml.sax.XMLFilter

Known indirect subclasses

XMLFilterImpl Base class for deriving an XML filter.

Interface for 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.

An XML filter is like an XML reader, except that it obtains its events from another XML reader rather than a primary source like an XML document or database. Filters can modify a stream of events as they pass on to the final application.

The XMLFilterImpl helper class provides a convenient base for creating SAX2 filters, by passing on all EntityResolver, DTDHandler, ContentHandler and ErrorHandler events automatically.

See also:

XMLFilterImpl

Summary

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

Inherited methods

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 methods

getParent

Added in API level 1

public abstract XMLReader getParent ()

Get the parent reader.

This method allows the application to query the parent reader (which may be another filter). It is generally a bad idea to perform any operations on the parent reader directly: they should all pass through this filter.

Returns
`XMLReader`	The parent filter, or null if none has been set.

setParent

Added in API level 1

public abstract void setParent (XMLReader parent)

Set the parent reader.

This method allows the application to link the filter to a parent reader (which may be another filter). The argument may not be null.

Parameters
`parent`	`XMLReader`: The parent reader.