| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:58 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Interface ContextNodeList
|
| </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/ContextNodeList.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">
|
| PREV CLASS
|
| <A HREF="../../../../org/apache/xpath/axes/PathComponent.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="ContextNodeList.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | 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.xpath.axes</FONT>
|
| <BR>
|
| Interface ContextNodeList</H2>
|
| <DL>
|
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xpath/NodeSet.html">NodeSet</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public interface <B>ContextNodeList</B></DL>
|
|
|
| <P>
|
| Classes who implement this interface can be a |
| <a href="http://www.w3.org/TR/xslt#dt-current-node-list">current node list</a>, |
| also refered to here as a <term>context node list</term>.
|
| <P>
|
| <DL>
|
| <DT><B>Usage:</B><DD><i><font size="-1" color="#00FF00"> **For advanced use only**</font></i></DD> |
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
| <!-- ======== 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> java.lang.Object</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/ContextNodeList.html#clone()">clone</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a clone of this iterator.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/ContextNodeList.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a cloned Iterator that is reset to the start of the iteration.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/ContextNodeList.html#getCurrentNode()">getCurrentNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the <a href="http://www.w3.org/TR/xslt#dt-current-node">current node</a>.</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/xpath/axes/ContextNodeList.html#getCurrentPos()">getCurrentPos</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the current position, which is one less than |
| the next nextNode() call will retrieve.</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/xpath/axes/ContextNodeList.html#getLast()">getLast</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the index of the last node in this list.</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/xpath/axes/ContextNodeList.html#isFresh()">isFresh</A></B>()</CODE>
|
|
|
| <BR>
|
| Tells if this NodeSetDTM is "fresh", in other words, if |
| the first nextNode() that is called will return the |
| first node in the set.</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/xpath/axes/ContextNodeList.html#reset()">reset</A></B>()</CODE>
|
|
|
| <BR>
|
| Reset the iterator.</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/xpath/axes/ContextNodeList.html#runTo(int)">runTo</A></B>(int index)</CODE>
|
|
|
| <BR>
|
| If an index is requested, NodeSetDTM will call this method |
| to run the iterator to the index.</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/xpath/axes/ContextNodeList.html#setCurrentPos(int)">setCurrentPos</A></B>(int i)</CODE>
|
|
|
| <BR>
|
| Set the current position in the node set.</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/xpath/axes/ContextNodeList.html#setLast(int)">setLast</A></B>(int last)</CODE>
|
|
|
| <BR>
|
| Set the index of the last node in this list.</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/xpath/axes/ContextNodeList.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></B>(boolean b)</CODE>
|
|
|
| <BR>
|
| If setShouldCacheNodes(true) is called, then nodes will |
| be cached.</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/xpath/axes/ContextNodeList.html#size()">size</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the length of the list.</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
| <!-- ========= 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="getCurrentNode()"><!-- --></A><H3>
|
| getCurrentNode</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/Node.html">Node</A> <B>getCurrentNode</B>()</PRE>
|
| <DL>
|
| <DD>Get the <a href="http://www.w3.org/TR/xslt#dt-current-node">current node</a>.<DD><DL>
|
| <DT><B>Returns:</B><DD>The current node, or null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCurrentPos()"><!-- --></A><H3>
|
| getCurrentPos</H3>
|
| <PRE>
|
| public int <B>getCurrentPos</B>()</PRE>
|
| <DL>
|
| <DD>Get the current position, which is one less than |
| the next nextNode() call will retrieve. i.e. if |
| you call getCurrentPos() and the return is 0, the next |
| fetch will take place at index 1.<DD><DL>
|
| <DT><B>Returns:</B><DD>The position of the |
| <a href="http://www.w3.org/TR/xslt#dt-current-node">current node</a> |
| in the <a href="http://www.w3.org/TR/xslt#dt-current-node-list">current node list</a>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="reset()"><!-- --></A><H3>
|
| reset</H3>
|
| <PRE>
|
| public void <B>reset</B>()</PRE>
|
| <DL>
|
| <DD>Reset the iterator.</DL>
|
| <HR>
|
|
|
| <A NAME="setShouldCacheNodes(boolean)"><!-- --></A><H3>
|
| setShouldCacheNodes</H3>
|
| <PRE>
|
| public void <B>setShouldCacheNodes</B>(boolean b)</PRE>
|
| <DL>
|
| <DD>If setShouldCacheNodes(true) is called, then nodes will |
| be cached. They are not cached by default.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>b</CODE> - true if the nodes should be cached.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="runTo(int)"><!-- --></A><H3>
|
| runTo</H3>
|
| <PRE>
|
| public void <B>runTo</B>(int index)</PRE>
|
| <DL>
|
| <DD>If an index is requested, NodeSetDTM will call this method |
| to run the iterator to the index. By default this sets |
| m_next to the index. If the index argument is -1, this |
| signals that the iterator should be run to the end.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>index</CODE> - The index to run to, or -1 if the iterator should be run |
| to the end.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setCurrentPos(int)"><!-- --></A><H3>
|
| setCurrentPos</H3>
|
| <PRE>
|
| public void <B>setCurrentPos</B>(int i)</PRE>
|
| <DL>
|
| <DD>Set the current position in the node set.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>i</CODE> - Must be a valid index.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="size()"><!-- --></A><H3>
|
| size</H3>
|
| <PRE>
|
| public int <B>size</B>()</PRE>
|
| <DL>
|
| <DD>Get the length of the list.<DD><DL>
|
| <DT><B>Returns:</B><DD>The number of nodes in this node list.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isFresh()"><!-- --></A><H3>
|
| isFresh</H3>
|
| <PRE>
|
| public boolean <B>isFresh</B>()</PRE>
|
| <DL>
|
| <DD>Tells if this NodeSetDTM is "fresh", in other words, if |
| the first nextNode() that is called will return the |
| first node in the set.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if the iteration of this list has not yet begun.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="cloneWithReset()"><!-- --></A><H3>
|
| cloneWithReset</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> <B>cloneWithReset</B>() |
| throws java.lang.CloneNotSupportedException</PRE>
|
| <DL>
|
| <DD>Get a cloned Iterator that is reset to the start of the iteration.<DD><DL>
|
| <DT><B>Returns:</B><DD>A clone of this iteration that has been reset.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="clone()"><!-- --></A><H3>
|
| clone</H3>
|
| <PRE>
|
| public java.lang.Object <B>clone</B>() |
| throws java.lang.CloneNotSupportedException</PRE>
|
| <DL>
|
| <DD>Get a clone of this iterator. Be aware that this operation may be |
| somewhat expensive.<DD><DL>
|
| <DT><B>Returns:</B><DD>A clone of this object.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLast()"><!-- --></A><H3>
|
| getLast</H3>
|
| <PRE>
|
| public int <B>getLast</B>()</PRE>
|
| <DL>
|
| <DD>Get the index of the last node in this list.<DD><DL>
|
| <DT><B>Returns:</B><DD>the index of the last node in this list.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setLast(int)"><!-- --></A><H3>
|
| setLast</H3>
|
| <PRE>
|
| public void <B>setLast</B>(int last)</PRE>
|
| <DL>
|
| <DD>Set the index of the last node in this list.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>last</CODE> - the index of the last node in this list.</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/ContextNodeList.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">
|
| PREV CLASS
|
| <A HREF="../../../../org/apache/xpath/axes/PathComponent.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="ContextNodeList.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | 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>
|
