org.apache.commons.digester
Class NodeCreateRule

A rule implementation that creates a DOM
Node containing the XML at the element that matched
the rule. Two concrete types of nodes can be created by this rule:

the default is to create an Element node.
The created element will correspond to the element that matched the rule,
containing all XML content underneath that element.

alternatively, this rule can create nodes of type
DocumentFragment, which will contain
only the XML content under the element the rule was trigged on.

The created node will be normalized, meaning it will not contain text nodes
that only contain white space characters.

The created Node will be pushed on Digester's object stack
when done. To use it in the context of another DOM
Document, it must be imported first, using the
Document method
importNode().

Important Note: This is implemented by replacing the SAX
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.

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.

NodeCreateRule

Constructor. Creates an instance of this rule that will create either a
DOM Element or a DOM
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.

begin

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. When the
end of the current xml element is encountered, the original content
handler is restored (expected to be NULL, allowing normal Digester
operations to continue).