Package org.apache.xml.dtm.ref.sax2dtm

Class SAX2DTM2.TypedAncestorIterator

java.lang.Object

org.apache.xml.dtm.ref.DTMAxisIteratorBase

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

org.apache.xml.dtm.ref.sax2dtm.SAX2DTM2.AncestorIterator

org.apache.xml.dtm.ref.sax2dtm.SAX2DTM2.TypedAncestorIterator

All Implemented Interfaces:

Cloneable, DTMAxisIterator

Enclosing class:

SAX2DTM2

public final class SAX2DTM2.TypedAncestorIterator
extends SAX2DTM2.AncestorIterator

Typed iterator that returns the ancestors of a given node.

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
TypedAncestorIterator(int type)	Constructor TypedAncestorIterator

Method Summary

Modifier and Type	Method	Description
int	getLast()	Returns the position of the last node within the iteration, as defined by XPath.
int	getNodeByPosition(int position)	Return the node at the given position.
DTMAxisIterator	setStartNode(int node)	Set start to END should 'close' the iterator, i.e.

Methods inherited from class org.apache.xml.dtm.ref.sax2dtm.SAX2DTM2.AncestorIterator

cloneIterator, getStartNode, gotoMark, isReverse, next, reset, setMark

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

getAxis, getPosition, includeSelf, isDocOrdered, resetPosition, returnNode, setRestartable

Methods inherited from class java.lang.Object

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

Constructor Details

TypedAncestorIterator

public TypedAncestorIterator(int type)

Constructor TypedAncestorIterator

Parameters:

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

Specified by:

setStartNode in interface DTMAxisIterator

Overrides:

setStartNode in class SAX2DTM2.AncestorIterator

Parameters:

node - Sets the root of the iteration.

Returns:

A DTMAxisIterator set to the start of the iteration.

getNodeByPosition

public int getNodeByPosition(int position)

Return the node at the given position.

Specified by:

getNodeByPosition in interface DTMAxisIterator

Overrides:

getNodeByPosition in class DTMAxisIteratorBase

Parameters:

position - The position

Returns:

The node at the given position.

getLast

public int getLast()

Returns the position of the last node within the iteration, as defined by XPath.

Specified by:

getLast in interface DTMAxisIterator

Overrides:

getLast in class DTMAxisIteratorBase

Returns:

The number of nodes in this iterator (forward) or 1 (reverse).