org.apache.commons.digester
public class NodeCreateRule extends Rule
The created Node
will be pushed on Digester's object stack
when done. To use it in the context of another DOM
{@link org.w3c.dom.Document Document}, it must be imported first, using the
Document method
{@link org.w3c.dom.Document#importNode(org.w3c.dom.Node, boolean) importNode()}.
Important Note: This is implemented by replacing the SAX
{@link 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
Nested Class Summary | |
---|---|
class | NodeCreateRule.NodeBuilder
The SAX content handler that does all the actual work of assembling the
DOM node tree from the SAX events. |
Field Summary | |
---|---|
DocumentBuilder | documentBuilder
The JAXP DocumentBuilder to use. |
int | nodeType
The type of the node that should be created. |
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)
When this method fires, the digester is told to forward all SAX
ContentHandler events to the builder object, resulting in a DOM being
built instead of normal digester rule-handling occurring. |
void | end()
Pop the Node off the top of the stack. |
DocumentBuilder
to use.DocumentBuilder
that should be used when constructing the
node tree.
Parameters: documentBuilder the JAXP DocumentBuilder
to use
nodeType
parameter.
Parameters: nodeType the type of node to create, which can be either {@link org.w3c.dom.Node#ELEMENT_NODE Node.ELEMENT_NODE} or {@link org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE Node.DOCUMENT_FRAGMENT_NODE}
Throws: IllegalArgumentException if the node type is not supported
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
{@link org.w3c.dom.Node#ELEMENT_NODE Node.ELEMENT_NODE} or
{@link 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