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

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

All Implemented Interfaces:

Cloneable, DTMAxisIterator

Enclosing class:

DTMDefaultBaseIterators

private final class DTMDefaultBaseIterators.TypedPrecedingIterator

extends DTMDefaultBaseIterators.PrecedingIterator

Iterator that returns preceding nodes of agiven type for a given node. This includes the node set {root+1, start-1}, but excludes all ancestors.

Field Summary

protected int	_currentNode Current iteration location.
private int	_nodeType The extended type ID that was requested.

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

DTMDefaultBaseIterators.TypedPrecedingIterator(int type)
Constructor TypedPrecedingIterator

Method Summary

DTMAxisIterator	cloneIterator() Returns a deep copy of this iterator.
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, getLast, getPosition, getStartNode, includeSelf, isDocOrdered, resetPosition, returnNode

Methods inherited from class java.lang.Object

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

Field Detail

_nodeType

private final int _nodeType

The extended type ID that was requested.

_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.TypedPrecedingIterator

public DTMDefaultBaseIterators.TypedPrecedingIterator(int type)

Constructor TypedPrecedingIterator

Parameters:

type - The extended type ID being requested.

Method Detail

next

public int next()

Get the next node in the iteration.

Specified by:

next in interface DTMAxisIterator

Overrides:

next in class DTMDefaultBaseIterators.PrecedingIterator

Returns:

The next node handle in the iteration, or END.

isReverse

public 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.

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.

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?