Class TupleSorter

    • Constructor Detail

      • TupleSorter

        public TupleSorter​(Expression base,
                           SortKeyDefinition[] keys)
        Create a TupleSorter
        Parameters:
        base - The base expression returns the sequence of tuples to be sorted. Each tuple is represented by an ObjectValue which wraps a Value (that is, in general, a sequence)
        keys - Although this class uses the SortKeyDefinition class to define the sort keys, the actual sort key expression in the SortKeyDefinition is not used. This is because the sort key is instead computed as one of the members of the tuple delivered by the TupleSorter. Therefore, the sort key expression is not managed as a child of this expression. Moreover, in xquery the other aspects of a sort key are always fixed statically, so we don't treat those as subexpressions either.
    • Method Detail

      • getComparators

        public AtomicComparer[] getComparators()
        Get the array of AtomicComparer objects, one per sort key, that are used to compare values in the sequence
        Returns:
        an array of AtomicComparer objects, one per sort key
      • getBaseExpression

        public Expression getBaseExpression()
        Get the base expression, the expression that computes the sequence to be sorted
        Returns:
        the base expression
      • simplify

        public Expression simplify​(ExpressionVisitor visitor)
                            throws XPathException
        Description copied from class: Expression
        Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression). The default implementation does nothing.
        Overrides:
        simplify in class Expression
        Parameters:
        visitor - an expression visitor
        Returns:
        the simplified expression
        Throws:
        XPathException - if an error is discovered during expression rewriting
      • typeCheck

        public Expression typeCheck​(ExpressionVisitor visitor,
                                    ItemType contextItemType)
                             throws XPathException
        Description copied from class: Expression
        Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.

        This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

        This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.

        If the implementation returns a value other than "this", then it is required to ensure that the parent pointer and location information in the returned expression have been set up correctly. It should not rely on the caller to do this, although for historical reasons many callers do so.

        Overrides:
        typeCheck in class Expression
        Parameters:
        visitor - an expression visitor
        contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
        Returns:
        the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
        Throws:
        XPathException - if an error is discovered during this phase (typically a type error)
      • optimize

        public Expression optimize​(ExpressionVisitor visitor,
                                   ItemType contextItemType)
                            throws XPathException
        Description copied from class: Expression
        Perform optimisation of an expression and its subexpressions. This is the third and final phase of static optimization.

        This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.

        Overrides:
        optimize in class Expression
        Parameters:
        visitor - an expression visitor
        contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
        Returns:
        the original expression, rewritten if appropriate to optimize execution
        Throws:
        XPathException - if an error is discovered during this phase (typically a type error)
      • copy

        public Expression copy()
        Copy an expression. This makes a deep copy.
        Specified by:
        copy in class Expression
        Returns:
        the copy of the original expression
      • getItemType

        public ItemType getItemType​(TypeHierarchy th)
        Description copied from class: Expression
        Determine the data type of the expression, if possible. All expression return sequences, in general; this method determines the type of the items within the sequence, assuming that (a) this is known in advance, and (b) it is the same for all items in the sequence.

        This method should always return a result, though it may be the best approximation that is available at the time.

        Specified by:
        getItemType in class Expression
        Parameters:
        th - the type hierarchy cache
        Returns:
        a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known at compile time)
      • iterateSubExpressions

        public java.util.Iterator iterateSubExpressions()
        Description copied from class: Expression
        Get the immediate sub-expressions of this expression. Default implementation returns a zero-length array, appropriate for an expression that has no sub-expressions.
        Overrides:
        iterateSubExpressions in class Expression
        Returns:
        an iterator containing the sub-expressions of this expression
      • replaceSubExpression

        public boolean replaceSubExpression​(Expression original,
                                            Expression replacement)
        Replace one subexpression by a replacement subexpression
        Overrides:
        replaceSubExpression in class Expression
        Parameters:
        original - the original subexpression
        replacement - the replacement subexpression
        Returns:
        true if the original subexpression is found
      • promote

        public Expression promote​(PromotionOffer offer)
                           throws XPathException
        Promote this expression if possible
        Overrides:
        promote in class Expression
        Parameters:
        offer - details of the offer, for example the offer to move expressions that don't depend on the context to an outer level in the containing expression
        Returns:
        if the offer is not accepted, return this expression unchanged. Otherwise return the result of rewriting the expression to promote this subexpression
        Throws:
        XPathException - if any error is detected
      • iterate

        public SequenceIterator iterate​(XPathContext context)
                                 throws XPathException
        Description copied from class: Expression
        Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.
        Specified by:
        iterate in interface SequenceIterable
        Overrides:
        iterate in class Expression
        Parameters:
        context - supplies the context for evaluation
        Returns:
        a SequenceIterator that can be used to iterate over the result of the expression
        Throws:
        XPathException - if any dynamic error occurs evaluating the expression
      • explain

        public void explain​(ExpressionPresenter out)
        Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
        Specified by:
        explain in class Expression
        Parameters:
        out - the expression presenter used to display the structure