<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:10 GMT 2011 --> <TITLE> WhereClause </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="WhereClause"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <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="../../../../../net/sf/saxon/expr/flwor/TuplePush.html" title="class in net.sf.saxon.expr.flwor"><B>PREV CLASS</B></A> <A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClausePull.html" title="class in net.sf.saxon.expr.flwor"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?net/sf/saxon/expr/flwor/WhereClause.html" target="_top"><B>FRAMES</B></A> <A HREF="WhereClause.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_net.sf.saxon.expr.flwor.Clause">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> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> net.sf.saxon.expr.flwor</FONT> <BR> Class WhereClause</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">net.sf.saxon.expr.flwor.Clause</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.expr.flwor.WhereClause</B> </PRE> <HR> <DL> <DT><PRE>public class <B>WhereClause</B><DT>extends <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></DL> </PRE> <P> A "where" clause in a FLWOR expression <P> <P> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.expr.flwor.Clause"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.expr.flwor.<A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#COUNT">COUNT</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#FOR">FOR</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#GROUPBYCLAUSE">GROUPBYCLAUSE</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#LET">LET</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#ORDERBYCLAUSE">ORDERBYCLAUSE</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#WHERE">WHERE</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#WINDOW">WINDOW</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#WhereClause(net.sf.saxon.expr.Expression)">WhereClause</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> predicate)</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html" title="class in net.sf.saxon.expr.flwor">WhereClause</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#copy()">copy</A></B>()</CODE> <BR> </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="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#explain(net.sf.saxon.trace.ExpressionPresenter)">explain</A></B>(<A HREF="../../../../../net/sf/saxon/trace/ExpressionPresenter.html" title="class in net.sf.saxon.trace">ExpressionPresenter</A> out)</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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#gatherVariableReferences(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.Binding, java.util.List)">gatherVariableReferences</A></B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor, <A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A> binding, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../net/sf/saxon/expr/VariableReference.html" title="class in net.sf.saxon.expr">VariableReference</A>> references)</CODE> <BR> Build a list of all references to a variables declared in this clause</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#getBaseExpression()">getBaseExpression</A></B>()</CODE> <BR> </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="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#getClauseKey()">getClauseKey</A></B>()</CODE> <BR> Get a keyword identifying what kind of clause this is</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#getPredicate()">getPredicate</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePull.html" title="class in net.sf.saxon.expr.flwor">TuplePull</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#getPullStream(net.sf.saxon.expr.flwor.TuplePull, net.sf.saxon.expr.XPathContext)">getPullStream</A></B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePull.html" title="class in net.sf.saxon.expr.flwor">TuplePull</A> base, <A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE> <BR> Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePush.html" title="class in net.sf.saxon.expr.flwor">TuplePush</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#getPushStream(net.sf.saxon.expr.flwor.TuplePush, net.sf.saxon.expr.XPathContext)">getPushStream</A></B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePush.html" title="class in net.sf.saxon.expr.flwor">TuplePush</A> destination, <A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE> <BR> Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream</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="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#processSubExpressions(net.sf.saxon.expr.flwor.ExpressionProcessor)">processSubExpressions</A></B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/ExpressionProcessor.html" title="interface in net.sf.saxon.expr.flwor">ExpressionProcessor</A> processor)</CODE> <BR> Process the subexpressions of this clause</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="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#refineVariableType(net.sf.saxon.expr.parser.ExpressionVisitor, java.util.List, net.sf.saxon.expr.Expression)">refineVariableType</A></B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../net/sf/saxon/expr/VariableReference.html" title="class in net.sf.saxon.expr">VariableReference</A>> references, <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> returnExpr)</CODE> <BR> Supply improved type information to the expressions that contain references to the variables declared in this clause</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="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#setPredicate(net.sf.saxon.expr.Expression)">setPredicate</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> predicate)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#toString()">toString</A></B>()</CODE> <BR> </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="../../../../../net/sf/saxon/expr/flwor/WhereClause.html#typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor)">typeCheck</A></B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor)</CODE> <BR> Type-check the expression</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.expr.flwor.Clause"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.expr.flwor.<A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#getRangeVariables()">getRangeVariables</A>, <A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#optimize(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)">optimize</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="WhereClause(net.sf.saxon.expr.Expression)"><!-- --></A><H3> WhereClause</H3> <PRE> public <B>WhereClause</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> predicate)</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getClauseKey()"><!-- --></A><H3> getClauseKey</H3> <PRE> public int <B>getClauseKey</B>()</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#getClauseKey()">Clause</A></CODE></B></DD> <DD>Get a keyword identifying what kind of clause this is <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#getClauseKey()">getClauseKey</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the kind of clause</DL> </DD> </DL> <HR> <A NAME="getPredicate()"><!-- --></A><H3> getPredicate</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getPredicate</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setPredicate(net.sf.saxon.expr.Expression)"><!-- --></A><H3> setPredicate</H3> <PRE> public void <B>setPredicate</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> predicate)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="copy()"><!-- --></A><H3> copy</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClause.html" title="class in net.sf.saxon.expr.flwor">WhereClause</A> <B>copy</B>()</PRE> <DL> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#copy()">copy</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor)"><!-- --></A><H3> typeCheck</H3> <PRE> public void <B>typeCheck</B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor) throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Type-check the expression <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor)">typeCheck</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>visitor</CODE> - the ExpressionVisitor, providing access to static context information <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any error is detected</DL> </DD> </DL> <HR> <A NAME="getPullStream(net.sf.saxon.expr.flwor.TuplePull, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3> getPullStream</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePull.html" title="class in net.sf.saxon.expr.flwor">TuplePull</A> <B>getPullStream</B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePull.html" title="class in net.sf.saxon.expr.flwor">TuplePull</A> base, <A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE> <DL> <DD>Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#getPullStream(net.sf.saxon.expr.flwor.TuplePull, net.sf.saxon.expr.XPathContext)">getPullStream</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>base</CODE> - the input tuple stream<DD><CODE>context</CODE> - the dynamic evaluation context <DT><B>Returns:</B><DD>the output tuple stream</DL> </DD> </DL> <HR> <A NAME="gatherVariableReferences(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.Binding, java.util.List)"><!-- --></A><H3> gatherVariableReferences</H3> <PRE> public void <B>gatherVariableReferences</B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor, <A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A> binding, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../net/sf/saxon/expr/VariableReference.html" title="class in net.sf.saxon.expr">VariableReference</A>> references)</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#gatherVariableReferences(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.Binding, java.util.List)">Clause</A></CODE></B></DD> <DD>Build a list of all references to a variables declared in this clause <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#gatherVariableReferences(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.Binding, java.util.List)">gatherVariableReferences</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>visitor</CODE> - the expression visitor<DD><CODE>binding</CODE> - a variable declared in this clause<DD><CODE>references</CODE> - the list of variable references, initially empty, to which the method will append</DL> </DD> </DL> <HR> <A NAME="refineVariableType(net.sf.saxon.expr.parser.ExpressionVisitor, java.util.List, net.sf.saxon.expr.Expression)"><!-- --></A><H3> refineVariableType</H3> <PRE> public void <B>refineVariableType</B>(<A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> visitor, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../net/sf/saxon/expr/VariableReference.html" title="class in net.sf.saxon.expr">VariableReference</A>> references, <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> returnExpr)</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#refineVariableType(net.sf.saxon.expr.parser.ExpressionVisitor, java.util.List, net.sf.saxon.expr.Expression)">Clause</A></CODE></B></DD> <DD>Supply improved type information to the expressions that contain references to the variables declared in this clause <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#refineVariableType(net.sf.saxon.expr.parser.ExpressionVisitor, java.util.List, net.sf.saxon.expr.Expression)">refineVariableType</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>visitor</CODE> - the expression visitor<DD><CODE>references</CODE> - the list of variable references<DD><CODE>returnExpr</CODE> - the expression in the return clause</DL> </DD> </DL> <HR> <A NAME="getPushStream(net.sf.saxon.expr.flwor.TuplePush, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3> getPushStream</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePush.html" title="class in net.sf.saxon.expr.flwor">TuplePush</A> <B>getPushStream</B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/TuplePush.html" title="class in net.sf.saxon.expr.flwor">TuplePush</A> destination, <A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE> <DL> <DD>Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#getPushStream(net.sf.saxon.expr.flwor.TuplePush, net.sf.saxon.expr.XPathContext)">getPushStream</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>destination</CODE> - the output tuple stream<DD><CODE>context</CODE> - the dynamic evaluation context <DT><B>Returns:</B><DD>the push tuple stream that implements the functionality of this clause of the FLWOR expression</DL> </DD> </DL> <HR> <A NAME="processSubExpressions(net.sf.saxon.expr.flwor.ExpressionProcessor)"><!-- --></A><H3> processSubExpressions</H3> <PRE> public void <B>processSubExpressions</B>(<A HREF="../../../../../net/sf/saxon/expr/flwor/ExpressionProcessor.html" title="interface in net.sf.saxon.expr.flwor">ExpressionProcessor</A> processor) throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Process the subexpressions of this clause <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#processSubExpressions(net.sf.saxon.expr.flwor.ExpressionProcessor)">processSubExpressions</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>processor</CODE> - the expression processor used to process the subexpressions <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any error is detected</DL> </DD> </DL> <HR> <A NAME="getBaseExpression()"><!-- --></A><H3> getBaseExpression</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getBaseExpression</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="explain(net.sf.saxon.trace.ExpressionPresenter)"><!-- --></A><H3> explain</H3> <PRE> public void <B>explain</B>(<A HREF="../../../../../net/sf/saxon/trace/ExpressionPresenter.html" title="class in net.sf.saxon.trace">ExpressionPresenter</A> out)</PRE> <DL> <DD>Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html#explain(net.sf.saxon.trace.ExpressionPresenter)">explain</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/flwor/Clause.html" title="class in net.sf.saxon.expr.flwor">Clause</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>out</CODE> - the expression presenter used to display the structure</DL> </DD> </DL> <HR> <A NAME="toString()"><!-- --></A><H3> toString</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> <DL> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <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="../../../../../net/sf/saxon/expr/flwor/TuplePush.html" title="class in net.sf.saxon.expr.flwor"><B>PREV CLASS</B></A> <A HREF="../../../../../net/sf/saxon/expr/flwor/WhereClausePull.html" title="class in net.sf.saxon.expr.flwor"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?net/sf/saxon/expr/flwor/WhereClause.html" target="_top"><B>FRAMES</B></A> <A HREF="WhereClause.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_net.sf.saxon.expr.flwor.Clause">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> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>