NodeIterator.java revision 320c9890e8241fb0ad05de6fa5e6c3eb3aece159
1320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson/* 2320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Copyright (c) 2000 World Wide Web Consortium, 3320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * (Massachusetts Institute of Technology, Institut National de 4320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Recherche en Informatique et en Automatique, Keio University). All 5320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Rights Reserved. This program is distributed under the W3C's Software 6320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Intellectual Property License. This program is distributed in the 7320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * hope that it will be useful, but WITHOUT ANY WARRANTY; without even 8320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 9320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * PURPOSE. 10320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * See W3C License http://www.w3.org/Consortium/Legal/ for more details. 11320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 12320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 13320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilsonpackage org.w3c.dom.traversal; 14320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 15320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilsonimport org.w3c.dom.Node; 16320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilsonimport org.w3c.dom.DOMException; 17320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 18320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson/** 19320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterators</code> are used to step through a set of nodes, e.g. 20320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * the set of nodes in a <code>NodeList</code>, the document subtree 21320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * governed by a particular <code>Node</code>, the results of a query, or 22320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * any other set of nodes. The set of nodes to be iterated is determined by 23320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * the implementation of the <code>NodeIterator</code>. DOM Level 2 24320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * specifies a single <code>NodeIterator</code> implementation for 25320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * document-order traversal of a document subtree. Instances of these 26320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterators</code> are created by calling 27320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>DocumentTraversal</code><code>.createNodeIterator()</code>. 28320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <p>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>. 29320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * @since DOM Level 2 30320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 31320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilsonpublic interface NodeIterator { 32320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 33320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * The root node of the <code>NodeIterator</code>, as specified when it 34320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * was created. 35320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 36320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public Node getRoot(); 37320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 38320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 39320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * This attribute determines which node types are presented via the 40320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterator</code>. The available set of constants is defined 41320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * in the <code>NodeFilter</code> interface. Nodes not accepted by 42320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>whatToShow</code> will be skipped, but their children may still 43320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * be considered. Note that this skip takes precedence over the filter, 44320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * if any. 45320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 46320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public int getWhatToShow(); 47320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 48320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 49320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * The <code>NodeFilter</code> used to screen nodes. 50320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 51320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public NodeFilter getFilter(); 52320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 53320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 54320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * The value of this flag determines whether the children of entity 55320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * reference nodes are visible to the <code>NodeIterator</code>. If 56320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * false, these children and their descendants will be rejected. Note 57320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * that this rejection takes precedence over <code>whatToShow</code> and 58320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * the filter. Also note that this is currently the only situation where 59320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterators</code> may reject a complete subtree rather than 60320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * skipping individual nodes. 61320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <br> 62320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <br> To produce a view of the document that has entity references 63320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * expanded and does not expose the entity reference node itself, use 64320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * the <code>whatToShow</code> flags to hide the entity reference node 65320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * and set <code>expandEntityReferences</code> to true when creating the 66320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterator</code>. To produce a view of the document that has 67320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * entity reference nodes but no entity expansion, use the 68320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>whatToShow</code> flags to show the entity reference node and 69320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * set <code>expandEntityReferences</code> to false. 70320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 71320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public boolean getExpandEntityReferences(); 72320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 73320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 74320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Returns the next node in the set and advances the position of the 75320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterator</code> in the set. After a 76320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterator</code> is created, the first call to 77320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>nextNode()</code> returns the first node in the set. 78320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * @return The next <code>Node</code> in the set being iterated over, or 79320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>null</code> if there are no more members in that set. 80320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * @exception DOMException 81320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * INVALID_STATE_ERR: Raised if this method is called after the 82320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>detach</code> method was invoked. 83320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 84320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public Node nextNode() 85320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson throws DOMException; 86320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 87320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 88320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Returns the previous node in the set and moves the position of the 89320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterator</code> backwards in the set. 90320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * @return The previous <code>Node</code> in the set being iterated over, 91320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * or <code>null</code> if there are no more members in that set. 92320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * @exception DOMException 93320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * INVALID_STATE_ERR: Raised if this method is called after the 94320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>detach</code> method was invoked. 95320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 96320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public Node previousNode() 97320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson throws DOMException; 98320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 99320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson /** 100320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * Detaches the <code>NodeIterator</code> from the set which it iterated 101320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * over, releasing any computational resources and placing the 102320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>NodeIterator</code> in the INVALID state. After 103320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * <code>detach</code> has been invoked, calls to <code>nextNode</code> 104320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * or <code>previousNode</code> will raise the exception 105320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson * INVALID_STATE_ERR. 106320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson */ 107320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson public void detach(); 108320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson 109320c9890e8241fb0ad05de6fa5e6c3eb3aece159Jesse Wilson} 110