Google Git
Sign in
apache / xalan-site / 9bd7a158adb6ed5414b8eefa57ab0f8b842ed7a3 / . / docs / xalan / xalan-j / apidocs / org / apache / xml / dtm / ref / DTMAxisIteratorBase.html
blob: a14716071409e8d7fd968bd236213b967febcdfc [file] [log] [blame]
<!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:30 PDT 2012 -->
<TITLE>
DTMAxisIteratorBase
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.ref.DTMAxisIteratorBase class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="DTMAxisIteratorBase";
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTMAxisIteratorBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/CustomStringPool.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIterNodeList.html" title="class in org.apache.xml.dtm.ref"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMAxisIteratorBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.xml.dtm.ref</FONT>
<BR>
Class DTMAxisIteratorBase</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.dtm.ref.DTMAxisIteratorBase</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/xalan/xsltc/dom/AbsoluteIterator.html" title="class in org.apache.xalan.xsltc.dom">AbsoluteIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/CachedNodeListIterator.html" title="class in org.apache.xalan.xsltc.dom">CachedNodeListIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/ClonedNodeListIterator.html" title="class in org.apache.xalan.xsltc.dom">ClonedNodeListIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/CurrentNodeListIterator.html" title="class in org.apache.xalan.xsltc.dom">CurrentNodeListIterator</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseIterators.InternalAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseIterators.InternalAxisIteratorBase</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/DupFilterIterator.html" title="class in org.apache.xalan.xsltc.dom">DupFilterIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html" title="class in org.apache.xalan.xsltc.dom">FilterIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/ForwardPositionIterator.html" title="class in org.apache.xalan.xsltc.dom">ForwardPositionIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/KeyIndex.html" title="class in org.apache.xalan.xsltc.dom">KeyIndex</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/MatchingIterator.html" title="class in org.apache.xalan.xsltc.dom">MatchingIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiDOM.AxisIterator.html" title="class in org.apache.xalan.xsltc.dom">MultiDOM.AxisIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiDOM.NodeValueIterator.html" title="class in org.apache.xalan.xsltc.dom">MultiDOM.NodeValueIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.html" title="class in org.apache.xalan.xsltc.dom">MultiValuedNodeHeapIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/NthIterator.html" title="class in org.apache.xalan.xsltc.dom">NthIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/SimpleResultTreeImpl.SimpleIterator.html" title="class in org.apache.xalan.xsltc.dom">SimpleResultTreeImpl.SimpleIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/SimpleResultTreeImpl.SingletonIterator.html" title="class in org.apache.xalan.xsltc.dom">SimpleResultTreeImpl.SingletonIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/SingletonIterator.html" title="class in org.apache.xalan.xsltc.dom">SingletonIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/SortingIterator.html" title="class in org.apache.xalan.xsltc.dom">SortingIterator</A>, <A HREF="../../../../../org/apache/xalan/xsltc/dom/StepIterator.html" title="class in org.apache.xalan.xsltc.dom">StepIterator</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.29"><B>DTMAxisIteratorBase</B></A><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></DL>
</PRE>
<P>
This class serves as a default base for implementations of mutable
DTMAxisIterators.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_includeSelf">_includeSelf</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if the start node should be considered part of the iteration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_isRestartable">_isRestartable</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if this iteration can be restarted.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_last">_last</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The position of the last node within the iteration, as defined by XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_markedNode">_markedNode</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The position of the marked node within the iteration;
a saved itaration state that we may want to come back to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_position">_position</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The position of the current node within the iteration, as defined by XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_startNode">_startNode</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The handle to the start, or root, of the iteration.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xml.dtm.DTMAxisIterator"><!-- --></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/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#END">END</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#DTMAxisIteratorBase()">DTMAxisIteratorBase</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#cloneIterator()">cloneIterator</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a deep copy of this iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getAxis()">getAxis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getLast()">getLast</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the position of the last node within the iteration, as
defined by XPath.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getNodeByPosition(int)">getNodeByPosition</A></B>(int&nbsp;position)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the node at the given position.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getPosition()">getPosition</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getStartNode()">getStartNode</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get start to END should 'close' the iterator,
i.e.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#includeSelf()">includeSelf</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the flag to include the start node in the iteration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#isDocOrdered()">isDocOrdered</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#isReverse()">isReverse</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#reset()">reset</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets the iterator to the last start node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#resetPosition()">resetPosition</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset the position to zero.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#returnNode(int)">returnNode</A></B>(int&nbsp;node)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do any final cleanup that is required before returning the node that was
passed in, and then return it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#setRestartable(boolean)">setRestartable</A></B>(boolean&nbsp;isRestartable)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set if restartable.</TD>
</TR>
</TABLE>
&nbsp;<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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xml.dtm.DTMAxisIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.xml.dtm.<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#gotoMark()">gotoMark</A>, <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#next()">next</A>, <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setMark()">setMark</A>, <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setStartNode(int)">setStartNode</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="_last"><!-- --></A><H3>
_last</H3>
<PRE>
protected int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.36"><B>_last</B></A></PRE>
<DL>
<DD>The position of the last node within the iteration, as defined by XPath.
Note that this is _not_ the node's handle within the DTM. Also, don't
confuse it with the current (most recently returned) position.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_position"><!-- --></A><H3>
_position</H3>
<PRE>
protected int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.41"><B>_position</B></A></PRE>
<DL>
<DD>The position of the current node within the iteration, as defined by XPath.
Note that this is _not_ the node's handle within the DTM!
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_markedNode"><!-- --></A><H3>
_markedNode</H3>
<PRE>
protected int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.47"><B>_markedNode</B></A></PRE>
<DL>
<DD>The position of the marked node within the iteration;
a saved itaration state that we may want to come back to.
Note that only one mark is maintained; there is no stack.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_startNode"><!-- --></A><H3>
_startNode</H3>
<PRE>
protected int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.52"><B>_startNode</B></A></PRE>
<DL>
<DD>The handle to the start, or root, of the iteration.
Set this to END to construct an empty iterator.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_includeSelf"><!-- --></A><H3>
_includeSelf</H3>
<PRE>
protected boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.57"><B>_includeSelf</B></A></PRE>
<DL>
<DD>True if the start node should be considered part of the iteration.
False will cause it to be skipped.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_isRestartable"><!-- --></A><H3>
_isRestartable</H3>
<PRE>
protected boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.63"><B>_isRestartable</B></A></PRE>
<DL>
<DD>True if this iteration can be restarted. False otherwise (eg, if
we are iterating over a stream that can not be re-scanned, or if
the iterator was produced by cloning another iterator.)
<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="DTMAxisIteratorBase()"><!-- --></A><H3>
DTMAxisIteratorBase</H3>
<PRE>
public <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.29"><B>DTMAxisIteratorBase</B></A>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getStartNode()"><!-- --></A><H3>
getStartNode</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.71"><B>getStartNode</B></A>()</PRE>
<DL>
<DD>Get start to END should 'close' the iterator,
i.e. subsequent call to next() should return END.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#getStartNode()">getStartNode</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The root node of the iteration.</DL>
</DD>
</DL>
<HR>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.80"><B>reset</B></A>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#reset()">DTMAxisIterator</A></CODE></B></DD>
<DD>Resets the iterator to the last start node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A DTMAxisIterator which has been reset to the start node,
which may or may not be the same as this iterator.</DL>
</DD>
</DL>
<HR>
<A NAME="includeSelf()"><!-- --></A><H3>
includeSelf</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.103"><B>includeSelf</B></A>()</PRE>
<DL>
<DD>Set the flag to include the start node in the iteration.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>This default method returns just returns this DTMAxisIterator,
after setting the flag.
(Returning "this" permits C++-style chaining of
method calls into a single expression.)</DL>
</DD>
</DL>
<HR>
<A NAME="getLast()"><!-- --></A><H3>
getLast</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.122"><B>getLast</B></A>()</PRE>
<DL>
<DD>Returns the position of the last node within the iteration, as
defined by XPath. In a forward iterator, I believe this equals the number of nodes which this
iterator will yield. In a reverse iterator, I believe it should return
1 (since the "last" is the first produced.)
This may be an expensive operation when called the first time, since
it may have to iterate through a large part of the document to produce
its answer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#getLast()">getLast</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The number of nodes in this iterator (forward) or 1 (reverse).</DL>
</DD>
</DL>
<HR>
<A NAME="getPosition()"><!-- --></A><H3>
getPosition</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.155"><B>getPosition</B></A>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#getPosition()">getPosition</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The position of the current node within the set, as defined by
XPath. Note that this is one-based, not zero-based.</DL>
</DD>
</DL>
<HR>
<A NAME="isReverse()"><!-- --></A><H3>
isReverse</H3>
<PRE>
public boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.163"><B>isReverse</B></A>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#isReverse()">isReverse</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this iterator has a reversed axis, else false</DL>
</DD>
</DL>
<HR>
<A NAME="cloneIterator()"><!-- --></A><H3>
cloneIterator</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.175"><B>cloneIterator</B></A>()</PRE>
<DL>
<DD>Returns a deep copy of this iterator. Cloned iterators may not be
restartable. The iterator being cloned may or may not become
non-restartable as a side effect of this operation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#cloneIterator()">cloneIterator</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a deep copy of this iterator.</DL>
</DD>
</DL>
<HR>
<A NAME="returnNode(int)"><!-- --></A><H3>
returnNode</H3>
<PRE>
protected final int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.211"><B>returnNode</B></A>(int&nbsp;node)</PRE>
<DL>
<DD>Do any final cleanup that is required before returning the node that was
passed in, and then return it. The intended use is
<br />
<code>return returnNode(node);</code>
%REVIEW% If we're calling it purely for side effects, should we really
be bothering with a return value? Something like
<br />
<code> accept(node); return node; </code>
<br />
would probably optimize just about as well and avoid questions
about whether what's returned could ever be different from what's
passed in.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Node handle which iteration is about to yield.
<DT><B>Returns:</B><DD>The node handle passed in.</DL>
</DD>
</DL>
<HR>
<A NAME="resetPosition()"><!-- --></A><H3>
resetPosition</H3>
<PRE>
protected final <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.226"><B>resetPosition</B></A>()</PRE>
<DL>
<DD>Reset the position to zero. NOTE that this does not change the iteration
state, only the position number associated with that state.
%REVIEW% Document when this would be used?
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>This instance.</DL>
</DD>
</DL>
<HR>
<A NAME="isDocOrdered()"><!-- --></A><H3>
isDocOrdered</H3>
<PRE>
public boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.240"><B>isDocOrdered</B></A>()</PRE>
<DL>
<DD>Returns true if all the nodes in the iteration well be returned in document
order.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true as a default.</DL>
</DD>
</DL>
<HR>
<A NAME="getAxis()"><!-- --></A><H3>
getAxis</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.251"><B>getAxis</B></A>()</PRE>
<DL>
<DD>Returns the axis being iterated, if it is known.
<P>
<DD><DL>
</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.</DL>
</DD>
</DL>
<HR>
<A NAME="setRestartable(boolean)"><!-- --></A><H3>
setRestartable</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.256"><B>setRestartable</B></A>(boolean&nbsp;isRestartable)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setRestartable(boolean)">DTMAxisIterator</A></CODE></B></DD>
<DD>Set if restartable.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setRestartable(boolean)">setRestartable</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeByPosition(int)"><!-- --></A><H3>
getNodeByPosition</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#line.266"><B>getNodeByPosition</B></A>(int&nbsp;position)</PRE>
<DL>
<DD>Return the node at the given position.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#getNodeByPosition(int)">getNodeByPosition</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>position</CODE> - The position
<DT><B>Returns:</B><DD>The node at the given position.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTMAxisIteratorBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/CustomStringPool.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIterNodeList.html" title="class in org.apache.xml.dtm.ref"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMAxisIteratorBase.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>