public class DOMBuilder extends Object implements ContentHandler, LexicalHandler
Modifier and Type | Field and Description |
---|---|
protected Node |
m_currentNode
Current node
|
Document |
m_doc
Root document
|
DocumentFragment |
m_docFrag
First node of document fragment or null if not a DocumentFragment
|
protected Stack |
m_elemStack
Vector of element nodes
|
protected boolean |
m_inCData
Flag indicating that we are processing a CData section
|
protected Node |
m_nextSibling
The next sibling node
|
protected Vector |
m_prefixMappings
Namespace support
|
protected Node |
m_root
The root node
|
Constructor and Description |
---|
DOMBuilder(Document doc)
DOMBuilder instance constructor...
|
DOMBuilder(Document doc,
DocumentFragment docFrag)
DOMBuilder instance constructor...
|
DOMBuilder(Document doc,
Node node)
DOMBuilder instance constructor...
|
Modifier and Type | Method and Description |
---|---|
protected void |
append(Node newNode)
Append a node to the current container.
|
void |
cdata(char[] ch,
int start,
int length)
Receive notification of cdata.
|
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data.
|
void |
charactersRaw(char[] ch,
int start,
int length)
If available, when the disable-output-escaping attribute is used,
output raw text without escaping.
|
void |
comment(char[] ch,
int start,
int length)
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 ns,
String localName,
String name)
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 |
entityReference(String name)
Receive notivication of a entityReference.
|
Node |
getCurrentNode()
Get the node currently being processed.
|
Node |
getNextSibling()
Return the next sibling node.
|
Node |
getRootDocument()
Get the root document or DocumentFragment of the DOM being created.
|
Node |
getRootNode()
Get the root node of the DOM tree.
|
Writer |
getWriter()
Return null since there is no Writer for this class.
|
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content.
|
void |
processingInstruction(String target,
String data)
Receive notification of a processing instruction.
|
void |
setDocumentLocator(Locator locator)
Receive an object for locating the origin of SAX document events.
|
void |
setIDAttribute(String id,
Element elem)
Set an ID string to node association in the ID table.
|
void |
setNextSibling(Node nextSibling)
Set the next sibling node, which is where the result nodes
should be inserted before.
|
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 ns,
String localName,
String name,
Attributes atts)
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.
|
public Document m_doc
protected Node m_currentNode
protected Node m_root
protected Node m_nextSibling
public DocumentFragment m_docFrag
protected Stack m_elemStack
protected Vector m_prefixMappings
protected boolean m_inCData
public DOMBuilder(Document doc, Node node)
doc
- Root documentnode
- Current nodepublic DOMBuilder(Document doc, DocumentFragment docFrag)
doc
- Root documentdocFrag
- Document fragmentpublic DOMBuilder(Document doc)
doc
- Root documentpublic Node getRootDocument()
public Node getRootNode()
public Node getCurrentNode()
public void setNextSibling(Node nextSibling)
nextSibling
- the next sibling node.public Node getNextSibling()
public Writer getWriter()
protected void append(Node newNode) throws SAXException
newNode
- New node to appendSAXException
public void setDocumentLocator(Locator locator)
SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.
The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.
Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.
setDocumentLocator
in interface ContentHandler
locator
- An object that can return the location of
any SAX document event.Locator
public void startDocument() throws SAXException
The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).
startDocument
in interface ContentHandler
SAXException
public void endDocument() throws SAXException
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
endDocument
in interface ContentHandler
SAXException
public void startElement(String ns, String localName, String name, Attributes atts) throws SAXException
The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.
If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.
startElement
in interface ContentHandler
ns
- The namespace of the nodelocalName
- The local part of the qualified namename
- The element name.atts
- The attributes attached to the element, if any.SAXException
endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void endElement(String ns, String localName, String name) throws SAXException
The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).
If the element name has a namespace prefix, the prefix will still be attached to the name.
endElement
in interface ContentHandler
ns
- the namespace of the elementlocalName
- The local part of the qualified name of the elementname
- The element nameSAXException
public void setIDAttribute(String id, Element elem)
id
- The ID string.elem
- The associated ID.public void characters(char[] ch, int start, int length) throws SAXException
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
characters
in interface ContentHandler
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.SAXException
ignorableWhitespace(char[], int, int)
,
Locator
public void charactersRaw(char[] ch, int start, int length) throws SAXException
ch
- Array containing the charactersstart
- Index to start of characters in the arraylength
- Number of characters in the arraySAXException
public void startEntity(String name) throws SAXException
startEntity
in interface LexicalHandler
name
- The name of the entity. If it is a parameter
entity, the name will begin with '%'.SAXException
endEntity(java.lang.String)
,
DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)
,
DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
public void endEntity(String name) throws SAXException
endEntity
in interface LexicalHandler
name
- The name of the entity that is ending.SAXException
startEntity(java.lang.String)
public void entityReference(String name) throws SAXException
name
- name of the entity referenceSAXException
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
ignorableWhitespace
in interface ContentHandler
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.SAXException
characters(char[], int, int)
public void processingInstruction(String target, String data) throws SAXException
The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
processingInstruction
in interface ContentHandler
target
- The processing instruction target.data
- The processing instruction data, or null if
none was supplied.SAXException
public void comment(char[] ch, int start, int length) throws SAXException
comment
in interface LexicalHandler
ch
- An array holding the characters in the comment.start
- The starting position in the array.length
- The number of characters to use from the array.SAXException
public void startCDATA() throws SAXException
startCDATA
in interface LexicalHandler
SAXException
endCDATA()
public void endCDATA() throws SAXException
endCDATA
in interface LexicalHandler
SAXException
startCDATA()
public void cdata(char[] ch, int start, int length) throws SAXException
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.SAXException
ignorableWhitespace(char[], int, int)
,
Locator
public void startDTD(String name, String publicId, String systemId) throws SAXException
startDTD
in interface 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.SAXException
endDTD()
,
startEntity(java.lang.String)
public void endDTD() throws SAXException
endDTD
in interface LexicalHandler
SAXException
startDTD(java.lang.String, java.lang.String, java.lang.String)
public void startPrefixMapping(String prefix, String uri) throws SAXException
The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is true (the default).
There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.
Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each-other: all startPrefixMapping events will occur before the corresponding startElement event, and all endPrefixMapping events will occur after the corresponding endElement event, but their order is not guaranteed.
startPrefixMapping
in interface ContentHandler
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.SAXException
endPrefixMapping(java.lang.String)
,
startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endPrefixMapping(String prefix) throws SAXException
See startPrefixMapping for details. This event will always occur after the corresponding endElement event, but the order of endPrefixMapping events is not otherwise guaranteed.
endPrefixMapping
in interface ContentHandler
prefix
- The prefix that was being mapping.SAXException
startPrefixMapping(java.lang.String, java.lang.String)
,
endElement(java.lang.String, java.lang.String, java.lang.String)
public void skippedEntity(String name) throws SAXException
The Parser will invoke this method once for each entity skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-parameter-entities properties.
skippedEntity
in interface ContentHandler
name
- The name of the skipped entity. If it is a
parameter entity, the name will begin with '%'.SAXException
Copyright © 2016 JBoss by Red Hat. All rights reserved.