Class DOMBuilder
- All Implemented Interfaces:
ContentHandler
,LexicalHandler
-
Field Summary
FieldsModifier and TypeFieldDescriptionRoot documentFirst node of document fragment or null if not a DocumentFragment -
Constructor Summary
ConstructorsConstructorDescriptionDOMBuilder
(Document doc) DOMBuilder instance constructor... it will add the DOM nodes to the document.DOMBuilder
(Document doc, DocumentFragment docFrag) DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.DOMBuilder
(Document doc, Node node) DOMBuilder instance constructor... it will add the DOM nodes to the document fragment. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
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
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.Get the node currently being processed.Return the next sibling node.Get the root document or DocumentFragment of the DOM being created.Get the root node of the DOM tree.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
Report the start of a CDATA section.void
Receive notification of the beginning of a document.void
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.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
declaration
-
Field Details
-
m_doc
Root document -
m_docFrag
First node of document fragment or null if not a DocumentFragment
-
-
Constructor Details
-
DOMBuilder
DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.- Parameters:
doc
- Root documentnode
- Current node
-
DOMBuilder
DOMBuilder instance constructor... it will add the DOM nodes to the document fragment.- Parameters:
doc
- Root documentdocFrag
- Document fragment
-
DOMBuilder
DOMBuilder instance constructor... it will add the DOM nodes to the document.- Parameters:
doc
- Root document
-
-
Method Details
-
getRootDocument
Get the root document or DocumentFragment of the DOM being created.- Returns:
- The root document or document fragment if not null
-
getRootNode
Get the root node of the DOM tree. -
getCurrentNode
Get the node currently being processed.- Returns:
- the current node being processed
-
setNextSibling
Set the next sibling node, which is where the result nodes should be inserted before.- Parameters:
nextSibling
- the next sibling node.
-
getNextSibling
Return the next sibling node.- Returns:
- the next sibling node.
-
getWriter
Return null since there is no Writer for this class.- Returns:
- null
-
setDocumentLocator
Receive an object for locating the origin of SAX document events.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.
- Specified by:
setDocumentLocator
in interfaceContentHandler
- Parameters:
locator
- An object that can return the location of any SAX document event.- See Also:
-
startDocument
Receive notification of the beginning of a document.The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).
- Specified by:
startDocument
in interfaceContentHandler
- Throws:
SAXException
-
endDocument
Receive notification of the end of a document.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.
- Specified by:
endDocument
in interfaceContentHandler
- Throws:
SAXException
-
startElement
public void startElement(String ns, String localName, String name, Attributes atts) throws SAXException Receive notification of the beginning of an element.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.
- Specified by:
startElement
in interfaceContentHandler
- Parameters:
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.- Throws:
SAXException
- See Also:
-
endElement
Receive notification of the end of an element.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.
- Specified by:
endElement
in interfaceContentHandler
- Parameters:
ns
- the namespace of the elementlocalName
- The local part of the qualified name of the elementname
- The element name- Throws:
SAXException
-
setIDAttribute
Set an ID string to node association in the ID table.- Parameters:
id
- The ID string.elem
- The associated ID.
-
characters
Receive notification of character data.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).
- Specified by:
characters
in interfaceContentHandler
- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- See Also:
-
charactersRaw
If available, when the disable-output-escaping attribute is used, output raw text without escaping. A PI will be inserted in front of the node with the name "lotusxsl-next-is-raw" and a value of "formatter-to-dom".- Parameters:
ch
- Array containing the charactersstart
- Index to start of characters in the arraylength
- Number of characters in the array- Throws:
SAXException
-
startEntity
Report the beginning of an entity. The start and end of the document entity are not reported. The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.- Specified by:
startEntity
in interfaceLexicalHandler
- Parameters:
name
- The name of the entity. If it is a parameter entity, the name will begin with '%'.- Throws:
SAXException
- See Also:
-
endEntity
Report the end of an entity.- Specified by:
endEntity
in interfaceLexicalHandler
- Parameters:
name
- The name of the entity that is ending.- Throws:
SAXException
- See Also:
-
entityReference
Receive notivication of a entityReference.- Parameters:
name
- name of the entity reference- Throws:
SAXException
-
ignorableWhitespace
Receive notification of ignorable whitespace in element content.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.
- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- See Also:
-
processingInstruction
Receive notification of a processing instruction.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.
- Specified by:
processingInstruction
in interfaceContentHandler
- Parameters:
target
- The processing instruction target.data
- The processing instruction data, or null if none was supplied.- Throws:
SAXException
-
comment
Report an XML comment anywhere in the document. This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).- Specified by:
comment
in interfaceLexicalHandler
- Parameters:
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.- Throws:
SAXException
-
startCDATA
Report the start of a CDATA section.- Specified by:
startCDATA
in interfaceLexicalHandler
- Throws:
SAXException
- See Also:
-
endCDATA
Report the end of a CDATA section.- Specified by:
endCDATA
in interfaceLexicalHandler
- Throws:
SAXException
- See Also:
-
cdata
Receive notification of cdata.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).
- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- See Also:
-
startDTD
Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.- Specified by:
startDTD
in interfaceLexicalHandler
- Parameters:
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.- Throws:
SAXException
- See Also:
-
endDTD
Report the end of DTD declarations.- Specified by:
endDTD
in interfaceLexicalHandler
- Throws:
SAXException
- See Also:
-
startPrefixMapping
Begin the scope of a prefix-URI Namespace mapping.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.
- Specified by:
startPrefixMapping
in interfaceContentHandler
- Parameters:
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.- Throws:
SAXException
- See Also:
-
endPrefixMapping
End the scope of a prefix-URI mapping.See startPrefixMapping for details. This event will always occur after the corresponding endElement event, but the order of endPrefixMapping events is not otherwise guaranteed.
- Specified by:
endPrefixMapping
in interfaceContentHandler
- Parameters:
prefix
- The prefix that was being mapping.- Throws:
SAXException
- See Also:
-
skippedEntity
Receive notification of a skipped entity.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.
- Specified by:
skippedEntity
in interfaceContentHandler
- Parameters:
name
- The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.- Throws:
SAXException
-