Package org.apache.xml.security.utils
Class XPathFuncHereAPI
java.lang.Object
org.apache.xml.security.utils.XPathFuncHereAPI
This class does the same as
The methods in this class are convenience methods into the low-level XPath API. These functions tend to be a little slow, since a number of objects must be created for each evaluation. A faster way is to precompile the XPaths using the low-level API, and then just use the XPaths over and over.
XPathAPI
except that the XPath strings
are not supplied as Strings but as Text
, Attr
ibute or
{ProcessingInstruction} nodes which contain the XPath string. This enables
us to use the here()
function.
The methods in this class are convenience methods into the low-level XPath API. These functions tend to be a little slow, since a number of objects must be created for each evaluation. A faster way is to precompile the XPaths using the low-level API, and then just use the XPaths over and over.
- Author:
- $Author$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic org.apache.xpath.objects.XObject
Evaluate XPath string to an XObject.static org.apache.xpath.objects.XObject
Evaluate XPath string to an XObject.static org.apache.xpath.objects.XObject
Evaluate XPath string to an XObject.static org.w3c.dom.traversal.NodeIterator
selectNodeIterator
(Node contextNode, Node xpathnode) Use an XPath string to select a nodelist.static org.w3c.dom.traversal.NodeIterator
selectNodeIterator
(Node contextNode, Node xpathnode, Node namespaceNode) Use an XPath string to select a nodelist.static NodeList
selectNodeList
(Node contextNode, Node xpathnode) Use an XPath string to select a nodelist.static NodeList
selectNodeList
(Node contextNode, Node xpathnode, Node namespaceNode) Use an XPath string to select a nodelist.static Node
selectSingleNode
(Node contextNode, Node xpathnode) Use an XPath string to select a single node.static Node
selectSingleNode
(Node contextNode, Node xpathnode, Node namespaceNode) Use an XPath string to select a single node.
-
Constructor Details
-
XPathFuncHereAPI
public XPathFuncHereAPI()
-
-
Method Details
-
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.xpathnode
- A Node containing a valid XPath string.- Returns:
- The first node found that matches the XPath, or null.
- Throws:
TransformerException
-
selectSingleNode
public static Node selectSingleNode(Node contextNode, Node xpathnode, 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.xpathnode
-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 static org.w3c.dom.traversal.NodeIterator selectNodeIterator(Node contextNode, Node xpathnode) 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.xpathnode
-- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
selectNodeIterator
public static org.w3c.dom.traversal.NodeIterator selectNodeIterator(Node contextNode, Node xpathnode, 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.xpathnode
-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.xpathnode
-- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
selectNodeList
public static NodeList selectNodeList(Node contextNode, Node xpathnode, 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.xpathnode
-namespaceNode
- The node from which prefixes in the XPath will be resolved to namespaces.- Returns:
- A NodeIterator, should never be null.
- Throws:
TransformerException
-
eval
public static org.apache.xpath.objects.XObject eval(Node contextNode, Node xpathnode) throws TransformerException 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.xpathnode
-- Returns:
- An XObject, which can be used to obtain a string, number, nodelist, etc, should never be null.
- Throws:
TransformerException
- See Also:
-
eval
public static org.apache.xpath.objects.XObject eval(Node contextNode, Node xpathnode, Node namespaceNode) 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.xpathnode
-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 static org.apache.xpath.objects.XObject eval(Node contextNode, Node xpathnode, org.apache.xml.utils.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.xpathnode
-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:
-