<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc on Tue Sep 18 10:25:38 GMT+01:00 2001 --> <TITLE> : Class NodeSetValue </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> </HEAD> <BODY BGCOLOR="white"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_top"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/icl/saxon/expr/NodeSetIntent.html"><B>PREV CLASS</B></A> <A HREF="../../../../com/icl/saxon/expr/NumericValue.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="NodeSetValue.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | <A HREF="#fields_inherited_from_class_com.icl.saxon.expr.Value">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.icl.saxon.expr</FONT> <BR> Class NodeSetValue</H2> <PRE> java.lang.Object | +--<A HREF="../../../../com/icl/saxon/expr/Expression.html">com.icl.saxon.expr.Expression</A> | +--<A HREF="../../../../com/icl/saxon/expr/Value.html">com.icl.saxon.expr.Value</A> | +--<B>com.icl.saxon.expr.NodeSetValue</B> </PRE> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/icl/saxon/expr/EmptyNodeSet.html">EmptyNodeSet</A>, <A HREF="../../../../com/icl/saxon/expr/NodeSetExtent.html">NodeSetExtent</A>, <A HREF="../../../../com/icl/saxon/expr/NodeSetIntent.html">NodeSetIntent</A>, <A HREF="../../../../com/icl/saxon/expr/SingletonNodeSet.html">SingletonNodeSet</A></DD> </DL> <HR> <DL> <DT>public abstract class <B>NodeSetValue</B><DT>extends <A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></DL> <P> A node-set value. We use this both for node-sets and node-lists. The node set will only be sorted into document order when requested (using sort() or evaluate()). This is an abstract class with a number of concrete implementations including NodeSetExtent (for extensional node-sets) and NodeSetIntent (for intensional node-sets). <P> <HR> <P> <!-- ======== INNER CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <A NAME="fields_inherited_from_class_com.icl.saxon.expr.Value"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Fields inherited from class com.icl.saxon.expr.<A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#ANY">ANY</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#BOOLEAN">BOOLEAN</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#NODESET">NODESET</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#NUMBER">NUMBER</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#OBJECT">OBJECT</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#STRING">STRING</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_com.icl.saxon.expr.Expression"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Fields inherited from class com.icl.saxon.expr.<A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html#staticContext">staticContext</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#NodeSetValue()">NodeSetValue</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#asBoolean()">asBoolean</A></B>()</CODE> <BR> Evaluate as a boolean.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> double</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#asNumber()">asNumber</A></B>()</CODE> <BR> Evaluate as a number.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#asString()">asString</A></B>()</CODE> <BR> Convert to string value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#compare(int, com.icl.saxon.expr.Value)">compare</A></B>(int operator, <A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> other)</CODE> <BR> Test how a nodeset compares to another Value under a relational comparison</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#conversionPreference(java.lang.Class)">conversionPreference</A></B>(java.lang.Class required)</CODE> <BR> Get conversion preference for this value to a Java class.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#convertToJava(java.lang.Class)">convertToJava</A></B>(java.lang.Class target)</CODE> <BR> Convert to Java object (for passing to external functions)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#display(int)">display</A></B>(int level)</CODE> <BR> Diagnostic print of expression structure</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract <A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#enumerate()">enumerate</A></B>()</CODE> <BR> Return an enumeration of this nodeset value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#enumerate(com.icl.saxon.Context, boolean)">enumerate</A></B>(<A HREF="../../../../com/icl/saxon/Context.html">Context</A> c, boolean sorted)</CODE> <BR> Return an enumeration of this nodeset value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#equals(com.icl.saxon.expr.Value)">equals</A></B>(<A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> other)</CODE> <BR> Test whether a nodeset "equals" another Value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#evaluate(com.icl.saxon.Context)">evaluate</A></B>(<A HREF="../../../../com/icl/saxon/Context.html">Context</A> context)</CODE> <BR> Evaluate the Node Set.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html">NodeSetValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#evaluateAsNodeSet(com.icl.saxon.Context)">evaluateAsNodeSet</A></B>(<A HREF="../../../../com/icl/saxon/Context.html">Context</A> context)</CODE> <BR> Evaluate an expression as a NodeSet.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#getCount()">getCount</A></B>()</CODE> <BR> Count the nodes in the node-set.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#getDataType()">getDataType</A></B>()</CODE> <BR> Determine the data type of the expression</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract <A HREF="../../../../com/icl/saxon/om/NodeInfo.html">NodeInfo</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#getFirst()">getFirst</A></B>()</CODE> <BR> Get the first node in the nodeset (in document order)</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#isSorted()">isSorted</A></B>()</CODE> <BR> Test whether the value is known to be sorted</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#notEquals(com.icl.saxon.expr.Value)">notEquals</A></B>(<A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> other)</CODE> <BR> Test whether a nodeset "not-equals" another Value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#setSorted(boolean)">setSorted</A></B>(boolean isSorted)</CODE> <BR> Set a flag to indicate whether the nodes are sorted.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract <A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html">NodeSetValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html#sort()">sort</A></B>()</CODE> <BR> Sort the nodes into document order.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.icl.saxon.expr.Value"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class com.icl.saxon.expr.<A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#getDependencies()">getDependencies</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#inverse(int)">inverse</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#numericCompare(int, double, double)">numericCompare</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#reduce(int, com.icl.saxon.Context)">reduce</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#simplify()">simplify</A>, <A HREF="../../../../com/icl/saxon/expr/Value.html#stringToNumber(java.lang.String)">stringToNumber</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.icl.saxon.expr.Expression"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class com.icl.saxon.expr.<A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html#containsReferences()">containsReferences</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#evaluateAsBoolean(com.icl.saxon.Context)">evaluateAsBoolean</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#evaluateAsNumber(com.icl.saxon.Context)">evaluateAsNumber</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#evaluateAsString(com.icl.saxon.Context)">evaluateAsString</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#getStaticContext()">getStaticContext</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#indent(int)">indent</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#isContextDocumentNodeSet()">isContextDocumentNodeSet</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#make(java.lang.String, com.icl.saxon.expr.StaticContext)">make</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#outputStringValue(com.icl.saxon.output.Outputter, com.icl.saxon.Context)">outputStringValue</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#setStaticContext(com.icl.saxon.expr.StaticContext)">setStaticContext</A>, <A HREF="../../../../com/icl/saxon/expr/Expression.html#usesCurrent()">usesCurrent</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class java.lang.Object</B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="NodeSetValue()"><!-- --></A><H3> NodeSetValue</H3> <PRE> public <B>NodeSetValue</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="getDataType()"><!-- --></A><H3> getDataType</H3> <PRE> public int <B>getDataType</B>()</PRE> <DL> <DD>Determine the data type of the expression<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html#getDataType()">getDataType</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>Value.NODESET</DL> </DD> </DL> <HR> <A NAME="evaluate(com.icl.saxon.Context)"><!-- --></A><H3> evaluate</H3> <PRE> public <A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> <B>evaluate</B>(<A HREF="../../../../com/icl/saxon/Context.html">Context</A> context) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Evaluate the Node Set. This guarantees to return the result in sorted order.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#evaluate(com.icl.saxon.Context)">evaluate</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>context</CODE> - The context for evaluation (not used)</DL> </DD> </DL> <HR> <A NAME="evaluateAsNodeSet(com.icl.saxon.Context)"><!-- --></A><H3> evaluateAsNodeSet</H3> <PRE> public <A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html">NodeSetValue</A> <B>evaluateAsNodeSet</B>(<A HREF="../../../../com/icl/saxon/Context.html">Context</A> context) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Evaluate an expression as a NodeSet.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html#evaluateAsNodeSet(com.icl.saxon.Context)">evaluateAsNodeSet</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>context</CODE> - The context in which the expression is to be evaluated<DT><B>Returns:</B><DD>the value of the expression, evaluated in the current context</DL> </DD> </DL> <HR> <A NAME="enumerate()"><!-- --></A><H3> enumerate</H3> <PRE> public abstract <A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A> <B>enumerate</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Return an enumeration of this nodeset value. Unless sort() has been called the nodes can be in any order.</DL> <HR> <A NAME="enumerate(com.icl.saxon.Context, boolean)"><!-- --></A><H3> enumerate</H3> <PRE> public <A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A> <B>enumerate</B>(<A HREF="../../../../com/icl/saxon/Context.html">Context</A> c, boolean sorted) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Return an enumeration of this nodeset value. This is to satisfy the interface for Expression.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html#enumerate(com.icl.saxon.Context, boolean)">enumerate</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>context</CODE> - The context is ignored.<DD><CODE>sorted</CODE> - Indicates that the result must be in document order</DL> </DD> </DL> <HR> <A NAME="setSorted(boolean)"><!-- --></A><H3> setSorted</H3> <PRE> public abstract void <B>setSorted</B>(boolean isSorted)</PRE> <DL> <DD>Set a flag to indicate whether the nodes are sorted. Used when the creator of the node-set knows that they are already in document order.<DD><DL> <DT><B>Parameters:</B><DD><CODE>isSorted</CODE> - true if the caller wishes to assert that the nodes are in document order and do not need to be further sorted</DL> </DD> </DL> <HR> <A NAME="isSorted()"><!-- --></A><H3> isSorted</H3> <PRE> public abstract boolean <B>isSorted</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Test whether the value is known to be sorted<DD><DL> <DT><B>Returns:</B><DD>true if the value is known to be sorted in document order, false if it is not known whether it is sorted.</DL> </DD> </DL> <HR> <A NAME="asString()"><!-- --></A><H3> asString</H3> <PRE> public abstract java.lang.String <B>asString</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Convert to string value<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#asString()">asString</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the value of the first node in the node-set if there is one, otherwise an empty string</DL> </DD> </DL> <HR> <A NAME="asNumber()"><!-- --></A><H3> asNumber</H3> <PRE> public double <B>asNumber</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Evaluate as a number.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#asNumber()">asNumber</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the number obtained by evaluating as a String and converting the string to a number</DL> </DD> </DL> <HR> <A NAME="asBoolean()"><!-- --></A><H3> asBoolean</H3> <PRE> public abstract boolean <B>asBoolean</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Evaluate as a boolean.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#asBoolean()">asBoolean</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>true if the node set is not empty</DL> </DD> </DL> <HR> <A NAME="getCount()"><!-- --></A><H3> getCount</H3> <PRE> public abstract int <B>getCount</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Count the nodes in the node-set. Note this will sort the node set if necessary, to make sure there are no duplicates.</DL> <HR> <A NAME="sort()"><!-- --></A><H3> sort</H3> <PRE> public abstract <A HREF="../../../../com/icl/saxon/expr/NodeSetValue.html">NodeSetValue</A> <B>sort</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Sort the nodes into document order. This does nothing if the nodes are already known to be sorted; to force a sort, call setSorted(false)<DD><DL> <DT><B>Parameters:</B><DD><CODE>controller</CODE> - The controller used to sort nodes into document order<DT><B>Returns:</B><DD>the same NodeSetValue, after sorting. (The reason for returning this is that it makes life easier for the XSL compiler).</DL> </DD> </DL> <HR> <A NAME="getFirst()"><!-- --></A><H3> getFirst</H3> <PRE> public abstract <A HREF="../../../../com/icl/saxon/om/NodeInfo.html">NodeInfo</A> <B>getFirst</B>() throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Get the first node in the nodeset (in document order)<DD><DL> <DT><B>Returns:</B><DD>the first node</DL> </DD> </DL> <HR> <A NAME="equals(com.icl.saxon.expr.Value)"><!-- --></A><H3> equals</H3> <PRE> public boolean <B>equals</B>(<A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> other) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Test whether a nodeset "equals" another Value<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#equals(com.icl.saxon.expr.Value)">equals</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD>Following copied from class: <CODE>com.icl.saxon.expr.Value</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD>a boolean giving the value of the expression, evaluated in the current context</DL> </DD> </DL> <HR> <A NAME="notEquals(com.icl.saxon.expr.Value)"><!-- --></A><H3> notEquals</H3> <PRE> public boolean <B>notEquals</B>(<A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> other) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Test whether a nodeset "not-equals" another Value<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#notEquals(com.icl.saxon.expr.Value)">notEquals</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD>Following copied from class: <CODE>com.icl.saxon.expr.Value</CODE></DD> <DD><DL> <DT><B>Returns:</B><DD>a boolean giving the value of the expression, evaluated in the current context</DL> </DD> </DL> <HR> <A NAME="compare(int, com.icl.saxon.expr.Value)"><!-- --></A><H3> compare</H3> <PRE> public boolean <B>compare</B>(int operator, <A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A> other) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Test how a nodeset compares to another Value under a relational comparison<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#compare(int, com.icl.saxon.expr.Value)">compare</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>operator</CODE> - The comparison operator, one of Tokenizer.LE, Tokenizer.LT, Tokenizer.GE, Tokenizer.GT,</DL> </DD> </DL> <HR> <A NAME="display(int)"><!-- --></A><H3> display</H3> <PRE> public void <B>display</B>(int level)</PRE> <DL> <DD>Diagnostic print of expression structure<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html#display(int)">display</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A></CODE></DL> </DD> </DL> <HR> <A NAME="conversionPreference(java.lang.Class)"><!-- --></A><H3> conversionPreference</H3> <PRE> public int <B>conversionPreference</B>(java.lang.Class required)</PRE> <DL> <DD>Get conversion preference for this value to a Java class. A low result indicates higher preference.<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#conversionPreference(java.lang.Class)">conversionPreference</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> </DL> <HR> <A NAME="convertToJava(java.lang.Class)"><!-- --></A><H3> convertToJava</H3> <PRE> public java.lang.Object <B>convertToJava</B>(java.lang.Class target) throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE> <DL> <DD>Convert to Java object (for passing to external functions)<DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/icl/saxon/expr/Value.html#convertToJava(java.lang.Class)">convertToJava</A></CODE> in class <CODE><A HREF="../../../../com/icl/saxon/expr/Value.html">Value</A></CODE></DL> </DD> <DD>Following copied from class: <CODE>com.icl.saxon.expr.Value</CODE></DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>target</CODE> - The class required by the external function<DT><B>Returns:</B><DD>an object of the target class</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/icl/saxon/expr/NodeSetIntent.html"><B>PREV CLASS</B></A> <A HREF="../../../../com/icl/saxon/expr/NumericValue.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="NodeSetValue.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | <A HREF="#fields_inherited_from_class_com.icl.saxon.expr.Value">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> </BODY> </HTML>