com.deltaxml.pipe

Class XMLFilterImpl3

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

com.deltaxml.pipe.XMLFilterImpl2

com.deltaxml.pipe.XMLFilterImpl3

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.XMLFilter, org.xml.sax.XMLReader

Direct Known Subclasses:

LexicalPreservationBase

public class XMLFilterImpl3
extends XMLFilterImpl2
implements org.xml.sax.DTDHandler

Provides an extensible class for filtering SAX events, including lexical events such as XML comments. The class is functionally similar to XMLFilterImpl2 but provides additional extensible methods to support the suppression of output.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLFilterImpl3.SaxEventItem The SAX event items for marking which SAX events to process.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_ADDITIONAL_INFO Process additional information events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_ALL Process all filter events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_BODY Process body events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_DATA Process text data events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_DECLS Process all declaration events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_ELEM_AND_ATTRIB_DECLS Process element and attribute declaration events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_ENTITY_AND_NOTATION_DECLS Process the entity and notation declaration events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_ENTITY_DECLS Process the entity declaration events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_ENTITY_REFS Process all entity reference events (including skipped reference events).
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_EXCEPTIONS Process exception events.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_INTERNAL_SUBSET Process the events that occur in the internal subset.
static java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	PROCESS_NORMAL_BODY Process normal body events.

Constructor Summary

Constructors

Constructor and Description
XMLFilterImpl3() Creates a new XMLFilterImpl3.

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) Process the SAX attributeDecl event.
void	characters(char[] ch, int start, int length) Process the SAX characters event.
void	comment(char[] ch, int start, int length) Process the SAX comment event.
void	elementDecl(java.lang.String name, java.lang.String model) Process the SAX elementDecl event.
void	endCDATA() Process the SAX endCDATA event.
void	endDocument() Process the SAX endDocument event.
void	endDTD() Process the SAX endDTD event.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Process the SAX endElement event.
void	endEntity(java.lang.String name) Process the SAX endEntity event.
void	endPrefixMapping(java.lang.String prefix) Process the SAX endPrefixMapping event.
void	error(org.xml.sax.SAXParseException e) Process the SAX error event.
void	externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Process the SAX externalEntityDecl event.
void	fatalError(org.xml.sax.SAXParseException e) Process the SAX fatalEror event.
java.util.EnumSet<XMLFilterImpl3.SaxEventItem>	getProcessFilter() Get a copy of the current process filter set.
void	ignorableWhitespace(char[] ch, int start, int length) Process the SAX ignorableWhitespace event.
void	internalEntityDecl(java.lang.String name, java.lang.String value) Process the SAX internalEntityDecl event.
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Process the SAX notationDecl event.
boolean	processEvent(XMLFilterImpl3.SaxEventItem pi) State whether the filter is processing the given event.
void	processingInstruction(java.lang.String target, java.lang.String data) Process the SAX processingInstruction event.
void	setDocumentLocator(org.xml.sax.Locator locator) Process the SAX setDocumentLocator event.
void	setProcessFilter(java.util.EnumSet<XMLFilterImpl3.SaxEventItem> pis) Set which SAX event items to process an item set.
void	setProcessFilter(java.util.EnumSet<XMLFilterImpl3.SaxEventItem> pis, boolean process) Set whether to process the set of SAX event items.
void	setProcessFilter(XMLFilterImpl3.SaxEventItem pi, boolean process) Set whether to process a SAX event item.
void	skippedEntity(java.lang.String name) Process the SAX skippedEntity event.
void	startCDATA() Process the SAX startCDATA event.
void	startDocument() Process the SAX startDocument event.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Process the SAX startDTD event.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) Process the SAX startElement event.
void	startEntity(java.lang.String name) Process the SAX startEntity event.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Process the SAX startPrefixMapping event.
void	unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) Process the SAX unparsedEntityDecl event.
void	warning(org.xml.sax.SAXParseException e) Process the SAX warning event.

Methods inherited from class com.deltaxml.pipe.XMLFilterImpl2

getProperty, parse, parse, setProperty

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

getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, resolveEntity, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_ALL

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_ALL

Process all filter events.

PROCESS_ENTITY_DECLS

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_ENTITY_DECLS

Process the entity declaration events. That is the internal parsed entity, external parsed entity and the unparsed entity events. (i.e. XMLFilterImpl3.SaxEventItem.INT_PAR_ENTITY_DECL, XMLFilterImpl3.SaxEventItem.EXT_PAR_ENTITY_DECL, and XMLFilterImpl3.SaxEventItem.UNPAR_ENTITY_DECL SAX event items).

PROCESS_ENTITY_AND_NOTATION_DECLS

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_ENTITY_AND_NOTATION_DECLS

Process the entity and notation declaration events. Add the XMLFilterImpl3.SaxEventItem.NOTATION_DECL item to the entity declarations ( XMLFilterImpl3.PROCESS_ENTITY_DECLS).

PROCESS_ELEM_AND_ATTRIB_DECLS

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_ELEM_AND_ATTRIB_DECLS

Process element and attribute declaration events. That is the XMLFilterImpl3.SaxEventItem.ELEMENT_DECL and XMLFilterImpl3.SaxEventItem.ATTRIBUTE_DECL items.

PROCESS_DECLS

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_DECLS

Process all declaration events. That is process entity, notation, element and attribute declarations (i.e. union of XMLFilterImpl3.PROCESS_ENTITY_AND_NOTATION_DECLS and XMLFilterImpl3.PROCESS_ELEM_AND_ATTRIB_DECLS).

PROCESS_ENTITY_REFS

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_ENTITY_REFS

Process all entity reference events (including skipped reference events). That is the XMLFilterImpl3.SaxEventItem.ENTITY and XMLFilterImpl3.SaxEventItem.SKIPPED_ENTITY items.

PROCESS_DATA

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_DATA

Process text data events. That is the CDATA, character and ignorable whitespace events (i.e. XMLFilterImpl3.SaxEventItem.CDATA, XMLFilterImpl3.SaxEventItem.CHARACTERS, and XMLFilterImpl3.SaxEventItem.IGNORABLE_WHITESPACE items).

PROCESS_ADDITIONAL_INFO

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_ADDITIONAL_INFO

Process additional information events. That is location, comments and processing instruction events (i.e. XMLFilterImpl3.SaxEventItem.LOCATOR, XMLFilterImpl3.SaxEventItem.COMMENT, and XMLFilterImpl3.SaxEventItem.PROCESSING_INSTRUCTION items). Note that the setLocator event always precedes the startDocument event.

PROCESS_INTERNAL_SUBSET

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_INTERNAL_SUBSET

Process the events that occur in the internal subset. That is the declaration, entity reference, and DTD events (i.e. the union of the XMLFilterImpl3.PROCESS_DECLS and XMLFilterImpl3.PROCESS_ENTITY_REFS sets with the XMLFilterImpl3.SaxEventItem.DTD item). Note that this does not include the additional information or exception events that may also appear in the internal subset.

PROCESS_NORMAL_BODY

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_NORMAL_BODY

Process normal body events. That is the text data events and the start/stop element and prefix-mapping events (i.e. the union of the XMLFilterImpl3.PROCESS_DATA set with the XMLFilterImpl3.SaxEventItem.ELEMENT and XMLFilterImpl3.SaxEventItem.PREFIX_MAPPING items. Note this set does not contain the entity reference, additional data, and exception events.

PROCESS_BODY

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_BODY

Process body events. That is the text data events, the start/stop element and prefix-mapping events, and the entity reference events (i.e. the union of the XMLFilterImpl3.PROCESS_NORMAL_BODY and XMLFilterImpl3.PROCESS_ENTITY_REFS sets). Note this set does not contain the additional data and exception events.

PROCESS_EXCEPTIONS

public static final java.util.EnumSet<XMLFilterImpl3.SaxEventItem> PROCESS_EXCEPTIONS

Process exception events. That is process warning, error, and fatal-error events (i.e. XMLFilterImpl3.SaxEventItem.WARNING, XMLFilterImpl3.SaxEventItem.ERROR and XMLFilterImpl3.SaxEventItem.FATAL_ERROR process items).

Constructor Detail

XMLFilterImpl3

public XMLFilterImpl3()

Creates a new XMLFilterImpl3.

Method Detail

getProcessFilter

public java.util.EnumSet<XMLFilterImpl3.SaxEventItem> getProcessFilter()

Get a copy of the current process filter set.

Returns:

a copy of the current process filter set.

processEvent

public boolean processEvent(XMLFilterImpl3.SaxEventItem pi)

State whether the filter is processing the given event.

Parameters:

pi - The SAX event item.

Returns:

Whether this item should be processed.

setProcessFilter

public void setProcessFilter(XMLFilterImpl3.SaxEventItem pi,
                             boolean process)

Set whether to process a SAX event item.

Parameters:

pi - The process item.

process - Whether to add (true) or remove the item from this object's current process filter set.

setProcessFilter

public void setProcessFilter(java.util.EnumSet<XMLFilterImpl3.SaxEventItem> pis,
                             boolean process)

Set whether to process the set of SAX event items. This effectively performs a union or set difference operation on this object's current process filter set, depending on whether the process parameter is set to true or false respectively.

Parameters:

pis - A set of SAX event items.

process - Whether to add (true) or remove items from this object's current process filter set.

setProcessFilter

public void setProcessFilter(java.util.EnumSet<XMLFilterImpl3.SaxEventItem> pis)

Set which SAX event items to process an item set. This replaces this object's current process filter set.

Parameters:

pis - The set of SAX event items to process.

setDocumentLocator

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

Process the SAX setDocumentLocator event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.LOCATOR element, then the parent's setDocumentLocator is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

locator - the document locator.

startDocument

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

Process the SAX startDocument event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.DOCUMENT element, then the parent's startDocument is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.XMLFilterImpl

Throws:

org.xml.sax.SAXException - when there is a SAX error.

endDocument

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

Process the SAX endDocument event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.DOCUMENT element, then the parent's endDocument is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.XMLFilterImpl

Throws:

org.xml.sax.SAXException - when there is a SAX error.

startDTD

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

Process the SAX startDTD event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.DTD element, then the parent's startDTD is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

startDTD in class XMLFilterImpl2

Parameters:

name - root element name

publicId - the optional public document id

systemId - the optional system document id

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

LexicalHandler.startDTD(String, String, String)

endDTD

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

Process the SAX endDTD event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.DTD element, then the parent's endDTD is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

endDTD in class XMLFilterImpl2

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

LexicalHandler.startDTD(String, String, String)

elementDecl

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

Process the SAX elementDecl event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ELEMENT_DECL element, then the parent's elementDecl is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

elementDecl in class XMLFilterImpl2

Parameters:

name - the element name

model - the elements/data that this element can contain

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

DeclHandler.elementDecl(String, 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

Process the SAX attributeDecl event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ATTRIBUTE_DECL element, then the parent's attributeDecl is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

attributeDecl in class XMLFilterImpl2

Parameters:

eName - the name of the associated element.

aName - the name of the attribute

type - the attribute's type

mode - the attribute's mode

value - the attribute's value

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

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

internalEntityDecl

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

Process the SAX internalEntityDecl event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.INT_PAR_ENTITY_DECL element, then the parent's internalEntityDecl is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

internalEntityDecl in class XMLFilterImpl2

Parameters:

name - the entity's mode

value - the entity's value

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

DeclHandler.internalEntityDecl(String, String)

externalEntityDecl

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

Process the SAX externalEntityDecl event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.EXT_PAR_ENTITY_DECL element, then the parent's externalEntityDecl is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

externalEntityDecl in class XMLFilterImpl2

Parameters:

name - the entity's name

publicId - the entity's public identifier

systemId - the entity's system identifier

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

DeclHandler.externalEntityDecl(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

Process the SAX unparsedEntityDecl event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.UNPAR_ENTITY_DECL element, then the parent's unparsedEntityDecl is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

unparsedEntityDecl in interface org.xml.sax.DTDHandler

Overrides:

unparsedEntityDecl in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

name - the entity's name

publicId - the entity's public identifier

systemId - the entity's system identifier

notationName - the entity's notation

Throws:

org.xml.sax.SAXException - when there is a SAX error.

notationDecl

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

Process the SAX notationDecl event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.NOTATION_DECL element, then the parent's notationDecl is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

notationDecl in interface org.xml.sax.DTDHandler

Overrides:

notationDecl in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

name - the notation name

publicId - the notation public identifier

systemId - the notation system identifier

Throws:

org.xml.sax.SAXException - when there is a SAX error.

startEntity

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

Process the SAX startEntity event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ENTITY element, then the parent's startEntity is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

startEntity in class XMLFilterImpl2

Parameters:

name - the name of the entity being referenced.

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

LexicalHandler.startEntity(String)

endEntity

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

Process the SAX endEntity event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ENTITY element, then the parent's endEntity is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

endEntity in class XMLFilterImpl2

Parameters:

name - the name of the entity being referenced.

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

LexicalHandler.endEntity(String)

skippedEntity

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

Process the SAX skippedEntity event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.SKIPPED_ENTITY element, then the parent's skippedEntity is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Overrides:

skippedEntity in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

name - the name of the entity being skipped.

Throws:

org.xml.sax.SAXException - when there is a SAX error.

startCDATA

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

Process the SAX startCDATA event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.CDATA element, then the parent's startCDATA is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

startCDATA in class XMLFilterImpl2

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

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

endCDATA

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

Process the SAX endCDATA event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.CDATA element, then the parent's endCDATA is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

endCDATA in class XMLFilterImpl2

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

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

characters

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

Process the SAX characters event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.CHARACTERS element, then the parent's characters is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

ch - characters an array of characters

start - the starting character position

length - the number of characters to process

Throws:

org.xml.sax.SAXException - when there is a SAX error.

ignorableWhitespace

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

Process the SAX ignorableWhitespace event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.IGNORABLE_WHITESPACE element, then the parent's ignorableWhitespace is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Overrides:

ignorableWhitespace in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

ch - characters an array of characters

start - the starting character position

length - the number of characters to process

Throws:

org.xml.sax.SAXException - when there is a SAX error.

comment

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

Process the SAX comment event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.COMMENT element, then the parent's comment is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

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

Overrides:

comment in class XMLFilterImpl2

Parameters:

ch - characters an array of characters

start - the starting character position

length - the number of characters to process

Throws:

org.xml.sax.SAXException - when there is a SAX error.

See Also:

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

processingInstruction

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

Process the SAX processingInstruction event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.PROCESSING_INSTRUCTION element, then the parent's processingInstruction is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

target - the name of the processing instruction

data - the content of the processing instruction

Throws:

org.xml.sax.SAXException - when there is a SAX error.

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

Process the SAX startElement event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ELEMENT element, then the parent's startElement is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

uri - the element's UTI

localName - the element's local name

qName - the element's qualified name

atts - the elements attributes

Throws:

org.xml.sax.SAXException - when there is a SAX error.

endElement

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

Process the SAX endElement event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ELEMENT element, then the parent's endElement is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

uri - the element's UTI

localName - the element's local name

qName - the element's qualified name

Throws:

org.xml.sax.SAXException - when there is a SAX error.

startPrefixMapping

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

Process the SAX startPrefixMapping event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.PREFIX_MAPPING element, then the parent's startPrefixMapping is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

prefix - the namespace prefix

uri - the namespace URI

Throws:

org.xml.sax.SAXException - when there is a SAX error.

endPrefixMapping

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

Process the SAX endPrefixMapping event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.PREFIX_MAPPING element, then the parent's endPrefixMapping is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

prefix - the namespace prefix

Throws:

org.xml.sax.SAXException - when there is a SAX error.

warning

public void warning(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException

Process the SAX warning event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.WARNING element, then the parent's warning is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

warning in interface org.xml.sax.ErrorHandler

Overrides:

warning in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

e - a parse exception.

Throws:

org.xml.sax.SAXException - when there is a SAX error.

error

public void error(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException

Process the SAX error event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.ERROR element, then the parent's error is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

error in interface org.xml.sax.ErrorHandler

Overrides:

error in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

e - a parse exception.

Throws:

org.xml.sax.SAXException - when there is a SAX error.

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException

Process the SAX fatalEror event.

When this object's process filter set contains a XMLFilterImpl3.SaxEventItem.FATAL_ERROR element, then the parent's fatalError is invoked before this method returns. In all other cases this method returns without doing anything.

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Overrides:

fatalError in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

e - a parse exception.

Throws:

org.xml.sax.SAXException - when there is a SAX error.