blob: 94cd3737b5d79edaedc946c723d9358ce6667378 [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.DescendantOrSelfTraverser
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.DescendantOrSelfTraverser class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="DTMDefaultBaseTraversers.DescendantOrSelfTraverser";
}
</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.DescendantOrSelfTraverser.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.DescendantOrSelfFromRootTraverser.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.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.DescendantOrSelfTraverser.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMDefaultBaseTraversers.DescendantOrSelfTraverser.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.DescendantOrSelfTraverser</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 "><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html" title="class in org.apache.xml.dtm.ref">org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.DescendantTraverser</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.DescendantOrSelfTraverser</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.AllFromNodeTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.AllFromNodeTraverser</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.761"><B>DTMDefaultBaseTraversers.DescendantOrSelfTraverser</B></A><DT>extends <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.DescendantTraverser</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.DescendantOrSelfTraverser.html#DTMDefaultBaseTraversers.DescendantOrSelfTraverser()">DTMDefaultBaseTraversers.DescendantOrSelfTraverser</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;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantOrSelfTraverser.html#first(int)">first</A></B>(int&nbsp;context)</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.DescendantOrSelfTraverser.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, which is the
axis context, in this case.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.DescendantTraverser"><!-- --></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.DescendantTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.DescendantTraverser</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#axisHasBeenProcessed(int)">axisHasBeenProcessed</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#first(int, int)">first</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#getSubtreeRoot(int)">getSubtreeRoot</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#isAfterAxis(int, int)">isAfterAxis</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#isDescendant(int, int)">isDescendant</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#next(int, int)">next</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#next(int, int, int)">next</A></CODE></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_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.DescendantOrSelfTraverser()"><!-- --></A><H3>
DTMDefaultBaseTraversers.DescendantOrSelfTraverser</H3>
<PRE>
private <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantOrSelfTraverser.html#line.761"><B>DTMDefaultBaseTraversers.DescendantOrSelfTraverser</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.DescendantOrSelfTraverser.html#line.772"><B>getFirstPotential</B></A>(int&nbsp;identity)</PRE>
<DL>
<DD>Get the first potential identity that can be returned, which is the
axis context, in this case.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html#getFirstPotential(int)">getFirstPotential</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.html" title="class in org.apache.xml.dtm.ref">DTMDefaultBaseTraversers.DescendantTraverser</A></CODE></DL>
</DD>
<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 axis context.</DL>
</DD>
</DL>
<HR>
<A NAME="first(int)"><!-- --></A><H3>
first</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantOrSelfTraverser.html#line.786"><B>first</B></A>(int&nbsp;context)</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. To see if
the self node should be processed, use this function.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisTraverser.html#first(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.
<DT><B>Returns:</B><DD>the first node in the traversal.</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.DescendantOrSelfTraverser.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.DescendantOrSelfFromRootTraverser.html" title="class in org.apache.xml.dtm.ref"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/dtm/ref/DTMDefaultBaseTraversers.DescendantTraverser.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.DescendantOrSelfTraverser.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMDefaultBaseTraversers.DescendantOrSelfTraverser.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>