| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:56 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Interface DTMAxisIterator
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTMAxisIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../org/apache/xml/dtm/DTM.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xml/dtm/DTMFilter.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="DTMAxisIterator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xml.dtm</FONT>
|
| <BR>
|
| Interface DTMAxisIterator</H2>
|
| <DL>
|
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html">DTMAxisIteratorBase</A>, <A HREF="../../../../org/apache/xml/dtm/ref/EmptyIterator.html">EmptyIterator</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public interface <B>DTMAxisIterator</B><DT>extends java.lang.Cloneable</DL>
|
|
|
| <P>
|
| This class iterates over a single XPath Axis, and returns node handles.
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Field Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#END">END</A></B></CODE>
|
|
|
| <BR>
|
| Specifies the end of the iteration, and is the same as DTM.NULL.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#cloneIterator()">cloneIterator</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#getLast()">getLast</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#getNodeByPosition(int)">getNodeByPosition</A></B>(int position)</CODE>
|
|
|
| <BR>
|
| Return the node at the given position.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#getPosition()">getPosition</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#getStartNode()">getStartNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Get start to END should 'close' the iterator, |
| i.e.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#gotoMark()">gotoMark</A></B>()</CODE>
|
|
|
| <BR>
|
| Restores the current node remembered by setMark().</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#isReverse()">isReverse</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#next()">next</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the next node in the iteration.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#reset()">reset</A></B>()</CODE>
|
|
|
| <BR>
|
| Resets the iterator to the last start node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#setMark()">setMark</A></B>()</CODE>
|
|
|
| <BR>
|
| Remembers the current node for the next call to gotoMark().</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#setRestartable(boolean)">setRestartable</A></B>(boolean isRestartable)</CODE>
|
|
|
| <BR>
|
| Set if restartable.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html#setStartNode(int)">setStartNode</A></B>(int node)</CODE>
|
|
|
| <BR>
|
| Set start to END should 'close' the iterator, |
| i.e.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="END"><!-- --></A><H3>
|
| END</H3>
|
| <PRE>
|
| public static final int <B>END</B></PRE>
|
| <DL>
|
| <DD>Specifies the end of the iteration, and is the same as DTM.NULL.</DL>
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="next()"><!-- --></A><H3>
|
| next</H3>
|
| <PRE>
|
| public int <B>next</B>()</PRE>
|
| <DL>
|
| <DD>Get the next node in the iteration.<DD><DL>
|
| <DT><B>Returns:</B><DD>The next node handle in the iteration, or END.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="reset()"><!-- --></A><H3>
|
| reset</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A> <B>reset</B>()</PRE>
|
| <DL>
|
| <DD>Resets the iterator to the last start node.<DD><DL>
|
| <DT><B>Returns:</B><DD>A DTMAxisIterator, which may or may not be the same as this |
| iterator.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLast()"><!-- --></A><H3>
|
| getLast</H3>
|
| <PRE>
|
| public int <B>getLast</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Returns:</B><DD>the number of nodes in this iterator. This may be an expensive |
| operation when called the first time.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getPosition()"><!-- --></A><H3>
|
| getPosition</H3>
|
| <PRE>
|
| public int <B>getPosition</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Returns:</B><DD>The position of the current node in the set, as defined by XPath.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setMark()"><!-- --></A><H3>
|
| setMark</H3>
|
| <PRE>
|
| public void <B>setMark</B>()</PRE>
|
| <DL>
|
| <DD>Remembers the current node for the next call to gotoMark().<DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="gotoMark()"><!-- --></A><H3>
|
| gotoMark</H3>
|
| <PRE>
|
| public void <B>gotoMark</B>()</PRE>
|
| <DL>
|
| <DD>Restores the current node remembered by setMark().<DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setStartNode(int)"><!-- --></A><H3>
|
| setStartNode</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A> <B>setStartNode</B>(int node)</PRE>
|
| <DL>
|
| <DD>Set start to END should 'close' the iterator, |
| i.e. subsequent call to next() should return END.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - Sets the root of the iteration.<DT><B>Returns:</B><DD>A DTMAxisIterator set to the start of the iteration.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getStartNode()"><!-- --></A><H3>
|
| getStartNode</H3>
|
| <PRE>
|
| public int <B>getStartNode</B>()</PRE>
|
| <DL>
|
| <DD>Get start to END should 'close' the iterator, |
| i.e. subsequent call to next() should return END.<DD><DL>
|
| <DT><B>Returns:</B><DD>The root node of the iteration.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isReverse()"><!-- --></A><H3>
|
| isReverse</H3>
|
| <PRE>
|
| public boolean <B>isReverse</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Returns:</B><DD>true if this iterator has a reversed axis, else false.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="cloneIterator()"><!-- --></A><H3>
|
| cloneIterator</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/dtm/DTMAxisIterator.html">DTMAxisIterator</A> <B>cloneIterator</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Returns:</B><DD>a deep copy of this iterator. The clone should not be reset |
| from its current position.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setRestartable(boolean)"><!-- --></A><H3>
|
| setRestartable</H3>
|
| <PRE>
|
| public void <B>setRestartable</B>(boolean isRestartable)</PRE>
|
| <DL>
|
| <DD>Set if restartable.<DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNodeByPosition(int)"><!-- --></A><H3>
|
| getNodeByPosition</H3>
|
| <PRE>
|
| public int <B>getNodeByPosition</B>(int position)</PRE>
|
| <DL>
|
| <DD>Return the node at the given position.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>position</CODE> - The position<DT><B>Returns:</B><DD>The node at the given position.</DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTMAxisIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../org/apache/xml/dtm/DTM.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xml/dtm/DTMFilter.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="DTMAxisIterator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
