Class DTMDefaultBaseTraversers.AllFromRootTraverser

Direct Known Subclasses:
DTMDefaultBaseTraversers.RootTraverser
Enclosing class:
DTMDefaultBaseTraversers

private class DTMDefaultBaseTraversers.AllFromRootTraverser extends DTMDefaultBaseTraversers.AllFromNodeTraverser
Implements traversal of the Ancestor access, in reverse document order.
  • Constructor Details

    • AllFromRootTraverser

      private AllFromRootTraverser()
  • Method Details

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

      Overrides:
      first in class DTMDefaultBaseTraversers.DescendantOrSelfTraverser
      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.

      Overrides:
      first in class DTMDefaultBaseTraversers.DescendantTraverser
      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 extended 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.
      Overrides:
      next in class DTMDefaultBaseTraversers.AllFromNodeTraverser
      Parameters:
      context - The context node of this traversal. This is the point of origin for the traversal -- its "root node" or starting point.
      current - The current node of the traversal. This is the last known location in the traversal, typically the node-handle returned by the previous traversal step. For the first traversal step, context should be set equal to current. Note that in order to test whether context is in the set, you must use the first() method instead.
      Returns:
      the next node in the iteration, or DTM.NULL.
      See Also:
    • next

      public int next(int context, int current, int expandedTypeID)
      Traverse to the next node after the current node that is matched by the extended type ID.
      Overrides:
      next in class DTMDefaultBaseTraversers.DescendantTraverser
      Parameters:
      context - The context node of this traversal. This is the point of origin for the traversal -- its "root node" or starting point.
      current - The current node of the traversal. This is the last known location in the traversal, typically the node-handle returned by the previous traversal step. For the first traversal step, context should be set equal to current. Note that in order to test whether context is in the set, you must use the first() method instead.
      expandedTypeID - The extended type ID that must match.
      Returns:
      the next node in the iteration, or DTM.NULL.
      See Also: