FileDocCategorySizeDatePackage
XMLFilter.javaAPI DocJava SE 5 API2097Fri Aug 26 14:58:42 BST 2005org.xml.sax

XMLFilter

public interface XMLFilter implements XMLReader
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 {@link org.xml.sax.EntityResolver EntityResolver}, {@link org.xml.sax.DTDHandler DTDHandler}, {@link org.xml.sax.ContentHandler ContentHandler} and {@link org.xml.sax.ErrorHandler ErrorHandler} events automatically.

since
SAX 2.0
author
David Megginson
version
2.0.1 (sax2r2)
see
org.xml.sax.helpers.XMLFilterImpl

Fields Summary
Constructors Summary
Methods Summary
public abstract org.xml.sax.XMLReadergetParent()
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.

return
The parent filter, or null if none has been set.

public abstract voidsetParent(org.xml.sax.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.

param
parent The parent reader.