org.apache.xml.dtm.ref.sax2dtm

Class SAX2DTM2.ParentIterator

public final class SAX2DTM2.ParentIterator extends 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.
Method Summary
intnext()
Get the next node in the iteration.
DTMAxisIteratorsetNodeType(int type)
Set the node type of the parent that we're looking for.
DTMAxisIteratorsetStartNode(int node)
Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Method Detail

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.

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.

Parameters: node Sets the root of the iteration.

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

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