org.apache.tomcat.util.digester
public class NodeCreateRule extends Rule
org.w3c.dom.Node Node
containing the XML at the element that matched
the rule. Two concrete types of nodes can be created by this rule:
org.w3c.dom.Element Element
node.
The created element will correspond to the element that matched the rule,
containing all XML content underneath that element.org.w3c.dom.DocumentFragment DocumentFragment
, which will contain
only the XML content under the element the rule was trigged on.The created Node
will be pushed on Digester's object stack
when done. To use it in the context of another DOM
org.w3c.dom.Document Document
, it must be imported first, using the
Document method
org.w3c.dom.Document#importNode(org.w3c.dom.Node, boolean) importNode()
.
Important Note: This is implemented by replacing the SAX
org.xml.sax.ContentHandler ContentHandler
in the parser used by
Digester, and resetting it when the matched element is closed. As a side
effect, rules that would match XML nodes under the element that matches
a NodeCreateRule
will never be triggered by Digester, which
usually is the behavior one would expect.
Note that the current implementation does not set the namespace prefixes in the exported nodes. The (usually more important) namespace URIs are set, of course.
Since: Digester 1.4
Constructor Summary | |
---|---|
NodeCreateRule()
Default constructor. | |
NodeCreateRule(DocumentBuilder documentBuilder)
Constructor. | |
NodeCreateRule(int nodeType)
Constructor. | |
NodeCreateRule(int nodeType, DocumentBuilder documentBuilder)
Constructor. |
Method Summary | |
---|---|
void | begin(String namespaceURI, String name, Attributes attributes)
Implemented to replace the content handler currently in use by a
NodeBuilder.
|
void | end()
Pop the Node off the top of the stack. |
org.w3c.dom.Element Element
.org.w3c.dom.Element Element
, but lets you specify the JAXP
DocumentBuilder
that should be used when constructing the
node tree.
Parameters: documentBuilder the JAXP DocumentBuilder
to use
org.w3c.dom.Element Element
or a DOM
org.w3c.dom.DocumentFragment DocumentFragment
, depending on the
value of the nodeType
parameter.
Parameters: nodeType the type of node to create, which can be either
org.w3c.dom.Node#ELEMENT_NODE Node.ELEMENT_NODE
or
org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE
Throws: IllegalArgumentException if the node type is not supported
org.w3c.dom.Element Element
or a DOM
org.w3c.dom.DocumentFragment DocumentFragment
, depending on the
value of the nodeType
parameter. This constructor lets you
specify the JAXP DocumentBuilder
that should be used when
constructing the node tree.
Parameters: nodeType the type of node to create, which can be either
org.w3c.dom.Node#ELEMENT_NODE Node.ELEMENT_NODE
or
org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE
documentBuilder the JAXP DocumentBuilder
to use
Throws: IllegalArgumentException if the node type is not supported
Parameters: namespaceURI the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace name the local name if the parser is namespace aware, or just the element name otherwise attributes The attribute list of this element
Throws: Exception indicates a JAXP configuration problem