old/xalan-j/apidocs/org/w3c/dom/traversal/NodeIterator.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">  <HTML> <HEAD>  <TITLE> Xalan-Java 2.7.1: Interface NodeIterator </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> </HEAD> <BODY BGCOLOR="white">  <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">Overview</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NodeIterator.html">Use</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2">  <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">PREV CLASS</A>   <A HREF="../../../../org/w3c/dom/traversal/TreeWalker.html">NEXT CLASS</A></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"> <A HREF="../../../../index.html" TARGET="_top">FRAMES</A>    <A HREF="NodeIterator.html" TARGET="_top">NO FRAMES</A></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"> SUMMARY:  INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD> <TD VALIGN="top" CLASS="NavBarCell3"> DETAIL:  FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD> </TR> </TABLE>  <HR>  <H2> org.w3c.dom.traversal Interface NodeIterator</H2> <DL> <DT>All Known Implementing Classes: <DD><A HREF="../../../../org/apache/xml/dtm/ref/DTMNodeIterator.html">DTMNodeIterator</A>, <A HREF="../../../../org/apache/xpath/NodeSet.html">NodeSet</A></DD> </DL> <HR> <DL> <DT>public interface NodeIterator</DL> <code>NodeIterators</code> are used to step through a set of nodes, e.g. the set of nodes in a <code>NodeList</code>, the document subtree governed by a particular <code>Node</code>, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of the <code>NodeIterator</code>. DOM Level 2 specifies a single <code>NodeIterator</code> implementation for document-order traversal of a document subtree. Instances of these <code>NodeIterators</code> are created by calling <code>DocumentTraversal</code><code>.createNodeIterator()</code>. See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>. <DL> <DT>Since: <DD>DOM Level 2</DD> </DL> <HR>     <A NAME="method_summary"></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2> Method Summary</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> void</CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#detach()">detach</A>()</CODE>           Detaches the <code>NodeIterator</code> from the set which it iterated over, releasing any computational resources and placing the <code>NodeIterator</code> in the INVALID state.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> boolean</CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A>()</CODE>           The value of this flag determines whether the children of entity reference nodes are visible to the <code>NodeIterator</code>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A></CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#getFilter()">getFilter</A>()</CODE>           The <code>NodeFilter</code> used to screen nodes.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#getRoot()">getRoot</A>()</CODE>           The root node of the <code>NodeIterator</code>, as specified when it was created.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> int</CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#getWhatToShow()">getWhatToShow</A>()</CODE>           This attribute determines which node types are presented via the <code>NodeIterator</code>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#nextNode()">nextNode</A>()</CODE>           Returns the next node in the set and advances the position of the <code>NodeIterator</code> in the set.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <CODE> <A HREF="../../../../org/w3c/dom/Node.html">Node</A></CODE></TD> <TD><CODE><A HREF="../../../../org/w3c/dom/traversal/NodeIterator.html#previousNode()">previousNode</A>()</CODE>           Returns the previous node in the set and moves the position of the <code>NodeIterator</code> backwards in the set.</TD> </TR> </TABLE>      <A NAME="method_detail"></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1> Method Detail</TD> </TR> </TABLE> <A NAME="getRoot()"></A><H3> getRoot</H3> <PRE> public <A HREF="../../../../org/w3c/dom/Node.html">Node</A> getRoot()</PRE> <DL> <DD>The root node of the <code>NodeIterator</code>, as specified when it was created.</DL> <HR> <A NAME="getWhatToShow()"></A><H3> getWhatToShow</H3> <PRE> public int getWhatToShow()</PRE> <DL> <DD>This attribute determines which node types are presented via the <code>NodeIterator</code>. The available set of constants is defined in the <code>NodeFilter</code> interface. Nodes not accepted by <code>whatToShow</code> will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any.</DL> <HR> <A NAME="getFilter()"></A><H3> getFilter</H3> <PRE> public <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">NodeFilter</A> getFilter()</PRE> <DL> <DD>The <code>NodeFilter</code> used to screen nodes.</DL> <HR> <A NAME="getExpandEntityReferences()"></A><H3> getExpandEntityReferences</H3> <PRE> public boolean getExpandEntityReferences()</PRE> <DL> <DD>The value of this flag determines whether the children of entity reference nodes are visible to the <code>NodeIterator</code>. If false, these children and their descendants will be rejected. Note that this rejection takes precedence over <code>whatToShow</code> and the filter. Also note that this is currently the only situation where <code>NodeIterators</code> may reject a complete subtree rather than skipping individual nodes. To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the <code>whatToShow</code> flags to hide the entity reference node and set <code>expandEntityReferences</code> to true when creating the <code>NodeIterator</code>. To produce a view of the document that has entity reference nodes but no entity expansion, use the <code>whatToShow</code> flags to show the entity reference node and set <code>expandEntityReferences</code> to false.</DL> <HR> <A NAME="nextNode()"></A><H3> nextNode</H3> <PRE> public <A HREF="../../../../org/w3c/dom/Node.html">Node</A> nextNode() throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A></PRE> <DL> <DD>Returns the next node in the set and advances the position of the <code>NodeIterator</code> in the set. After a <code>NodeIterator</code> is created, the first call to <code>nextNode()</code> returns the first node in the set.<DD><DL> <DT>Returns:<DD>The next <code>Node</code> in the set being iterated over, or <code>null</code> if there are no more members in that set.<DT>Throws:<DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - INVALID_STATE_ERR: Raised if this method is called after the <code>detach</code> method was invoked.</DL> </DD> </DL> <HR> <A NAME="previousNode()"></A><H3> previousNode</H3> <PRE> public <A HREF="../../../../org/w3c/dom/Node.html">Node</A> previousNode() throws <A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A></PRE> <DL> <DD>Returns the previous node in the set and moves the position of the <code>NodeIterator</code> backwards in the set.<DD><DL> <DT>Returns:<DD>The previous <code>Node</code> in the set being iterated over, or <code>null</code> if there are no more members in that set.<DT>Throws:<DD><A HREF="../../../../org/w3c/dom/DOMException.html">DOMException</A> - INVALID_STATE_ERR: Raised if this method is called after the <code>detach</code> method was invoked.</DL> </DD> </DL> <HR> <A NAME="detach()"></A><H3> detach</H3> <PRE> public void detach()</PRE> <DL> <DD>Detaches the <code>NodeIterator</code> from the set which it iterated over, releasing any computational resources and placing the <code>NodeIterator</code> 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.</DL>  <HR>  <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">Overview</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NodeIterator.html">Use</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2">  <A HREF="../../../../org/w3c/dom/traversal/NodeFilter.html">PREV CLASS</A>   <A HREF="../../../../org/w3c/dom/traversal/TreeWalker.html">NEXT CLASS</A></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"> <A HREF="../../../../index.html" TARGET="_top">FRAMES</A>    <A HREF="NodeIterator.html" TARGET="_top">NO FRAMES</A></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"> SUMMARY:  INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD> <TD VALIGN="top" CLASS="NavBarCell3"> DETAIL:  FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD> </TR> </TABLE>  <HR> Copyright � 2006 Apache XML Project. All Rights Reserved. </BODY> </HTML>

old/xalan-j/apidocs/org/w3c/dom/traversal/NodeIterator.html (279 lines of code) (raw):