org.apache.xml.dtm.ref
Class DTMDefaultBaseIterators.AncestorIterator

java.lang.Object
  org.apache.xml.dtm.ref.DTMAxisIteratorBase
      org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
          org.apache.xml.dtm.ref.DTMDefaultBaseIterators.AncestorIterator

All Implemented Interfaces:

Cloneable, DTMAxisIterator

Direct Known Subclasses:

DTMDefaultBaseIterators.TypedAncestorIterator

Enclosing class:

DTMDefaultBaseIterators

private class DTMDefaultBaseIterators.AncestorIterator

extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns the ancestors of a given node in document order. (NOTE! This was changed from the XSLTC code!)

Field Summary

protected int	_currentNode Current iteration location.
(package private) NodeVector	m_ancestors
(package private) int	m_ancestorsPos
(package private) int	m_realStartNode The real start node for this axes, since _startNode will be adjusted.

Fields inherited from class org.apache.xml.dtm.ref.DTMAxisIteratorBase

_includeSelf, _isRestartable, _markedNode, _startNode

Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator

END

Constructor Summary

private

DTMDefaultBaseIterators.AncestorIterator()

Method Summary

DTMAxisIterator	cloneIterator() Returns a deep copy of this iterator.
int	getLast() Returns the last element in this interation.
int	getStartNode() Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
void	gotoMark() Restores the current node remembered by setMark().
boolean	isReverse() True if this iterator has a reversed axis.
int	next() Get the next node in the iteration.
DTMAxisIterator	reset() Resets the iterator to the last start node.
void	setMark() Remembers the current node for the next call to gotoMark().
DTMAxisIterator	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, getPosition, includeSelf, isDocOrdered, resetPosition, returnNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_ancestors

NodeVector m_ancestors

m_ancestorsPos

int m_ancestorsPos

m_realStartNode

int m_realStartNode

The real start node for this axes, since _startNode will be adjusted.

_currentNode

protected int _currentNode

Current iteration location. Usually this is the last location returned (starting point for the next() search); for single-node iterators it may instead be initialized to point to that single node.

Constructor Detail

DTMDefaultBaseIterators.AncestorIterator

private DTMDefaultBaseIterators.AncestorIterator()

Method Detail

getStartNode

public int getStartNode()

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

Specified by:

getStartNode in interface DTMAxisIterator

Overrides:

getStartNode in class DTMAxisIteratorBase

Returns:

The root node of the iteration.

isReverse

public final boolean isReverse()

True if this iterator has a reversed axis.

Specified by:

isReverse in interface DTMAxisIterator

Overrides:

isReverse in class DTMAxisIteratorBase

Returns:

true since this iterator is a reversed axis.

getLast

public int getLast()

Returns the last element in this interation. %TBD% %BUG% This is returning a nodeHandle rather than a _position value. That conflicts with what everyone else is doing. And it's talking about the start node, which conflicts with some of the other reverse iterators. DEFINITE BUG; needs to be reconciled.

Specified by:

getLast in interface DTMAxisIterator

Overrides:

getLast in class DTMAxisIteratorBase

Returns:

the last element in this interation.

cloneIterator

public DTMAxisIterator cloneIterator()

Returns a deep copy of this iterator. The cloned iterator is not reset.

Specified by:

cloneIterator in interface DTMAxisIterator

Overrides:

cloneIterator in class DTMAxisIteratorBase

Returns:

a deep copy of this iterator.

setStartNode

public DTMAxisIterator setStartNode(int node)

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.

reset

public DTMAxisIterator reset()

Resets the iterator to the last start node.

Specified by:

reset in interface DTMAxisIterator

Overrides:

reset in class DTMAxisIteratorBase

Returns:

A DTMAxisIterator, which may or may not be the same as this iterator.

next

public int next()

Get the next node in the iteration.

Returns:

The next node handle in the iteration, or END.

setMark

public void setMark()

Remembers the current node for the next call to gotoMark(). %REVIEW% Should this save _position too?

gotoMark

public void gotoMark()

Restores the current node remembered by setMark(). %REVEIW% Should this restore _position too?