Class AbsoluteIterator

java.lang.Object
org.apache.xml.dtm.ref.DTMAxisIteratorBase
org.apache.xalan.xsltc.dom.AbsoluteIterator
All Implemented Interfaces:
Cloneable, DTMAxisIterator

public final class AbsoluteIterator extends DTMAxisIteratorBase
Absolute iterators ignore the node that is passed to setStartNode(). Instead, they always start from the root node. The node passed to setStartNode() is not totally useless, though. It is needed to obtain the DOM mask, i.e. the index into the MultiDOM table that corresponds to the DOM "owning" the node. The DOM mask is cached, so successive calls to setStartNode() passing nodes from other DOMs will have no effect (i.e. this iterator cannot migrate between DOMs).
Author:
Jacek Ambroziak, Santiago Pericas-Geertsen
  • Constructor Details

  • Method Details

    • setRestartable

      public void setRestartable(boolean isRestartable)
      Description copied from interface: DTMAxisIterator
      Set if restartable.
      Specified by:
      setRestartable in interface DTMAxisIterator
      Overrides:
      setRestartable in class DTMAxisIteratorBase
    • setStartNode

      public DTMAxisIterator setStartNode(int node)
      Description copied from interface: DTMAxisIterator
      Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
      Parameters:
      node - Sets the root of the iteration.
      Returns:
      A DTMAxisIterator set to the start of the iteration.
    • 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.
    • cloneIterator

      public DTMAxisIterator cloneIterator()
      Description copied from class: DTMAxisIteratorBase
      Returns a deep copy of this iterator. Cloned iterators may not be restartable. The iterator being cloned may or may not become non-restartable as a side effect of this operation.
      Specified by:
      cloneIterator in interface DTMAxisIterator
      Overrides:
      cloneIterator in class DTMAxisIteratorBase
      Returns:
      a deep copy of this iterator.
    • reset

      public DTMAxisIterator reset()
      Description copied from interface: DTMAxisIterator
      Resets the iterator to the last start node.
      Specified by:
      reset in interface DTMAxisIterator
      Overrides:
      reset in class DTMAxisIteratorBase
      Returns:
      A DTMAxisIterator which has been reset to the start node, which may or may not be the same as this iterator.
    • 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().