Package net.sf.saxon.expr.flwor
Class LetClause
- java.lang.Object
-
- net.sf.saxon.expr.flwor.Clause
-
- net.sf.saxon.expr.flwor.LetClause
-
public class LetClause extends Clause
A "let" clause in a FLWOR expression
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.expr.flwor.Clause
COUNT, FOR, GROUPBYCLAUSE, LET, ORDERBYCLAUSE, TRACE, WHERE, WINDOW
-
-
Constructor Summary
Constructors Constructor Description LetClause()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LetClause
copy()
Create a copy of this clausevoid
explain(ExpressionPresenter out)
Diagnostic print of expression structure.void
gatherVariableReferences(ExpressionVisitor visitor, Binding binding, java.util.List<VariableReference> references)
Build a list of all references to a variables declared in this clauseint
getClauseKey()
Get a keyword identifying what kind of clause this isTuplePull
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 modifiesTuplePush
getPushStream(TuplePush destination, XPathContext context)
Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple streamLocalVariableBinding
getRangeVariable()
LocalVariableBinding[]
getRangeVariables()
Get the number of variables bound by this clauseExpression
getSequence()
void
processSubExpressions(ExpressionProcessor processor)
Process the subexpressions of this clausevoid
refineVariableType(ExpressionVisitor visitor, java.util.List<VariableReference> references, Expression returnExpr)
Supply improved type information to the expressions that contain references to the variables declared in this clausevoid
refineVariableType(ItemType type, int cardinality, Value constantValue, int properties, ExpressionVisitor visitor)
Provide additional information about the type of the variable, typically derived by analyzing the initializer of the variable bindingvoid
setRangeVariable(LocalVariableBinding binding)
void
setSequence(Expression sequence)
java.lang.String
toString()
void
typeCheck(ExpressionVisitor visitor)
Type-check the expression-
Methods inherited from class net.sf.saxon.expr.flwor.Clause
containsNonInlineableVariableReference, getLocationId, optimize, setLocationId
-
-
-
-
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 classClause
- Returns:
- the kind of clause
-
setSequence
public void setSequence(Expression sequence)
-
getSequence
public Expression getSequence()
-
setRangeVariable
public void setRangeVariable(LocalVariableBinding binding)
-
getRangeVariable
public LocalVariableBinding getRangeVariable()
-
getRangeVariables
public LocalVariableBinding[] getRangeVariables()
Get the number of variables bound by this clause- Overrides:
getRangeVariables
in classClause
- Returns:
- the number of variable bindings
-
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 classClause
- Parameters:
base
- the input tuple streamcontext
-- 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 classClause
- Parameters:
destination
- the output tuple streamcontext
-- Returns:
- the push tuple stream that implements the functionality of this clause of the FLWOR expression
-
processSubExpressions
public void processSubExpressions(ExpressionProcessor processor) throws XPathException
Process the subexpressions of this clause- Specified by:
processSubExpressions
in classClause
- Parameters:
processor
- the expression processor used to process the subexpressions- Throws:
XPathException
- if any error is detected
-
typeCheck
public void typeCheck(ExpressionVisitor visitor) throws XPathException
Type-check the expression- Overrides:
typeCheck
in classClause
- Parameters:
visitor
- the ExpressionVisitor, providing access to static context information- Throws:
XPathException
- if any error is detected
-
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 classClause
- Parameters:
visitor
- the expression visitorbinding
- a variable declared in this clausereferences
- 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 classClause
- Parameters:
visitor
- the expression visitorreferences
- the list of variable referencesreturnExpr
- the expression in the return clause
-
refineVariableType
public void refineVariableType(ItemType type, int cardinality, Value constantValue, int properties, ExpressionVisitor visitor)
Provide additional information about the type of the variable, typically derived by analyzing the initializer of the variable binding- Parameters:
type
- the item type of the variablecardinality
- the cardinality of the variableconstantValue
- the actual value of the variable, if this is known statically, otherwise nullproperties
- additional static properties of the variable's initializervisitor
- an ExpressionVisitor
-
explain
public void explain(ExpressionPresenter out)
Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-