org.apache.xml.dtm
Interface DTMAxisIterator
- Cloneable
- AbsoluteIterator, CachedNodeListIterator, ClonedNodeListIterator, CurrentNodeListIterator, DTMAxisIteratorBase, DTMDefaultBaseIterators.AncestorIterator, DTMDefaultBaseIterators.AttributeIterator, DTMDefaultBaseIterators.ChildrenIterator, DTMDefaultBaseIterators.DescendantIterator, DTMDefaultBaseIterators.FollowingIterator, DTMDefaultBaseIterators.FollowingSiblingIterator, DTMDefaultBaseIterators.InternalAxisIteratorBase, DTMDefaultBaseIterators.NamespaceAttributeIterator, DTMDefaultBaseIterators.NamespaceChildrenIterator, DTMDefaultBaseIterators.NamespaceIterator, DTMDefaultBaseIterators.NthDescendantIterator, DTMDefaultBaseIterators.ParentIterator, DTMDefaultBaseIterators.PrecedingIterator, DTMDefaultBaseIterators.PrecedingSiblingIterator, DTMDefaultBaseIterators.RootIterator, DTMDefaultBaseIterators.SingletonIterator, DTMDefaultBaseIterators.TypedAncestorIterator, DTMDefaultBaseIterators.TypedAttributeIterator, DTMDefaultBaseIterators.TypedChildrenIterator, DTMDefaultBaseIterators.TypedDescendantIterator, DTMDefaultBaseIterators.TypedFollowingIterator, DTMDefaultBaseIterators.TypedFollowingSiblingIterator, DTMDefaultBaseIterators.TypedNamespaceIterator, DTMDefaultBaseIterators.TypedPrecedingIterator, DTMDefaultBaseIterators.TypedPrecedingSiblingIterator, DTMDefaultBaseIterators.TypedRootIterator, DTMDefaultBaseIterators.TypedSingletonIterator, DupFilterIterator, EmptyIterator, FilteredStepIterator, FilterIterator, ForwardPositionIterator, KeyIndex, KeyIndex.KeyIndexIterator, MatchingIterator, MultiValuedNodeHeapIterator, NthIterator, SAX2DTM2.AncestorIterator, SAX2DTM2.AttributeIterator, SAX2DTM2.ChildrenIterator, SAX2DTM2.DescendantIterator, SAX2DTM2.FollowingIterator, SAX2DTM2.FollowingSiblingIterator, SAX2DTM2.ParentIterator, SAX2DTM2.PrecedingIterator, SAX2DTM2.PrecedingSiblingIterator, SAX2DTM2.TypedAncestorIterator, SAX2DTM2.TypedAttributeIterator, SAX2DTM2.TypedChildrenIterator, SAX2DTM2.TypedDescendantIterator, SAX2DTM2.TypedFollowingIterator, SAX2DTM2.TypedFollowingSiblingIterator, SAX2DTM2.TypedPrecedingIterator, SAX2DTM2.TypedPrecedingSiblingIterator, SAX2DTM2.TypedRootIterator, SAX2DTM2.TypedSingletonIterator, SAXImpl.NamespaceAttributeIterator, SAXImpl.NamespaceChildrenIterator, SAXImpl.NamespaceWildcardIterator, SAXImpl.TypedNamespaceIterator, SimpleResultTreeImpl.SimpleIterator, SimpleResultTreeImpl.SingletonIterator, SingletonIterator, SortingIterator, StepIterator, UnionIterator
public interface DTMAxisIterator
extends Cloneable
This class iterates over a single XPath Axis, and returns node handles.
static int | END - Specifies the end of the iteration, and is the same as DTM.NULL.
|
END
public static final int END
Specifies the end of the iteration, and is the same as DTM.NULL.
cloneIterator
public DTMAxisIterator cloneIterator()
- a deep copy of this iterator. The clone should not be reset
from its current position.
getLast
public int getLast()
- the number of nodes in this iterator. This may be an expensive
operation when called the first time.
getNodeByPosition
public int getNodeByPosition(int position)
Return the node at the given position.
- The node at the given position.
getPosition
public int getPosition()
- The position of the current node in the set, as defined by XPath.
getStartNode
public int getStartNode()
Get start to END should 'close' the iterator,
i.e. subsequent call to next() should return END.
- The root node of the iteration.
gotoMark
public void gotoMark()
Restores the current node remembered by setMark().
isReverse
public boolean isReverse()
- true if this iterator has a reversed axis, else false.
next
public int next()
Get the next node in the iteration.
- The next node handle in the iteration, or END.
reset
public DTMAxisIterator reset()
Resets the iterator to the last start node.
- A DTMAxisIterator, which may or may not be the same as this
iterator.
setMark
public void setMark()
Remembers the current node for the next call to gotoMark().
setRestartable
public void setRestartable(boolean isRestartable)
Set if restartable.
setStartNode
public DTMAxisIterator setStartNode(int node)
Set start to END should 'close' the iterator,
i.e. subsequent call to next() should return END.
node
- Sets the root of the iteration.
- A DTMAxisIterator set to the start of the iteration.
Copyright © 2006 Apache XML Project. All Rights Reserved.