FileDocCategorySizeDatePackage
PassThroughFilter.javaAPI DocApache Xerces 3.0.113879Fri Sep 14 20:33:56 BST 2007xni

PassThroughFilter

public class PassThroughFilter extends Object implements org.apache.xerces.xni.XMLDocumentHandler
This sample demonstrates how to implement a simple pass-through filter for the document "streaming" information set using XNI. This filter could be used in a pipeline of XNI parser components that communicate document events.

Note: This sample does not contain a main method and cannot be run. It is only for demonstration purposes.

author
Andy Clark, IBM
version
$Id: PassThroughFilter.java 447690 2006-09-19 02:41:53Z mrglavas $

Fields Summary
protected org.apache.xerces.xni.XMLDocumentHandler
fDocumentHandler
The document handler.
protected org.apache.xerces.xni.parser.XMLDocumentSource
fDocumentSource
The document source
Constructors Summary
Methods Summary
public voidcharacters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Character content.

param
text The content.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.characters(text, augs);
        }
public voidcomment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
A comment.

param
text The text in the comment.
throws
XNIException Thrown by application to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.comment(text, augs);
        }
public voiddoctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.

param
rootElement The name of the root element.
param
publicId The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
param
systemId The system identifier if an external DTD, null otherwise.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.doctypeDecl(rootElement, publicId, systemId, augs);
        }
public voidemptyElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
An empty element.

param
element The name of the element.
param
attributes The element attributes.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.emptyElement(element, attributes, augs);
        }
public voidendCDATA(org.apache.xerces.xni.Augmentations augs)
The end of a CDATA section.

throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.endCDATA(augs);
        }
public voidendDocument(org.apache.xerces.xni.Augmentations augs)
The end of the document.

throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.endDocument(augs);
        }
public voidendElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs)
The end of an element.

param
element The name of the element.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.endElement(element, augs);
        }
public voidendGeneralEntity(java.lang.String name, org.apache.xerces.xni.Augmentations augs)
This method notifies the end of an entity.

Note: This method is not called for entity references appearing as part of attribute values.

param
name The name of the entity.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.endGeneralEntity(name, augs);
        }
public org.apache.xerces.xni.parser.XMLDocumentSourcegetDocumentSource()
Returns the document source.

        return fDocumentSource;
public voidignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.

param
text The ignorable whitespace.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.ignorableWhitespace(text, augs);
        }
public voidprocessingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs)
A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

param
target The target.
param
data The data or null if none specified.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.processingInstruction(target, data, augs);
        }
public voidsetDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler handler)
Sets the document handler.

param
handler The new document handler.

        fDocumentHandler = handler;
public voidsetDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source)
Sets the document source.

        fDocumentSource = source;
public voidstartCDATA(org.apache.xerces.xni.Augmentations augs)
The start of a CDATA section.

throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.startCDATA(augs);
        }
public voidstartDocument(org.apache.xerces.xni.XMLLocator locator, java.lang.String encoding, org.apache.xerces.xni.NamespaceContext namespaceContext, org.apache.xerces.xni.Augmentations augs)
The start of the document.

param
locator The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.
param
encoding The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.startDocument(locator, encoding, namespaceContext, augs);
	    }
public voidstartElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
The start of an element.

param
element The name of the element.
param
attributes The element attributes.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.startElement(element, attributes, augs);
        }
public voidstartGeneralEntity(java.lang.String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs)
This method notifies the start of an entity.

Note: This method is not called for entity references appearing as part of attribute values.

param
name The name of the entity.
param
publicId The public identifier of the entity if the entity is external, null otherwise.
param
systemId The system identifier of the entity if the entity is external, null otherwise.
param
baseSystemId The base system identifier of the entity if the entity is external, null otherwise.
param
encoding The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.startGeneralEntity(name, identifier, encoding, augs);
        }
public voidtextDecl(java.lang.String version, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.

Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.

Note: This method is not called for entity references appearing as part of attribute values.

param
version The XML version, or null if not specified.
param
encoding The IANA encoding name of the entity.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.textDecl(version, encoding, augs);
        }
public voidxmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.

param
version The XML version.
param
encoding The IANA encoding name of the document, or null if not specified.
param
standalone The standalone value, or null if not specified.
throws
XNIException Thrown by handler to signal an error.

        if (fDocumentHandler != null) {
            fDocumentHandler.xmlDecl(version, encoding, standalone, augs);
	    }