| <!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.5.0_18) on Sun Apr 01 21:18:40 PDT 2012 --> | |
| <TITLE> | |
| NodeSequence | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xpath.axes.NodeSequence class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="NodeSequence"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= 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="class-use/NodeSequence.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xpath/axes/MatchPatternIterator.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xpath/axes/NodeSequence.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="NodeSequence.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"> | |
| org.apache.xpath.axes</FONT> | |
| <BR> | |
| Class NodeSequence</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">org.apache.xpath.Expression</A> | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">org.apache.xpath.objects.XObject</A> | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.axes.NodeSequence</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, javax.xml.transform.SourceLocator, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A>, <A HREF="../../../../org/apache/xpath/axes/PathComponent.html" title="interface in org.apache.xpath.axes">PathComponent</A>, <A HREF="../../../../org/apache/xpath/ExpressionNode.html" title="interface in org.apache.xpath">ExpressionNode</A>, <A HREF="../../../../org/apache/xpath/XPathVisitable.html" title="interface in org.apache.xpath">XPathVisitable</A></DD> | |
| </DL> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xpath/objects/XNodeSet.html" title="class in org.apache.xpath.objects">XNodeSet</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.38"><B>NodeSequence</B></A><DT>extends <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A><DT>implements <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A>, java.lang.Cloneable, <A HREF="../../../../org/apache/xpath/axes/PathComponent.html" title="interface in org.apache.xpath.axes">PathComponent</A></DL> | |
| </PRE> | |
| <P> | |
| This class is the dynamic wrapper for a Xalan DTMIterator instance, and | |
| provides random access capabilities. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.xpath.axes.NodeSequence">Serialized Form</A></DL> | |
| <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>private static class</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A></B></CODE> | |
| <BR> | |
| Each NodeSequence object has an iterator which is "walked".</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>private <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#m_cache">m_cache</A></B></CODE> | |
| <BR> | |
| A cache of a list of nodes obtained from the iterator so far.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected <A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#m_dtmMgr">m_dtmMgr</A></B></CODE> | |
| <BR> | |
| The DTMManager to use if we're using a NodeVector only.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#m_iter">m_iter</A></B></CODE> | |
| <BR> | |
| The functional iterator that fetches nodes.</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="../../../../org/apache/xpath/axes/NodeSequence.html#m_last">m_last</A></B></CODE> | |
| <BR> | |
| The index of the last node in the iteration.</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="../../../../org/apache/xpath/axes/NodeSequence.html#m_next">m_next</A></B></CODE> | |
| <BR> | |
| The index of the next node to be fetched.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>(package private) static long</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#serialVersionUID">serialVersionUID</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.xpath.objects.XObject"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.xpath.objects.<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_BOOLEAN">CLASS_BOOLEAN</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_NODESET">CLASS_NODESET</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_NULL">CLASS_NULL</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_NUMBER">CLASS_NUMBER</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_RTREEFRAG">CLASS_RTREEFRAG</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_STRING">CLASS_STRING</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_UNKNOWN">CLASS_UNKNOWN</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#CLASS_UNRESOLVEDVARIABLE">CLASS_UNRESOLVEDVARIABLE</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#m_obj">m_obj</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.xml.dtm.DTMIterator"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from interface org.apache.xml.dtm.<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#FILTER_ACCEPT">FILTER_ACCEPT</A>, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#FILTER_REJECT">FILTER_REJECT</A>, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#FILTER_SKIP">FILTER_SKIP</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#NodeSequence()">NodeSequence</A></B>()</CODE> | |
| <BR> | |
| Create a new NodeSequence in an invalid (null) state.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#NodeSequence(org.apache.xml.dtm.DTMIterator, int, org.apache.xpath.XPathContext, boolean)">NodeSequence</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> iter, | |
| int context, | |
| <A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A> xctxt, | |
| boolean shouldCacheNodes)</CODE> | |
| <BR> | |
| Create a new NodeSequence from a (already cloned) iterator.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#NodeSequence(org.apache.xml.dtm.DTMManager)">NodeSequence</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A> dtmMgr)</CODE> | |
| <BR> | |
| Construct an empty XNodeSet object.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#NodeSequence(java.lang.Object)">NodeSequence</A></B>(java.lang.Object nodeVector)</CODE> | |
| <BR> | |
| Create a new NodeSequence from a (already cloned) iterator.</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>protected int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#addNodeInDocOrder(int)">addNodeInDocOrder</A></B>(int node)</CODE> | |
| <BR> | |
| Add the node into a vector of nodes where it should occur in | |
| document order.</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="../../../../org/apache/xpath/axes/NodeSequence.html#allowDetachToRelease(boolean)">allowDetachToRelease</A></B>(boolean allowRelease)</CODE> | |
| <BR> | |
| Calling this with a value of false will cause the nodeset | |
| to be cached.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#cacheComplete()">cacheComplete</A></B>()</CODE> | |
| <BR> | |
| If this NodeSequence has a cache, and that cache is | |
| fully populated then this method returns true, otherwise | |
| if there is no cache or it is not complete it returns false.</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="../../../../org/apache/xpath/axes/NodeSequence.html#clone()">clone</A></B>()</CODE> | |
| <BR> | |
| Get a clone of this iterator, but don't reset the iteration in the | |
| process, so that it may be used from the current position.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#cloneWithReset()">cloneWithReset</A></B>()</CODE> | |
| <BR> | |
| Note: Not a deep clone.</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="../../../../org/apache/xpath/axes/NodeSequence.html#detach()">detach</A></B>()</CODE> | |
| <BR> | |
| Detaches the <code>DTMIterator</code> from the set which it iterated | |
| over, releasing any computational resources and placing the iterator | |
| in the INVALID state.</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="../../../../org/apache/xpath/axes/NodeSequence.html#fixupVariables(java.util.Vector, int)">fixupVariables</A></B>(java.util.Vector vars, | |
| int globalsSize)</CODE> | |
| <BR> | |
| XObjects should not normally need to fix up variables.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getAnalysisBits()">getAnalysisBits</A></B>()</CODE> | |
| <BR> | |
| Get the analysis bits for this path component, as defined in the WalkerFactory.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getAxis()">getAxis</A></B>()</CODE> | |
| <BR> | |
| Returns the axis being iterated, if it is known.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#getCache()">getCache</A></B>()</CODE> | |
| <BR> | |
| Get the cache (if any) of nodes obtained from | |
| the iterator so far.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#getContainedIter()">getContainedIter</A></B>()</CODE> | |
| <BR> | |
| Get the functional iterator that fetches nodes.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getCurrentNode()">getCurrentNode</A></B>()</CODE> | |
| <BR> | |
| Get the current node in the iterator.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getCurrentPos()">getCurrentPos</A></B>()</CODE> | |
| <BR> | |
| Get the current position within the cached list, which is one | |
| less than the next nextNode() call will retrieve.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#getDTM(int)">getDTM</A></B>(int nodeHandle)</CODE> | |
| <BR> | |
| Get an instance of a DTM that "owns" a node handle.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#getDTMManager()">getDTMManager</A></B>()</CODE> | |
| <BR> | |
| Get an instance of the DTMManager.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getExpandEntityReferences()">getExpandEntityReferences</A></B>()</CODE> | |
| <BR> | |
| The value of this flag determines whether the children of entity | |
| reference nodes are visible to the iterator.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#getIteratorCache()">getIteratorCache</A></B>()</CODE> | |
| <BR> | |
| Get the cached list of nodes appended with | |
| values obtained from the iterator as | |
| a NodeSequence is walked when its | |
| nextNode() method is called.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getLength()">getLength</A></B>()</CODE> | |
| <BR> | |
| The number of nodes in the list.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getRoot()">getRoot</A></B>()</CODE> | |
| <BR> | |
| The root node of the <code>DTMIterator</code>, as specified when it | |
| was created.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected <A HREF="../../../../org/apache/xml/utils/NodeVector.html" title="class in org.apache.xml.utils">NodeVector</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#getVector()">getVector</A></B>()</CODE> | |
| <BR> | |
| If this iterator needs to cache nodes that are fetched, they | |
| are stored in the Vector in the generic object.</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="../../../../org/apache/xpath/axes/NodeSequence.html#getWhatToShow()">getWhatToShow</A></B>()</CODE> | |
| <BR> | |
| This attribute determines which node types are presented via the | |
| iterator.</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="../../../../org/apache/xpath/axes/NodeSequence.html#hasCache()">hasCache</A></B>()</CODE> | |
| <BR> | |
| If the iterator needs to cache nodes as they are fetched, | |
| then this method returns true.</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="../../../../org/apache/xpath/axes/NodeSequence.html#isDocOrdered()">isDocOrdered</A></B>()</CODE> | |
| <BR> | |
| Returns true if all the nodes in the iteration well be returned in document | |
| order.</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="../../../../org/apache/xpath/axes/NodeSequence.html#isFresh()">isFresh</A></B>()</CODE> | |
| <BR> | |
| Tells if this NodeSetDTM is "fresh", in other words, if | |
| the first nextNode() that is called will return the | |
| first node in the set.</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="../../../../org/apache/xpath/axes/NodeSequence.html#isMutable()">isMutable</A></B>()</CODE> | |
| <BR> | |
| Tells if this iterator can have nodes added to it or set via | |
| the <code>setItem(int node, int index)</code> method.</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="../../../../org/apache/xpath/axes/NodeSequence.html#item(int)">item</A></B>(int index)</CODE> | |
| <BR> | |
| Returns the <code>node handle</code> of an item in the collection.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#markCacheComplete()">markCacheComplete</A></B>()</CODE> | |
| <BR> | |
| If this NodeSequence has a cache, mark that it is complete.</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="../../../../org/apache/xpath/axes/NodeSequence.html#nextNode()">nextNode</A></B>()</CODE> | |
| <BR> | |
| Returns the next node in the set and advances the position of the | |
| iterator in the 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="../../../../org/apache/xpath/axes/NodeSequence.html#previousNode()">previousNode</A></B>()</CODE> | |
| <BR> | |
| Returns the previous node in the set and moves the position of the | |
| <code>DTMIterator</code> backwards in the set.</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="../../../../org/apache/xpath/axes/NodeSequence.html#reset()">reset</A></B>()</CODE> | |
| <BR> | |
| Reset for fresh reuse.</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="../../../../org/apache/xpath/axes/NodeSequence.html#runTo(int)">runTo</A></B>(int index)</CODE> | |
| <BR> | |
| If an index is requested, NodeSetDTM will call this method | |
| to run the iterator to the index.</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="../../../../org/apache/xpath/axes/NodeSequence.html#setCurrentPos(int)">setCurrentPos</A></B>(int i)</CODE> | |
| <BR> | |
| Set the current position in the node set.</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="../../../../org/apache/xpath/axes/NodeSequence.html#setItem(int, int)">setItem</A></B>(int node, | |
| int index)</CODE> | |
| <BR> | |
| Sets the node at the specified index of this vector to be the | |
| specified node.</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="../../../../org/apache/xpath/axes/NodeSequence.html#setIter(org.apache.xml.dtm.DTMIterator)">setIter</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> iter)</CODE> | |
| <BR> | |
| Set the functional iterator that fetches nodes.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#setObject(java.lang.Object)">setObject</A></B>(java.lang.Object obj)</CODE> | |
| <BR> | |
| It used to be that many locations in the code simply | |
| did an assignment to this.m_obj directly, rather than | |
| calling the setObject(Object) method.</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="../../../../org/apache/xpath/axes/NodeSequence.html#setRoot(int, java.lang.Object)">setRoot</A></B>(int nodeHandle, | |
| java.lang.Object environment)</CODE> | |
| <BR> | |
| Reset the root node of the <code>DTMIterator</code>, overriding | |
| the value specified when it was created.</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="../../../../org/apache/xpath/axes/NodeSequence.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></B>(boolean b)</CODE> | |
| <BR> | |
| If setShouldCacheNodes(true) is called, then nodes will | |
| be cached, enabling random access, and giving the ability to do | |
| sorts and the like.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html#SetVector(org.apache.xml.utils.NodeVector)">SetVector</A></B>(<A HREF="../../../../org/apache/xml/utils/NodeVector.html" title="class in org.apache.xml.utils">NodeVector</A> v)</CODE> | |
| <BR> | |
| Set the vector where nodes will be cached.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.xpath.objects.XObject"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.objects.<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#appendToFsb(org.apache.xml.utils.FastStringBuffer)">appendToFsb</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#bool()">bool</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#boolWithSideEffects()">boolWithSideEffects</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#castToType(int, org.apache.xpath.XPathContext)">castToType</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#create(java.lang.Object)">create</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#create(java.lang.Object, org.apache.xpath.XPathContext)">create</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#destruct()">destruct</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#dispatchCharactersEvents(org.xml.sax.ContentHandler)">dispatchCharactersEvents</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#equals(org.apache.xpath.objects.XObject)">equals</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#error(java.lang.String)">error</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#error(java.lang.String, java.lang.Object[])">error</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#execute(org.apache.xpath.XPathContext)">execute</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#getFresh()">getFresh</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#getType()">getType</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#getTypeString()">getTypeString</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#greaterThan(org.apache.xpath.objects.XObject)">greaterThan</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#greaterThanOrEqual(org.apache.xpath.objects.XObject)">greaterThanOrEqual</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#iter()">iter</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#lessThan(org.apache.xpath.objects.XObject)">lessThan</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#lessThanOrEqual(org.apache.xpath.objects.XObject)">lessThanOrEqual</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#mutableNodeset()">mutableNodeset</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#nodelist()">nodelist</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#nodeset()">nodeset</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#notEquals(org.apache.xpath.objects.XObject)">notEquals</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#num()">num</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#numWithSideEffects()">numWithSideEffects</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#object()">object</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#rtf()">rtf</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#rtf(org.apache.xpath.XPathContext)">rtf</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#rtree()">rtree</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#rtree(org.apache.xpath.XPathContext)">rtree</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#str()">str</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#toString()">toString</A>, <A HREF="../../../../org/apache/xpath/objects/XObject.html#xstr()">xstr</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.xpath.Expression"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/xpath/Expression.html#asIterator(org.apache.xpath.XPathContext, int)">asIterator</A>, <A HREF="../../../../org/apache/xpath/Expression.html#asIteratorRaw(org.apache.xpath.XPathContext, int)">asIteratorRaw</A>, <A HREF="../../../../org/apache/xpath/Expression.html#asNode(org.apache.xpath.XPathContext)">asNode</A>, <A HREF="../../../../org/apache/xpath/Expression.html#assertion(boolean, java.lang.String)">assertion</A>, <A HREF="../../../../org/apache/xpath/Expression.html#bool(org.apache.xpath.XPathContext)">bool</A>, <A HREF="../../../../org/apache/xpath/Expression.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A>, <A HREF="../../../../org/apache/xpath/Expression.html#error(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">error</A>, <A HREF="../../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, boolean)">execute</A>, <A HREF="../../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, int)">execute</A>, <A HREF="../../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)">execute</A>, <A HREF="../../../../org/apache/xpath/Expression.html#executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)">executeCharsToContentHandler</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprAddChild(org.apache.xpath.ExpressionNode, int)">exprAddChild</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprGetChild(int)">exprGetChild</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprGetNumChildren()">exprGetNumChildren</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprGetParent()">exprGetParent</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprSetParent(org.apache.xpath.ExpressionNode)">exprSetParent</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getColumnNumber()">getColumnNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getExpressionOwner()">getExpressionOwner</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getLineNumber()">getLineNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getPublicId()">getPublicId</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getSystemId()">getSystemId</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isNodesetExpr()">isNodesetExpr</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isSameClass(org.apache.xpath.Expression)">isSameClass</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isStableNumber()">isStableNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#num(org.apache.xpath.XPathContext)">num</A>, <A HREF="../../../../org/apache/xpath/Expression.html#warn(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">warn</A>, <A HREF="../../../../org/apache/xpath/Expression.html#xstr(org.apache.xpath.XPathContext)">xstr</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.Object</B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="serialVersionUID"><!-- --></A><H3> | |
| serialVersionUID</H3> | |
| <PRE> | |
| static final long <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.41"><B>serialVersionUID</B></A></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xpath.axes.NodeSequence.serialVersionUID">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_last"><!-- --></A><H3> | |
| m_last</H3> | |
| <PRE> | |
| protected int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.43"><B>m_last</B></A></PRE> | |
| <DL> | |
| <DD>The index of the last node in the iteration. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_next"><!-- --></A><H3> | |
| m_next</H3> | |
| <PRE> | |
| protected int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.50"><B>m_next</B></A></PRE> | |
| <DL> | |
| <DD>The index of the next node to be fetched. Useful if this | |
| is a cached iterator, and is being used as random access | |
| NodeList. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_cache"><!-- --></A><H3> | |
| m_cache</H3> | |
| <PRE> | |
| private <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.59"><B>m_cache</B></A></PRE> | |
| <DL> | |
| <DD>A cache of a list of nodes obtained from the iterator so far. | |
| This list is appended to until the iterator is exhausted and | |
| the cache is complete. | |
| <p> | |
| Multiple NodeSequence objects may share the same cache. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_iter"><!-- --></A><H3> | |
| m_iter</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.129"><B>m_iter</B></A></PRE> | |
| <DL> | |
| <DD>The functional iterator that fetches nodes. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_dtmMgr"><!-- --></A><H3> | |
| m_dtmMgr</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.153"><B>m_dtmMgr</B></A></PRE> | |
| <DL> | |
| <DD>The DTMManager to use if we're using a NodeVector only. | |
| We may well want to do away with this, and store it in the NodeVector. | |
| <P> | |
| <DL> | |
| </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="NodeSequence(org.apache.xml.dtm.DTMIterator, int, org.apache.xpath.XPathContext, boolean)"><!-- --></A><H3> | |
| NodeSequence</H3> | |
| <PRE> | |
| private <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.165"><B>NodeSequence</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> iter, | |
| int context, | |
| <A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A> xctxt, | |
| boolean shouldCacheNodes)</PRE> | |
| <DL> | |
| <DD>Create a new NodeSequence from a (already cloned) iterator. | |
| <P> | |
| <DL> | |
| <DT><B>Parameters:</B><DD><CODE>iter</CODE> - Cloned (not static) DTMIterator.<DD><CODE>context</CODE> - The initial context node.<DD><CODE>xctxt</CODE> - The execution context.<DD><CODE>shouldCacheNodes</CODE> - True if this sequence can random access.</DL> | |
| </DL> | |
| <HR> | |
| <A NAME="NodeSequence(java.lang.Object)"><!-- --></A><H3> | |
| NodeSequence</H3> | |
| <PRE> | |
| public <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.177"><B>NodeSequence</B></A>(java.lang.Object nodeVector)</PRE> | |
| <DL> | |
| <DD>Create a new NodeSequence from a (already cloned) iterator. | |
| <P> | |
| <DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeVector</CODE> - </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="NodeSequence(org.apache.xml.dtm.DTMManager)"><!-- --></A><H3> | |
| NodeSequence</H3> | |
| <PRE> | |
| private <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.200"><B>NodeSequence</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A> dtmMgr)</PRE> | |
| <DL> | |
| <DD>Construct an empty XNodeSet object. This is used to create a mutable | |
| nodeset to which random nodes may be added. | |
| <P> | |
| </DL> | |
| <HR> | |
| <A NAME="NodeSequence()"><!-- --></A><H3> | |
| NodeSequence</H3> | |
| <PRE> | |
| public <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.211"><B>NodeSequence</B></A>()</PRE> | |
| <DL> | |
| <DD>Create a new NodeSequence in an invalid (null) state. | |
| <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="getVector()"><!-- --></A><H3> | |
| getVector</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/xml/utils/NodeVector.html" title="class in org.apache.xml.utils">NodeVector</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.65"><B>getVector</B></A>()</PRE> | |
| <DL> | |
| <DD>If this iterator needs to cache nodes that are fetched, they | |
| are stored in the Vector in the generic object. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCache()"><!-- --></A><H3> | |
| getCache</H3> | |
| <PRE> | |
| private <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.76"><B>getCache</B></A>()</PRE> | |
| <DL> | |
| <DD>Get the cache (if any) of nodes obtained from | |
| the iterator so far. Note that the cache keeps | |
| growing until the iterator is walked to exhaustion, | |
| at which point the cache is "complete". | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="SetVector(org.apache.xml.utils.NodeVector)"><!-- --></A><H3> | |
| SetVector</H3> | |
| <PRE> | |
| protected void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.83"><B>SetVector</B></A>(<A HREF="../../../../org/apache/xml/utils/NodeVector.html" title="class in org.apache.xml.utils">NodeVector</A> v)</PRE> | |
| <DL> | |
| <DD>Set the vector where nodes will be cached. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasCache()"><!-- --></A><H3> | |
| hasCache</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.93"><B>hasCache</B></A>()</PRE> | |
| <DL> | |
| <DD>If the iterator needs to cache nodes as they are fetched, | |
| then this method returns true. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="cacheComplete()"><!-- --></A><H3> | |
| cacheComplete</H3> | |
| <PRE> | |
| private boolean <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.104"><B>cacheComplete</B></A>()</PRE> | |
| <DL> | |
| <DD>If this NodeSequence has a cache, and that cache is | |
| fully populated then this method returns true, otherwise | |
| if there is no cache or it is not complete it returns false. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="markCacheComplete()"><!-- --></A><H3> | |
| markCacheComplete</H3> | |
| <PRE> | |
| private void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.118"><B>markCacheComplete</B></A>()</PRE> | |
| <DL> | |
| <DD>If this NodeSequence has a cache, mark that it is complete. | |
| This method should be called after the iterator is exhausted. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setIter(org.apache.xml.dtm.DTMIterator)"><!-- --></A><H3> | |
| setIter</H3> | |
| <PRE> | |
| public final void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.135"><B>setIter</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> iter)</PRE> | |
| <DL> | |
| <DD>Set the functional iterator that fetches nodes. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>iter</CODE> - The iterator that is to be contained.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getContainedIter()"><!-- --></A><H3> | |
| getContainedIter</H3> | |
| <PRE> | |
| public final <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.144"><B>getContainedIter</B></A>()</PRE> | |
| <DL> | |
| <DD>Get the functional iterator that fetches nodes. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The contained iterator.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDTM(int)"><!-- --></A><H3> | |
| getDTM</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.220"><B>getDTM</B></A>(int nodeHandle)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTM(int)">DTMIterator</A></CODE></B></DD> | |
| <DD>Get an instance of a DTM that "owns" a node handle. Since a node | |
| iterator may be passed without a DTMManager, this allows the | |
| caller to easily get the DTM using just the iterator. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTM(int)">getDTM</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the nodeHandle. | |
| <DT><B>Returns:</B><DD>a non-null DTM reference.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTM(int)"><CODE>DTMIterator.getDTM(int)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDTMManager()"><!-- --></A><H3> | |
| getDTMManager</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/xml/dtm/DTMManager.html" title="class in org.apache.xml.dtm">DTMManager</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.235"><B>getDTMManager</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTMManager()">DTMIterator</A></CODE></B></DD> | |
| <DD>Get an instance of the DTMManager. Since a node | |
| iterator may be passed without a DTMManager, this allows the | |
| caller to easily get the DTMManager using just the iterator. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTMManager()">getDTMManager</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>a non-null DTMManager reference.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTMManager()"><CODE>DTMIterator.getDTMManager()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getRoot()"><!-- --></A><H3> | |
| getRoot</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.243"><B>getRoot</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getRoot()">DTMIterator</A></CODE></B></DD> | |
| <DD>The root node of the <code>DTMIterator</code>, as specified when it | |
| was created. Note the root node is not the root node of the | |
| document tree, but the context node from where the iteration | |
| begins and ends. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getRoot()">getRoot</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>nodeHandle int Handle of the context node.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getRoot()"><CODE>DTMIterator.getRoot()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setRoot(int, java.lang.Object)"><!-- --></A><H3> | |
| setRoot</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.259"><B>setRoot</B></A>(int nodeHandle, | |
| java.lang.Object environment)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setRoot(int, java.lang.Object)">DTMIterator</A></CODE></B></DD> | |
| <DD>Reset the root node of the <code>DTMIterator</code>, overriding | |
| the value specified when it was created. Note the root node is | |
| not the root node of the document tree, but the context node from | |
| where the iteration begins. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setRoot(int, java.lang.Object)">setRoot</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the context node.<DD><CODE>environment</CODE> - The environment object. | |
| The environment in which this iterator operates, which should provide: | |
| <ul> | |
| <li>a node (the context node... same value as "root" defined below) </li> | |
| <li>a pair of non-zero positive integers (the context position and the context size) </li> | |
| <li>a set of variable bindings </li> | |
| <li>a function library </li> | |
| <li>the set of namespace declarations in scope for the expression.</li> | |
| <ul> | |
| <p>At this time the exact implementation of this environment is application | |
| dependent. Probably a proper interface will be created fairly soon.</p><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setRoot(int, java.lang.Object)"><CODE>DTMIterator.setRoot(int, Object)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="reset()"><!-- --></A><H3> | |
| reset</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.281"><B>reset</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#reset()">XObject</A></CODE></B></DD> | |
| <DD>Reset for fresh reuse. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#reset()">reset</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#reset()"><CODE>DTMIterator.reset()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getWhatToShow()"><!-- --></A><H3> | |
| getWhatToShow</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.290"><B>getWhatToShow</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getWhatToShow()">DTMIterator</A></CODE></B></DD> | |
| <DD>This attribute determines which node types are presented via the | |
| iterator. The available set of constants is defined above. | |
| Nodes not accepted by | |
| <code>whatToShow</code> will be skipped, but their children may still | |
| be considered. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getWhatToShow()">getWhatToShow</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>one of the SHOW_XXX constants, or several ORed together.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getWhatToShow()"><CODE>DTMIterator.getWhatToShow()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getExpandEntityReferences()"><!-- --></A><H3> | |
| getExpandEntityReferences</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.299"><B>getExpandEntityReferences</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getExpandEntityReferences()">DTMIterator</A></CODE></B></DD> | |
| <DD><p>The value of this flag determines whether the children of entity | |
| reference nodes are visible to the iterator. If false, they and | |
| their descendants will be rejected. Note that this rejection takes | |
| precedence over <code>whatToShow</code> and the filter. </p> | |
| <p> To produce a view of the document that has entity references | |
| expanded and does not expose the entity reference node itself, use | |
| the <code>whatToShow</code> flags to hide the entity reference node | |
| and set <code>expandEntityReferences</code> to true when creating the | |
| iterator. To produce a view of the document that has entity reference | |
| nodes but no entity expansion, use the <code>whatToShow</code> flags | |
| to show the entity reference node and set | |
| <code>expandEntityReferences</code> to false.</p> | |
| <p>NOTE: In Xalan's use of DTM we will generally have fully expanded | |
| entity references when the document tree was built, and thus this | |
| flag will have no effect.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>true if entity references will be expanded.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getExpandEntityReferences()"><CODE>DTMIterator.getExpandEntityReferences()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="nextNode()"><!-- --></A><H3> | |
| nextNode</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.310"><B>nextNode</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#nextNode()">DTMIterator</A></CODE></B></DD> | |
| <DD>Returns the next node in the set and advances the position of the | |
| iterator in the set. After a <code>DTMIterator</code> has setRoot called, | |
| the first call to <code>nextNode()</code> returns that root or (if it | |
| is rejected by the filters) the first node within its subtree which is | |
| not filtered out. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#nextNode()">nextNode</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The next node handle in the set being iterated over, or | |
| <code>DTM.NULL</code> if there are no more members in that set.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#nextNode()"><CODE>DTMIterator.nextNode()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="previousNode()"><!-- --></A><H3> | |
| previousNode</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.372"><B>previousNode</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#previousNode()">DTMIterator</A></CODE></B></DD> | |
| <DD>Returns the previous node in the set and moves the position of the | |
| <code>DTMIterator</code> backwards in the set. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#previousNode()">previousNode</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The previous node handle in the set being iterated over, | |
| or <code>DTM.NULL</code> if there are no more members in that set.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#previousNode()"><CODE>DTMIterator.previousNode()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="detach()"><!-- --></A><H3> | |
| detach</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.395"><B>detach</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#detach()">XObject</A></CODE></B></DD> | |
| <DD>Detaches the <code>DTMIterator</code> from the set which it iterated | |
| over, releasing any computational resources and placing the iterator | |
| in the INVALID state. After <code>detach</code> has been invoked, | |
| calls to <code>nextNode</code> or <code>previousNode</code> will | |
| raise a runtime exception. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#detach()">detach</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#detach()">detach</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#detach()"><CODE>DTMIterator.detach()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="allowDetachToRelease(boolean)"><!-- --></A><H3> | |
| allowDetachToRelease</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.407"><B>allowDetachToRelease</B></A>(boolean allowRelease)</PRE> | |
| <DL> | |
| <DD>Calling this with a value of false will cause the nodeset | |
| to be cached. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#allowDetachToRelease(boolean)">allowDetachToRelease</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#allowDetachToRelease(boolean)">allowDetachToRelease</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>allowRelease</CODE> - true if it is OK for detach to release this iterator | |
| for pooling.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#allowDetachToRelease(boolean)"><CODE>DTMIterator.allowDetachToRelease(boolean)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCurrentNode()"><!-- --></A><H3> | |
| getCurrentNode</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.422"><B>getCurrentNode</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentNode()">DTMIterator</A></CODE></B></DD> | |
| <DD>Get the current node in the iterator. Note that this differs from | |
| the DOM's NodeIterator, where the current position lies between two | |
| nodes (as part of the maintain-relative-position semantic). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentNode()">getCurrentNode</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The current node handle, or -1.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentNode()"><CODE>DTMIterator.getCurrentNode()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isFresh()"><!-- --></A><H3> | |
| isFresh</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.445"><B>isFresh</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isFresh()">DTMIterator</A></CODE></B></DD> | |
| <DD>Tells if this NodeSetDTM is "fresh", in other words, if | |
| the first nextNode() that is called will return the | |
| first node in the set. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isFresh()">isFresh</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>true if the iteration of this list has not yet begun.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isFresh()"><CODE>DTMIterator.isFresh()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setShouldCacheNodes(boolean)"><!-- --></A><H3> | |
| setShouldCacheNodes</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.453"><B>setShouldCacheNodes</B></A>(boolean b)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setShouldCacheNodes(boolean)">DTMIterator</A></CODE></B></DD> | |
| <DD>If setShouldCacheNodes(true) is called, then nodes will | |
| be cached, enabling random access, and giving the ability to do | |
| sorts and the like. They are not cached by default. | |
| %REVIEW% Shouldn't the other random-access methods throw an exception | |
| if they're called on a DTMIterator with this flag set false? | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>b</CODE> - true if the nodes should be cached.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setShouldCacheNodes(boolean)"><CODE>DTMIterator.setShouldCacheNodes(boolean)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isMutable()"><!-- --></A><H3> | |
| isMutable</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.471"><B>isMutable</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isMutable()">DTMIterator</A></CODE></B></DD> | |
| <DD>Tells if this iterator can have nodes added to it or set via | |
| the <code>setItem(int node, int index)</code> method. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isMutable()">isMutable</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>True if the nodelist can be mutated.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isMutable()"><CODE>DTMIterator.isMutable()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCurrentPos()"><!-- --></A><H3> | |
| getCurrentPos</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.479"><B>getCurrentPos</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentPos()">DTMIterator</A></CODE></B></DD> | |
| <DD>Get the current position within the cached list, which is one | |
| less than the next nextNode() call will retrieve. i.e. if you | |
| call getCurrentPos() and the return is 0, the next fetch will | |
| take place at index 1. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentPos()">getCurrentPos</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The position of the iteration.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentPos()"><CODE>DTMIterator.getCurrentPos()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="runTo(int)"><!-- --></A><H3> | |
| runTo</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.487"><B>runTo</B></A>(int index)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#runTo(int)">DTMIterator</A></CODE></B></DD> | |
| <DD>If an index is requested, NodeSetDTM will call this method | |
| to run the iterator to the index. By default this sets | |
| m_next to the index. If the index argument is -1, this | |
| signals that the iterator should be run to the end and | |
| completely fill the cache. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#runTo(int)">runTo</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>index</CODE> - The index to run to, or -1 if the iterator should be run | |
| to the end.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#runTo(int)"><CODE>DTMIterator.runTo(int)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setCurrentPos(int)"><!-- --></A><H3> | |
| setCurrentPos</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.519"><B>setCurrentPos</B></A>(int i)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setCurrentPos(int)">DTMIterator</A></CODE></B></DD> | |
| <DD>Set the current position in the node set. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setCurrentPos(int)">setCurrentPos</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>i</CODE> - Must be a valid index.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setCurrentPos(int)"><CODE>DTMIterator.setCurrentPos(int)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="item(int)"><!-- --></A><H3> | |
| item</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.527"><B>item</B></A>(int index)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#item(int)">DTMIterator</A></CODE></B></DD> | |
| <DD>Returns the <code>node handle</code> of an item in the collection. If | |
| <code>index</code> is greater than or equal to the number of nodes in | |
| the list, this returns <code>null</code>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#item(int)">item</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>index</CODE> - of the item. | |
| <DT><B>Returns:</B><DD>The node handle at the <code>index</code>th position in the | |
| <code>DTMIterator</code>, or <code>-1</code> if that is not a valid | |
| index.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#item(int)"><CODE>DTMIterator.item(int)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setItem(int, int)"><!-- --></A><H3> | |
| setItem</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.538"><B>setItem</B></A>(int node, | |
| int index)</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setItem(int, int)">DTMIterator</A></CODE></B></DD> | |
| <DD>Sets the node at the specified index of this vector to be the | |
| specified node. The previous component at that position is discarded. | |
| <p>The index must be a value greater than or equal to 0 and less | |
| than the current size of the vector. | |
| The iterator must be in cached mode.</p> | |
| <p>Meant to be used for sorted iterators.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setItem(int, int)">setItem</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - Node to set<DD><CODE>index</CODE> - Index of where to set the node<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setItem(int, int)"><CODE>DTMIterator.setItem(int, int)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLength()"><!-- --></A><H3> | |
| getLength</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.587"><B>getLength</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getLength()">DTMIterator</A></CODE></B></DD> | |
| <DD>The number of nodes in the list. The range of valid child node indices | |
| is 0 to <code>length-1</code> inclusive. Note that this requires running | |
| the iterator to completion, and presumably filling the cache. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getLength()">getLength</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The number of nodes in the list.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getLength()"><CODE>DTMIterator.getLength()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="cloneWithReset()"><!-- --></A><H3> | |
| cloneWithReset</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.627"><B>cloneWithReset</B></A>() | |
| throws java.lang.CloneNotSupportedException</PRE> | |
| <DL> | |
| <DD>Note: Not a deep clone. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#cloneWithReset()">cloneWithReset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>A clone of this iteration that has been reset. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.CloneNotSupportedException</CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#cloneWithReset()"><CODE>DTMIterator.cloneWithReset()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="clone()"><!-- --></A><H3> | |
| clone</H3> | |
| <PRE> | |
| public java.lang.Object <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.652"><B>clone</B></A>() | |
| throws java.lang.CloneNotSupportedException</PRE> | |
| <DL> | |
| <DD>Get a clone of this iterator, but don't reset the iteration in the | |
| process, so that it may be used from the current position. | |
| Note: Not a deep clone. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#clone()">clone</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE>clone</CODE> in class <CODE>java.lang.Object</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>A clone of this object. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.CloneNotSupportedException</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isDocOrdered()"><!-- --></A><H3> | |
| isDocOrdered</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.672"><B>isDocOrdered</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isDocOrdered()">DTMIterator</A></CODE></B></DD> | |
| <DD>Returns true if all the nodes in the iteration well be returned in document | |
| order. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isDocOrdered()">isDocOrdered</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>true if all the nodes in the iteration well be returned in document | |
| order.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isDocOrdered()"><CODE>DTMIterator.isDocOrdered()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAxis()"><!-- --></A><H3> | |
| getAxis</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.683"><B>getAxis</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getAxis()">DTMIterator</A></CODE></B></DD> | |
| <DD>Returns the axis being iterated, if it is known. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getAxis()">getAxis</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>Axis.CHILD, etc., or -1 if the axis is not known or is of multiple | |
| types.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getAxis()"><CODE>DTMIterator.getAxis()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAnalysisBits()"><!-- --></A><H3> | |
| getAnalysisBits</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.697"><B>getAnalysisBits</B></A>()</PRE> | |
| <DL> | |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xpath/axes/PathComponent.html#getAnalysisBits()">PathComponent</A></CODE></B></DD> | |
| <DD>Get the analysis bits for this path component, as defined in the WalkerFactory. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/PathComponent.html#getAnalysisBits()">getAnalysisBits</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xpath/axes/PathComponent.html" title="interface in org.apache.xpath.axes">PathComponent</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>One of WalkerFactory#BIT_DESCENDANT, etc.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/axes/PathComponent.html#getAnalysisBits()"><CODE>PathComponent.getAnalysisBits()</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="fixupVariables(java.util.Vector, int)"><!-- --></A><H3> | |
| fixupVariables</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.708"><B>fixupVariables</B></A>(java.util.Vector vars, | |
| int globalsSize)</PRE> | |
| <DL> | |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#fixupVariables(java.util.Vector, int)">XObject</A></CODE></B></DD> | |
| <DD>XObjects should not normally need to fix up variables. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#fixupVariables(java.util.Vector, int)">fixupVariables</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>vars</CODE> - List of QNames that correspond to variables. This list | |
| should be searched backwards for the first qualified name that | |
| corresponds to the variable reference qname. The position of the | |
| QName in the vector from the start of the vector will be its position | |
| in the stack frame (but variables above the globalsTop value will need | |
| to be offset to the current stack frame). | |
| NEEDSDOC @param globalsSize<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#fixupVariables(java.util.Vector, int)"><CODE>Expression.fixupVariables(Vector, int)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addNodeInDocOrder(int)"><!-- --></A><H3> | |
| addNodeInDocOrder</H3> | |
| <PRE> | |
| protected int <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.721"><B>addNodeInDocOrder</B></A>(int node)</PRE> | |
| <DL> | |
| <DD>Add the node into a vector of nodes where it should occur in | |
| document order. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be added. | |
| <DT><B>Returns:</B><DD>insertIndex. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.RuntimeException</CODE> - thrown if this NodeSetDTM is not of | |
| a mutable type.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setObject(java.lang.Object)"><!-- --></A><H3> | |
| setObject</H3> | |
| <PRE> | |
| protected void <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.777"><B>setObject</B></A>(java.lang.Object obj)</PRE> | |
| <DL> | |
| <DD>It used to be that many locations in the code simply | |
| did an assignment to this.m_obj directly, rather than | |
| calling the setObject(Object) method. The problem is | |
| that our super-class would be updated on what the | |
| cache associated with this NodeSequence, but | |
| we wouldn't know ourselves. | |
| <p> | |
| All setting of m_obj is done through setObject() now, | |
| and this method over-rides the super-class method. | |
| So now we are in the loop have an opportunity | |
| to update some caching information. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html#setObject(java.lang.Object)">setObject</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getIteratorCache()"><!-- --></A><H3> | |
| getIteratorCache</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A> <A HREF="../../../../src-html/org/apache/xpath/axes/NodeSequence.html#line.949"><B>getIteratorCache</B></A>()</PRE> | |
| <DL> | |
| <DD>Get the cached list of nodes appended with | |
| values obtained from the iterator as | |
| a NodeSequence is walked when its | |
| nextNode() method is called. | |
| <P> | |
| <DD><DL> | |
| </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="class-use/NodeSequence.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xpath/axes/MatchPatternIterator.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xpath/axes/NodeSequence.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="NodeSequence.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> | |
| </BODY> | |
| </HTML> |