<!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:44 GMT 2011 --> <TITLE> MemoClosure </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="MemoClosure"; } } </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/value/IntegerValue.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/value/MemoClosure.ProgressiveIterator.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/value/MemoClosure.html" target="_top"><B>FRAMES</B></A> <A HREF="MemoClosure.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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.value</FONT> <BR> Class MemoClosure<T extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></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/value/Value.html" title="class in net.sf.saxon.value">net.sf.saxon.value.Value</A><T> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value">net.sf.saxon.value.Closure</A><T> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.value.MemoClosure<T></B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A><T></DD> </DL> <HR> <DL> <DT><PRE>public class <B>MemoClosure<T extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></B><DT>extends <A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value">Closure</A><T></DL> </PRE> <P> A MemoClosure represents a value that has not yet been evaluated: the value is represented by an expression, together with saved values of all the context variables that the expression depends on. <p/> <p>The MemoClosure is designed for use when the value is only read several times. The value is saved on the first evaluation and remembered for later use.</p> <p/> <p>The MemoClosure maintains a reservoir containing those items in the value that have already been read. When a new iterator is requested to read the value, this iterator first examines and returns any items already placed in the reservoir by previous users of the MemoClosure. When the reservoir is exhausted, it then uses an underlying Input Iterator to read further values of the underlying expression. If the value is not read to completion (for example, if the first user did exists($expr), then the Input Iterator is left positioned where this user abandoned it. The next user will read any values left in the reservoir by the first user, and then pick up iterating the base expression where the first user left off. Eventually, all the values of the expression will find their way into the reservoir, and future users simply iterate over the reservoir contents. Alternatively, of course, the values may be left unread.</p> <p/> <p>Delayed evaluation is used only for expressions with a static type that allows more than one item, so the evaluateItem() method will not normally be used, but it is supported for completeness.</p> <p/> <p>The expression may depend on local variables and on the context item; these values are held in the saved XPathContext object that is kept as part of the Closure, and they will always be read from that object. The expression may also depend on global variables; these are unchanging, so they can be read from the Bindery in the normal way. Expressions that depend on other contextual information, for example the values of position(), last(), current(), current-group(), should not be evaluated using this mechanism: they should always be evaluated eagerly. This means that the Closure does not need to keep a copy of these context variables.</p> <p/> <p>In Saxon-EE, a for-each loop can be multithreaded. If a variable declared outside the loop is evaluated as a MemoClosure, then a reference to the variable within the loop can result in concurrent attempts to evaluate the variable incrementally. This is prevented by synchronizing the evaluation methods.</p> <P> <P> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.ProgressiveIterator.html" title="class in net.sf.saxon.value">MemoClosure.ProgressiveIterator</A></B></CODE> <BR> A ProgressiveIterator starts by reading any items already held in the reservoir; when the reservoir is exhausted, it reads further items from the inputIterator, copying them into the reservoir as they are read.</TD> </TR> </TABLE> <!-- =========== 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> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.html#EMPTY">EMPTY</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.html#state">state</A></B></CODE> <BR> </TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.value.Closure"><!-- --></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.value.<A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value">Closure</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/Closure.html#depth">depth</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#expression">expression</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#inputIterator">inputIterator</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#savedXPathContext">savedXPathContext</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.value.Value"><!-- --></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.value.<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#INDETERMINATE_ORDERING">INDETERMINATE_ORDERING</A></CODE></TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.om.ValueRepresentation"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.om.<A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#EMPTY_VALUE_ARRAY">EMPTY_VALUE_ARRAY</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/value/MemoClosure.html#MemoClosure()">MemoClosure</A></B>()</CODE> <BR> Constructor should not be called directly, instances should be made using the make() method.</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> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.html#getLength()">getLength</A></B>()</CODE> <BR> Get the length of the sequence</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="../../../../net/sf/saxon/value/MemoClosure.html#isFullyRead()">isFullyRead</A></B>()</CODE> <BR> Determine whether the contents of the MemoClosure have been fully read</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.html#itemAt(int)">itemAt</A></B>(int n)</CODE> <BR> Get the n'th item in the sequence (starting from 0).</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.html#iterate()">iterate</A></B>()</CODE> <BR> Evaluate the expression in a given context to return an iterator over a sequence</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/value/MemoClosure.html#materialize()">materialize</A></B>()</CODE> <BR> Return a value containing all the items in the sequence returned by this SequenceIterator</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/value/MemoClosure.html#process(net.sf.saxon.expr.XPathContext)">process</A></B>(<A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE> <BR> Process the expression by writing the value to the current Receiver</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.value.Closure"><!-- --></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.value.<A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value">Closure</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/Closure.html#getCardinality()">getCardinality</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#getExpression()">getExpression</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#getItemType(net.sf.saxon.type.TypeHierarchy)">getItemType</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#getSavedXPathContext()">getSavedXPathContext</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#make(net.sf.saxon.expr.Expression, net.sf.saxon.expr.XPathContext, int)">make</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#makeIteratorClosure(net.sf.saxon.om.SequenceIterator)">makeIteratorClosure</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#reduce()">reduce</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#saveContext(net.sf.saxon.expr.Expression, net.sf.saxon.expr.XPathContext)">saveContext</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#setExpression(net.sf.saxon.expr.Expression)">setExpression</A>, <A HREF="../../../../net/sf/saxon/value/Closure.html#setSavedXPathContext(net.sf.saxon.expr.XPathContextMajor)">setSavedXPathContext</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.value.Value"><!-- --></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.value.<A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#asItem()">asItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asItem(net.sf.saxon.om.ValueRepresentation)">asItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asIterator(net.sf.saxon.om.ValueRepresentation)">asIterator</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#asValue(net.sf.saxon.om.ValueRepresentation)">asValue</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#checkPermittedContents(net.sf.saxon.type.SchemaType, net.sf.saxon.expr.StaticContext, boolean)">checkPermittedContents</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#convertToJava(net.sf.saxon.om.Item)">convertToJava</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#effectiveBooleanValue()">effectiveBooleanValue</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#fromItem(net.sf.saxon.om.Item)">fromItem</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getCanonicalLexicalRepresentation()">getCanonicalLexicalRepresentation</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getIterator(net.sf.saxon.om.ValueRepresentation)">getIterator</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getSchemaComparable()">getSchemaComparable</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getSequenceLength(net.sf.saxon.om.ValueRepresentation)">getSequenceLength</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getStringValue()">getStringValue</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#getStringValueCS()">getStringValueCS</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#hashCode()">hashCode</A>, <A HREF="../../../../net/sf/saxon/value/Value.html#isIdentical(net.sf.saxon.value.Value)">isIdentical</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#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#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#toString()" title="class or interface in java.lang">toString</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> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_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>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="state"><!-- --></A><H3> state</H3> <PRE> protected int <B>state</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="EMPTY"><!-- --></A><H3> EMPTY</H3> <PRE> protected static final int <B>EMPTY</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.value.MemoClosure.EMPTY">Constant Field Values</A></DL> </DL> <!-- ========= 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="MemoClosure()"><!-- --></A><H3> MemoClosure</H3> <PRE> public <B>MemoClosure</B>()</PRE> <DL> <DD>Constructor should not be called directly, instances should be made using the make() method. <P> </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="iterate()"><!-- --></A><H3> iterate</H3> <PRE> public <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A>> <B>iterate</B>() throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Evaluate the expression in a given context to return an iterator over a sequence <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/Closure.html#iterate()">iterate</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value">Closure</A><<A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A> extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>an iterator over the sequence of items <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 a dynamic error occurs. This is possible only in the case of values that are materialized lazily, that is, where the iterate() method leads to computation of an expression that delivers the values.</DL> </DD> </DL> <HR> <A NAME="process(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3> process</H3> <PRE> public void <B>process</B>(<A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Process the expression by writing the value to the current Receiver <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/Closure.html#process(net.sf.saxon.expr.XPathContext)">process</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/Closure.html" title="class in net.sf.saxon.value">Closure</A><<A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A> extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>context</CODE> - The dynamic context, giving access to the current node, the current variables, etc. <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 an error occurs (for example if the value is a closure that needs to be evaluated)</DL> </DD> </DL> <HR> <A NAME="itemAt(int)"><!-- --></A><H3> itemAt</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A> <B>itemAt</B>(int n) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Get the n'th item in the sequence (starting from 0). This is defined for all SequenceValues, but its real benefits come for a SequenceValue stored extensionally <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#itemAt(int)">itemAt</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A><<A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A> extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>n</CODE> - position of the required item, counting from zero. <DT><B>Returns:</B><DD>the n'th item in the sequence, where the first item in the sequence is numbered zero. If n is negative or >= the length of the sequence, returns null. <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 an error occurs (for example if the value is a Closure that needs to be evaluated to find the Nth item)</DL> </DD> </DL> <HR> <A NAME="getLength()"><!-- --></A><H3> getLength</H3> <PRE> public int <B>getLength</B>() throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Get the length of the sequence <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/value/Value.html#getLength()">getLength</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A><<A HREF="../../../../net/sf/saxon/value/MemoClosure.html" title="type parameter in MemoClosure">T</A> extends <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the number of items in the sequence <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 an error occurs (for example if the value is a closure that needs to be read to determine its length)</DL> </DD> </DL> <HR> <A NAME="isFullyRead()"><!-- --></A><H3> isFullyRead</H3> <PRE> public boolean <B>isFullyRead</B>()</PRE> <DL> <DD>Determine whether the contents of the MemoClosure have been fully read <P> <DD><DL> <DT><B>Returns:</B><DD>true if the contents have been fully read</DL> </DD> </DL> <HR> <A NAME="materialize()"><!-- --></A><H3> materialize</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> <B>materialize</B>() throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Return a value containing all the items in the sequence returned by this SequenceIterator <P> <DD><DL> <DT><B>Returns:</B><DD>the corresponding value <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 a failure occurs reading the input</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/value/IntegerValue.html" title="class in net.sf.saxon.value"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/value/MemoClosure.ProgressiveIterator.html" title="class in net.sf.saxon.value"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/value/MemoClosure.html" target="_top"><B>FRAMES</B></A> <A HREF="MemoClosure.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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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>