|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tomcat.util.digester.Rule
org.apache.tomcat.util.digester.NodeCreateRule
public 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:
Element node.
The created element will correspond to the element that matched the rule,
containing all XML content underneath that element.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
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.
| Field Summary |
|---|
| Fields inherited from class org.apache.tomcat.util.digester.Rule |
|---|
digester, namespaceURI |
| Constructor Summary | |
|---|---|
NodeCreateRule()
Default constructor. |
|
NodeCreateRule(javax.xml.parsers.DocumentBuilder documentBuilder)
Constructor. |
|
NodeCreateRule(int nodeType)
Constructor. |
|
NodeCreateRule(int nodeType,
javax.xml.parsers.DocumentBuilder documentBuilder)
Constructor. |
|
| Method Summary | |
|---|---|
void |
begin(java.lang.String namespaceURI,
java.lang.String name,
org.xml.sax.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. |
| Methods inherited from class org.apache.tomcat.util.digester.Rule |
|---|
begin, body, body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public NodeCreateRule()
throws javax.xml.parsers.ParserConfigurationException
Element.
javax.xml.parsers.ParserConfigurationExceptionpublic NodeCreateRule(javax.xml.parsers.DocumentBuilder documentBuilder)
Element, but lets you specify the JAXP
DocumentBuilder that should be used when constructing the
node tree.
documentBuilder - the JAXP DocumentBuilder to use
public NodeCreateRule(int nodeType)
throws javax.xml.parsers.ParserConfigurationException
Element or a DOM
DocumentFragment, depending on the
value of the nodeType parameter.
nodeType - the type of node to create, which can be either
Node.ELEMENT_NODE or
Node.DOCUMENT_FRAGMENT_NODE
java.lang.IllegalArgumentException - if the node type is not supported
javax.xml.parsers.ParserConfigurationException
public NodeCreateRule(int nodeType,
javax.xml.parsers.DocumentBuilder documentBuilder)
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.
nodeType - the type of node to create, which can be either
Node.ELEMENT_NODE or
Node.DOCUMENT_FRAGMENT_NODEdocumentBuilder - the JAXP DocumentBuilder to use
java.lang.IllegalArgumentException - if the node type is not supported| Method Detail |
|---|
public void begin(java.lang.String namespaceURI,
java.lang.String name,
org.xml.sax.Attributes attributes)
throws java.lang.Exception
begin in class RulenamespaceURI - the namespace URI of the matching element, or an
empty string if the parser is not namespace aware or the element has
no namespacename - the local name if the parser is namespace aware, or just
the element name otherwiseattributes - The attribute list of this element
java.lang.Exception - indicates a JAXP configuration problem
public void end()
throws java.lang.Exception
end in class Rulejava.lang.Exception
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||