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

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

All Implemented Interfaces:

Cloneable, DTMAxisIterator

Direct Known Subclasses:

DTMDefaultBaseIterators.TypedSingletonIterator

Enclosing class:

DTMDefaultBaseIterators

private class DTMDefaultBaseIterators.SingletonIterator

extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Class SingletonIterator.

Field Summary

protected int	_currentNode Current iteration location.
private boolean	_isConstant (not sure yet what this is.

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.SingletonIterator()
Constructor SingletonIterator

DTMDefaultBaseIterators.SingletonIterator(int node)
Constructor SingletonIterator

DTMDefaultBaseIterators.SingletonIterator(int node, boolean constant)
Constructor SingletonIterator

Method Summary

void	gotoMark() Restores the current node remembered by setMark().
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

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

Methods inherited from class java.lang.Object

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

Field Detail

_isConstant

private boolean _isConstant

(not sure yet what this is. -sb) (sc & sb remove final to compile in JDK 1.1.8)

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

public DTMDefaultBaseIterators.SingletonIterator()

Constructor SingletonIterator

DTMDefaultBaseIterators.SingletonIterator

public DTMDefaultBaseIterators.SingletonIterator(int node)

Constructor SingletonIterator

Parameters:

node - The node handle to return.

DTMDefaultBaseIterators.SingletonIterator

public DTMDefaultBaseIterators.SingletonIterator(int node,
                                                 boolean constant)

Constructor SingletonIterator

Parameters:

node - the node handle to return.

constant - (Not sure what this is yet. -sb)

Method Detail

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?