| java.lang.Object
 org.apache.xpath.XPathAPI
| XPathAPI | | public class XPathAPI (Code) | | 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.
NOTE: In particular, each call to this method will create a new
XPathContext, a new DTMManager... and thus a new DTM. That's very
safe, since it guarantees that you're always processing against a
fully up-to-date view of your document. But it's also portentially
very expensive, since you're rebuilding the DTM every time. You should
consider using an instance of CachedXPathAPI rather than these static
methods.
See Also: XPath Specification |
| Method Summary | |
| public static XObject | eval(Node contextNode, String str)
Evaluate XPath string to an XObject. | | public static XObject | eval(Node contextNode, String str, Node namespaceNode)
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. | | public static XObject | eval(Node contextNode, String str, PrefixResolver prefixResolver)
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. | | public static NodeIterator | selectNodeIterator(Node contextNode, String str)
Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the contextNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string. | | public static NodeIterator | selectNodeIterator(Node contextNode, String str, Node namespaceNode)
Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the namespaceNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string.
Parameters:
namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces. | | public static NodeList | selectNodeList(Node contextNode, String str)
Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the contextNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string. | | public static NodeList | selectNodeList(Node contextNode, String str, Node namespaceNode)
Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the namespaceNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string.
Parameters:
namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces. | | public static Node | selectSingleNode(Node contextNode, String str)
Use an XPath string to select a single node. | | public static Node | selectSingleNode(Node contextNode, String str, Node namespaceNode)
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.
Parameters:
str - A valid XPath string.
Parameters:
namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces. |
| eval | | public static XObject eval(Node contextNode, String str, PrefixResolver prefixResolver) throws TransformerException(Code) | | 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.
Parameters:
str - A valid XPath string.
Parameters:
prefixResolver - Will be called if the parser encounters namespaceprefixes, to resolve the prefixes to URLs. An XObject, which can be used to obtain a string, number, nodelist, etc, should never be null.
See Also: org.apache.xpath.objects.XObject
See Also: org.apache.xpath.objects.XNull
See Also: org.apache.xpath.objects.XBoolean
See Also: org.apache.xpath.objects.XNumber
See Also: org.apache.xpath.objects.XString
See Also: org.apache.xpath.objects.XRTreeFrag
throws:
TransformerException - |
| selectNodeIterator | | public static NodeIterator selectNodeIterator(Node contextNode, String str) throws TransformerException(Code) | | Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the contextNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string. A NodeIterator, should never be null.
throws:
TransformerException - |
| selectNodeIterator | | public static NodeIterator selectNodeIterator(Node contextNode, String str, Node namespaceNode) throws TransformerException(Code) | | Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the namespaceNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string.
Parameters:
namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces. A NodeIterator, should never be null.
throws:
TransformerException - |
| selectNodeList | | public static NodeList selectNodeList(Node contextNode, String str) throws TransformerException(Code) | | Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the contextNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string. A NodeIterator, should never be null.
throws:
TransformerException - |
| selectNodeList | | public static NodeList selectNodeList(Node contextNode, String str, Node namespaceNode) throws TransformerException(Code) | | Use an XPath string to select a nodelist.
XPath namespace prefixes are resolved from the namespaceNode.
Parameters:
contextNode - The node to start searching from.
Parameters:
str - A valid XPath string.
Parameters:
namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces. A NodeIterator, should never be null.
throws:
TransformerException - |
| selectSingleNode | | public static Node selectSingleNode(Node contextNode, String str) throws TransformerException(Code) | | 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.
Parameters:
str - A valid XPath string. The first node found that matches the XPath, or null.
throws:
TransformerException - |
| selectSingleNode | | public static Node selectSingleNode(Node contextNode, String str, Node namespaceNode) throws TransformerException(Code) | | 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.
Parameters:
str - A valid XPath string.
Parameters:
namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces. The first node found that matches the XPath, or null.
throws:
TransformerException - |
|
|