Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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(org.w3c.dom.Node contextNode, org.w3c.dom.Node xpathnode, java.lang.String str, org.w3c.dom.Node namespaceNode)` Evaluate an XPath string and return true if the output is to be included or not.
`org.w3c.dom.NodeList` | `selectNodeList(org.w3c.dom.Node contextNode, org.w3c.dom.Node xpathnode, java.lang.String str, org.w3c.dom.Node namespaceNode)` Use an XPath string to select a nodelist.

Method Detail

### selectNodeList

    org.w3c.dom.NodeList selectNodeList(org.w3c.dom.Node contextNode,
                                        org.w3c.dom.Node xpathnode,
                                        java.lang.String str,
                                        org.w3c.dom.Node namespaceNode)
                                        throws javax.xml.transform.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:
    `javax.xml.transform.TransformerException`

### evaluate

    boolean evaluate(org.w3c.dom.Node contextNode,
                     org.w3c.dom.Node xpathnode,
                     java.lang.String str,
                     org.w3c.dom.Node namespaceNode)
                     throws javax.xml.transform.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:
    `javax.xml.transform.TransformerException`

### clear

    void clear()

  Clear any context information from this object

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD