org.apache.xml.dtm.ref
Class DTMDefaultBaseTraversers.ChildTraverser

java.lang.Object
  org.apache.xml.dtm.DTMAxisTraverser
      org.apache.xml.dtm.ref.DTMDefaultBaseTraversers.ChildTraverser

Enclosing class:

DTMDefaultBaseTraversers

private class DTMDefaultBaseTraversers.ChildTraverser
extends DTMAxisTraverser

Implements traversal of the Ancestor access, in reverse document order.

Constructor Summary

private

DTMDefaultBaseTraversers.ChildTraverser()

Method Summary

int	first(int context) By the nature of the stateless traversal, the context node can not be returned or the iteration will go into an infinate loop.
int	first(int context, int expandedTypeID) By the nature of the stateless traversal, the context node can not be returned or the iteration will go into an infinate loop.
protected int	getNextIndexed(int axisRoot, int nextPotential, int expandedTypeID) Get the next indexed node that matches the expanded type ID.
int	next(int context, int current) Traverse to the next node after the current node.
int	next(int context, int current, int expandedTypeID) Traverse to the next node after the current node that is matched by the expanded type ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

DTMDefaultBaseTraversers.ChildTraverser

private DTMDefaultBaseTraversers.ChildTraverser()

Method Detail

getNextIndexed

protected int getNextIndexed(int axisRoot,
                             int nextPotential,
                             int expandedTypeID)

Get the next indexed node that matches the expanded type ID. Before calling this function, one should first call isIndexed to make sure that the index can contain nodes that match the given expanded type ID.

Parameters:

axisRoot - The root identity of the axis.

nextPotential - The node found must match or occur after this node.

expandedTypeID - The expanded type ID for the request.

Returns:

The node ID or NULL if not found.

first

public int first(int context)

By the nature of the stateless traversal, the context node can not be returned or the iteration will go into an infinate loop. So to traverse an axis, the first function must be used to get the first node.

This method needs to be overloaded only by those axis that process the self node. <\p>

Overrides:

first in class DTMAxisTraverser

Parameters:

context - The context node of this traversal. This is the point that the traversal starts from.

Returns:

the first node in the traversal.

first

public int first(int context,
                 int expandedTypeID)

By the nature of the stateless traversal, the context node can not be returned or the iteration will go into an infinate loop. So to traverse an axis, the first function must be used to get the first node.

This method needs to be overloaded only by those axis that process the self node. <\p>

Overrides:

first in class DTMAxisTraverser

Parameters:

context - The context node of this traversal. This is the point of origin for the traversal -- its "root node" or starting point.

expandedTypeID - The expanded type ID that must match.

Returns:

the first node in the traversal.

next

public int next(int context,
                int current)

Traverse to the next node after the current node.

Specified by:

next in class DTMAxisTraverser

Parameters:

context - The context node of this iteration.

current - The current node of the iteration.

Returns:

the next node in the iteration, or DTM.NULL.

See Also:

DTMAxisTraverser.first(int)

next

public int next(int context,
                int current,
                int expandedTypeID)

Traverse to the next node after the current node that is matched by the expanded type ID.

Specified by:

next in class DTMAxisTraverser

Parameters:

context - The context node of this iteration.

current - The current node of the iteration.

expandedTypeID - The expanded type ID that must match.

Returns:

the next node in the iteration, or DTM.NULL.

See Also:

DTMAxisTraverser.first(int,int)