Package com.deltaxml.pipe

Class XMLFilterImpl2

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

com.deltaxml.pipe.XMLFilterImpl2

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, LexicalHandler, XMLFilter, XMLReader

Direct Known Subclasses:

AncestorXMLFilter, CleanHouse, NormalizeSpace, WordInfilter62, XMLFilterImpl3

public class XMLFilterImpl2
extends XMLFilterImpl
implements DeclHandler, LexicalHandler

Provides an extensible class for filtering SAX events, including lexical events such as XML comments. The class is functionally similar to XMLFilterImpl but provides additional extensible methods to support the LexicalHandler and DeclHandler interfaces. The class name follows the naming scheme used in the SAX 2.0.2 release, for the extended classes such as DefaultHandler2.

The default action of a method, unless overridden, is to copy input events to the output. In some respects this behaviour is similar to the XSLT identity transform.

This class will attempt to act as a LexicalHandler and DeclHandler but will silently ignore any SAXNotRecognizedException or SAXNotSupportedException thrown by the parent XMLReader when setting these properties. In this case it will act as if it were a standard XMLFilterImpl. When an XMLFilter produced by Saxon (and possibly by other XSLT processors) is followed by one extended from this class in a filter chain (PipelinedComparator input filters or JAXP) this is likely to be the case.

Author:

Nigel Whitaker

Constructor Summary

Constructors

Constructor	Description
XMLFilterImpl2()	Creates a new XMLFilterImpl2.

Method Summary

Modifier and Type	Method	Description
void	attributeDecl(String eName, String aName, String type, String valueDefault, String value)	An extensible implementation of the Declaration Handler attributeDecl event, which reports DTD related (external DTD or internal subset) attribute declarations.
void	comment(char[] ch, int start, int length)	An extensible implementation of the SAX LexicalHandler comment event, which reports any comments identified by the parser.
void	elementDecl(String name, String model)	An extensible implementation of the Declaration Handler elementDecl event, which reports DTD related (external DTD or internal subset) element declarations.
void	endCDATA()	An extensible implementation of the SAX LexicalHandler endCDATA event, which reports the end of a CDATA boundry idenitified by the parser.
void	endDTD()	An extensible implementation of the SAX LexicalHandler endDTD event, which reports the end of DOCTYPE processing by the parser.
void	endEntity(String name)	An extensible implementation of the SAX LexicalHandler endEntity event, which reports the end of entity instance processing by the parser.
void	externalEntityDecl(String name, String publicId, String systemId)	An extensible implementation of the Declaration Handler externalEntityDecl event, which reports DTD related (external DTD or internal subset) external entity declarations.
Object	getProperty(String name)	Reports a current property setting.
void	internalEntityDecl(String name, String value)	An extensible implementation of the Declaration Handler intenalEntityDecl event, which reports DTD related (external DTD or internal subset) internal entity declarations.
void	parse(String systemId)	An implementation of the XMLReader.parse(String) method.
void	parse(InputSource source)	An implementation of the XMLReader.parse(InputSource) method.
void	setProperty(String name, Object value)	Specifies a property used to configure the filter.
void	startCDATA()	An extensible implementation of the SAX LexicalHandler startCDATA event, which reports the start of a CDATA boundry idenitified by the parser.
void	startDTD(String name, String publicId, String systemId)	An extensible implementation of the SAX LexicalHandler startDTD event, which reports the start of DOCTYPE processing by the parser.
void	startEntity(String name)	An extensible implementation of the SAX LexicalHandler startEntity event, which reports the start of entity instance processing by the parser.

Methods inherited from class org.xml.sax.helpers.XMLFilterImpl

characters, endDocument, endElement, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

XMLFilterImpl2

public XMLFilterImpl2()

Creates a new XMLFilterImpl2.

Method Details

parse

public void parse(InputSource source)
           throws SAXException,
IOException,
UnsupportedOperationException

An implementation of the XMLReader.parse(InputSource) method. This method when called can trigger a JAXP SAX-event passing pipeline. Alternatively it may be called indirectly (behind the scenes) by triggering another pipeline stage and then via the setParent method the triggered stage will call this parse method.

The behaviour of this method differs from that of the supertype XMLFilterImpl.parse(InputSource) method in that it does not 'chain' the entityResolver from the parent. This allows an XMLReader at the start of a SAX filter pipeline to set and control its own entityResolver without interference from downstream filters. The behaviour of this class is also consistent with the behaviour of XMLFilters produced from Saxon B 9.1

Specified by:

parse in interface XMLReader

Overrides:

parse in class XMLFilterImpl

Parameters:

source - the data to be processed (by this stage, or initially by an upstream pipeline stage and passed to this stage as SAX events)

Throws:

SAXException - if the supertype throws this exception

IOException - if the supertype throws this exception

UnsupportedOperationException - if this method is called before configuring the pipeline with the setParent method

See Also:

• XMLFilterImpl.setParent(XMLReader)
• XMLFilterImpl.parse(InputSource)
• XMLReader.parse(InputSource)

parse

public void parse(String systemId)
           throws SAXException,
IOException,
UnsupportedOperationException

An implementation of the XMLReader.parse(String) method. This method when called can trigger a JAXP SAX-event passing pipeline. Alternatively it may be called indirectly (behind the scenes) by triggering another pipeline stage and then via the setParent method the triggered stage will call this parse method.

Specified by:

parse in interface XMLReader

Overrides:

parse in class XMLFilterImpl

Parameters:

systemId - A URL which specifies the data to be processed (by this stage, or an upstream pipeline stage)

Throws:

SAXException - if the supertype throws this exception

IOException - if the supertype throws this exception

UnsupportedOperationException - if this method is called before configuring the pipeline with the setParent method

See Also:

• XMLFilterImpl.setParent(XMLReader)
• XMLFilterImpl.parse(String)
• XMLReader.parse(String)

setProperty

public void setProperty(String name,
 Object value)
                 throws SAXNotRecognizedException,
SAXNotSupportedException

Specifies a property used to configure the filter. In addition to the property values typically supported by the standard (supertype) XMLFilterImpl this class also supports the following properties:

• http://xml.org/sax/properties/lexical-handler
• http://xml.org/sax/properties/declaration-handler

Specified by:

setProperty in interface XMLReader

Overrides:

setProperty in class XMLFilterImpl

Parameters:

name - the name of the property to be assigned

value - the new value of the property

Throws:

SAXNotRecognizedException - if the feature name is not recognized

SAXNotSupportedException - if it is not possible to configure the feature with the specified value

See Also:

• XMLFilterImpl.setProperty(String, Object)
• XMLReader.setProperty(String, Object)
• SAX Property documentation

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
SAXNotSupportedException

Reports a current property setting. Properties are used to configure the filter behaviour. In addition to the property values typically supported by the standard (supertype) XMLFilterImpl this class also supports the following properties:

• http://xml.org/sax/properties/lexical-handler
• http://xml.org/sax/properties/declaration-handler

Specified by:

getProperty in interface XMLReader

Overrides:

getProperty in class XMLFilterImpl

Parameters:

name - the name of the property to be reported

Returns:

an Object representation of the requested property

Throws:

SAXNotRecognizedException - if the feature name is not recognized

SAXNotSupportedException - if it is not possible to determine the feature's value

See Also:

• XMLFilterImpl.getProperty(String)
• XMLReader.getProperty(String)
• SAX Property documentation

elementDecl

public void elementDecl(String name,
 String model)
                 throws SAXException

An extensible implementation of the Declaration Handler elementDecl event, which reports DTD related (external DTD or internal subset) element declarations. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

elementDecl in interface DeclHandler

Parameters:

name - The element name reported

model - The declaration content

Throws:

SAXException - if the supertype throws this exception

See Also:

• DeclHandler.elementDecl(String, String)

attributeDecl

public void attributeDecl(String eName,
 String aName,
 String type,
 String valueDefault,
 String value)
                   throws SAXException

An extensible implementation of the Declaration Handler attributeDecl event, which reports DTD related (external DTD or internal subset) attribute declarations. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

attributeDecl in interface DeclHandler

Parameters:

eName - The name of the element containing the attribute

aName - The name of the attribute

type - The type of the attribute

valueDefault - The default value of the attribute, unless specified otherwise

value - ????

Throws:

SAXException - if the supertype throws this exception

See Also:

• DeclHandler.attributeDecl(String, String, String, String, String)

internalEntityDecl

public void internalEntityDecl(String name,
 String value)
                        throws SAXException

An extensible implementation of the Declaration Handler intenalEntityDecl event, which reports DTD related (external DTD or internal subset) internal entity declarations. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

internalEntityDecl in interface DeclHandler

Parameters:

name - The name of the entity

value - The entity value

Throws:

SAXException - if the supertype throws this exception

See Also:

• DeclHandler.internalEntityDecl(String, String)

externalEntityDecl

public void externalEntityDecl(String name,
 String publicId,
 String systemId)
                        throws SAXException

An extensible implementation of the Declaration Handler externalEntityDecl event, which reports DTD related (external DTD or internal subset) external entity declarations. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

externalEntityDecl in interface DeclHandler

Parameters:

name - The name of the entity

publicId - A publicId which identifies the external entity

systemId - A systemId which locates the external entity

Throws:

SAXException - if the supertype throws this exception

See Also:

• DeclHandler.externalEntityDecl(String, String, String)

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)
              throws SAXException

An extensible implementation of the SAX LexicalHandler startDTD event, which reports the start of DOCTYPE processing by the parser. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

startDTD in interface LexicalHandler

Parameters:

name - The name of the root element

publicId - The publicId of an external DTD

systemId - The systemId used to locate the external DTD

Throws:

SAXException - if the supertype throws this exception

See Also:

• LexicalHandler.startDTD(String, String, String)

endDTD

public void endDTD()
            throws SAXException

An extensible implementation of the SAX LexicalHandler endDTD event, which reports the end of DOCTYPE processing by the parser. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException - if the supertype throws this exception

See Also:

• LexicalHandler.startDTD(String, String, String)

startEntity

public void startEntity(String name)
                 throws SAXException

An extensible implementation of the SAX LexicalHandler startEntity event, which reports the start of entity instance processing by the parser. This method handles internal and external, general and parameter entities. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

startEntity in interface LexicalHandler

Parameters:

name - the name of the entity

Throws:

SAXException - if the supertype throws this exception

See Also:

• LexicalHandler.startEntity(String)

endEntity

public void endEntity(String name)
               throws SAXException

An extensible implementation of the SAX LexicalHandler endEntity event, which reports the end of entity instance processing by the parser. This method handles internal and external, general and parameter entities. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

endEntity in interface LexicalHandler

Parameters:

name - the name of the entity

Throws:

SAXException - if the supertype throws this exception

See Also:

• LexicalHandler.endEntity(String)

startCDATA

public void startCDATA()
                throws SAXException

An extensible implementation of the SAX LexicalHandler startCDATA event, which reports the start of a CDATA boundry idenitified by the parser. The actual CDATA content is reported by the character event. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException - if the supertype throws this exception

See Also:

• LexicalHandler.startCDATA()
• ContentHandler.characters(char[], int, int)

endCDATA

public void endCDATA()
              throws SAXException

An extensible implementation of the SAX LexicalHandler endCDATA event, which reports the end of a CDATA boundry idenitified by the parser. The actual CDATA content is reported by the character event. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException - if the supertype throws this exception

See Also:

• LexicalHandler.endCDATA()
• ContentHandler.characters(char[], int, int)

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

An extensible implementation of the SAX LexicalHandler comment event, which reports any comments identified by the parser. The actual CDATA content is reported by the character event. The default action of this filter method is to pass the parse event from input to output; it can be overriden to change this behaviour.

Specified by:

comment in interface LexicalHandler

Parameters:

ch - an array holding the comment amongst other character data

start - the starting position of this comment with the array

length - the number of characters to use from the array

Throws:

SAXException - if the supertype throws this exception

See Also:

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