Class WhileClause


  • public class WhileClause
    extends Clause
    A "where" clause in a FLWOR expression
    • Method Detail

      • setRepeated

        public void setRepeated​(boolean repeated)
        Overrides:
        setRepeated in class Clause
      • 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
      • setPredicate

        public void setPredicate​(Expression predicate)
      • copy

        public WhileClause 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
        rebindings - the rebinding map
        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 - the dynamic evaluation context
        Returns:
        the output tuple stream
      • gatherVariableReferences

        public void gatherVariableReferences​(ExpressionVisitor visitor,
                                             Binding binding,
                                             java.util.List<VariableReference> references)
        Description copied from class: Clause
        Build a list of all references to a variables declared in this clause
        Overrides:
        gatherVariableReferences in class Clause
        Parameters:
        visitor - the expression visitor
        binding - a variable declared in this clause
        references - the list of variable references, initially empty, to which the method will append
      • refineVariableType

        public void refineVariableType​(ExpressionVisitor visitor,
                                       java.util.List<VariableReference> references,
                                       Expression returnExpr)
        Description copied from class: Clause
        Supply improved type information to the expressions that contain references to the variables declared in this clause
        Overrides:
        refineVariableType in class Clause
        Parameters:
        visitor - the expression visitor
        references - the list of variable references
        returnExpr - the expression in the return clause
      • 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 - the dynamic evaluation 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 - if any error occurs
      • toShortString

        public java.lang.String toShortString()
        Description copied from class: Clause
        Get a short string representation of the clause
        Overrides:
        toShortString in class Clause
        Returns:
        a recognizable string
      • toString

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

        public java.util.Map<java.lang.String,​java.lang.Object> getTraceInfo()
        Get information for inclusion in trace output
        Overrides:
        getTraceInfo in class Clause
        Returns:
        a map containing the properties to be output