Class UnionPathIterator

    • Constructor Detail

      • UnionPathIterator

        public UnionPathIterator()
        Constructor to create an instance which you can add location paths to.
      • UnionPathIterator

        public UnionPathIterator​(Compiler compiler,
                                 int opPos)
                          throws javax.xml.transform.TransformerException
        Create a UnionPathIterator object, including creation of location path iterators from the opcode list, and call back into the Compiler to create predicate expressions.
        Parameters:
        compiler - The Compiler which is creating this expression.
        opPos - The position of this iterator in the opcode list from the compiler.
        Throws:
        javax.xml.transform.TransformerException
    • Method Detail

      • setRoot

        public void setRoot​(int context,
                            java.lang.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.

      • addIterator

        public void addIterator​(DTMIterator expr)
        Add an iterator to the union list.
        Parameters:
        expr - non-null reference to a location path iterator.
      • 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
      • createUnionIterator

        public static LocPathIterator createUnionIterator​(Compiler compiler,
                                                          int opPos)
                                                   throws javax.xml.transform.TransformerException
        This will return an iterator capable of handling the union of paths given.
        Parameters:
        compiler - The Compiler which is creating this expression.
        opPos - The position of this iterator in the opcode list from the compiler.
        Returns:
        Object that is derived from LocPathIterator.
        Throws:
        javax.xml.transform.TransformerException
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Get a cloned LocPathIterator that holds the same position as this iterator.
        Specified by:
        clone in interface DTMIterator
        Overrides:
        clone in class PredicatedNodeTest
        Returns:
        A clone of this iterator that holds the same node position.
        Throws:
        java.lang.CloneNotSupportedException
      • nextNode

        public int nextNode()
        Returns the next node in the set and advances the position of the iterator in the set. After a DTMIterator 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.
      • fixupVariables

        public void fixupVariables​(java.util.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).
      • 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.
      • 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)