com.deltaxml.pipe

Class XMLPushFilterImpl

java.lang.Object

com.deltaxml.pipe.XMLPushFilterImpl

All Implemented Interfaces:

XMLPushFilter, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler

public abstract class XMLPushFilterImpl
extends java.lang.Object
implements XMLPushFilter

A framework class which can be easily extended to provide custom push-mode SAX event filtering.

This class can be used to provide a Java equivalent of the JAXP TransformerHandler. When used directly it simply copies SAX events from input to the output and is equivalent to creating a TransformerHandler without an associated XSLT stylesheet or Template. When extended it can be used to provide custom behaviour and a route to the possible reimplementation of XSLT based TransformerHandlers directly in Java.

Constructor Summary

Constructors

Constructor and Description
XMLPushFilterImpl() Create a new instance of XMLPushFilterImpl.

Method Summary

Modifier and Type	Method and Description
void	attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String mode, java.lang.String value) An implementation of the DeclHandler attributeDecl method.
void	characters(char[] ch, int start, int length) An extensible implementation of the ContentHandler characters method.
void	comment(char[] ch, int start, int length) An extensible implementation of the LexicalHandler comment method.
void	elementDecl(java.lang.String name, java.lang.String model) An implementation of the DeclHandler elementDecl method.
void	endCDATA() An extensible implementation of the LexicalHandler endCDATA method.
void	endDocument() An extensible implementation of the ContentHandler endDocument method.
void	endDTD() An extensible implementation of the LexicalHandler endDTD method.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) An extensible implementation of the ContentHandler endElement method.
void	endEntity(java.lang.String name) An extensible implementation of the LexicalHandler endEntity method.
void	endPrefixMapping(java.lang.String prefix) An extensible implementation of the ContentHandler endPrefixMapping method.
void	externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) An implementation of the DeclHandler externalEntityDecl method.
void	ignorableWhitespace(char[] ch, int start, int length) An extensible implementation of the ContentHandler ignorableWhitespace method.
void	internalEntityDecl(java.lang.String name, java.lang.String value) An implementation of the DeclHandler internalEntityDecl method.
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Filter a notationDecl event.
void	processingInstruction(java.lang.String target, java.lang.String data) An extensible implementation of the ContentHandler processingInstruction method.
void	setDocumentLocator(org.xml.sax.Locator locator) An extensible implementation of the ContentHandler setDocumentLocator method.
void	setResult(javax.xml.transform.Result result) Enables the user to set the Result of the transformation.
void	skippedEntity(java.lang.String name) An extensible implementation of the ContentHandler skippedEntity method.
void	startCDATA() An extensible implementation of the LexicalHandler startCDATA method.
void	startDocument() An extensible implementation of the ContentHandler startDocument method.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) An extensible implementation of the LexicalHandler startDTD method.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) An extensible implementation of the ContentHandler startElement method.
void	startEntity(java.lang.String name) An extensible implementation of the LexicalHandler startEntity method.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) An extensible implementation of the ContentHandler startPrefixMapping method.
void	unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) An extensible implementation of the DTDHandler unparsedEntityDecl method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLPushFilterImpl

public XMLPushFilterImpl()

Create a new instance of XMLPushFilterImpl.

Method Detail

setResult

public void setResult(javax.xml.transform.Result result)
               throws java.lang.IllegalArgumentException

Enables the user to set the Result of the transformation.

Specified by:

setResult in interface XMLPushFilter

Parameters:

result - a Result instance. Should not be null.

Throws:

java.lang.IllegalArgumentException - if the parameter is null

See Also:

XMLPushFilter.setResult(Result), TransformerHandler.setResult(javax.xml.transform.Result)

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

An extensible implementation of the ContentHandler setDocumentLocator method.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Parameters:

locator - - an object that can return the location of any SAX document event

See Also:

ContentHandler.setDocumentLocator(org.xml.sax.Locator)

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler startDocument method.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler endDocument method.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.endDocument()

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler startPrefixMapping method.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix - - the namespace prefix

uri - - the namespace URI

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler endPrefixMapping method.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix - - the namespace prefix

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler startElement method.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Parameters:

uri - - the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed

localName - - the local name (without prefix), or the empty string if Namespace processing is not being performed

qName - - the qualified name (with prefix), or the empty string if qualified names are not available

atts - - the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler endElement method.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Parameters:

uri - - the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed

localName - - the local name (without prefix), or the empty string if Namespace processing is not being performed

qName - - the qualified XML name (with prefix), or the empty string if qualified names are not available

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler characters method.

Specified by:

characters in interface org.xml.sax.ContentHandler

Parameters:

ch - - the characters from the XML document

start - - the start position in the array

length - - the number of characters to read from the array

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.characters(char[], int, int)

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler ignorableWhitespace method.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Parameters:

ch - - the characters from the XML document

start - - the start position in the array

length - - the number of characters to read from the array

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler processingInstruction method.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Parameters:

target - - the processing instruction target

data - - the processing instruction data, or null if none was supplied. The data does not include any whitespace separating it from the target

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

An extensible implementation of the ContentHandler skippedEntity method.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Parameters:

name - - the name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]"

Throws:

org.xml.sax.SAXException - if the Result ContentHandler throws a SAXException

See Also:

ContentHandler.skippedEntity(java.lang.String)

comment

public void comment(char[] ch,
                    int start,
                    int length)
             throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler comment method.

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler

Parameters:

ch - - an array holding the characters in the comment.

start - - the starting position in the array.

length - - the number of characters to use from the array.

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.comment(char[], int, int)

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)
              throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler startDTD method.

Specified by:

startDTD in interface org.xml.sax.ext.LexicalHandler

Parameters:

name - - the document type name.

publicId - - the declared public identifier for the external DTD subset, or null if none was declared.

systemId - - the declared system identifier for the external DTD subset, or null if none was declared. (Note that this is not resolved against the document base URI.)

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)

endDTD

public void endDTD()
            throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler endDTD method.

Specified by:

endDTD in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.endDTD()

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler startEntity method.

Specified by:

startEntity in interface org.xml.sax.ext.LexicalHandler

Parameters:

name - - the name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]"

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.startEntity(java.lang.String)

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler endEntity method.

Specified by:

endEntity in interface org.xml.sax.ext.LexicalHandler

Parameters:

name - - the name of the entity that is ending

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.endEntity(java.lang.String)

startCDATA

public void startCDATA()
                throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler startCDATA method.

Specified by:

startCDATA in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.startCDATA()

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException

An extensible implementation of the LexicalHandler endCDATA method.

Specified by:

endCDATA in interface org.xml.sax.ext.LexicalHandler

Throws:

org.xml.sax.SAXException - if the Result LexicalHandler throws a SAXException

See Also:

LexicalHandler.endCDATA()

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)
                  throws org.xml.sax.SAXException

Filter a notationDecl event. While this method does filter the event it is likely that upstream processes, which subsequently receive the event may not do anything meaningful. For example if the events are sent to a SAX event serializer or the setResult method uses a StreamResult argument then the notation declaration may be lost and not appear in any output.

Specified by:

notationDecl in interface org.xml.sax.DTDHandler

Parameters:

name - - the notation name.

publicId - - the notation's public identifier, or null if none was given.

systemId - - the notation's system identifier, or null if none was given.

Throws:

org.xml.sax.SAXException - if the Result DTDHandler throws a SAXException

See Also:

DTDHandler.notationDecl(String, String, String)

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)
                        throws org.xml.sax.SAXException

An extensible implementation of the DTDHandler unparsedEntityDecl method.

Specified by:

unparsedEntityDecl in interface org.xml.sax.DTDHandler

Parameters:

name - - The unparsed entity's name.

publicId - - The entity's public identifier, or null if none was given.

systemId - - The entity's system identifier.

notationName - - The name of the associated notation.

Throws:

org.xml.sax.SAXException - if the Result DTDHandler throws a SAXException

See Also:

DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

attributeDecl

public void attributeDecl(java.lang.String eName,
                          java.lang.String aName,
                          java.lang.String type,
                          java.lang.String mode,
                          java.lang.String value)
                   throws org.xml.sax.SAXException

An implementation of the DeclHandler attributeDecl method.

Specified by:

attributeDecl in interface org.xml.sax.ext.DeclHandler

Parameters:

eName - - the name of the associated element.

aName - - the name of the attribute.

type - - a string representing the attribute type.

mode - - a string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.

value - - a string representing the attribute's default value, or null if there is none.

Throws:

org.xml.sax.SAXException - if the Result DeclHandler throws a SAXException

See Also:

DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

elementDecl

public void elementDecl(java.lang.String name,
                        java.lang.String model)
                 throws org.xml.sax.SAXException

An implementation of the DeclHandler elementDecl method.

Specified by:

elementDecl in interface org.xml.sax.ext.DeclHandler

Parameters:

name - - the element type name

model - - the content model as a normalized string

Throws:

org.xml.sax.SAXException - if the Result DeclHandler throws a SAXException

See Also:

DeclHandler.elementDecl(java.lang.String, java.lang.String)

externalEntityDecl

public void externalEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId)
                        throws org.xml.sax.SAXException

An implementation of the DeclHandler externalEntityDecl method.

Specified by:

externalEntityDecl in interface org.xml.sax.ext.DeclHandler

Parameters:

name - - The name of the entity. If it is a parameter entity, the name will begin with '%'.

publicId - - The entity's public identifier, or null if none was given.

systemId - - The entity's system identifier.

Throws:

org.xml.sax.SAXException - if the Result DeclHandler throws a SAXException

See Also:

DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)

internalEntityDecl

public void internalEntityDecl(java.lang.String name,
                               java.lang.String value)
                        throws org.xml.sax.SAXException

An implementation of the DeclHandler internalEntityDecl method.

Specified by:

internalEntityDecl in interface org.xml.sax.ext.DeclHandler

Parameters:

name - - the name of the entity. If it is a parameter entity, the name will begin with '%'.

value - - the replacement text of the entity.

Throws:

org.xml.sax.SAXException - if the Result DeclHandler throws a SAXException

See Also:

DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)