This project has retired. For details please refer to its Attic page.

org.apache.cocoon.xml
Class DocumentHandlerWrapper

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

All Implemented Interfaces:

LogEnabled, XMLConsumer, ContentHandler, LexicalHandler

public class DocumentHandlerWrapper
extends AbstractXMLConsumer

This class is an utility class "wrapping" around a SAX version 1.0 DocumentHandler and forwarding it those events received throug its XMLConsumers interface.
This class fully supports XML namespaces, converting startPrefixMapping(...) and endPrefixMapping(...) calls into appropriate xmlns and xmlns:... element attributes.

Version:

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

Author:

Pierpaolo Fumagalli (Apache Software Foundation)

Field Summary

protected DocumentHandler	documentHandler The current DocumentHandler.
protected Logger	log

Constructor Summary

DocumentHandlerWrapper()
Create a new DocumentHandlerWrapper instance.

DocumentHandlerWrapper(DocumentHandler document)
Create a new DocumentHandlerWrapper instance.

Method Summary

void	characters(char[] ch, int start, int len) Receive notification of character data.
void	enableLogging(Logger logger) Provide component with a logger.
void	endDocument() Receive notification of the end of a document.
void	endElement(String uri, String loc, String raw) Receive notification of the end of an element.
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() Implementation of the recycle method
void	setDocumentHandler(DocumentHandler document) Set the DocumentHandler that will receive XML data.
void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
void	startDocument() Receive notification of the beginning of a document.
void	startElement(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of an element.
void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class org.apache.cocoon.xml.AbstractXMLConsumer

comment, endCDATA, endDTD, endEntity, skippedEntity, startCDATA, startDTD, startEntity

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

getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

log

protected Logger log

documentHandler

protected DocumentHandler documentHandler

The current DocumentHandler.

Constructor Detail

DocumentHandlerWrapper

public DocumentHandlerWrapper()

Create a new DocumentHandlerWrapper instance.

DocumentHandlerWrapper

public DocumentHandlerWrapper(DocumentHandler document)

Create a new DocumentHandlerWrapper instance.

Method Detail

enableLogging

public void enableLogging(Logger logger)

Provide component with a logger.

Specified by:

enableLogging in interface LogEnabled

Overrides:

enableLogging in class AbstractLogEnabled

Parameters:

logger - the logger

recycle

public void recycle()

Implementation of the recycle method

setDocumentHandler

public void setDocumentHandler(DocumentHandler document)
                        throws IllegalStateException

Set the DocumentHandler that will receive XML data.

Throws:

IllegalStateException - If the DocumentHandler was already set.

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