blob: 96e0f9ba20057b2940bc288760eca13179bd7ae2 [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:40 PDT 2012 -->
<TITLE>
OneStepIterator
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xpath.axes.OneStepIterator class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="OneStepIterator";
}
</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/OneStepIterator.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/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/axes/OneStepIteratorForward.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xpath/axes/OneStepIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="OneStepIterator.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;<A HREF="#nested_classes_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest">NESTED</A>&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.xpath.axes</FONT>
<BR>
Class OneStepIterator</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">org.apache.xpath.Expression</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">org.apache.xpath.patterns.NodeTest</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">org.apache.xpath.axes.PredicatedNodeTest</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">org.apache.xpath.axes.LocPathIterator</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/axes/BasicTestIterator.html" title="class in org.apache.xpath.axes">org.apache.xpath.axes.BasicTestIterator</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">org.apache.xpath.axes.ChildTestIterator</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.axes.OneStepIterator</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, javax.xml.transform.SourceLocator, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A>, <A HREF="../../../../org/apache/xpath/axes/PathComponent.html" title="interface in org.apache.xpath.axes">PathComponent</A>, <A HREF="../../../../org/apache/xpath/axes/SubContextList.html" title="interface in org.apache.xpath.axes">SubContextList</A>, <A HREF="../../../../org/apache/xpath/ExpressionNode.html" title="interface in org.apache.xpath">ExpressionNode</A>, <A HREF="../../../../org/apache/xpath/XPathVisitable.html" title="interface in org.apache.xpath">XPathVisitable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.38"><B>OneStepIterator</B></A><DT>extends <A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></DL>
</PRE>
<P>
This class implements a general iterator for
those LocationSteps with only one step, and perhaps a predicate.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/axes/package-summary.html"><CODE>org.apache.xpath.axes</CODE></A>,
<A HREF="../../../../serialized-form.html#org.apache.xpath.axes.OneStepIterator">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.PredOwner.html" title="class in org.apache.xpath.axes">PredicatedNodeTest.PredOwner</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== 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;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#m_axis">m_axis</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The traversal axis from where the nodes will be filtered.</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/xpath/axes/OneStepIterator.html#m_iterator">m_iterator</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The DTM inner traversal class, that corresponds to the super axis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#serialVersionUID">serialVersionUID</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xpath.axes.ChildTestIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html#m_traverser">m_traverser</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xpath.axes.LocPathIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">LocPathIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_allowDetach">m_allowDetach</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_cdtm">m_cdtm</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_clones">m_clones</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_context">m_context</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_currentContextNode">m_currentContextNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_execContext">m_execContext</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_lastFetched">m_lastFetched</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_length">m_length</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_pos">m_pos</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#m_stackFrame">m_stackFrame</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#DEBUG_PREDICATECOUNTING">DEBUG_PREDICATECOUNTING</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#m_foundLast">m_foundLast</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#m_lpi">m_lpi</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#m_predCount">m_predCount</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#m_predicateIndex">m_predicateIndex</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#m_proximityPositions">m_proximityPositions</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#m_name">m_name</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#m_whatToShow">m_whatToShow</A>, <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>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xml.dtm.DTMIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.apache.xml.dtm.<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#FILTER_ACCEPT">FILTER_ACCEPT</A>, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#FILTER_REJECT">FILTER_REJECT</A>, <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#FILTER_SKIP">FILTER_SKIP</A></CODE></TD>
</TR>
</TABLE>
&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/xpath/axes/OneStepIterator.html#OneStepIterator(org.apache.xpath.compiler.Compiler, int, int)">OneStepIterator</A></B>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html" title="class in org.apache.xpath.compiler">Compiler</A>&nbsp;compiler,
int&nbsp;opPos,
int&nbsp;analysis)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a OneStepIterator object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#OneStepIterator(org.apache.xml.dtm.DTMAxisIterator, int)">OneStepIterator</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A>&nbsp;iterator,
int&nbsp;axis)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a OneStepIterator object.</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;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#clone()">clone</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a cloned iterator.</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/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#countProximityPosition(int)">countProximityPosition</A></B>(int&nbsp;i)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Count backwards one proximity position.</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/xpath/axes/OneStepIterator.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A></B>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>&nbsp;expr)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compare this object with another object and see
if they are equal, include the sub heararchy.</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/xpath/axes/OneStepIterator.html#detach()">detach</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.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/xpath/axes/OneStepIterator.html#getLength()">getLength</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html#getNextNode()">getNextNode</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the next node via getFirstAttribute && getNextAttribute.</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/xpath/axes/OneStepIterator.html#getProximityPosition(int)">getProximityPosition</A></B>(int&nbsp;predicateIndex)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the current sub-context position.</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/xpath/axes/OneStepIterator.html#isReverseAxes()">isReverseAxes</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tells if this is a reverse axes.</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/xpath/axes/OneStepIterator.html#reset()">reset</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset the iterator.</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/xpath/axes/OneStepIterator.html#setRoot(int, java.lang.Object)">setRoot</A></B>(int&nbsp;context,
java.lang.Object&nbsp;environment)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the context values for this expression
after it is cloned.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.axes.BasicTestIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/BasicTestIterator.html" title="class in org.apache.xpath.axes">BasicTestIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/BasicTestIterator.html#nextNode()">nextNode</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.axes.LocPathIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">LocPathIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#allowDetachToRelease(boolean)">allowDetachToRelease</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#asIterator(org.apache.xpath.XPathContext, int)">asIterator</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#asNode(org.apache.xpath.XPathContext)">asNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#bool(org.apache.xpath.XPathContext)">bool</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#execute(org.apache.xpath.XPathContext)">execute</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)">executeCharsToContentHandler</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getAnalysisBits()">getAnalysisBits</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getContext()">getContext</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCurrentContextNode()">getCurrentContextNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCurrentNode()">getCurrentNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getCurrentPos()">getCurrentPos</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getDTM(int)">getDTM</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getDTMManager()">getDTMManager</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getFilter()">getFilter</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getFoundLast()">getFoundLast</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getIsTopLevel()">getIsTopLevel</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getPrefixResolver()">getPrefixResolver</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getRoot()">getRoot</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getWhatToShow()">getWhatToShow</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getXPathContext()">getXPathContext</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#incrementCurrentPos()">incrementCurrentPos</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#isDocOrdered()">isDocOrdered</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#isFresh()">isFresh</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#isMutable()">isMutable</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#isNodesetExpr()">isNodesetExpr</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#item(int)">item</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#previousNode()">previousNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#returnNextNode(int)">returnNextNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#runTo(int)">runTo</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setCurrentContextNode(int)">setCurrentContextNode</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setCurrentPos(int)">setCurrentPos</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setEnvironment(java.lang.Object)">setEnvironment</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setIsTopLevel(boolean)">setIsTopLevel</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setItem(int, int)">setItem</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setNextPosition(int)">setNextPosition</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#size()">size</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.axes.<A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></B></TH>
</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#executePredicates(int, org.apache.xpath.XPathContext)">executePredicates</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#initPredicateInfo(org.apache.xpath.compiler.Compiler, int)">initPredicateInfo</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#initProximityPosition(int)">initProximityPosition</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#nodeToString(int)">nodeToString</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>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#calcScore()">calcScore</A>, <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>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.Expression"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.xpath.<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/Expression.html#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#isSameClass(org.apache.xpath.Expression)">isSameClass</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isStableNumber()">isStableNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#num(org.apache.xpath.XPathContext)">num</A>, <A HREF="../../../../org/apache/xpath/Expression.html#warn(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">warn</A>, <A HREF="../../../../org/apache/xpath/Expression.html#xstr(org.apache.xpath.XPathContext)">xstr</A></CODE></TD>
</TR>
</TABLE>
&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>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="serialVersionUID"><!-- --></A><H3>
serialVersionUID</H3>
<PRE>
static final long <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.40"><B>serialVersionUID</B></A></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xpath.axes.OneStepIterator.serialVersionUID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="m_axis"><!-- --></A><H3>
m_axis</H3>
<PRE>
protected int <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.42"><B>m_axis</B></A></PRE>
<DL>
<DD>The traversal axis from where the nodes will be filtered.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_iterator"><!-- --></A><H3>
m_iterator</H3>
<PRE>
protected <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.45"><B>m_iterator</B></A></PRE>
<DL>
<DD>The DTM inner traversal class, that corresponds to the super axis.
<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="OneStepIterator(org.apache.xpath.compiler.Compiler, int, int)"><!-- --></A><H3>
OneStepIterator</H3>
<PRE>
<A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.56"><B>OneStepIterator</B></A>(<A HREF="../../../../org/apache/xpath/compiler/Compiler.html" title="class in org.apache.xpath.compiler">Compiler</A>&nbsp;compiler,
int&nbsp;opPos,
int&nbsp;analysis)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Create a OneStepIterator object.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>compiler</CODE> - A reference to the Compiler that contains the op map.<DD><CODE>opPos</CODE> - The position within the op map, which contains the
location path expression for this itterator.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
</DL>
<HR>
<A NAME="OneStepIterator(org.apache.xml.dtm.DTMAxisIterator, int)"><!-- --></A><H3>
OneStepIterator</H3>
<PRE>
public <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.75"><B>OneStepIterator</B></A>(<A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A>&nbsp;iterator,
int&nbsp;axis)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Create a OneStepIterator object.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>iterator</CODE> - The DTM iterator which this iterator will use.<DD><CODE>axis</CODE> - One of Axis.Child, etc., or -1 if the axis is unknown.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></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="setRoot(int, java.lang.Object)"><!-- --></A><H3>
setRoot</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.93"><B>setRoot</B></A>(int&nbsp;context,
java.lang.Object&nbsp;environment)</PRE>
<DL>
<DD>Initialize the context values for this expression
after it is cloned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#setRoot(int, java.lang.Object)">setRoot</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html#setRoot(int, java.lang.Object)">setRoot</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - The XPath runtime context for this
transformation.<DD><CODE>environment</CODE> - The environment object.
The environment in which this iterator operates, which should provide:
<ul>
<li>a node (the context node... same value as "root" defined below) </li>
<li>a pair of non-zero positive integers (the context position and the context size) </li>
<li>a set of variable bindings </li>
<li>a function library </li>
<li>the set of namespace declarations in scope for the expression.</li>
<ul>
<p>At this time the exact implementation of this environment is application
dependent. Probably a proper interface will be created fairly soon.</p></DL>
</DD>
</DL>
<HR>
<A NAME="detach()"><!-- --></A><H3>
detach</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.108"><B>detach</B></A>()</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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#detach()">detach</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html#detach()">detach</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNextNode()"><!-- --></A><H3>
getNextNode</H3>
<PRE>
protected int <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.123"><B>getNextNode</B></A>()</PRE>
<DL>
<DD>Get the next node via getFirstAttribute && getNextAttribute.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html#getNextNode()">getNextNode</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The next node on the axis, or DTM.NULL.</DL>
</DD>
</DL>
<HR>
<A NAME="clone()"><!-- --></A><H3>
clone</H3>
<PRE>
public java.lang.Object <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.135"><B>clone</B></A>()
throws java.lang.CloneNotSupportedException</PRE>
<DL>
<DD>Get a cloned iterator.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#clone()">clone</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#clone()">clone</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A new iterator that can be used without mutating this one.
<DT><B>Throws:</B>
<DD><CODE>java.lang.CloneNotSupportedException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="cloneWithReset()"><!-- --></A><H3>
cloneWithReset</H3>
<PRE>
public <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A> <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.156"><B>cloneWithReset</B></A>()
throws java.lang.CloneNotSupportedException</PRE>
<DL>
<DD>Get a cloned Iterator that is reset to the beginning
of the query.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#cloneWithReset()">cloneWithReset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html#cloneWithReset()">cloneWithReset</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A cloned NodeIterator set of the start of the query.
<DT><B>Throws:</B>
<DD><CODE>java.lang.CloneNotSupportedException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isReverseAxes()"><!-- --></A><H3>
isReverseAxes</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.172"><B>isReverseAxes</B></A>()</PRE>
<DL>
<DD>Tells if this is a reverse axes. Overrides AxesWalker#isReverseAxes.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#isReverseAxes()">isReverseAxes</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true for this class.</DL>
</DD>
</DL>
<HR>
<A NAME="getProximityPosition(int)"><!-- --></A><H3>
getProximityPosition</H3>
<PRE>
protected int <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.188"><B>getProximityPosition</B></A>(int&nbsp;predicateIndex)</PRE>
<DL>
<DD>Get the current sub-context position. In order to do the
reverse axes count, for the moment this re-searches the axes
up to the predicate. An optimization on this is to cache
the nodes searched, but, for the moment, this case is probably
rare enough that the added complexity isn't worth it.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#getProximityPosition(int)">getProximityPosition</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>predicateIndex</CODE> - The predicate index of the proximity position.
<DT><B>Returns:</B><DD>The pridicate index, or -1.</DL>
</DD>
</DL>
<HR>
<A NAME="getLength()"><!-- --></A><H3>
getLength</H3>
<PRE>
public int <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.244"><B>getLength</B></A>()</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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getLength()">getLength</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#getLength()">getLength</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">LocPathIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The number of nodes in the list, always greater or equal to zero.</DL>
</DD>
</DL>
<HR>
<A NAME="countProximityPosition(int)"><!-- --></A><H3>
countProximityPosition</H3>
<PRE>
protected void <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.300"><B>countProximityPosition</B></A>(int&nbsp;i)</PRE>
<DL>
<DD>Count backwards one proximity position.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#countProximityPosition(int)">countProximityPosition</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - The predicate index.</DL>
</DD>
</DL>
<HR>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.311"><B>reset</B></A>()</PRE>
<DL>
<DD>Reset the iterator.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html#reset()">reset</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">LocPathIterator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getAxis()"><!-- --></A><H3>
getAxis</H3>
<PRE>
public int <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.325"><B>getAxis</B></A>()</PRE>
<DL>
<DD>Returns the axis being iterated, if it is known.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html#getAxis()">getAxis</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm">DTMIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html#getAxis()">getAxis</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Axis.CHILD, etc., or -1 if the axis is not known or is of multiple
types.</DL>
</DD>
</DL>
<HR>
<A NAME="deepEquals(org.apache.xpath.Expression)"><!-- --></A><H3>
deepEquals</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/apache/xpath/axes/OneStepIterator.html#line.333"><B>deepEquals</B></A>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>&nbsp;expr)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xpath/Expression.html#deepEquals(org.apache.xpath.Expression)">Expression</A></CODE></B></DD>
<DD>Compare this object with another object and see
if they are equal, include the sub heararchy.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expr</CODE> - Another expression object.
<DT><B>Returns:</B><DD>true if this objects class and the expr
object's class are the same, and the data contained
within both objects are considered equal.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#deepEquals(org.apache.xpath.Expression)"><CODE>Expression.deepEquals(Expression)</CODE></A></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/OneStepIterator.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/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/axes/OneStepIteratorForward.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xpath/axes/OneStepIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="OneStepIterator.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;<A HREF="#nested_classes_inherited_from_class_org.apache.xpath.axes.PredicatedNodeTest">NESTED</A>&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>