org.apache.xml.security.utils
Interface XPathAPI

All Known Implementing Classes:

JDKXPathAPI, XalanXPathAPI

public interface XPathAPI

An interface to abstract XPath evaluation

Method Summary

void	clear() Clear any context information from this object
boolean	evaluate(Node contextNode, Node xpathnode, String str, Node namespaceNode) Evaluate an XPath string and return true if the output is to be included or not.
NodeList	selectNodeList(Node contextNode, Node xpathnode, String str, Node namespaceNode) Use an XPath string to select a nodelist.

Method Detail

selectNodeList

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

evaluate

boolean evaluate(Node contextNode,
                 Node xpathnode,
                 String str,
                 Node namespaceNode)
                 throws TransformerException

Evaluate an XPath string and return true if the output is to be included or not.

Parameters:

contextNode - The node to start searching from.

xpathnode - The XPath node

str - The XPath expression

namespaceNode - The node from which prefixes in the XPath will be resolved to namespaces.

Throws:

TransformerException

clear

void clear()

Clear any context information from this object