org.apache.xml.dtm.ref.sax2dtm

Class SAX2DTM2.ParentIterator

Enclosing Class:
SAX2DTM2
Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class SAX2DTM2.ParentIterator
extends DTMDefaultBaseIterators.InternalAxisIteratorBase

Iterator that returns the parent of a given node. Note that this delivers only a single node; if you want all the ancestors, see AncestorIterator.

Nested Class Summary

Fields inherited from interface org.apache.xml.dtm.DTMAxisIterator

END

Method Summary

int
next()
Get the next node in the iteration.
DTMAxisIterator
setNodeType(int type)
Set the node type of the parent that we're looking for.
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.DTMDefaultBaseIterators.InternalAxisIteratorBase

gotoMark, setMark

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

cloneIterator, getAxis, getLast, getNodeByPosition, getPosition, getStartNode, includeSelf, isDocOrdered, isReverse, reset, setRestartable

Method Details

next

public int next()
Get the next node in the iteration. In this case, we return only the immediate parent, _if_ it matches the requested nodeType.
Specified by:
next in interface DTMAxisIterator

Returns:
The next node handle in the iteration, or END.


setNodeType

public DTMAxisIterator setNodeType(int type)
Set the node type of the parent that we're looking for. Note that this does _not_ mean "find the nearest ancestor of this type", but "yield the parent if it is of this type".

Parameters:
type - extended type ID.

Returns:
ParentIterator configured with the type filter set.


setStartNode

public DTMAxisIterator setStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
Specified by:
setStartNode in interface DTMAxisIterator

Parameters:
node - Sets the root of the iteration.

Returns:
A DTMAxisIterator set to the start of the iteration.


Copyright B) 2004 Apache XML Project. All Rights Reserved.