Class ChildTestIterator

All Implemented Interfaces:
Serializable, Cloneable, SourceLocator, DTMIterator, PathComponent, SubContextList, ExpressionNode, XPathVisitable
Direct Known Subclasses:
AttributeIterator, KeyRefIterator, 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:
  • Constructor Details

    • ChildTestIterator

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

    • cloneWithReset

      public DTMIterator cloneWithReset() throws CloneNotSupportedException
      Get a cloned Iterator that is reset to the beginning of the query.
      Specified by:
      cloneWithReset in interface DTMIterator
      Overrides:
      cloneWithReset in class BasicTestIterator
      Returns:
      A cloned NodeIterator set of the start of the query.
      Throws:
      CloneNotSupportedException
    • setRoot

      public void setRoot(int context, Object environment)
      Initialize the context values for this expression after it is cloned.
      Specified by:
      setRoot in interface DTMIterator
      Overrides:
      setRoot in class LocPathIterator
      Parameters:
      context - The XPath runtime context for this transformation.
      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 iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. Afterdetach has been invoked, calls to nextNode orpreviousNode will raise the exception INVALID_STATE_ERR.
      Specified by:
      detach in interface DTMIterator
      Overrides:
      detach in class LocPathIterator