Package org.apache.xml.dtm.ref

Class DTMDefaultBaseIterators.TypedChildrenIterator

java.lang.Object

org.apache.xml.dtm.ref.DTMAxisIteratorBase

org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase

org.apache.xml.dtm.ref.DTMDefaultBaseIterators.TypedChildrenIterator

All Implemented Interfaces:

Cloneable, DTMAxisIterator

Enclosing class:

DTMDefaultBaseIterators

public final class DTMDefaultBaseIterators.TypedChildrenIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns children of a given type for a given node. The functionality chould be achieved by putting a filter on top of a basic child iterator, but a specialised iterator is used for efficiency (both speed and size of translet).

Field Summary

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

Constructors

Constructor	Description
TypedChildrenIterator(int nodeType)	Constructor TypedChildrenIterator

Method Summary

Modifier and Type	Method	Description
int	next()	Get the next node in the iteration.
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, reset, resetPosition, returnNode, setRestartable

Methods inherited from class java.lang.Object

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

Constructor Details

TypedChildrenIterator

public TypedChildrenIterator(int nodeType)

Constructor TypedChildrenIterator

Parameters:

nodeType - The extended type ID being requested.

Method Details

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.

next

public int next()

Get the next node in the iteration.

Returns:

The next node handle in the iteration, or END.