Package org.apache.xpath.axes

Class FilterExprIterator

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.BasicTestIterator
org.apache.xpath.axes.FilterExprIterator
All Implemented Interfaces:
Serializable, Cloneable, SourceLocator, DTMIterator, PathComponent, SubContextList, ExpressionNode, XPathVisitable
public class FilterExprIterator
extends BasicTestIterator
See Also:
Serialized Form

  • Constructor Details

    • FilterExprIterator

      public FilterExprIterator()
      Create a FilterExprIterator object.

    • FilterExprIterator

      public FilterExprIterator​(Expression expr)
      Create a FilterExprIterator object.

  • Method Details

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

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

    • detach

      public void detach()
      Detaches the walker from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.
      Specified by:
      detach in interface DTMIterator
      Overrides:
      detach in class LocPathIterator

    • fixupVariables

      public void fixupVariables​(Vector vars, int globalsSize)
      This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
      Overrides:
      fixupVariables in class PredicatedNodeTest
      Parameters:
      vars - List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).

    • getInnerExpression

      public Expression getInnerExpression()
      Get the inner contained expression of this filter.

    • setInnerExpression

      public void setInnerExpression​(Expression expr)
      Set the inner contained expression of this filter.

    • getAnalysisBits

      public int getAnalysisBits()
      Get the analysis bits for this walker, as defined in the WalkerFactory.
      Specified by:
      getAnalysisBits in interface PathComponent
      Overrides:
      getAnalysisBits in class LocPathIterator
      Returns:
      One of WalkerFactory#BIT_DESCENDANT, etc.

    • isDocOrdered

      public boolean isDocOrdered()
      Returns true if all the nodes in the iteration well be returned in document order. Warning: This can only be called after setRoot has been called!
      Specified by:
      isDocOrdered in interface DTMIterator
      Overrides:
      isDocOrdered in class LocPathIterator
      Returns:
      true as a default.

    • callPredicateVisitors

      public void callPredicateVisitors​(XPathVisitor visitor)
      This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.
      Overrides:
      callPredicateVisitors in class PredicatedNodeTest
      Parameters:
      visitor - The visitor whose appropriate method will be called.

    • deepEquals

      public boolean deepEquals​(Expression expr)
      Description copied from class: Expression
      Compare this object with another object and see if they are equal, include the sub heararchy.
      Overrides:
      deepEquals in class PredicatedNodeTest
      Parameters:
      expr - Another expression object.
      Returns:
      true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.
      See Also:
      Expression.deepEquals(Expression)