Package org.eclipse.wst.xml.xpath2.api

org.eclipse.wst.xml.xpath2.api
Class XPath2Expression


public class XPath2Expression
extends
This interface represents a parsed and statically bound XPath2 expression.

Method Summary

public org.eclipse.wst.xml.xpath2.api.ResultSequenceevaluate(org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext , java.lang.Object[] contextItems)
     Evaluate the XPath2 expression, using the supplied DynamicContext.
public java.util.CollectiongetAxes()
     Return a collections of the axis used in the XPath2 expression.
public java.util.CollectiongetFreeVariables()
     Return a collections of QNames of the names of free variables referenced in the XPath expression. These variables may be requested during evaluation.
public java.util.CollectiongetResolvedFunctions()
     Return a collections of the functions used in the XPath2 expression.
public booleanisRootPathUsed()
     Whether or not the root path is in use in the XPath2 expression.

Methods Detail

evaluate

public org.eclipse.wst.xml.xpath2.api.ResultSequence evaluate(org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext , java.lang.Object[] contextItems)

Evaluate the XPath2 expression, using the supplied DynamicContext.

Parameters

dynamicContext - Dynamic context for the expression.

contextItems - Context item (typically nodes, often one) to evaluate under.

Returns

org.eclipse.wst.xml.xpath2.api.ResultSequence - A ResultSequence

getAxes

public java.util.Collection getAxes()

Return a collections of the axis used in the XPath2 expression.

Returns

java.util.Collection - A Collection containing Strings with the axis names in use.

getFreeVariables

public java.util.Collection getFreeVariables()

Return a collections of QNames of the names of free variables referenced in the XPath expression. These variables may be requested during evaluation.

Returns

java.util.Collection - A Collection containing javax.xml.namespacing.QName of free variables

getResolvedFunctions

public java.util.Collection getResolvedFunctions()

Return a collections of the functions used in the XPath2 expression.

Returns

java.util.Collection - A Collection containing javax.xml.namespacing.QName of functions in use.

isRootPathUsed

public boolean isRootPathUsed()

Whether or not the root path is in use in the XPath2 expression.

Returns

boolean - true if the expression uses / or //, false otherwise.