org.jasig.portal.utils
Class SAX2DuplicatingFilterImpl

java.lang.Object
  org.jasig.portal.utils.SAX2FilterImpl
      org.jasig.portal.utils.SAX2DuplicatingFilterImpl

All Implemented Interfaces:

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

public class SAX2DuplicatingFilterImpl
extends SAX2FilterImpl

This is a remake of org.xml.sax.helpers.XMLFilterImpl that allows for downward chaining of LexicalHandlers, and further extensions.

Some of the behavior is slightly different from that of hte XMLFilterImpl. For example this implementation allows to set null handlers. It also redirects parent's handlers right after instantiation or setParent() invokation, not just at the parse().

See Also:

XMLFilterImpl

Field Summary

protected ContentHandler	contentHandler2
protected DTDHandler	dtdHandler2
protected EntityResolver	entityResolver2
protected ErrorHandler	errorHandler2
protected LexicalHandler	lexicalHandler2

Fields inherited from class org.jasig.portal.utils.SAX2FilterImpl

contentHandler, dtdHandler, entityResolver, errorHandler, lexicalHandler, locator, log

Constructor Summary

SAX2DuplicatingFilterImpl()
Construct an empty XML filter, with no parent.

SAX2DuplicatingFilterImpl(ContentHandler ch, ContentHandler ch2)
Try to imply all of the handlers from ContentHandler alone.

SAX2DuplicatingFilterImpl(ContentHandler ch, EntityResolver er, ErrorHandler eh, LexicalHandler lh, DTDHandler dh, ContentHandler ch2, EntityResolver er2, ErrorHandler eh2, LexicalHandler lh2, DTDHandler dh2)
Construct an XML filter with the specified children handlers.

SAX2DuplicatingFilterImpl(XMLReader parent)
Construct an XML filter with the specified parent.

Method Summary

void	characters(char[] ch, int start, int length) Filter a character data event.
void	comment(char[] ch, int start, int length) Filter comment event.
void	endCDATA() Filter endCDATA event.
void	endDocument() Filter an end document event.
void	endDTD() Filter endDTD event
void	endElement(String uri, String localName, String qName) Filter an end element event.
void	endEntity(String name) Filter endEntity event.
void	endPrefixMapping(String prefix) Filter an end Namespace prefix mapping event.
void	error(SAXParseException e) Filter an error event.
void	fatalError(SAXParseException e) Filter a fatal error event.
ContentHandler	getContentHandler2() Get the content event handler.
DTDHandler	getDTDHandler2() Get the current DTD event handler.
ErrorHandler	getErrorHandler2() Get the current error event handler.
void	ignorableWhitespace(char[] ch, int start, int length) Filter an ignorable whitespace event.
void	notationDecl(String name, String publicId, String systemId) Filter a notation declaration event.
void	processingInstruction(String target, String data) Filter a processing instruction event.
InputSource	resolveEntity(String publicId, String systemId) Filter an external entity resolution.
void	setAllHandlers(ContentHandler ch, ContentHandler ch2) Try to imply all of the handlers from ContentHandler alone.
void	setContentHandler2(ContentHandler handler) Set the content event handler.
void	setDocumentLocator(Locator locator) Filter a new document locator event.
void	setDTDHandler2(DTDHandler handler) Set the DTD event handler.
void	setErrorHandler2(ErrorHandler handler) Set the error event handler.
void	setLexicalHandler2(LexicalHandler handler) Set the lexical handler.
void	skippedEntity(String name) Filter a skipped entity event.
void	startCDATA() Filter startCDATA event.
void	startDocument() Filter a start document event.
void	startDTD(String name, String publicId, String systemId) Filter startDTD event.
void	startElement(String uri, String localName, String qName, Attributes atts) Filter a start element event.
void	startEntity(String name) Filter startEntity event.
void	startPrefixMapping(String prefix, String uri) Filter a start Namespace prefix mapping event.
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName) Filter an unparsed entity declaration event.
void	warning(SAXParseException e) Filter a warning event.

Methods inherited from class org.jasig.portal.utils.SAX2FilterImpl

getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, parse, parse, setAllHandlers, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setLexicalHandler, setParent, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

entityResolver2

protected EntityResolver entityResolver2

dtdHandler2

protected DTDHandler dtdHandler2

contentHandler2

protected ContentHandler contentHandler2

errorHandler2

protected ErrorHandler errorHandler2

lexicalHandler2

protected LexicalHandler lexicalHandler2

Constructor Detail

SAX2DuplicatingFilterImpl

public SAX2DuplicatingFilterImpl()

Construct an empty XML filter, with no parent.

This filter will have no parent: you must assign a parent before you start a parse or do any configuration with setFeature or setProperty.

See Also:

XMLReader.setFeature(java.lang.String, boolean), XMLReader.setProperty(java.lang.String, java.lang.Object)

SAX2DuplicatingFilterImpl

public SAX2DuplicatingFilterImpl(XMLReader parent)

Construct an XML filter with the specified parent.

See Also:

SAX2FilterImpl.setParent(XMLReader), SAX2FilterImpl.getParent()

SAX2DuplicatingFilterImpl

public SAX2DuplicatingFilterImpl(ContentHandler ch,
                                 EntityResolver er,
                                 ErrorHandler eh,
                                 LexicalHandler lh,
                                 DTDHandler dh,
                                 ContentHandler ch2,
                                 EntityResolver er2,
                                 ErrorHandler eh2,
                                 LexicalHandler lh2,
                                 DTDHandler dh2)

Construct an XML filter with the specified children handlers.

See Also:

SAX2FilterImpl.setContentHandler(ContentHandler), SAX2FilterImpl.setDTDHandler(DTDHandler), SAX2FilterImpl.setErrorHandler(ErrorHandler), SAX2FilterImpl.setEntityResolver(EntityResolver), SAX2FilterImpl.setLexicalHandler(LexicalHandler)

SAX2DuplicatingFilterImpl

public SAX2DuplicatingFilterImpl(ContentHandler ch,
                                 ContentHandler ch2)

Try to imply all of the handlers from ContentHandler alone.

Method Detail

setAllHandlers

public void setAllHandlers(ContentHandler ch,
                           ContentHandler ch2)

Try to imply all of the handlers from ContentHandler alone.

setDTDHandler2

public void setDTDHandler2(DTDHandler handler)

Set the DTD event handler.

Parameters:

handler - The new DTD handler.

See Also:

XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

getDTDHandler2

public DTDHandler getDTDHandler2()

Get the current DTD event handler.

Returns:

The current DTD handler, or null if none was set.

See Also:

XMLReader.getDTDHandler()

setContentHandler2

public void setContentHandler2(ContentHandler handler)

Set the content event handler.

Parameters:

handler - The new content handler.

See Also:

XMLReader.setContentHandler(org.xml.sax.ContentHandler)

getContentHandler2

public ContentHandler getContentHandler2()

Get the content event handler.

Returns:

The current content handler, or null if none was set.

See Also:

XMLReader.getContentHandler()

setErrorHandler2

public void setErrorHandler2(ErrorHandler handler)

Set the error event handler.

Parameters:

handler - The new error handler.

See Also:

XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

setLexicalHandler2

public void setLexicalHandler2(LexicalHandler handler)

Set the lexical handler.

Parameters:

handler - The new lexical handler.

getErrorHandler2

public ErrorHandler getErrorHandler2()

Get the current error event handler.

Returns:

The current error handler, or null if none was set.

See Also:

XMLReader.getErrorHandler()

startDTD

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

Filter startDTD event.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class SAX2FilterImpl

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.

Throws:

SAXException - The application may raise an exception.

See Also:

endDTD(), startEntity(java.lang.String)

endDTD

public void endDTD()
            throws SAXException

Filter endDTD event

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class SAX2FilterImpl

Throws:

SAXException - The application may raise an exception.

See Also:

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

startEntity

public void startEntity(String name)
                 throws SAXException

Filter startEntity event.

Specified by:

startEntity in interface LexicalHandler

Overrides:

startEntity in class SAX2FilterImpl

Parameters:

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

Throws:

SAXException - The application may raise an exception.

See Also:

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

endEntity

public void endEntity(String name)
               throws SAXException

Filter endEntity event.

Specified by:

endEntity in interface LexicalHandler

Overrides:

endEntity in class SAX2FilterImpl

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException - The application may raise an exception.

See Also:

startEntity(java.lang.String)

startCDATA

public void startCDATA()
                throws SAXException

Filter startCDATA event.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class SAX2FilterImpl

Throws:

SAXException - The application may raise an exception.

See Also:

endCDATA()

endCDATA

public void endCDATA()
              throws SAXException

Filter endCDATA event.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class SAX2FilterImpl

Throws:

SAXException - The application may raise an exception.

See Also:

startCDATA()

comment

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

Filter comment event.

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class SAX2FilterImpl

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:

SAXException - The application may raise an exception.

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException

Filter an external entity resolution.

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class SAX2FilterImpl

Parameters:

publicId - The entity's public identifier, or null.

systemId - The entity's system identifier.

Returns:

A new InputSource or null for the default.

Throws:

SAXException - The client may throw an exception during processing.

IOException - The client may throw an I/O-related exception while obtaining the new InputSource.

See Also:

EntityResolver.resolveEntity(java.lang.String, java.lang.String)

notationDecl

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

Filter a notation declaration event.

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in class SAX2FilterImpl

Parameters:

name - The notation name.

publicId - The notation's public identifier, or null.

systemId - The notation's system identifier, or null.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
                        throws SAXException

Filter an unparsed entity declaration event.

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in class SAX2FilterImpl

Parameters:

name - The entity name.

publicId - The entity's public identifier, or null.

systemId - The entity's system identifier, or null.

notationName - The name of the associated notation.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

setDocumentLocator

public void setDocumentLocator(Locator locator)

Filter a new document locator event.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class SAX2FilterImpl

Parameters:

locator - The document locator.

See Also:

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

startDocument

public void startDocument()
                   throws SAXException

Filter a start document event.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class SAX2FilterImpl

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

Filter an end document event.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class SAX2FilterImpl

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.endDocument()

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Filter a start Namespace prefix mapping event.

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class SAX2FilterImpl

Parameters:

prefix - The Namespace prefix.

uri - The Namespace URI.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Filter an end Namespace prefix mapping event.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class SAX2FilterImpl

Parameters:

prefix - The Namespace prefix.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException

Filter a start element event.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class SAX2FilterImpl

Parameters:

uri - The element's Namespace URI, or the empty string.

localName - The element's local name, or the empty string.

qName - The element's qualified (prefixed) name, or the empty string.

atts - The element's attributes.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Filter an end element event.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class SAX2FilterImpl

Parameters:

uri - The element's Namespace URI, or the empty string.

localName - The element's local name, or the empty string.

qName - The element's qualified (prefixed) name, or the empty string.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

characters

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

Filter a character data event.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class SAX2FilterImpl

Parameters:

ch - An array of characters.

start - The starting position in the array.

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

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

ignorableWhitespace

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

Filter an ignorable whitespace event.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class SAX2FilterImpl

Parameters:

ch - An array of characters.

start - The starting position in the array.

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

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Filter a processing instruction event.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class SAX2FilterImpl

Parameters:

target - The processing instruction target.

data - The text following the target.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Filter a skipped entity event.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class SAX2FilterImpl

Parameters:

name - The name of the skipped entity.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.skippedEntity(java.lang.String)

warning

public void warning(SAXParseException e)
             throws SAXException

Filter a warning event.

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class SAX2FilterImpl

Parameters:

e - The nwarning as an exception.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ErrorHandler.warning(org.xml.sax.SAXParseException)

error

public void error(SAXParseException e)
           throws SAXException

Filter an error event.

Specified by:

error in interface ErrorHandler

Overrides:

error in class SAX2FilterImpl

Parameters:

e - The error as an exception.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ErrorHandler.error(org.xml.sax.SAXParseException)

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Filter a fatal error event.

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class SAX2FilterImpl

Parameters:

e - The error as an exception.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ErrorHandler.fatalError(org.xml.sax.SAXParseException)