blob: 55333d113ceafa02e7b49072da5002ee430cba9f [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:31 PDT 2012 -->
<TITLE>
DTMDefaultBaseTraversers.DescendantTraverser
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.DescendantTraverser class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="DTMDefaultBaseTraversers.DescendantTraverser";
}
</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/DTMDefaultBaseTraversers.DescendantTraverser.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/DTMDefaultBaseTraversers.DescendantOrSelfTraverser.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.FollowingSiblingTraverser.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/DTMDefaultBaseTraversers.DescendantTraverser.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMDefaultBaseTraversers.DescendantTraverser.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;FIELD&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;FIELD&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 DTMDefaultBaseTraversers.DescendantTraverser</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">org.apache.xml.dtm.DTMAxisTraverser</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html" title="class in org.apache.xml.dtm.ref">org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.IndexedDTMAxisTraverser</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.DescendantTraverser</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantFromRootTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.DescendantFromRootTraverser</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantOrSelfFromRootTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.DescendantOrSelfFromRootTraverser</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantOrSelfTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.DescendantOrSelfTraverser</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.FollowingTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.FollowingTraverser</A></DD>
</DL>
<DL>
<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>private class <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.html#line.582"><B>DTMDefaultBaseTraversers.DescendantTraverser</B></A><DT>extends <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.IndexedDTMAxisTraverser</A></DL>
</PRE>
<P>
Implements traversal of the Ancestor access, in reverse document order.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#DTMDefaultBaseTraversers.DescendantTraverser()">DTMDefaultBaseTraversers.DescendantTraverser</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>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#axisHasBeenProcessed(int)">axisHasBeenProcessed</A></B>(int&nbsp;axisRoot)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if the axis has been fully processed to tell if a the wait for
an arriving node should terminate.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#first(int, int)">first</A></B>(int&nbsp;context,
int&nbsp;expandedTypeID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;By the nature of the stateless traversal, the context node can not be
returned or the iteration will go into an infinate loop.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#getFirstPotential(int)">getFirstPotential</A></B>(int&nbsp;identity)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the first potential identity that can be returned.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#getSubtreeRoot(int)">getSubtreeRoot</A></B>(int&nbsp;handle)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the subtree root identity from the handle that was passed in by
the caller.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#isAfterAxis(int, int)">isAfterAxis</A></B>(int&nbsp;axisRoot,
int&nbsp;identity)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if a node is outside the axis being traversed.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#isDescendant(int, int)">isDescendant</A></B>(int&nbsp;subtreeRootIdentity,
int&nbsp;identity)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if this node identity is a descendant.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#next(int, int)">next</A></B>(int&nbsp;context,
int&nbsp;current)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Traverse to the next node after the current node.</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/DTMDefaultBaseTraversers.DescendantTraverser.html#next(int, int, int)">next</A></B>(int&nbsp;context,
int&nbsp;current,
int&nbsp;expandedTypeID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Traverse to the next node after the current node that is matched
by the expanded type ID.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.IndexedDTMAxisTraverser"><!-- --></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.xml.dtm.ref.<A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.IndexedDTMAxisTraverser</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html#getNextIndexed(int, int, int)">getNextIndexed</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html#isIndexed(int)">isIndexed</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xml.dtm.DTMAxisTraverser"><!-- --></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.xml.dtm.<A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">DTMAxisTraverser</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#first(int)">first</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= 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="DTMDefaultBaseTraversers.DescendantTraverser()"><!-- --></A><H3>
DTMDefaultBaseTraversers.DescendantTraverser</H3>
<PRE>
private <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.582"><B>DTMDefaultBaseTraversers.DescendantTraverser</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="getFirstPotential(int)"><!-- --></A><H3>
getFirstPotential</H3>
<PRE>
protected int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.592"><B>getFirstPotential</B></A>(int&nbsp;identity)</PRE>
<DL>
<DD>Get the first potential identity that can be returned. This should
be overridded by classes that need to return the self node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>identity</CODE> - The node identity of the root context of the traversal.
<DT><B>Returns:</B><DD>The first potential node that can be in the traversal.</DL>
</DD>
</DL>
<HR>
<A NAME="axisHasBeenProcessed(int)"><!-- --></A><H3>
axisHasBeenProcessed</H3>
<PRE>
protected boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.605"><B>axisHasBeenProcessed</B></A>(int&nbsp;axisRoot)</PRE>
<DL>
<DD>Tell if the axis has been fully processed to tell if a the wait for
an arriving node should terminate.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html#axisHasBeenProcessed(int)">axisHasBeenProcessed</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.IndexedDTMAxisTraverser</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axisRoot</CODE> - The root identity of the axis.
<DT><B>Returns:</B><DD>true if the axis has been fully processed.</DL>
</DD>
</DL>
<HR>
<A NAME="getSubtreeRoot(int)"><!-- --></A><H3>
getSubtreeRoot</H3>
<PRE>
protected int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.618"><B>getSubtreeRoot</B></A>(int&nbsp;handle)</PRE>
<DL>
<DD>Get the subtree root identity from the handle that was passed in by
the caller. Derived classes may override this to change the root
context of the traversal.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>handle</CODE> - handle to the root context.
<DT><B>Returns:</B><DD>identity of the root of the subtree.</DL>
</DD>
</DL>
<HR>
<A NAME="isDescendant(int, int)"><!-- --></A><H3>
isDescendant</H3>
<PRE>
protected boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.635"><B>isDescendant</B></A>(int&nbsp;subtreeRootIdentity,
int&nbsp;identity)</PRE>
<DL>
<DD>Tell if this node identity is a descendant. Assumes that
the node info for the element has already been obtained.
%REVIEW% This is really parentFollowsRootInDocumentOrder ...
which fails if the parent starts after the root ends.
May be sufficient for this class's logic, but misleadingly named!
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subtreeRootIdentity</CODE> - The root context of the subtree in question.<DD><CODE>identity</CODE> - The index number of the node in question.
<DT><B>Returns:</B><DD>true if the index is a descendant of _startNode.</DL>
</DD>
</DL>
<HR>
<A NAME="isAfterAxis(int, int)"><!-- --></A><H3>
isAfterAxis</H3>
<PRE>
protected boolean <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.650"><B>isAfterAxis</B></A>(int&nbsp;axisRoot,
int&nbsp;identity)</PRE>
<DL>
<DD>Tell if a node is outside the axis being traversed. This method must be
implemented by derived classes, and must be robust enough to handle any
node that occurs after the axis root.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html#isAfterAxis(int, int)">isAfterAxis</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.IndexedDTMAxisTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.IndexedDTMAxisTraverser</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axisRoot</CODE> - The root identity of the axis.<DD><CODE>identity</CODE> - The node in question.
<DT><B>Returns:</B><DD>true if the given node falls outside the axis being traversed.</DL>
</DD>
</DL>
<HR>
<A NAME="first(int, int)"><!-- --></A><H3>
first</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.680"><B>first</B></A>(int&nbsp;context,
int&nbsp;expandedTypeID)</PRE>
<DL>
<DD>By the nature of the stateless traversal, the context node can not be
returned or the iteration will go into an infinate loop. So to traverse
an axis, the first function must be used to get the first node.
<p>This method needs to be overloaded only by those axis that process
the self node. <\p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#first(int, int)">first</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">DTMAxisTraverser</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - The context node of this traversal. This is the point
of origin for the traversal -- its "root node" or starting point.<DD><CODE>expandedTypeID</CODE> - The expanded type ID that must match.
<DT><B>Returns:</B><DD>the first node in the traversal.</DL>
</DD>
</DL>
<HR>
<A NAME="next(int, int)"><!-- --></A><H3>
next</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.702"><B>next</B></A>(int&nbsp;context,
int&nbsp;current)</PRE>
<DL>
<DD>Traverse to the next node after the current node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#next(int, int)">next</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">DTMAxisTraverser</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - The context node of this iteration.<DD><CODE>current</CODE> - The current node of the iteration.
<DT><B>Returns:</B><DD>the next node in the iteration, or DTM.NULL.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#first(int)"><CODE>DTMAxisTraverser.first(int)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="next(int, int, int)"><!-- --></A><H3>
next</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#line.731"><B>next</B></A>(int&nbsp;context,
int&nbsp;current,
int&nbsp;expandedTypeID)</PRE>
<DL>
<DD>Traverse to the next node after the current node that is matched
by the expanded type ID.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#next(int, int, int)">next</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html" title="class in org.apache.xml.dtm">DTMAxisTraverser</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - The context node of this iteration.<DD><CODE>current</CODE> - The current node of the iteration.<DD><CODE>expandedTypeID</CODE> - The expanded type ID that must match.
<DT><B>Returns:</B><DD>the next node in the iteration, or DTM.NULL.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#first(int, int)"><CODE>DTMAxisTraverser.first(int,int)</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/DTMDefaultBaseTraversers.DescendantTraverser.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/DTMDefaultBaseTraversers.DescendantOrSelfTraverser.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.FollowingSiblingTraverser.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/DTMDefaultBaseTraversers.DescendantTraverser.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMDefaultBaseTraversers.DescendantTraverser.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;FIELD&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;FIELD&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>