Package org.apache.xml.dtm.ref.sax2dtm
Class SAX2DTM2.PrecedingIterator
java.lang.Object
org.apache.xml.dtm.ref.DTMAxisIteratorBase
org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
org.apache.xml.dtm.ref.sax2dtm.SAX2DTM2.PrecedingIterator
- All Implemented Interfaces:
Cloneable
,DTMAxisIterator
- Direct Known Subclasses:
SAX2DTM2.TypedPrecedingIterator
- Enclosing class:
- SAX2DTM2
Iterator that returns preceding nodes of a given node.
This includes the node set {root+1, start-1}, but excludes
all ancestors, attributes, and namespace nodes.
-
Field Summary
Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator
END
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a deep copy of this iterator.void
gotoMark()
Restores the current node remembered by setMark().boolean
True if this iterator has a reversed axis.int
next()
Get the next node in the iteration.reset()
Resets the iterator to the last start node.void
setMark()
Remembers the current node for the next call to gotoMark().setStartNode
(int node) Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.Methods inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase
getAxis, getLast, getNodeByPosition, getPosition, getStartNode, includeSelf, isDocOrdered, setRestartable
-
Constructor Details
-
PrecedingIterator
public PrecedingIterator()
-
-
Method Details
-
isReverse
public boolean isReverse()True if this iterator has a reversed axis.- Specified by:
isReverse
in interfaceDTMAxisIterator
- Overrides:
isReverse
in classDTMAxisIteratorBase
- Returns:
- true since this iterator is a reversed axis.
-
cloneIterator
Returns a deep copy of this iterator. The cloned iterator is not reset.- Specified by:
cloneIterator
in interfaceDTMAxisIterator
- Overrides:
cloneIterator
in classDTMAxisIteratorBase
- Returns:
- a deep copy of this iterator.
-
setStartNode
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.- Parameters:
node
- Sets the root of the iteration.- Returns:
- A DTMAxisIterator set to the start of the iteration.
-
next
public int next()Get the next node in the iteration.- Returns:
- The next node handle in the iteration, or END.
-
reset
Resets the iterator to the last start node.- Specified by:
reset
in interfaceDTMAxisIterator
- Overrides:
reset
in classDTMAxisIteratorBase
- Returns:
- A DTMAxisIterator, which may or may not be the same as this iterator.
-
setMark
public void setMark()Description copied from class:DTMDefaultBaseIterators.InternalAxisIteratorBase
Remembers the current node for the next call to gotoMark(). %REVIEW% Should this save _position too?- Specified by:
setMark
in interfaceDTMAxisIterator
- Overrides:
setMark
in classDTMDefaultBaseIterators.InternalAxisIteratorBase
-
gotoMark
public void gotoMark()Description copied from class:DTMDefaultBaseIterators.InternalAxisIteratorBase
Restores the current node remembered by setMark(). %REVEIW% Should this restore _position too?- Specified by:
gotoMark
in interfaceDTMAxisIterator
- Overrides:
gotoMark
in classDTMDefaultBaseIterators.InternalAxisIteratorBase
-