blob: 80b8e59bd66af7d9ba818068cf25f8558dffe8ea [file] [log] [blame]
<html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.api</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.api</strong></font><br>
Class XPath2Expression</h2><br><hr><pre>public class <strong>XPath2Expression</strong>
extends </pre>This interface represents a parsed and statically bound XPath2 expression.<p></p><p></p><hr><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Method Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_evaluate">evaluate</a>(org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext
,
java.lang.Object[] contextItems)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Evaluate the XPath2 expression, using the supplied DynamicContext.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.Collection</code></td><td width="" align="left"><code><a href="#method_getAxes">getAxes</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Return a collections of the axis used in the XPath2 expression.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.Collection</code></td><td width="" align="left"><code><a href="#method_getFreeVariables">getFreeVariables</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Return a collections of QNames of the names of free variables referenced in the XPath expression.
These variables may be requested during evaluation.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.Collection</code></td><td width="" align="left"><code><a href="#method_getResolvedFunctions">getResolvedFunctions</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Return a collections of the functions used in the XPath2 expression.</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_isRootPathUsed">isRootPathUsed</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Whether or not the root path is in use in the XPath2 expression.</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
Methods Detail
</h2></td></tr></table><h2><a name="method_evaluate">evaluate</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>evaluate</strong>(org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext
,
java.lang.Object[] contextItems)</code></p><p>Evaluate the XPath2 expression, using the supplied DynamicContext.</p><h3>Parameters</h3><p><code>dynamicContext</code> - Dynamic context for the expression.</p><p><code>contextItems</code> - Context item (typically nodes, often one) to evaluate under.</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - A ResultSequence</p><hr><h2><a name="method_getAxes">getAxes</a></h2><p><code>public java.util.Collection <strong>getAxes</strong>()</code></p><p>Return a collections of the axis used in the XPath2 expression.</p><h3>Returns</h3><p><code>java.util.Collection</code> - A Collection containing Strings with the axis names in use.</p><hr><h2><a name="method_getFreeVariables">getFreeVariables</a></h2><p><code>public java.util.Collection <strong>getFreeVariables</strong>()</code></p><p>Return a collections of QNames of the names of free variables referenced in the XPath expression.
These variables may be requested during evaluation.</p><h3>Returns</h3><p><code>java.util.Collection</code> - A Collection containing javax.xml.namespacing.QName of free variables</p><hr><h2><a name="method_getResolvedFunctions">getResolvedFunctions</a></h2><p><code>public java.util.Collection <strong>getResolvedFunctions</strong>()</code></p><p>Return a collections of the functions used in the XPath2 expression.</p><h3>Returns</h3><p><code>java.util.Collection</code> - A Collection containing javax.xml.namespacing.QName of functions in use.</p><hr><h2><a name="method_isRootPathUsed">isRootPathUsed</a></h2><p><code>public boolean <strong>isRootPathUsed</strong>()</code></p><p>Whether or not the root path is in use in the XPath2 expression.</p><h3>Returns</h3><p><code>boolean</code> - true if the expression uses / or //, false otherwise.</p><hr></body></html>