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:

java.lang.Cloneable, DTMAxisIterator

Direct Known Subclasses:

DTMDefaultBaseIterators.TypedSingletonIterator, SAX2DTM2.TypedSingletonIterator

Enclosing class:

DTMDefaultBaseIterators

public class DTMDefaultBaseIterators.SingletonIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Class SingletonIterator.

Field Summary

private boolean

_isConstant (not sure yet what this is.

Fields inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase

_currentNode

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

_includeSelf, _isRestartable, _last, _markedNode, _position, _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

int	next() Get the next node in the iteration.
DTMAxisIterator	reset() Resets the iterator to the last start node.
DTMAxisIterator	setStartNode(int node) Set start to END should 'close' the iterator, i.e.

Methods inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase

gotoMark, setMark

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

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

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)

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.