Class OrderByClause


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

      • getClauseKey

        public int 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()
        Description copied from class: Clause
        Create a copy of this clause
        Specified by:
        copy in class 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 -
        Returns:
        the output tuple stream
      • getPushStream

        public TuplePush getPushStream​(TuplePush destination,
                                       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
        context -
        Returns:
        the push tuple stream that implements the functionality of this clause of the FLWOR 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 Clause
        Parameters:
        out - the expression presenter used to display the structure
      • toString

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