org.apache.xml.dtm.ref

Class DTMAxisIteratorBase

public abstract class DTMAxisIteratorBase extends Object implements DTMAxisIterator

This class serves as a default base for implementations of mutable DTMAxisIterators.
Method Summary
DTMAxisIteratorcloneIterator()
Returns a deep copy of this iterator.
intgetAxis()
Returns the axis being iterated, if it is known.
intgetLast()
Returns the position of the last node within the iteration, as defined by XPath.
intgetNodeByPosition(int position)
Return the node at the given position.
intgetPosition()
intgetStartNode()
Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
DTMAxisIteratorincludeSelf()
Set the flag to include the start node in the iteration.
booleanisDocOrdered()
Returns true if all the nodes in the iteration well be returned in document order.
booleanisReverse()
DTMAxisIteratorreset()
voidsetRestartable(boolean isRestartable)

Method Detail

cloneIterator

public DTMAxisIterator cloneIterator()
Returns a deep copy of this iterator. Cloned iterators may not be restartable. The iterator being cloned may or may not become non-restartable as a side effect of this operation.

Returns: a deep copy of this iterator.

getAxis

public int getAxis()
Returns the axis being iterated, if it is known.

Returns: Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.

getLast

public int getLast()
Returns the position of the last node within the iteration, as defined by XPath. In a forward iterator, I believe this equals the number of nodes which this iterator will yield. In a reverse iterator, I believe it should return 1 (since the "last" is the first produced.) This may be an expensive operation when called the first time, since it may have to iterate through a large part of the document to produce its answer.

Returns: The number of nodes in this iterator (forward) or 1 (reverse).

getNodeByPosition

public int getNodeByPosition(int position)
Return the node at the given position.

Parameters: position The position

Returns: The node at the given position.

getPosition

public int getPosition()

Returns: The position of the current node within the set, as defined by XPath. Note that this is one-based, not zero-based.

getStartNode

public int getStartNode()
Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Returns: The root node of the iteration.

includeSelf

public DTMAxisIterator includeSelf()
Set the flag to include the start node in the iteration.

Returns: This default method returns just returns this DTMAxisIterator, after setting the flag. (Returning "this" permits C++-style chaining of method calls into a single expression.)

isDocOrdered

public boolean isDocOrdered()
Returns true if all the nodes in the iteration well be returned in document order.

Returns: true as a default.

isReverse

public boolean isReverse()

Returns: true if this iterator has a reversed axis, else false

reset

public DTMAxisIterator reset()

Returns: A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.

setRestartable

public void setRestartable(boolean isRestartable)
Copyright B) 2005 Apache XML Project. All Rights Reserved.