com.werken.xpath
Class XPath

java.lang.Object
  extended by com.werken.xpath.XPath

public class XPath
extends java.lang.Object

Main run-time interface into the XPath functionality

The XPath object embodies a textual XPath as described by the W3C XPath specification. It can be applied against a context node (or nodeset) along with context-helpers to produce the result of walking the XPath.

Example usage:

  

      // Create a new XPath
      XPath xpath = new XPath("a/b/c/../d/.[@name="foo"]);

      // Create the ContextSupport
      ContextSupport helper = new ContextSupport();

      // Use the XPathFunctionContext instance as the implement
      // for function resolution.
      helper.setFunctionContext( XPathFunctionContext.getInstance() );

      // Apply the XPath to your root context.
      Object results = xpath.applyTo(helper, myContext);

  
  

Author:
bob mcwhirter (bob @ werken.com)
See Also:
ContextSupport, NamespaceContext, VariableContext, FunctionContext, XPathFunctionContext

Constructor Summary
XPath(java.lang.String xpath)
          Construct an XPath
 
Method Summary
 java.util.List applyTo(ContextSupport contextSupport, org.jdom.Document doc)
           
 java.util.List applyTo(ContextSupport contextSupport, org.jdom.Element node)
          Apply this XPath to a single root node
 java.util.List applyTo(ContextSupport contextSupport, java.util.List nodes)
          Apply this XPath to a list of nodes
 java.util.List applyTo(org.jdom.Document doc)
           
 java.util.List applyTo(org.jdom.Element node)
           
 java.util.List applyTo(java.util.List nodes)
           
 java.lang.String getString()
          Retrieve the textual XPath string used to initialize this Object
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XPath

public XPath(java.lang.String xpath)
Construct an XPath

Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getString

public java.lang.String getString()
Retrieve the textual XPath string used to initialize this Object

Returns:
The XPath string

applyTo

public java.util.List applyTo(org.jdom.Document doc)

applyTo

public java.util.List applyTo(java.util.List nodes)

applyTo

public java.util.List applyTo(org.jdom.Element node)

applyTo

public java.util.List applyTo(ContextSupport contextSupport,
                              org.jdom.Document doc)

applyTo

public java.util.List applyTo(ContextSupport contextSupport,
                              java.util.List nodes)
Apply this XPath to a list of nodes

Parameters:
contextSupport - Walk-assisting state
nodes - Root NodeSet context

applyTo

public java.util.List applyTo(ContextSupport contextSupport,
                              org.jdom.Element node)
Apply this XPath to a single root node

Parameters:
contextSupport - Walk-assisting state
node - The root context node


Copyright ? 2000 bob mcwhirter and The Werken & Sons Company. All Rights Reserved.