Class SimpleResultTreeImpl.SimpleIterator

  • All Implemented Interfaces:
    java.lang.Cloneable, DTMAxisIterator
    Enclosing class:
    SimpleResultTreeImpl

    public final class SimpleResultTreeImpl.SimpleIterator
    extends DTMAxisIteratorBase
    The SimpleIterator is designed to support the nodeset() extension function. It has a traversal direction parameter. The DOWN direction is used for child and descendant axes, while the UP direction is used for parent and ancestor axes. This iterator only handles two nodes (RTF_ROOT and RTF_TEXT). If the type is set, it will also match the node type with the given type.
    • Constructor Detail

      • SimpleIterator

        public SimpleIterator()
      • SimpleIterator

        public SimpleIterator​(int direction)
      • SimpleIterator

        public SimpleIterator​(int direction,
                              int type)
    • Method Detail

      • next

        public int next()
        Description copied from interface: DTMAxisIterator
        Get the next node in the iteration.
        Returns:
        The next node handle in the iteration, or END.
      • setStartNode

        public DTMAxisIterator setStartNode​(int nodeHandle)
        Description copied from interface: DTMAxisIterator
        Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
        Parameters:
        nodeHandle - Sets the root of the iteration.
        Returns:
        A DTMAxisIterator set to the start of the iteration.
      • setMark

        public void setMark()
        Description copied from interface: DTMAxisIterator
        Remembers the current node for the next call to gotoMark().
      • gotoMark

        public void gotoMark()
        Description copied from interface: DTMAxisIterator
        Restores the current node remembered by setMark().