| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:58 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Class LocPathIterator
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LocPathIterator.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/IteratorPool.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xpath/axes/MatchPatternIterator.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="LocPathIterator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xpath.axes</FONT>
|
| <BR>
|
| Class LocPathIterator</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<A HREF="../../../../org/apache/xpath/Expression.html">org.apache.xpath.Expression</A>
|
| |
|
| +--<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">org.apache.xpath.patterns.NodeTest</A>
|
| |
|
| +--<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">org.apache.xpath.axes.PredicatedNodeTest</A>
|
| |
|
| +--<B>org.apache.xpath.axes.LocPathIterator</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xpath/axes/BasicTestIterator.html">BasicTestIterator</A>, <A HREF="../../../../org/apache/xpath/axes/ChildIterator.html">ChildIterator</A>, <A HREF="../../../../org/apache/xpath/axes/DescendantIterator.html">DescendantIterator</A>, <A HREF="../../../../org/apache/xpath/axes/FilterExprIteratorSimple.html">FilterExprIteratorSimple</A>, <A HREF="../../../../org/apache/xpath/axes/MatchPatternIterator.html">MatchPatternIterator</A>, <A HREF="../../../../org/apache/xpath/axes/SelfIteratorNoPredicate.html">SelfIteratorNoPredicate</A>, <A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html">UnionPathIterator</A>, <A HREF="../../../../org/apache/xpath/axes/WalkingIterator.html">WalkingIterator</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public abstract class <B>LocPathIterator</B><DT>extends <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A><DT>implements java.lang.Cloneable, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A>, java.io.Serializable, <A HREF="../../../../org/apache/xpath/axes/PathComponent.html">PathComponent</A></DL>
|
|
|
| <P>
|
| This class extends NodeSetDTM, which implements NodeIterator, |
| and fetches nodes one at a time in document order based on a XPath |
| <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a>. |
| |
| <p>If setShouldCacheNodes(true) is called, |
| as each node is iterated via nextNode(), the node is also stored |
| in the NodeVector, so that previousNode() can easily be done, except in |
| the case where the LocPathIterator is "owned" by a UnionPathIterator, |
| in which case the UnionPathIterator will cache the nodes.</p>
|
| <P>
|
| <DL>
|
| <DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#org.apache.xpath.axes.LocPathIterator">Serialized Form</A><DT><B>Usage:</B><DD><i><font size="-1" color="#00FF00"> **For advanced use only**</font></i></DD> |
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Field Summary</B></FONT></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/LocPathIterator.html#m_lastFetched">m_lastFetched</A></B></CODE>
|
|
|
| <BR>
|
| The last node that was fetched, usually by nextNode.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="fields_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Fields inherited from class org.apache.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST">SCORE_NODETEST</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE">SCORE_NONE</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD">SCORE_NSWILD</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER">SCORE_OTHER</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME">SCORE_QNAME</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SHOW_BYFUNCTION">SHOW_BYFUNCTION</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SUPPORTS_PRE_STRIPPING">SUPPORTS_PRE_STRIPPING</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#WILD">WILD</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#allowDetachToRelease(boolean)">allowDetachToRelease</A></B>(boolean allowRelease)</CODE>
|
|
|
| <BR>
|
| Specify if it's OK for detach to release the iterator for reuse.</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">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#asIterator(org.apache.xpath.XPathContext, int)">asIterator</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int contextNode)</CODE>
|
|
|
| <BR>
|
| Given an select expression and a context, evaluate the XPath |
| and return the resulting 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/LocPathIterator.html#asNode(org.apache.xpath.XPathContext)">asNode</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Return the first node out of the nodeset, if this expression is |
| a nodeset expression.</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/LocPathIterator.html#bool(org.apache.xpath.XPathContext)">bool</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Evaluate this operation directly to a boolean.</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/LocPathIterator.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A></B>(<A HREF="../../../../org/apache/xpath/ExpressionOwner.html">ExpressionOwner</A> owner, |
| <A HREF="../../../../org/apache/xpath/XPathVisitor.html">XPathVisitor</A> visitor)</CODE>
|
|
|
| <BR>
|
| </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">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a cloned Iterator that is reset to the beginning |
| of the query.</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/LocPathIterator.html#detach()">detach</A></B>()</CODE>
|
|
|
| <BR>
|
| Detaches the iterator 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> <A HREF="../../../../org/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#execute(org.apache.xpath.XPathContext)">execute</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Execute this iterator, meaning create a clone that can |
| store state, and initialize it for fast execution from |
| the current runtime 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/LocPathIterator.html#executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)">executeCharsToContentHandler</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| <A HREF="../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> handler)</CODE>
|
|
|
| <BR>
|
| Execute an expression in the XPath runtime context, and return the |
| result of the expression.</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/LocPathIterator.html#getAnalysisBits()">getAnalysisBits</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the analysis bits for this walker, 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/LocPathIterator.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> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getContext()">getContext</A></B>()</CODE>
|
|
|
| <BR>
|
| The node context for 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/LocPathIterator.html#getCurrentContextNode()">getCurrentContextNode</A></B>()</CODE>
|
|
|
| <BR>
|
| The node context from where the expression is being |
| executed from (i.e.</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/LocPathIterator.html#getCurrentNode()">getCurrentNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the last fetched node.</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/LocPathIterator.html#getCurrentPos()">getCurrentPos</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the current position, 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">DTM</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.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">DTMManager</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.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/LocPathIterator.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> <A HREF="../../../../org/apache/xml/dtm/DTMFilter.html">DTMFilter</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getFilter()">getFilter</A></B>()</CODE>
|
|
|
| <BR>
|
| The filter used to screen nodes.</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/LocPathIterator.html#getFoundLast()">getFoundLast</A></B>()</CODE>
|
|
|
| <BR>
|
| Tells if we've found the last node yet.</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/LocPathIterator.html#getIsTopLevel()">getIsTopLevel</A></B>()</CODE>
|
|
|
| <BR>
|
| Get if this is an iterator at the upper level of |
| the XPath.</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/LocPathIterator.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.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> <A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getPrefixResolver()">getPrefixResolver</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the saved reference to the prefix resolver that |
| was in effect when this iterator was created.</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/LocPathIterator.html#getRoot()">getRoot</A></B>()</CODE>
|
|
|
| <BR>
|
| The root node of the Iterator, as specified when it was created.</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/LocPathIterator.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> <A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getXPathContext()">getXPathContext</A></B>()</CODE>
|
|
|
| <BR>
|
| The XPath execution context we are operating on.</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/LocPathIterator.html#incrementCurrentPos()">incrementCurrentPos</A></B>()</CODE>
|
|
|
| <BR>
|
| Increment 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> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.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/LocPathIterator.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/LocPathIterator.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> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#isNodesetExpr()">isNodesetExpr</A></B>()</CODE>
|
|
|
| <BR>
|
| Tell if the expression is a nodeset expression.</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/LocPathIterator.html#item(int)">item</A></B>(int index)</CODE>
|
|
|
| <BR>
|
| Returns the <code>index</code> th item in the collection.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.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/LocPathIterator.html#previousNode()">previousNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the previous node in the set and moves the position of the |
| iterator 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/LocPathIterator.html#reset()">reset</A></B>()</CODE>
|
|
|
| <BR>
|
| Reset the iterator.</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/LocPathIterator.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/LocPathIterator.html#setCurrentContextNode(int)">setCurrentContextNode</A></B>(int n)</CODE>
|
|
|
| <BR>
|
| Set the current context node for this iterator.</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/LocPathIterator.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/LocPathIterator.html#setEnvironment(java.lang.Object)">setEnvironment</A></B>(java.lang.Object environment)</CODE>
|
|
|
| <BR>
|
| Set the environment in which this iterator operates, which should provide: |
| a node (the context 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/LocPathIterator.html#setIsTopLevel(boolean)">setIsTopLevel</A></B>(boolean b)</CODE>
|
|
|
| <BR>
|
| Set if this is an iterator at the upper level of |
| the XPath.</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/LocPathIterator.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/LocPathIterator.html#setRoot(int, java.lang.Object)">setRoot</A></B>(int context, |
| java.lang.Object environment)</CODE>
|
|
|
| <BR>
|
| Initialize the context values for this expression |
| after it is cloned.</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/LocPathIterator.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></B>(boolean b)</CODE>
|
|
|
| <BR>
|
| If setShouldCacheNodes(true) is called, then nodes will |
| be cached.</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/LocPathIterator.html#size()">size</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the length of the cached nodes.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#acceptNode(int)">acceptNode</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#callPredicateVisitors(org.apache.xpath.XPathVisitor)">callPredicateVisitors</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#clone()">clone</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#fixupVariables(java.util.Vector, int)">fixupVariables</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getLocPathIterator()">getLocPathIterator</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getPredicate(int)">getPredicate</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getPredicateCount()">getPredicateCount</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getPredicateIndex()">getPredicateIndex</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getProximityPosition()">getProximityPosition</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getProximityPosition(org.apache.xpath.XPathContext)">getProximityPosition</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#initProximityPosition(int)">initProximityPosition</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#isReverseAxes()">isReverseAxes</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#resetProximityPositions()">resetProximityPositions</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#setLocPathIterator(org.apache.xpath.axes.LocPathIterator)">setLocPathIterator</A>,
|
| <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#setPredicateCount(int)">setPredicateCount</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#debugWhatToShow(int)">debugWhatToShow</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext, int)">execute</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)">execute</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getDefaultScore()">getDefaultScore</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getLocalName()">getLocalName</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getNamespace()">getNamespace</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getNodeTypeTest(int)">getNodeTypeTest</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getStaticScore()">getStaticScore</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#initNodeTest(int)">initNodeTest</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#initNodeTest(int, java.lang.String, java.lang.String)">initNodeTest</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setLocalName(java.lang.String)">setLocalName</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setNamespace(java.lang.String)">setNamespace</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setStaticScore(org.apache.xpath.objects.XNumber)">setStaticScore</A>,
|
| <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setWhatToShow(int)">setWhatToShow</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_org.apache.xpath.Expression"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.xpath.<A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../org/apache/xpath/Expression.html#asIteratorRaw(org.apache.xpath.XPathContext, int)">asIteratorRaw</A>,
|
| <A HREF="../../../../org/apache/xpath/Expression.html#assertion(boolean, java.lang.String)">assertion</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#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#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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE>equals,
|
| getClass,
|
| hashCode,
|
| notify,
|
| notifyAll,
|
| toString,
|
| wait,
|
| wait,
|
| wait</CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="m_lastFetched"><!-- --></A><H3>
|
| m_lastFetched</H3>
|
| <PRE>
|
| public transient int <B>m_lastFetched</B></PRE>
|
| <DL>
|
| <DD>The last node that was fetched, usually by nextNode.</DL>
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="getAnalysisBits()"><!-- --></A><H3>
|
| getAnalysisBits</H3>
|
| <PRE>
|
| public int <B>getAnalysisBits</B>()</PRE>
|
| <DL>
|
| <DD>Get the analysis bits for this walker, as defined in the WalkerFactory.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xpath/axes/PathComponent.html#getAnalysisBits()">getAnalysisBits</A> in interface <A HREF="../../../../org/apache/xpath/axes/PathComponent.html">PathComponent</A><DT><B>Returns:</B><DD>One of WalkerFactory#BIT_DESCENDANT, etc.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setEnvironment(java.lang.Object)"><!-- --></A><H3>
|
| setEnvironment</H3>
|
| <PRE>
|
| public void <B>setEnvironment</B>(java.lang.Object environment)</PRE>
|
| <DL>
|
| <DD>Set the environment in which this iterator operates, which should provide: |
| a node (the context node... same value as "root" defined below) |
| a pair of non-zero positive integers (the context position and the context size) |
| a set of variable bindings |
| a function library |
| the set of namespace declarations in scope for the expression. |
| |
| <p>At this time the exact implementation of this environment is application |
| dependent. Probably a proper interface will be created fairly soon.</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>environment</CODE> - The environment object.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTM(int)"><!-- --></A><H3>
|
| getDTM</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> <B>getDTM</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTM(int)">getDTM</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the nodeHandle.<DT><B>Returns:</B><DD>a non-null DTM reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTMManager()"><!-- --></A><H3>
|
| getDTMManager</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> <B>getDTMManager</B>()</PRE>
|
| <DL>
|
| <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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getDTMManager()">getDTMManager</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>a non-null DTMManager reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="execute(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| execute</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xpath/objects/XObject.html">XObject</A> <B>execute</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Execute this iterator, meaning create a clone that can |
| store state, and initialize it for fast execution from |
| the current runtime state. When this is called, no actual |
| query from the current context node is performed.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath execution context.<DT><B>Returns:</B><DD>An XNodeSet reference that holds this iterator.<DT><B>Throws:</B><DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext)">execute</A> in class <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)"><!-- --></A><H3>
|
| executeCharsToContentHandler</H3>
|
| <PRE>
|
| public void <B>executeCharsToContentHandler</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| <A HREF="../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> handler) |
| throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A>, |
| <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Execute an expression in the XPath runtime context, and return the |
| result of the expression.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>handler</CODE> - The target content handler.<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.<DT><B>Throws:</B><DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if a runtime exception |
| occurs.<DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)">executeCharsToContentHandler</A> in class <A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="asIterator(org.apache.xpath.XPathContext, int)"><!-- --></A><H3>
|
| asIterator</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>asIterator</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int contextNode) |
| throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Given an select expression and a context, evaluate the XPath |
| and return the resulting iterator.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The execution context.<DD><CODE>contextNode</CODE> - The node that "." expresses.<DT><B>Throws:</B><DD>TransformerException - thrown if the active ProblemListener decides |
| the error condition is severe enough to halt processing.<DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#asIterator(org.apache.xpath.XPathContext, int)">asIterator</A> in class <A HREF="../../../../org/apache/xpath/Expression.html">Expression</A><DT><B>Usage:</B><DD><i><font size="-1" color="#0000FF"> **Experimental**</font></i></DD> |
| </DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isNodesetExpr()"><!-- --></A><H3>
|
| isNodesetExpr</H3>
|
| <PRE>
|
| public boolean <B>isNodesetExpr</B>()</PRE>
|
| <DL>
|
| <DD>Tell if the expression is a nodeset expression.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if the expression can be represented as a nodeset.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#isNodesetExpr()">isNodesetExpr</A> in class <A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="asNode(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| asNode</H3>
|
| <PRE>
|
| public int <B>asNode</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Return the first node out of the nodeset, if this expression is |
| a nodeset expression. This is the default implementation for |
| nodesets. Derived classes should try and override this and return a |
| value without having to do a clone operation.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>the first node out of the nodeset, or DTM.NULL.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#asNode(org.apache.xpath.XPathContext)">asNode</A> in class <A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="bool(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| bool</H3>
|
| <PRE>
|
| public boolean <B>bool</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Evaluate this operation directly to a boolean.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The runtime execution context.<DT><B>Returns:</B><DD>The result of the operation as a boolean.<DT><B>Throws:</B><DD><A HREF="../../../../javax/xml/transform/TransformerException.html">TransformerException</A> - <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#bool(org.apache.xpath.XPathContext)">bool</A> in class <A HREF="../../../../org/apache/xpath/Expression.html">Expression</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setIsTopLevel(boolean)"><!-- --></A><H3>
|
| setIsTopLevel</H3>
|
| <PRE>
|
| public void <B>setIsTopLevel</B>(boolean b)</PRE>
|
| <DL>
|
| <DD>Set if this is an iterator at the upper level of |
| the XPath.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>b</CODE> - true if this location path is at the top level of the |
| expression.<DT><B>Usage:</B><DD><i><font size="-1" color="#00FF00"> **For advanced use only**</font></i></DD> |
| </DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getIsTopLevel()"><!-- --></A><H3>
|
| getIsTopLevel</H3>
|
| <PRE>
|
| public boolean <B>getIsTopLevel</B>()</PRE>
|
| <DL>
|
| <DD>Get if this is an iterator at the upper level of |
| the XPath.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if this location path is at the top level of the |
| expression.<DT><B>Usage:</B><DD><i><font size="-1" color="#00FF00"> **For advanced use only**</font></i></DD> |
| </DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setRoot(int, java.lang.Object)"><!-- --></A><H3>
|
| setRoot</H3>
|
| <PRE>
|
| public void <B>setRoot</B>(int context, |
| java.lang.Object environment)</PRE>
|
| <DL>
|
| <DD>Initialize the context values for this expression |
| after it is cloned.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setRoot(int, java.lang.Object)">setRoot</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>context</CODE> - The XPath runtime context for this |
| transformation.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCurrentPos()"><!-- --></A><H3>
|
| getCurrentPos</H3>
|
| <PRE>
|
| public final int <B>getCurrentPos</B>()</PRE>
|
| <DL>
|
| <DD>Get the current position, 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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentPos()">getCurrentPos</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>A value greater than or equal to zero that indicates the next |
| node position to fetch.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setShouldCacheNodes(boolean)"><!-- --></A><H3>
|
| setShouldCacheNodes</H3>
|
| <PRE>
|
| public void <B>setShouldCacheNodes</B>(boolean b)</PRE>
|
| <DL>
|
| <DD>If setShouldCacheNodes(true) is called, then nodes will |
| be cached. They are not cached by default.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>b</CODE> - True if this iterator should cache nodes.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isMutable()"><!-- --></A><H3>
|
| isMutable</H3>
|
| <PRE>
|
| public boolean <B>isMutable</B>()</PRE>
|
| <DL>
|
| <DD>Tells if this iterator can have nodes added to it or set via |
| the <code>setItem(int node, int index)</code> method.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isMutable()">isMutable</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>True if the nodelist can be mutated.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setCurrentPos(int)"><!-- --></A><H3>
|
| setCurrentPos</H3>
|
| <PRE>
|
| public void <B>setCurrentPos</B>(int i)</PRE>
|
| <DL>
|
| <DD>Set the current position in the node set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setCurrentPos(int)">setCurrentPos</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>i</CODE> - Must be a valid index greater |
| than or equal to zero and less than m_cachedNodes.size().</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="incrementCurrentPos()"><!-- --></A><H3>
|
| incrementCurrentPos</H3>
|
| <PRE>
|
| public void <B>incrementCurrentPos</B>()</PRE>
|
| <DL>
|
| <DD>Increment the current position in the node set.<DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="size()"><!-- --></A><H3>
|
| size</H3>
|
| <PRE>
|
| public int <B>size</B>()</PRE>
|
| <DL>
|
| <DD>Get the length of the cached nodes. |
| |
| <p>Note: for the moment at least, this only returns |
| the size of the nodes that have been fetched to date, |
| it doesn't attempt to run to the end to make sure we |
| have found everything. This should be reviewed.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>The size of the current cache list.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="item(int)"><!-- --></A><H3>
|
| item</H3>
|
| <PRE>
|
| public int <B>item</B>(int index)</PRE>
|
| <DL>
|
| <DD>Returns the <code>index</code> th 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> .<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#item(int)">item</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - Index into the collection.<DT><B>Returns:</B><DD>The node at the <code>index</code> th position in the |
| <code>NodeList</code> , or <code>null</code> if that is not a valid |
| index.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setItem(int, int)"><!-- --></A><H3>
|
| setItem</H3>
|
| <PRE>
|
| public void <B>setItem</B>(int node, |
| int index)</PRE>
|
| <DL>
|
| <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><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setItem(int, int)">setItem</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>node</CODE> - Node to set<DD><CODE>index</CODE> - Index of where to set the node</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLength()"><!-- --></A><H3>
|
| getLength</H3>
|
| <PRE>
|
| public int <B>getLength</B>()</PRE>
|
| <DL>
|
| <DD>The number of nodes in the list. The range of valid child node indices |
| is 0 to <code>length-1</code> inclusive.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getLength()">getLength</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The number of nodes in the list, always greater or equal to zero.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isFresh()"><!-- --></A><H3>
|
| isFresh</H3>
|
| <PRE>
|
| public boolean <B>isFresh</B>()</PRE>
|
| <DL>
|
| <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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isFresh()">isFresh</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>true of nextNode has not been called.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="previousNode()"><!-- --></A><H3>
|
| previousNode</H3>
|
| <PRE>
|
| public int <B>previousNode</B>()</PRE>
|
| <DL>
|
| <DD>Returns the previous node in the set and moves the position of the |
| iterator backwards in the set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#previousNode()">previousNode</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The previous <code>Node</code> in the set being iterated over, |
| or<code>null</code> if there are no more members in that set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getWhatToShow()"><!-- --></A><H3>
|
| getWhatToShow</H3>
|
| <PRE>
|
| public int <B>getWhatToShow</B>()</PRE>
|
| <DL>
|
| <DD>This attribute determines which node types are presented via the |
| iterator. The available set of constants is defined in the |
| <code>NodeFilter</code> interface. |
| |
| <p>This is somewhat useless at this time, since it doesn't |
| really return information that tells what this iterator will |
| show. It is here only to fullfill the DOM NodeIterator |
| interface.</p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getWhatToShow()">getWhatToShow</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>For now, always NodeFilter.SHOW_ALL & ~NodeFilter.SHOW_ENTITY_REFERENCE.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getWhatToShow()">getWhatToShow</A> in class <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A><DT><B>See Also: </B><DD><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html"><CODE>NodeIterator</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getFilter()"><!-- --></A><H3>
|
| getFilter</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMFilter.html">DTMFilter</A> <B>getFilter</B>()</PRE>
|
| <DL>
|
| <DD>The filter used to screen nodes. Not used at this time, |
| this is here only to fullfill the DOM NodeIterator |
| interface.<DD><DL>
|
| <DT><B>Returns:</B><DD>Always null.<DT><B>See Also: </B><DD><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html"><CODE>NodeIterator</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getRoot()"><!-- --></A><H3>
|
| getRoot</H3>
|
| <PRE>
|
| public int <B>getRoot</B>()</PRE>
|
| <DL>
|
| <DD>The root node of the Iterator, as specified when it was created.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getRoot()">getRoot</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The "root" of this iterator, which, in XPath terms, |
| is the node context for this iterator.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getExpandEntityReferences()"><!-- --></A><H3>
|
| getExpandEntityReferences</H3>
|
| <PRE>
|
| public boolean <B>getExpandEntityReferences</B>()</PRE>
|
| <DL>
|
| <DD>The value of this flag determines whether the children of entity |
| reference nodes are visible to the iterator. If false, they will be |
| skipped over. |
| <br> To produce a view of the document that has entity references |
| expanded and does not expose the entity reference node itself, use the |
| whatToShow flags to hide the entity reference node and set |
| expandEntityReferences to true when creating the iterator. To produce |
| a view of the document that has entity reference nodes but no entity |
| expansion, use the whatToShow flags to show the entity reference node |
| and set expandEntityReferences to false.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>Always true, since entity reference nodes are not |
| visible in the XPath model.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="allowDetachToRelease(boolean)"><!-- --></A><H3>
|
| allowDetachToRelease</H3>
|
| <PRE>
|
| public void <B>allowDetachToRelease</B>(boolean allowRelease)</PRE>
|
| <DL>
|
| <DD>Specify if it's OK for detach to release the iterator for reuse.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#allowDetachToRelease(boolean)">allowDetachToRelease</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>allowRelease</CODE> - true if it is OK for detach to release this iterator |
| for pooling.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="detach()"><!-- --></A><H3>
|
| detach</H3>
|
| <PRE>
|
| public void <B>detach</B>()</PRE>
|
| <DL>
|
| <DD>Detaches the iterator 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 the |
| exception INVALID_STATE_ERR.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#detach()">detach</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="reset()"><!-- --></A><H3>
|
| reset</H3>
|
| <PRE>
|
| public void <B>reset</B>()</PRE>
|
| <DL>
|
| <DD>Reset the iterator.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#reset()">reset</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="cloneWithReset()"><!-- --></A><H3>
|
| cloneWithReset</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>cloneWithReset</B>() |
| throws java.lang.CloneNotSupportedException</PRE>
|
| <DL>
|
| <DD>Get a cloned Iterator that is reset to the beginning |
| of the query.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#cloneWithReset()">cloneWithReset</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>A cloned NodeIterator set of the start of the query.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="nextNode()"><!-- --></A><H3>
|
| nextNode</H3>
|
| <PRE>
|
| public abstract int <B>nextNode</B>()</PRE>
|
| <DL>
|
| <DD>Returns the next node in the set and advances the position of the |
| iterator in the set. After a NodeIterator is created, the first call |
| to nextNode() returns the first node in the set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#nextNode()">nextNode</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The next <code>Node</code> in the set being iterated over, or |
| <code>null</code> if there are no more members in that set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCurrentNode()"><!-- --></A><H3>
|
| getCurrentNode</H3>
|
| <PRE>
|
| public int <B>getCurrentNode</B>()</PRE>
|
| <DL>
|
| <DD>Return the last fetched node. Needed to support the UnionPathIterator.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getCurrentNode()">getCurrentNode</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The last fetched node, or null if the last fetch was null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="runTo(int)"><!-- --></A><H3>
|
| runTo</H3>
|
| <PRE>
|
| public void <B>runTo</B>(int index)</PRE>
|
| <DL>
|
| <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.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#runTo(int)">runTo</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - The index to run to, or -1 if the iterator |
| should run to the end.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getFoundLast()"><!-- --></A><H3>
|
| getFoundLast</H3>
|
| <PRE>
|
| public final boolean <B>getFoundLast</B>()</PRE>
|
| <DL>
|
| <DD>Tells if we've found the last node yet.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if the last nextNode returned null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getXPathContext()"><!-- --></A><H3>
|
| getXPathContext</H3>
|
| <PRE>
|
| public final <A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> <B>getXPathContext</B>()</PRE>
|
| <DL>
|
| <DD>The XPath execution context we are operating on.<DD><DL>
|
| <DT><B>Returns:</B><DD>XPath execution context this iterator is operating on, |
| or null if setRoot has not been called.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getContext()"><!-- --></A><H3>
|
| getContext</H3>
|
| <PRE>
|
| public final int <B>getContext</B>()</PRE>
|
| <DL>
|
| <DD>The node context for the iterator.<DD><DL>
|
| <DT><B>Returns:</B><DD>The node context, same as getRoot().</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCurrentContextNode()"><!-- --></A><H3>
|
| getCurrentContextNode</H3>
|
| <PRE>
|
| public final int <B>getCurrentContextNode</B>()</PRE>
|
| <DL>
|
| <DD>The node context from where the expression is being |
| executed from (i.e. for current() support).<DD><DL>
|
| <DT><B>Returns:</B><DD>The top-level node context of the entire expression.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setCurrentContextNode(int)"><!-- --></A><H3>
|
| setCurrentContextNode</H3>
|
| <PRE>
|
| public final void <B>setCurrentContextNode</B>(int n)</PRE>
|
| <DL>
|
| <DD>Set the current context node for this iterator.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>n</CODE> - Must be a non-null reference to the node context.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getPrefixResolver()"><!-- --></A><H3>
|
| getPrefixResolver</H3>
|
| <PRE>
|
| public final <A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A> <B>getPrefixResolver</B>()</PRE>
|
| <DL>
|
| <DD>Return the saved reference to the prefix resolver that |
| was in effect when this iterator was created.<DD><DL>
|
| <DT><B>Returns:</B><DD>The prefix resolver or this iterator, which may be null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)"><!-- --></A><H3>
|
| callVisitors</H3>
|
| <PRE>
|
| public void <B>callVisitors</B>(<A HREF="../../../../org/apache/xpath/ExpressionOwner.html">ExpressionOwner</A> owner, |
| <A HREF="../../../../org/apache/xpath/XPathVisitor.html">XPathVisitor</A> visitor)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A> in class <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A><DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xpath/XPathVisitable.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)"><CODE>XPathVisitable.callVisitors(ExpressionOwner, XPathVisitor)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isDocOrdered()"><!-- --></A><H3>
|
| isDocOrdered</H3>
|
| <PRE>
|
| public boolean <B>isDocOrdered</B>()</PRE>
|
| <DL>
|
| <DD>Returns true if all the nodes in the iteration well be returned in document |
| order.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#isDocOrdered()">isDocOrdered</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>true as a default.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getAxis()"><!-- --></A><H3>
|
| getAxis</H3>
|
| <PRE>
|
| public int <B>getAxis</B>()</PRE>
|
| <DL>
|
| <DD>Returns the axis being iterated, if it is known.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getAxis()">getAxis</A> in interface <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>Axis.CHILD, etc., or -1 if the axis is not known or is of multiple |
| types.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLastPos(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| getLastPos</H3>
|
| <PRE>
|
| public int <B>getLastPos</B>(<A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A> in class <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html">PredicatedNodeTest</A><DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getLastPos(org.apache.xpath.XPathContext)"><CODE>PredicatedNodeTest.getLastPos(XPathContext)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LocPathIterator.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/IteratorPool.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xpath/axes/MatchPatternIterator.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="LocPathIterator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
