org.apache.cocoon.xml
Class ContentHandlerWrapper

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLConsumer
          org.apache.cocoon.xml.ContentHandlerWrapper

All Implemented Interfaces:

Poolable, Recyclable, LogEnabled, XMLConsumer, ContentHandler, LexicalHandler

Direct Known Subclasses:

ContentAggregator, HtmlSaxParser.ContentFilter

public class ContentHandlerWrapper
extends AbstractXMLConsumer
implements Recyclable

This class is an utility class "wrapping" around a SAX version 2.0 ContentHandler and forwarding it those events received throug its XMLConsumers interface.

Version:

CVS $Id: ContentHandlerWrapper.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Davanum Srinivas (Apache Software Foundation, Computer Associates)

Field Summary

protected ContentHandler	contentHandler The current ContentHandler.
protected LexicalHandler	lexicalHandler The optional LexicalHandler

Constructor Summary

ContentHandlerWrapper()
Create a new ContentHandlerWrapper instance.

ContentHandlerWrapper(ContentHandler contentHandler)
Create a new ContentHandlerWrapper instance.

ContentHandlerWrapper(ContentHandler contentHandler, LexicalHandler lexicalHandler)
Create a new ContentHandlerWrapper instance.

Method Summary

void	characters(char[] ch, int start, int len) Receive notification of character data.
void	comment(char[] ch, int start, int len) Report an XML comment anywhere in the document.
void	endCDATA() Report the end of a CDATA section.
void	endDocument() Receive notification of the end of a document.
void	endDTD() Report the end of DTD declarations.
void	endElement(String uri, String loc, String raw) Receive notification of the end of an element.
void	endEntity(String name) Report the end of an entity.
void	endPrefixMapping(String prefix) End the scope of a prefix-URI mapping.
void	ignorableWhitespace(char[] ch, int start, int len) Receive notification of ignorable whitespace in element content.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
void	recycle()
void	setContentHandler(ContentHandler contentHandler) Set the ContentHandler that will receive XML data.
void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
void	setLexicalHandler(LexicalHandler lexicalHandler) Set the LexicalHandler that will receive XML data.
void	skippedEntity(String name) Receive notification of a skipped entity.
void	startCDATA() Report the start of a CDATA section.
void	startDocument() Receive notification of the beginning of a document.
void	startDTD(String name, String publicId, String systemId) Report the start of DTD declarations, if any.
void	startElement(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of an element.
void	startEntity(String name) Report the beginning of an entity.
void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

contentHandler

protected ContentHandler contentHandler

The current ContentHandler.

lexicalHandler

protected LexicalHandler lexicalHandler

The optional LexicalHandler

Constructor Detail

ContentHandlerWrapper

public ContentHandlerWrapper()

Create a new ContentHandlerWrapper instance.

ContentHandlerWrapper

public ContentHandlerWrapper(ContentHandler contentHandler)

Create a new ContentHandlerWrapper instance.

ContentHandlerWrapper

public ContentHandlerWrapper(ContentHandler contentHandler,
                             LexicalHandler lexicalHandler)

Create a new ContentHandlerWrapper instance.

Method Detail

setContentHandler

public void setContentHandler(ContentHandler contentHandler)
                       throws IllegalStateException

Set the ContentHandler that will receive XML data.

Throws:

IllegalStateException - If the ContentHandler was already set.

setLexicalHandler

public void setLexicalHandler(LexicalHandler lexicalHandler)
                       throws IllegalStateException

Set the LexicalHandler that will receive XML data.

Throws:

IllegalStateException - If the LexicalHandler was already set.

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

setDocumentLocator

public void setDocumentLocator(Locator locator)

Receive an object for locating the origin of SAX document events.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class AbstractXMLConsumer

Parameters:

locator - An object that can return the location of any SAX document event.

startDocument

public void startDocument()
                   throws SAXException

Receive notification of the beginning of a document.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class AbstractXMLConsumer

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Receive notification of the end of a document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class AbstractXMLConsumer

Throws:

SAXException

startPrefixMapping

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

Begin the scope of a prefix-URI Namespace mapping.

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class AbstractXMLConsumer

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

End the scope of a prefix-URI mapping.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class AbstractXMLConsumer

Parameters:

prefix - The prefix that was being mapping.

Throws:

SAXException

startElement

public void startElement(String uri,
                         String loc,
                         String raw,
                         Attributes a)
                  throws SAXException

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class AbstractXMLConsumer

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.

raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

a - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

SAXException

endElement

public void endElement(String uri,
                       String loc,
                       String raw)
                throws SAXException

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class AbstractXMLConsumer

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.

raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

Throws:

SAXException

characters

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

Receive notification of character data.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class AbstractXMLConsumer

Parameters:

ch - The characters from the XML document.

start - The start position in the array.

len - The number of characters to read from the array.

Throws:

SAXException

ignorableWhitespace

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

Receive notification of ignorable whitespace in element content.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class AbstractXMLConsumer

Parameters:

ch - The characters from the XML document.

start - The start position in the array.

len - The number of characters to read from the array.

Throws:

SAXException

processingInstruction

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

Receive notification of a processing instruction.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class AbstractXMLConsumer

Parameters:

target - The processing instruction target.

data - The processing instruction data, or null if none was supplied.

Throws:

SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Receive notification of a skipped entity.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class AbstractXMLConsumer

Parameters:

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

Throws:

SAXException

startDTD

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

Report the start of DTD declarations, if any.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class AbstractXMLConsumer

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

endDTD

public void endDTD()
            throws SAXException

Report the end of DTD declarations.

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class AbstractXMLConsumer

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Report the beginning of an entity.

Specified by:

startEntity in interface LexicalHandler

Overrides:

startEntity in class AbstractXMLConsumer

Parameters:

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

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Overrides:

endEntity in class AbstractXMLConsumer

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Report the start of a CDATA section.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class AbstractXMLConsumer

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class AbstractXMLConsumer

Throws:

SAXException

comment

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

Report an XML comment anywhere in the document.

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class AbstractXMLConsumer

Parameters:

ch - An array holding the characters in the comment.

start - The starting position in the array.

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

Throws:

SAXException