com.deltaxml.pipe

Class XMLPushFilterAdapter

java.lang.Object

com.deltaxml.pipe.XMLPushFilterAdapter

All Implemented Interfaces:

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

public class XMLPushFilterAdapter
extends java.lang.Object
implements XMLPushFilter

Used to convert an XMLFilter object into an XMLPushFilter object. This enables it to be used logically 'after' the triggered element in a JAXP pipeline. In the PipelinedComparator, any Java filters to be used as output filters must be compatible with XMLPushFilter. This class is used for that purpose.

Constructor Summary

Constructors

Constructor and Description
XMLPushFilterAdapter(org.xml.sax.helpers.XMLFilterImpl filter) Cannot support LexicalHandler events such as comments.
XMLPushFilterAdapter(XMLFilterImpl2 filter) Does support LexicalHandler events such as comments.
XMLPushFilterAdapter(org.xml.sax.helpers.XMLFilterImpl filter, org.xml.sax.ext.LexicalHandler lexicalHandler) Does support LexicalHandler events such as comments.

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 implementation of the ContentHandler characters method.
void	comment(char[] ch, int start, int length) An 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 implementation of the LexicalHandler endCDATA method.
void	endDocument() An implementation of the ContentHandler endDocument method.
void	endDTD() An implementation of the LexicalHandler endDTD method.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) An implementation of the ContentHandler endElement method.
void	endEntity(java.lang.String name) An implementation of the LexicalHandler endEntity method.
void	endPrefixMapping(java.lang.String prefix) An 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.
org.xml.sax.helpers.XMLFilterImpl	getUnderlyingFilter() Returns the underlying filter that was used to create this instance.
void	ignorableWhitespace(char[] ch, int start, int length) An 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) An implementation of the DTDHandler notationDecl method.
void	processingInstruction(java.lang.String target, java.lang.String data) An implementation of the ContentHandler processingInstruction method.
void	setDocumentLocator(org.xml.sax.Locator locator) An 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 implementation of the ContentHandler skippedEntity method.
void	startCDATA() An implementation of the LexicalHandler startCDATA method.
void	startDocument() An implementation of the ContentHandler startDocument method.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) An 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 implementation of the ContentHandler startElement method.
void	startEntity(java.lang.String name) An implementation of the LexicalHandler startEntity method.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) An 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 implementation of the DTDHandler unparsedEntityDecl method.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLPushFilterAdapter

public XMLPushFilterAdapter(org.xml.sax.helpers.XMLFilterImpl filter)

Cannot support LexicalHandler events such as comments.

Parameters:

filter - the XMLFilterImpl to use as an XMLPushFilter

XMLPushFilterAdapter

public XMLPushFilterAdapter(org.xml.sax.helpers.XMLFilterImpl filter,
                            org.xml.sax.ext.LexicalHandler lexicalHandler)

Does support LexicalHandler events such as comments.

Parameters:

filter - the XMLFilterImpl to use as an XMLPushFilter

lexicalHandler - the handler to use for lexical events such as comments

XMLPushFilterAdapter

public XMLPushFilterAdapter(XMLFilterImpl2 filter)

Does support LexicalHandler events such as comments.

Parameters:

filter - the XMLFilterImpl2 to use as an XMLPushFilter

Method Detail

getUnderlyingFilter

public org.xml.sax.helpers.XMLFilterImpl getUnderlyingFilter()

Returns the underlying filter that was used to create this instance.

Returns:

the underlying XMLFilter implementation

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 - the Result instance to which the output from this filter should be sent

Throws:

java.lang.IllegalArgumentException - if result is null

See Also:

XMLPushFilter.setResult(Result)

setDocumentLocator

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

An implementation of the ContentHandler setDocumentLocator method.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Parameters:

locator - to pass through to the underlying filter

See Also:

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

startDocument

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

An implementation of the ContentHandler startDocument method.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

ContentHandler.startDocument()

endDocument

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

An implementation of the ContentHandler endDocument method.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

ContentHandler.endDocument()

startPrefixMapping

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

An implementation of the ContentHandler startPrefixMapping method.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix - to pass through to the underlying filter

uri - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

endPrefixMapping

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

An implementation of the ContentHandler endPrefixMapping method.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

public final 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 implementation of the ContentHandler startElement method.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Parameters:

uri - to pass through to the underlying filter

localName - to pass through to the underlying filter

qName - to pass through to the underlying filter

atts - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

endElement

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

An implementation of the ContentHandler endElement method.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Parameters:

uri - to pass through to the underlying filter

localName - to pass through to the underlying filter

qName - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

characters

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

An implementation of the ContentHandler characters method.

Specified by:

characters in interface org.xml.sax.ContentHandler

Parameters:

ch - to pass through to the underlying filter

start - to pass through to the underlying filter

length - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

ignorableWhitespace

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

An implementation of the ContentHandler ignorableWhitespace method.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Parameters:

ch - to pass through to the underlying filter

start - to pass through to the underlying filter

length - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

processingInstruction

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

An implementation of the ContentHandler processingInstruction method.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Parameters:

target - to pass through to the underlying filter

data - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

skippedEntity

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

An implementation of the ContentHandler skippedEntity method.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Parameters:

name - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 implementation of the LexicalHandler comment method.

Specified by:

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

Parameters:

ch - to pass through to the underlying filter

start - to pass through to the underlying filter

length - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 implementation of the LexicalHandler startDTD method.

Specified by:

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

Parameters:

name - to pass through to the underlying filter

publicId - to pass through to the underlying filter

systemId - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 implementation of the LexicalHandler endDTD method.

Specified by:

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

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

LexicalHandler.endDTD()

startEntity

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

An implementation of the LexicalHandler startEntity method.

Specified by:

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

Parameters:

name - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

LexicalHandler.startEntity(java.lang.String)

endEntity

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

An implementation of the LexicalHandler endEntity method.

Specified by:

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

Parameters:

name - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

LexicalHandler.endEntity(java.lang.String)

startCDATA

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

An implementation of the LexicalHandler startCDATA method.

Specified by:

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

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

LexicalHandler.startCDATA()

endCDATA

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

An implementation of the LexicalHandler endCDATA method.

Specified by:

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

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

LexicalHandler.endCDATA()

notationDecl

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

An implementation of the DTDHandler notationDecl method.

Specified by:

notationDecl in interface org.xml.sax.DTDHandler

Parameters:

name - to pass through to the underlying filter

publicId - to pass through to the underlying filter

systemId - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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

unparsedEntityDecl

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

An implementation of the DTDHandler unparsedEntityDecl method.

Specified by:

unparsedEntityDecl in interface org.xml.sax.DTDHandler

Parameters:

name - to pass through to the underlying filter

publicId - to pass through to the underlying filter

systemId - to pass through to the underlying filter

notationName - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 - to pass through to the underlying filter

aName - to pass through to the underlying filter

type - to pass through to the underlying filter

mode - to pass through to the underlying filter

value - to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 name to pass through to the underlying filter

model - the model to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 to pass through to the underlying filter

publicId - the publicId to pass through to the underlying filter

systemId - the systemId to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter 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 to pass through to the underlying filter

value - the value to pass through to the underlying filter

Throws:

org.xml.sax.SAXException - if the underlying filter throws a SAXException

See Also:

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