|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.cocoon.xml.dom.DOMBuilder
The DOMBuilder
is a utility class that will generate a W3C
DOM Document from SAX events.
Inner Class Summary | |
static interface |
DOMBuilder.Listener
The Listener interface must be implemented by those objects willing to be notified of a successful DOM tree generation. |
Field Summary | |
protected DOMFactory |
factory
The document factory |
protected DOMBuilder.Listener |
listener
The listener |
protected org.apache.log.Logger |
log
|
Constructor Summary | |
protected |
DOMBuilder()
Construct a new instance of this TreeGenerator. |
|
DOMBuilder(DOMFactory factory)
Construct a new instance of this TreeGenerator. |
|
DOMBuilder(DOMFactory factory,
DOMBuilder.Listener listener)
Construct a new instance of this TreeGenerator. |
|
DOMBuilder(org.w3c.dom.Node parentNode)
Constructs a new instance that appends nodes to the given parent node. |
Method Summary | |
void |
characters(char[] chars,
int start,
int len)
Receive notification of character data. |
void |
comment(char[] chars,
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 beginning of a document. |
void |
endDTD()
Report the end of DTD declarations. |
void |
endElement(java.lang.String uri,
java.lang.String loc,
java.lang.String raw)
Receive notification of the end of an element. |
void |
endEntity(java.lang.String name)
Report the end of an entity. |
void |
endPrefixMapping(java.lang.String prefix)
End the scope of a prefix-URI mapping. |
org.w3c.dom.Document |
getDocument()
Return the newly built Document. |
void |
ignorableWhitespace(char[] chars,
int start,
int len)
Receive notification of ignorable whitespace data. |
protected void |
notify(org.w3c.dom.Document doc)
Receive notification of a successfully completed DOM tree generation. |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Receive notification of a processing instruction. |
void |
setDocumentLocator(org.xml.sax.Locator loc)
Set the SAX Document Locator. |
void |
setLogger(org.apache.log.Logger logger)
|
void |
skippedEntity(java.lang.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(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Report the start of DTD declarations, if any. |
void |
startElement(java.lang.String uri,
java.lang.String loc,
java.lang.String raw,
org.xml.sax.Attributes a)
Receive notification of the beginning of an element. |
void |
startEntity(java.lang.String name)
Report the beginning of an entity. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Begin the scope of a prefix-URI Namespace mapping. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected org.apache.log.Logger log
protected DOMBuilder.Listener listener
protected DOMFactory factory
Constructor Detail |
protected DOMBuilder()
public DOMBuilder(DOMFactory factory)
public DOMBuilder(DOMFactory factory, DOMBuilder.Listener listener)
public DOMBuilder(org.w3c.dom.Node parentNode)
Listener when appending to a
Node
, because the notification occurs at endDocument()
which does not happen here.
Method Detail |
public void setLogger(org.apache.log.Logger logger)
setLogger
in interface org.apache.avalon.framework.logger.Loggable
public org.w3c.dom.Document getDocument()
public void setDocumentLocator(org.xml.sax.Locator loc)
setDocumentLocator
in interface org.xml.sax.ContentHandler
loc
- The SAX Locator.public void startDocument() throws org.xml.sax.SAXException
startDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- If this method was not called appropriately.public void endDocument() throws org.xml.sax.SAXException
endDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- If this method was not called appropriately.public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
startDTD
in interface org.xml.sax.ext.LexicalHandler
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.org.xml.sax.SAXException
- If this method was not called appropriately.public void endDTD() throws org.xml.sax.SAXException
endDTD
in interface org.xml.sax.ext.LexicalHandler
chars
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.org.xml.sax.SAXException
- If this method was not called appropriately.public void startElement(java.lang.String uri, java.lang.String loc, java.lang.String raw, org.xml.sax.Attributes a) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- If this method was not called appropriately.public void endElement(java.lang.String uri, java.lang.String loc, java.lang.String raw) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
- If this method was not called appropriately.public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.SAXException
startPrefixMapping
in interface org.xml.sax.ContentHandler
pre
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.org.xml.sax.SAXException
- If this method was not called appropriately.public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
endPrefixMapping
in interface org.xml.sax.ContentHandler
prefix
- The Namespace prefix that was being mapped.public void startCDATA() throws org.xml.sax.SAXException
startCDATA
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
- If this method was not called appropriately.public void endCDATA() throws org.xml.sax.SAXException
endCDATA
in interface org.xml.sax.ext.LexicalHandler
org.xml.sax.SAXException
- If this method was not called appropriately.public void startEntity(java.lang.String name) throws org.xml.sax.SAXException
startEntity
in interface org.xml.sax.ext.LexicalHandler
chars
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.org.xml.sax.SAXException
- If this method was not called appropriately.public void endEntity(java.lang.String name) throws org.xml.sax.SAXException
endEntity
in interface org.xml.sax.ext.LexicalHandler
chars
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.org.xml.sax.SAXException
- If this method was not called appropriately.public void characters(char[] chars, int start, int len) throws org.xml.sax.SAXException
characters
in interface org.xml.sax.ContentHandler
chars
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.org.xml.sax.SAXException
- If this method was not called appropriately.public void ignorableWhitespace(char[] chars, int start, int len) throws org.xml.sax.SAXException
ignorableWhitespace
in interface org.xml.sax.ContentHandler
chars
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.org.xml.sax.SAXException
- If this method was not called appropriately.public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.SAXException
processingInstruction
in interface org.xml.sax.ContentHandler
target
- The processing instruction target.data
- The processing instruction data.org.xml.sax.SAXException
- If this method was not called appropriately.public void comment(char[] chars, int start, int len) throws org.xml.sax.SAXException
comment
in interface org.xml.sax.ext.LexicalHandler
chars
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.org.xml.sax.SAXException
- If this method was not called appropriately.public void skippedEntity(java.lang.String name) throws org.xml.sax.SAXException
skippedEntity
in interface org.xml.sax.ContentHandler
name
- The name of the skipped entity. If it is a parameter entity,
the name will begin with '%'.protected void notify(org.w3c.dom.Document doc) throws org.xml.sax.SAXException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |