Package org.apache.xpath.axes

Class ChildIterator

java.lang.Object
org.apache.xpath.Expression
org.apache.xpath.patterns.NodeTest
org.apache.xpath.axes.PredicatedNodeTest
org.apache.xpath.axes.LocPathIterator
org.apache.xpath.axes.ChildIterator
All Implemented Interfaces:
Serializable, Cloneable, SourceLocator, DTMIterator, PathComponent, SubContextList, ExpressionNode, XPathVisitable
public class ChildIterator extends LocPathIterator
This class implements an optimized iterator for "node()" patterns, that is, any children of the context node.
See Also:

  • Method Details

    • asNode

      public int asNode(XPathContext xctxt) throws TransformerException
      Return the first node out of the nodeset, if this expression is a nodeset expression. This is the default implementation for nodesets.

      WARNING: Do not mutate this class from this function!

      Overrides:
      asNode in class LocPathIterator
      Parameters:
      xctxt - The XPath runtime context.
      Returns:
      the first node out of the nodeset, or DTM.NULL.
      Throws:
      TransformerException

    • nextNode

      public int nextNode()
      Returns the next node in the set and advances the position of the iterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.
      Specified by:
      nextNode in interface DTMIterator
      Specified by:
      nextNode in class LocPathIterator
      Returns:
      The next Node in the set being iterated over, or null if there are no more members in that set.

    • getAxis

      public int getAxis()
      Returns the axis being iterated, if it is known.
      Specified by:
      getAxis in interface DTMIterator
      Overrides:
      getAxis in class LocPathIterator
      Returns:
      Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.