org.apache.cocoon.xml
Class DocumentHandlerWrapper

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.xml.AbstractXMLConsumer
          extended byorg.apache.cocoon.xml.DocumentHandlerWrapper
All Implemented Interfaces:
ContentHandler, LexicalHandler, XMLConsumer, org.apache.cocoon.xml.XMLConsumer

public class DocumentHandlerWrapper
extends org.apache.cocoon.xml.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:
$Id: DocumentHandlerWrapper.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
protected  DocumentHandler documentHandler
          The current DocumentHandler.
 
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 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.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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

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.


startDocument

public void startDocument()
                   throws SAXException
Receive notification of the beginning of a document.

Throws:
SAXException

endDocument

public void endDocument()
                 throws SAXException
Receive notification of the end of a document.

Throws:
SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException
Begin the scope of a prefix-URI Namespace mapping.

Throws:
SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException
End the scope of a prefix-URI 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.

Throws:
SAXException

endElement

public void endElement(String uri,
                       String loc,
                       String raw)
                throws SAXException
Receive notification of the end of an element.

Throws:
SAXException

characters

public void characters(char[] ch,
                       int start,
                       int len)
                throws SAXException
Receive notification of character data.

Throws:
SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int len)
                         throws SAXException
Receive notification of ignorable whitespace in element content.

Throws:
SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException
Receive notification of a processing instruction.

Throws:
SAXException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.