Package org.loboevolution.apache.xpath.axes

Class ChildTestIterator

java.lang.Object
org.loboevolution.apache.xpath.Expression
org.loboevolution.apache.xpath.patterns.NodeTest
org.loboevolution.apache.xpath.axes.PredicatedNodeTest
org.loboevolution.apache.xpath.axes.LocPathIterator
org.loboevolution.apache.xpath.axes.BasicTestIterator
org.loboevolution.apache.xpath.axes.ChildTestIterator
All Implemented Interfaces:
Cloneable, SourceLocator, DTMIterator, PathComponent, SubContextList, ExpressionNode, XPathVisitable
Direct Known Subclasses:
AttributeIterator, OneStepIterator, OneStepIteratorForward, UnionChildIterator
public class ChildTestIterator extends BasicTestIterator
This class implements an optimized iterator for children patterns that have a node test, and possibly a predicate.
See Also:

  • Field Details

    • m_traverser

      protected transient DTMAxisTraverser m_traverser
      The traverser to use to navigate over the descendants.

  • Constructor Details

    • ChildTestIterator

      public ChildTestIterator(DTMAxisTraverser traverser)
      Create a ChildTestIterator object.
      Parameters:
      traverser - Traverser that tells how the KeyIterator is to be handled.

  • Method Details

    • getNextNode

      protected int getNextNode()
      Get the next node via getNextXXX. Bottlenecked for derived class override.
      Specified by:
      getNextNode in class BasicTestIterator
      Returns:
      The next node on the axis, or DTM.NULL.

    • cloneWithReset

      public DTMIterator cloneWithReset() throws CloneNotSupportedException
      Get a cloned Iterator that is reset to the start of the iteration.
      Specified by:
      cloneWithReset in interface DTMIterator
      Overrides:
      cloneWithReset in class BasicTestIterator
      Returns:
      A clone of this iteration that has been reset.
      Throws:
      CloneNotSupportedException - if any

    • setRoot

      public void setRoot(int context, Object environment)
      Reset the root node of the DTMIterator, overriding the value specified when it was created. Note the root node is not the root node of the document tree, but the context node from where the iteration begins.
      Specified by:
      setRoot in interface DTMIterator
      Overrides:
      setRoot in class LocPathIterator
      Parameters:
      context - int Handle of the context node.
      environment - The environment object. The environment in which this iterator operates, which should provide:

      a node (the context node... same value as "root" defined below)

      a pair of non-zero positive integers (the context position and the context size)

      a set of variable bindings

      a function library

      the set of namespace declarations in scope for the expression.

      At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.

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

    • detach

      public void detach()
      Detaches the DTMIterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise a runtime exception.
      Specified by:
      detach in interface DTMIterator
      Overrides:
      detach in class LocPathIterator