class XMLFilter

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

org::xml::sax::XMLFilter Class Reference

#include <XMLFilter.h>

Inheritance diagram for org::xml::sax::XMLFilter:

List of all members.

Detailed Description

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.

Since:: SAX 2.0

See also:: org::xml::sax::helpers::XMLFilterImpl

Author:: Roger Rene Kommer

Version:

Revision: 1.5

Date:

Date: 2005/02/05 10:45:38

Public Member Functions

virtual void setParent (IN(RXMLReader) parent)=0

Set the parent reader.

virtual RXMLReader getParent ()=0

Get the parent reader.

Member Function Documentation

virtual RXMLReader org::xml::sax::XMLFilter::getParent ( ) [pure virtual]

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:
The parent filter, or null if none has been set.

Implemented in org::xml::sax::helpers::XMLFilterImpl.

virtual void org::xml::sax::XMLFilter::setParent ( IN(RXMLReader) parent ) [pure virtual]

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 The parent reader.

Implemented in org::xml::sax::helpers::XMLFilterImpl.