Class OrderByClause


  • public class OrderByClause
    extends Clause
    This class represents an "order by" clause in a FLWOR expression
    • Field Detail

      • SORT_KEYS_ROLE

        public static final OperandRole SORT_KEYS_ROLE
    • Method Detail

      • getClauseKey

        public Clause.ClauseName getClauseKey()
        Description copied from class: Clause
        Get a keyword identifying what kind of clause this is
        Specified by:
        getClauseKey in class Clause
        Returns:
        the kind of clause
      • containsNonInlineableVariableReference

        public boolean containsNonInlineableVariableReference​(Binding binding)
        Description copied from class: Clause
        Determine whether the clause contains a reference to a local variable binding that cannot be inlined
        Overrides:
        containsNonInlineableVariableReference in class Clause
        Parameters:
        binding - the binding for the local variable in question
        Returns:
        true if this clause uses the variable in a way that does not permit inlining
      • copy

        public OrderByClause copy​(FLWORExpression flwor,
                                  RebindingMap rebindings)
        Description copied from class: Clause
        Create a copy of this clause
        Specified by:
        copy in class Clause
        Parameters:
        flwor - the new FLWORExpression to contain the copied clause
        Returns:
        the copied clause
      • getPullStream

        public TuplePull getPullStream​(TuplePull base,
                                       XPathContext context)
        Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies
        Specified by:
        getPullStream in class Clause
        Parameters:
        base - the input tuple stream
        context - XQuery dynamic context
        Returns:
        the output tuple stream
      • getPushStream

        public TuplePush getPushStream​(TuplePush destination,
                                       Outputter output,
                                       XPathContext context)
        Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream
        Specified by:
        getPushStream in class Clause
        Parameters:
        destination - the output tuple stream
        output - the destination for the result
        context - XQuery dynamic context
        Returns:
        the push tuple stream that implements the functionality of this clause of the FLWOR expression
      • processOperands

        public void processOperands​(OperandProcessor processor)
                             throws XPathException
        Process the subexpressions of this clause
        Specified by:
        processOperands in class Clause
        Parameters:
        processor - the expression processor used to process the subexpressions
        Throws:
        XPathException - if any error is detected
      • addToPathMap

        public void addToPathMap​(PathMap pathMap,
                                 PathMap.PathMapNodeSet pathMapNodeSet)
        Description copied from class: Clause
        Collect information about the navigation paths followed by this clause, for document projection purposes
        Specified by:
        addToPathMap in class Clause
        Parameters:
        pathMap - the path map in which the data is to be collected
        pathMapNodeSet - the path map node set representing the paths to the context item
      • explain

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

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • evaluateSortKey

        public AtomicValue evaluateSortKey​(int n,
                                           XPathContext c)
                                    throws XPathException
        Callback for evaluating the sort keys
        Parameters:
        n - identifies the sort key to be evaluated
        c - the dynamic context for evaluation of the sort key
        Returns:
        the value of the sort key
        Throws:
        XPathException - if evaluation of the sort key fails