Class CachedXPathAPI
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.CachedXPathAPI
(CachedXPathAPI priorXPathAPI) This constructor shares itsXPathContext
with a pre-existingCachedXPathAPI
. -
Method Summary
Modifier and TypeMethodDescriptionEvaluate XPath string to an XObject.eval
(Node contextNode, String str, PrefixResolver prefixResolver) Evaluate XPath string to an XObject.Evaluate XPath string to an XObject.Returns the XPathSupport object used in this CachedXPathAPI %REVIEW% I'm somewhat concerned about the loss of encapsulation this causes, but the xml-security folks say they need it.org.w3c.dom.traversal.NodeIterator
selectNodeIterator
(Node contextNode, String str) Use an XPath string to select a nodelist.org.w3c.dom.traversal.NodeIterator
selectNodeIterator
(Node contextNode, String str, Node namespaceNode) Use an XPath string to select a nodelist.selectNodeList
(Node contextNode, String str) Use an XPath string to select a nodelist.selectNodeList
(Node contextNode, String str, Node namespaceNode) Use an XPath string to select a nodelist.selectSingleNode
(Node contextNode, String str) Use an XPath string to select a single node.selectSingleNode
(Node contextNode, String str, Node namespaceNode) Use an XPath string to select a single node.
-
Constructor Details
-
CachedXPathAPI
public CachedXPathAPI()Default constructor. Establishes its own
XPathContext
, and hence its ownDTMManager
. Good choice for simple uses.Note that any particular instance of
CachedXPathAPI
must not be operated upon by multiple threads without synchronization; we do not currently support multithreaded access to a singleDTM
. -
CachedXPathAPI
This constructor shares its
XPathContext
with a pre-existingCachedXPathAPI
. That allows sharing document models (DTM
) and previously established location state.Note that the original
CachedXPathAPI
and the new one should not be operated upon concurrently; we do not support multithreaded access to a singleDTM
at this time. Similarly, any particular instance ofCachedXPathAPI
must not be operated upon by multiple threads without synchronization.%REVIEW% Should this instead do a clone-and-reset on the XPathSupport object?
-
-
Method Details
-
getXPathContext
Returns the XPathSupport object used in this CachedXPathAPI %REVIEW% I'm somewhat concerned about the loss of encapsulation this causes, but the xml-security folks say they need it. -
selectSingleNode
Use an XPath string to select a single node. XPath namespace prefixes are resolved from the context node, which may not be what you want (see the next method).- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.- Returns:
- The first node found that matches the XPath, or null.
- Throws:
TransformerException
-
selectSingleNode
public Node selectSingleNode(Node contextNode, String str, Node namespaceNode) throws TransformerException Use an XPath string to select a single node. XPath namespace prefixes are resolved from the namespaceNode.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.namespaceNode
- The node from which prefixes in the XPath will be resolved to namespaces.- Returns:
- The first node found that matches the XPath, or null.
- Throws:
TransformerException
-
selectNodeIterator
public org.w3c.dom.traversal.NodeIterator selectNodeIterator(Node contextNode, String str) throws TransformerException Use an XPath string to select a nodelist. XPath namespace prefixes are resolved from the contextNode.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
selectNodeIterator
public org.w3c.dom.traversal.NodeIterator selectNodeIterator(Node contextNode, String str, Node namespaceNode) throws TransformerException Use an XPath string to select a nodelist. XPath namespace prefixes are resolved from the namespaceNode.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.namespaceNode
- The node from which prefixes in the XPath will be resolved to namespaces.- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
selectNodeList
Use an XPath string to select a nodelist. XPath namespace prefixes are resolved from the contextNode.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
selectNodeList
public NodeList selectNodeList(Node contextNode, String str, Node namespaceNode) throws TransformerException Use an XPath string to select a nodelist. XPath namespace prefixes are resolved from the namespaceNode.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.namespaceNode
- The node from which prefixes in the XPath will be resolved to namespaces.- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
eval
Evaluate XPath string to an XObject. Using this method, XPath namespace prefixes will be resolved from the namespaceNode.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.- Returns:
- An XObject, which can be used to obtain a string, number, nodelist, etc, should never be null.
- Throws:
TransformerException
- See Also:
-
eval
Evaluate XPath string to an XObject. XPath namespace prefixes are resolved from the namespaceNode. The implementation of this is a little slow, since it creates a number of objects each time it is called. This could be optimized to keep the same objects around, but then thread-safety issues would arise.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.namespaceNode
- The node from which prefixes in the XPath will be resolved to namespaces.- Returns:
- An XObject, which can be used to obtain a string, number, nodelist, etc, should never be null.
- Throws:
TransformerException
- See Also:
-
eval
public XObject eval(Node contextNode, String str, PrefixResolver prefixResolver) throws TransformerException Evaluate XPath string to an XObject. XPath namespace prefixes are resolved from the namespaceNode. The implementation of this is a little slow, since it creates a number of objects each time it is called. This could be optimized to keep the same objects around, but then thread-safety issues would arise.- Parameters:
contextNode
- The node to start searching from.str
- A valid XPath string.prefixResolver
- Will be called if the parser encounters namespace prefixes, to resolve the prefixes to URLs.- Returns:
- An XObject, which can be used to obtain a string, number, nodelist, etc, should never be null.
- Throws:
TransformerException
- See Also:
-