org.apache.cocoon.xml.dom

Class DOMBuilder

java.lang.Object

org.apache.cocoon.xml.sax.AbstractSAXProducer

org.apache.cocoon.xml.sax.AbstractSAXPipe

org.apache.cocoon.xml.dom.DOMBuilder

All Implemented Interfaces:

ContentHandler, LexicalHandler

public class DOMBuilder
extends AbstractSAXPipe

The DOMBuilder is a utility class that will generate a W3C DOM Document from SAX events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DOMBuilder.Listener The Listener interface must be implemented by those objects willing to be notified of a successful DOM tree generation.

Constructor Summary

Constructors

Constructor and Description
DOMBuilder() Construct a new instance of this DOMBuilder.
DOMBuilder(DOMBuilder.Listener listener) Construct a new instance of this DOMBuilder.
DOMBuilder(DOMBuilder.Listener listener, Node parentNode) Construct a new instance of this DOMBuilder.
DOMBuilder(Node parentNode) Constructs a new instance that appends nodes to the given parent node.
DOMBuilder(SAXTransformerFactory factory) Construct a new instance of this DOMBuilder.
DOMBuilder(SAXTransformerFactory factory, DOMBuilder.Listener listener, Node parentNode) Construct a new instance of this DOMBuilder.

Method Summary

Modifier and Type	Method and Description
void	endDocument() Receive notification of the end of a document.
Document	getDocument() Return the newly built Document.
void	recycle() Recycle this builder, prepare for re-use.

Methods inherited from class org.apache.cocoon.xml.sax.AbstractSAXPipe

characters, comment, endCDATA, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.sax.AbstractSAXProducer

setContentHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMBuilder

public DOMBuilder()

Construct a new instance of this DOMBuilder.

DOMBuilder

public DOMBuilder(SAXTransformerFactory factory)

Construct a new instance of this DOMBuilder.

DOMBuilder

public DOMBuilder(DOMBuilder.Listener listener)

Construct a new instance of this DOMBuilder.

DOMBuilder

public DOMBuilder(Node parentNode)

Constructs a new instance that appends nodes to the given parent node.
Note: You cannot use a Listener when appending to a Node, because the notification occurs at endDocument() which does not happen here.

DOMBuilder

public DOMBuilder(DOMBuilder.Listener listener,
                  Node parentNode)

Construct a new instance of this DOMBuilder.

DOMBuilder

public DOMBuilder(SAXTransformerFactory factory,
                  DOMBuilder.Listener listener,
                  Node parentNode)

Construct a new instance of this DOMBuilder.

Method Detail

recycle

public void recycle()

Recycle this builder, prepare for re-use.

Overrides:

recycle in class AbstractSAXProducer

getDocument

public Document getDocument()

Return the newly built Document.

endDocument

public void endDocument()
                 throws SAXException

Receive notification of the end of a document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class AbstractSAXPipe

Throws:

SAXException - If this method was not called appropriately.