Class UnionPathIterator

    • Field Detail

      • iterators_

        protected DTMIterator[] iterators_
        The location path iterators, one for each location path contained in the union expression.
    • Constructor Detail

      • 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 - if any
    • Method Detail

      • setRoot

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

      • 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
      • 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 - if any
      • getAnalysisBits

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

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Specified by:
        clone in interface DTMIterator
        Overrides:
        clone in class PredicatedNodeTest
        Returns:
        A clone of this object.
        Throws:
        java.lang.CloneNotSupportedException - if any
      • createDTMIterator

        protected LocPathIterator createDTMIterator​(Compiler compiler,
                                                    int opPos)
                                             throws javax.xml.transform.TransformerException
        Create a new location path iterator.
        Parameters:
        compiler - The Compiler which is creating this expression.
        opPos - The position of this iterator in the
        Returns:
        New location path iterator.
        Throws:
        javax.xml.transform.TransformerException - if any
      • loadLocationPaths

        protected void loadLocationPaths​(Compiler compiler,
                                         int opPos,
                                         int count)
                                  throws javax.xml.transform.TransformerException
        Initialize the location path iterators. Recursive.
        Parameters:
        compiler - The Compiler which is creating this expression.
        opPos - The position of this iterator in the opcode list from the compiler.
        count - The insert position of the iterator.
        Throws:
        javax.xml.transform.TransformerException - if any
      • nextNode

        public int nextNode()
        Returns the next node in the set and advances the position of the iterator in the set. After a DTMIterator has setRoot called, the first call to nextNode() returns that root or (if it is rejected by the filters) the first node within its subtree which is not filtered out.
        Specified by:
        nextNode in interface DTMIterator
        Specified by:
        nextNode in class LocPathIterator
        Returns:
        The next node handle in the set being iterated over, or DTM.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.
      • callVisitors

        public void callVisitors​(XPathVisitor visitor)
        This will traverse the hierarchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.
        Specified by:
        callVisitors in interface XPathVisitable
        Overrides:
        callVisitors in class LocPathIterator
        Parameters:
        visitor - The visitor whose appropriate method will be called.
      • deepEquals

        public boolean deepEquals​(Expression expr)
        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.