19f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 29f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one 39f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or more contributor license agreements. See the NOTICE file 49f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed with this work for additional information 59f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * regarding copyright ownership. The ASF licenses this file 69f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * to you under the Apache License, Version 2.0 (the "License"); 79f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * you may not use this file except in compliance with the License. 89f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * You may obtain a copy of the License at 99f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Unless required by applicable law or agreed to in writing, software 139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * See the License for the specific language governing permissions and 169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * limitations under the License. 179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * $Id: DTMAxisIteratorBase.java 468653 2006-10-28 07:07:05Z minchau $ 209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpackage org.apache.xml.dtm.ref; 229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xml.dtm.DTMAxisIterator; 249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/** 269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * This class serves as a default base for implementations of mutable 279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * DTMAxisIterators. 289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpublic abstract class DTMAxisIteratorBase implements DTMAxisIterator 309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson{ 319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** The position of the last node within the iteration, as defined by XPath. 339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Note that this is _not_ the node's handle within the DTM. Also, don't 349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * confuse it with the current (most recently returned) position. 359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected int _last = -1; 379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** The position of the current node within the iteration, as defined by XPath. 399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Note that this is _not_ the node's handle within the DTM! 409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected int _position = 0; 429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** The position of the marked node within the iteration; 449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * a saved itaration state that we may want to come back to. 459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Note that only one mark is maintained; there is no stack. 469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected int _markedNode; 489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** The handle to the start, or root, of the iteration. 509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Set this to END to construct an empty iterator. 519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected int _startNode = DTMAxisIterator.END; 539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** True if the start node should be considered part of the iteration. 559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * False will cause it to be skipped. 569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected boolean _includeSelf = false; 589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** True if this iteration can be restarted. False otherwise (eg, if 609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * we are iterating over a stream that can not be re-scanned, or if 619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * the iterator was produced by cloning another iterator.) 629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected boolean _isRestartable = true; 649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Get start to END should 'close' the iterator, 679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * i.e. subsequent call to next() should return END. 689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The root node of the iteration. 709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getStartNode() 729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return _startNode; 749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return A DTMAxisIterator which has been reset to the start node, 789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * which may or may not be the same as this iterator. 799f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * */ 809f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public DTMAxisIterator reset() 819f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 829f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 839f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson final boolean temp = _isRestartable; 849f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 859f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _isRestartable = true; 869f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 879f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson setStartNode(_startNode); 889f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 899f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _isRestartable = temp; 909f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 919f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return this; 929f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 939f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 949f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 959f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Set the flag to include the start node in the iteration. 969f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 979f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 989f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return This default method returns just returns this DTMAxisIterator, 999f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * after setting the flag. 1009f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * (Returning "this" permits C++-style chaining of 1019f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * method calls into a single expression.) 1029f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1039f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public DTMAxisIterator includeSelf() 1049f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1059f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1069f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _includeSelf = true; 1079f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1089f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return this; 1099f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** Returns the position of the last node within the iteration, as 1129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * defined by XPath. In a forward iterator, I believe this equals the number of nodes which this 1139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * iterator will yield. In a reverse iterator, I believe it should return 1149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1 (since the "last" is the first produced.) 1159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * This may be an expensive operation when called the first time, since 1179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * it may have to iterate through a large part of the document to produce 1189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * its answer. 1199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The number of nodes in this iterator (forward) or 1 (reverse). 1219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getLast() 1239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson if (_last == -1) // Not previously established 1269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // Note that we're doing both setMark() -- which saves _currentChild 1289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // -- and explicitly saving our position counter (number of nodes 1299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // yielded so far). 1309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // 1319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // %REVIEW% Should position also be saved by setMark()? 1329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // (It wasn't in the XSLTC version, but I don't understand why not.) 1339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson final int temp = _position; // Save state 1359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson setMark(); 1369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson reset(); // Count the nodes found by this iterator 1389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson do 1399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _last++; 1419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson while (next() != END); 1439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson gotoMark(); // Restore saved state 1459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _position = temp; 1469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return _last; 1499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The position of the current node within the set, as defined by 1539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * XPath. Note that this is one-based, not zero-based. 1549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getPosition() 1569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return _position == 0 ? 1 : _position; 1589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return true if this iterator has a reversed axis, else false 1629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public boolean isReverse() 1649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return false; 1669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Returns a deep copy of this iterator. Cloned iterators may not be 1709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * restartable. The iterator being cloned may or may not become 1719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * non-restartable as a side effect of this operation. 1729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return a deep copy of this iterator. 1749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public DTMAxisIterator cloneIterator() 1769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson try 1799f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1809f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson final DTMAxisIteratorBase clone = (DTMAxisIteratorBase) super.clone(); 1819f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1829f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson clone._isRestartable = false; 1839f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1849f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // return clone.reset(); 1859f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return clone; 1869f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1879f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson catch (CloneNotSupportedException e) 1889f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1899f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson throw new org.apache.xml.utils.WrappedRuntimeException(e); 1909f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1919f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1929f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1939f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 1949f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Do any final cleanup that is required before returning the node that was 1959f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * passed in, and then return it. The intended use is 1969f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <br /> 1979f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <code>return returnNode(node);</code> 1989f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1999f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * %REVIEW% If we're calling it purely for side effects, should we really 2009f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * be bothering with a return value? Something like 2019f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <br /> 2029f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <code> accept(node); return node; </code> 2039f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <br /> 2049f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * would probably optimize just about as well and avoid questions 2059f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * about whether what's returned could ever be different from what's 2069f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * passed in. 2079f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2089f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param node Node handle which iteration is about to yield. 2099f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The node handle passed in. */ 2119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected final int returnNode(final int node) 2129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 2139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _position++; 2149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return node; 2169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 2199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Reset the position to zero. NOTE that this does not change the iteration 2209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * state, only the position number associated with that state. 2219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * %REVIEW% Document when this would be used? 2239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return This instance. 2259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 2269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson protected final DTMAxisIterator resetPosition() 2279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 2289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _position = 0; 2309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return this; 2329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 2359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Returns true if all the nodes in the iteration well be returned in document 2369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * order. 2379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return true as a default. 2399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 2409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public boolean isDocOrdered() 2419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 2429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return true; 2439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 2469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Returns the axis being iterated, if it is known. 2479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return Axis.CHILD, etc., or -1 if the axis is not known or is of multiple 2499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * types. 2509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 2519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getAxis() 2529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 2539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return -1; 2549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void setRestartable(boolean isRestartable) { 2579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson _isRestartable = isRestartable; 2589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 2619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Return the node at the given position. 2629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 2639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param position The position 2649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The node at the given position. 2659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 2669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getNodeByPosition(int position) 2679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 2689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson if (position > 0) { 2699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson final int pos = isReverse() ? getLast() - position + 1 2709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson : position; 2719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson int node; 2729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson while ((node = next()) != DTMAxisIterator.END) { 2739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson if (pos == getPosition()) { 2749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return node; 2759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return END; 2799f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 2809f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 2819f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson} 282