Package org.apache.xml.security.utils
Class CachedXPathFuncHereAPI
java.lang.Object
org.apache.xml.security.utils.CachedXPathFuncHereAPI
- Author:
- $Author$
-
Constructor Summary
ConstructorsConstructorDescriptionCachedXPathFuncHereAPI
(org.apache.xpath.CachedXPathAPI previouslyUsed) Constructor CachedXPathFuncHereAPICachedXPathFuncHereAPI
(org.apache.xpath.XPathContext existingXPathContext) Constructor CachedXPathFuncHereAPI -
Method Summary
Modifier and TypeMethodDescriptionorg.apache.xpath.objects.XObject
Deprecated.org.apache.xpath.objects.XObject
eval
(Node contextNode, Node xpathnode, String str, org.apache.xml.utils.PrefixResolver prefixResolver) Evaluate XPath string to an XObject.org.apache.xpath.objects.XObject
Evaluate XPath string to an XObject.org.apache.xml.security.transforms.implementations.FuncHereContext
Method getFuncHereContextstatic String
getStrFromNode
(Node xpathnode) Method getStrFromNodeorg.w3c.dom.traversal.NodeIterator
selectNodeIterator
(Node contextNode, Node xpathnode) Use an XPath string to select a nodelist.org.w3c.dom.traversal.NodeIterator
selectNodeIterator
(Node contextNode, Node xpathnode, Node namespaceNode) Deprecated.selectNodeList
(Node contextNode, Node xpathnode) Deprecated.selectNodeList
(Node contextNode, Node xpathnode, String str, Node namespaceNode) Use an XPath string to select a nodelist.selectSingleNode
(Node contextNode, Node xpathnode) Use an XPath string to select a single node.selectSingleNode
(Node contextNode, Node xpathnode, Node namespaceNode) Use an XPath string to select a single node.
-
Constructor Details
-
CachedXPathFuncHereAPI
public CachedXPathFuncHereAPI(org.apache.xpath.XPathContext existingXPathContext) Constructor CachedXPathFuncHereAPI- Parameters:
existingXPathContext
-
-
CachedXPathFuncHereAPI
public CachedXPathFuncHereAPI(org.apache.xpath.CachedXPathAPI previouslyUsed) Constructor CachedXPathFuncHereAPI- Parameters:
previouslyUsed
-
-
-
Method Details
-
getFuncHereContext
public org.apache.xml.security.transforms.implementations.FuncHereContext getFuncHereContext()Method getFuncHereContext- Returns:
- the context for this object
-
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 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 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 org.w3c.dom.traversal.NodeIterator selectNodeIterator(Node contextNode, Node xpathnode, Node namespaceNode) throws TransformerException Deprecated.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
Deprecated.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 NodeList selectNodeList(Node contextNode, Node xpathnode, 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.xpathnode
-str
-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 org.apache.xpath.objects.XObject eval(Node contextNode, Node xpathnode) throws TransformerException Deprecated.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 org.apache.xpath.objects.XObject eval(Node contextNode, Node xpathnode, String str, 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
-str
-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 org.apache.xpath.objects.XObject eval(Node contextNode, Node xpathnode, String str, 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
-str
-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:
-
getStrFromNode
Method getStrFromNode- Parameters:
xpathnode
-- Returns:
- the string for the node.
-