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

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

All Implemented Interfaces:

Cloneable, DTMAxisIterator

Enclosing class:

DTMDefaultBaseIterators

private final class DTMDefaultBaseIterators.ChildrenIterator

extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns all immediate children of a given node

Field Summary

protected int

_currentNode Current iteration location.

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.ChildrenIterator()

Method Summary

void	gotoMark() Restores the current node remembered by setMark().
int	next() Get the next node in the iteration.
void	setMark() Remembers the current node for the next call to gotoMark().
DTMAxisIterator	setStartNode(int node) Setting 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

cloneIterator, getAxis, getLast, getPosition, getStartNode, includeSelf, isDocOrdered, isReverse, reset, resetPosition, returnNode

Methods inherited from class java.lang.Object

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

Field Detail

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

private DTMDefaultBaseIterators.ChildrenIterator()

Method Detail

setStartNode

public DTMAxisIterator setStartNode(int node)

Setting start to END should 'close' the iterator, i.e. subsequent call to next() should return END. If the iterator is not restartable, this has no effect. %REVIEW% Should it return/throw something in that case, or set current node to END, to indicate request-not-honored?

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 if no more are available.

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?