org.jasig.portal.utils
Class SAX2BufferImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ChannelRenderingBuffer

public class SAX2BufferImpl
extends SAX2FilterImpl

A basic XML buffer implementation.

Author:

Peter Kharchenko pkharchenko@interactivebusiness.com"

Field Summary

protected boolean	buffering
static Integer	CHARACTERS
static Integer	COMMENT
protected boolean	copyCharBlock
static Integer	ENDCDATA
static Integer	ENDDOCUMENT
static Integer	ENDDTD
static Integer	ENDELEMENT
static Integer	ENDENTITY
static Integer	ENDPREFIXMAPPING
static Integer	ERROR
protected Vector	eventArguments
protected Vector	eventTypes
static Integer	FATALERROR
static Integer	IGNORABLEWHITESPACE
static Integer	NOTATIONDECL
protected boolean	outputAtDocumentEnd
static Integer	PROCESSINGINSTRUCTION
static Integer	SKIPPEDENTITY
static Integer	STARTCDATA
static Integer	STARTDOCUMENT
static Integer	STARTDTD
static Integer	STARTELEMENT
static Integer	STARTENTITY
static Integer	STARTPREFIXMAPPING
static Integer	UNPARSEDENTITYDECL
static Integer	WARNING

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

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

Constructor Summary

SAX2BufferImpl()
Construct an empty XML buffer, with no parent.

SAX2BufferImpl(ContentHandler ch)
Construct an XML filter based on a unified handler.

SAX2BufferImpl(ContentHandler ch, EntityResolver er, ErrorHandler eh, LexicalHandler lh, DTDHandler dh)
Construct an XML filter with the specified children.

SAX2BufferImpl(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	clearBuffer()
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.
void	ignorableWhitespace(char[] ch, int start, int length) Filter an ignorable whitespace event.
boolean	isEmpty()
void	notationDecl(String name, String publicId, String systemId) Filter a notation declaration event.
void	outputBuffer() Outputs buffer's content to a current set of handlers.
void	outputBuffer(ContentHandler ch) Outputs buffer's content to a specified content handler.
void	processingInstruction(String target, String data) Filter a processing instruction event.
void	setDocumentLocator(Locator locator) Filter a new document locator event.
void	setOutputAtDocumentEnd(boolean setting) Tells buffer to automatically output itself once an end of a document is reached.
void	skippedEntity(String name) Filter a skipped entity event.
void	startBuffering()
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	stopBuffering()
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, resolveEntity, 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

eventTypes

protected Vector eventTypes

eventArguments

protected Vector eventArguments

buffering

protected boolean buffering

outputAtDocumentEnd

protected boolean outputAtDocumentEnd

STARTDOCUMENT

public static final Integer STARTDOCUMENT

ENDDOCUMENT

public static final Integer ENDDOCUMENT

STARTELEMENT

public static final Integer STARTELEMENT

ENDELEMENT

public static final Integer ENDELEMENT

CHARACTERS

public static final Integer CHARACTERS

IGNORABLEWHITESPACE

public static final Integer IGNORABLEWHITESPACE

PROCESSINGINSTRUCTION

public static final Integer PROCESSINGINSTRUCTION

NOTATIONDECL

public static final Integer NOTATIONDECL

UNPARSEDENTITYDECL

public static final Integer UNPARSEDENTITYDECL

STARTPREFIXMAPPING

public static final Integer STARTPREFIXMAPPING

ENDPREFIXMAPPING

public static final Integer ENDPREFIXMAPPING

SKIPPEDENTITY

public static final Integer SKIPPEDENTITY

WARNING

public static final Integer WARNING

ERROR

public static final Integer ERROR

FATALERROR

public static final Integer FATALERROR

COMMENT

public static final Integer COMMENT

STARTCDATA

public static final Integer STARTCDATA

ENDCDATA

public static final Integer ENDCDATA

STARTDTD

public static final Integer STARTDTD

ENDDTD

public static final Integer ENDDTD

STARTENTITY

public static final Integer STARTENTITY

ENDENTITY

public static final Integer ENDENTITY

copyCharBlock

protected boolean copyCharBlock

Constructor Detail

SAX2BufferImpl

public SAX2BufferImpl()

Construct an empty XML buffer, 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.

By default, buffering is on, outputAtDocumentEnd is off.

See Also:

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

SAX2BufferImpl

public SAX2BufferImpl(XMLReader parent)

Construct an XML filter with the specified parent.

Same default flag settings as with empty constructor

See Also:

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

SAX2BufferImpl

public SAX2BufferImpl(ContentHandler ch,
                      EntityResolver er,
                      ErrorHandler eh,
                      LexicalHandler lh,
                      DTDHandler dh)

Construct an XML filter with the specified children.

Same default flag settings as with empty constructor

See Also:

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

SAX2BufferImpl

public SAX2BufferImpl(ContentHandler ch)

Construct an XML filter based on a unified handler.

Same default flag settings as with empty constructor.

Method Detail

setOutputAtDocumentEnd

public void setOutputAtDocumentEnd(boolean setting)

Tells buffer to automatically output itself once an end of a document is reached.

Parameters:

setting - a boolean value

clearBuffer

public void clearBuffer()

stopBuffering

public void stopBuffering()
                   throws SAXException

Throws:

SAXException

startBuffering

public void startBuffering()

isEmpty

public boolean isEmpty()

outputBuffer

public void outputBuffer()
                  throws SAXException

Outputs buffer's content to a current set of handlers. Please note that this method is not thread-safe if handlers are being reset by different threads. Use the other outputBuffer(ContentHandler) method in such cases.

Throws:

SAXException - if an error occurs

outputBuffer

public void outputBuffer(ContentHandler ch)
                  throws SAXException

Outputs buffer's content to a specified content handler. Please note that the content handler can also represent lexical handler, dtd handler and error handler. This method is thread-safe.

Parameters:

ch - a ContenteHandler value

Throws:

SAXException - if an error occurs

startDTD

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

Description copied from class: SAX2FilterImpl

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:

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

endDTD

public void endDTD()
            throws SAXException

Description copied from class: SAX2FilterImpl

Filter endDTD event

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class SAX2FilterImpl

Throws:

SAXException - The application may raise an exception.

See Also:

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

startEntity

public void startEntity(String name)
                 throws SAXException

Description copied from class: SAX2FilterImpl

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:

SAX2FilterImpl.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

Description copied from class: SAX2FilterImpl

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:

SAX2FilterImpl.startEntity(java.lang.String)

startCDATA

public void startCDATA()
                throws SAXException

Description copied from class: SAX2FilterImpl

Filter startCDATA event.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class SAX2FilterImpl

Throws:

SAXException - The application may raise an exception.

See Also:

SAX2FilterImpl.endCDATA()

endCDATA

public void endCDATA()
              throws SAXException

Description copied from class: SAX2FilterImpl

Filter endCDATA event.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class SAX2FilterImpl

Throws:

SAXException - The application may raise an exception.

See Also:

SAX2FilterImpl.startCDATA()

comment

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

Description copied from class: SAX2FilterImpl

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.

notationDecl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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)

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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

Description copied from class: SAX2FilterImpl

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)