Class SAX2DTM2.ParentIterator

  extended by org.apache.xml.dtm.ref.DTMAxisIteratorBase
      extended by org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
          extended by org.apache.xml.dtm.ref.sax2dtm.SAX2DTM2.ParentIterator
All Implemented Interfaces:
java.lang.Cloneable, DTMAxisIterator
Enclosing class:

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.

Field Summary
private  int _nodeType
          The extended type ID that was requested.
Fields inherited from class org.apache.xml.dtm.ref.DTMDefaultBaseIterators.InternalAxisIteratorBase
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
Constructor Summary
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.
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

Field Detail


private int _nodeType
The extended type ID that was requested.

Constructor Detail


public SAX2DTM2.ParentIterator()
Method Detail


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

node - Sets the root of the iteration.
A DTMAxisIterator set to the start of the iteration.


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".

type - extended type ID.
ParentIterator configured with the type filter set.


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.

The next node handle in the iteration, or END.