Field Detail

• END

  static final int END

  Specifies the end of the iteration, and is the same as DTM.NULL.

  See Also:

  Constant Field Values

Method Detail

• next

  int next()

  Get the next node in the iteration.

  Returns:

  The next node handle in the iteration, or END.

• reset

  DTMAxisIterator reset()

  Resets the iterator to the last start node.

  Returns:

  A DTMAxisIterator, which may or may not be the same as this iterator.

• getLast

  int getLast()

  Returns:

  the number of nodes in this iterator. This may be an expensive operation when called the first time.

• getPosition

  int getPosition()

  Returns:

  The position of the current node in the set, as defined by XPath.

• setMark

  void setMark()

  Remembers the current node for the next call to gotoMark().

• gotoMark

  void gotoMark()

  Restores the current node remembered by setMark().

• setStartNode

  DTMAxisIterator setStartNode​(int node)

  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.

• getStartNode

  int getStartNode()

  Get start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

  Returns:

  The root node of the iteration.

• isReverse

  boolean isReverse()

  Returns:

  true if this iterator has a reversed axis, else false.

• cloneIterator

  DTMAxisIterator cloneIterator()

  Returns:

  a deep copy of this iterator. The clone should not be reset from its current position.

• setRestartable

  void setRestartable​(boolean isRestartable)

  Set if restartable.

• getNodeByPosition

  int getNodeByPosition​(int position)

  Return the node at the given position.

  Parameters:

  position - The position

  Returns:

  The node at the given position.