net.sf.saxon.expr

Class LetExpression

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.expr.Assignation

net.sf.saxon.expr.LetExpression

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.SourceLocator, Binding, Container, Expression, TailCallReturner, InstructionInfoProvider

Direct Known Subclasses:

EagerLetExpression

public class LetExpression
extends Assignation
implements TailCallReturner

A LetExpression is modelled on the XQuery syntax let $x := expr return expr. This syntax is not available in the surface XPath language, but it is used internally in an optimized expression tree.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	evaluationMode
(package private) int	refCount

Fields inherited from class net.sf.saxon.expr.Assignation

action, declaration, nameCode, sequence, slotNumber, variableName

Fields inherited from class net.sf.saxon.expr.ComputedExpression

locationId, staticProperties

Fields inherited from interface net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Constructors

Constructor and Description
LetExpression()

Method Summary

Modifier and Type	Method and Description
void	checkPermittedContents(SchemaType parentType, StaticContext env, boolean whole) Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type.
int	computeCardinality() Determine the static cardinality of the expression
int	computeSpecialProperties() Get the static properties of this expression (other than its type).
void	display(int level, java.io.PrintStream out, Configuration config) Diagnostic print of expression structure
protected ValueRepresentation	eval(XPathContext context) Evaluate the variable.
Item	evaluateItem(XPathContext context) Evaluate the expression as a singleton
ItemType	getItemType(TypeHierarchy th) Determine the data type of the items returned by the expression, if possible
SequenceIterator	iterate(XPathContext context) Iterate over the sequence of values
boolean	markTailFunctionCalls(int nameCode, int arity) Mark tail function calls
Expression	optimize(Optimizer opt, StaticContext env, ItemType contextItemType) Perform optimisation of an expression and its subexpressions.
void	process(XPathContext context) Process this expression as an instruction, writing results to the current outputter
TailCall	processLeavingTail(XPathContext context) ProcessLeavingTail: called to do the real work of this instruction.
Expression	promote(PromotionOffer offer) Promote this expression if possible
void	setIndexedVariable()
Expression	typeCheck(StaticContext env, ItemType contextItemType) Type-check the expression

Methods inherited from class net.sf.saxon.expr.Assignation

evaluateVariable, extendBindingList, getAction, getLocalSlotNumber, getRequiredSlots, getSequence, getVariableDeclaration, getVariableFingerprint, getVariableName, getVariableNameCode, isAssignable, isGlobal, iterateSubExpressions, promoteWhereClause, replaceSubExpression, setAction, setSequence, setSlotNumber, setVariableDeclaration, simplify, suppressValidation

Methods inherited from class net.sf.saxon.expr.ComputedExpression

adoptChildExpression, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, typeError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

refCount

int refCount

evaluationMode

int evaluationMode

Constructor Detail

LetExpression

public LetExpression()

Method Detail

setIndexedVariable

public void setIndexedVariable()

typeCheck

public Expression typeCheck(StaticContext env,
                            ItemType contextItemType)
                     throws XPathException

Type-check the expression

Specified by:

typeCheck in interface Expression

Parameters:

env - the static context of the expression

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:

StaticError - if an error is discovered during this phase (typically a type error)

XPathException

optimize

public Expression optimize(Optimizer opt,
                           StaticContext env,
                           ItemType contextItemType)
                    throws XPathException

Perform optimisation of an expression and its subexpressions.

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.

Specified by:

optimize in interface Expression

Parameters:

opt - the optimizer in use. This provides access to supporting functions; it also allows different optimization strategies to be used in different circumstances.

env - the static context of the expression

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:

StaticError - if an error is discovered during this phase (typically a type error)

XPathException

checkPermittedContents

public void checkPermittedContents(SchemaType parentType,
                                   StaticContext env,
                                   boolean whole)
                            throws XPathException

Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type. It's always OK to say yes, since the check will be repeated at run-time. The process of checking element and attribute constructors against the content model of a complex type also registers the type of content expected of those constructors, so the static validation can continue recursively.

Specified by:

checkPermittedContents in interface Expression

Overrides:

checkPermittedContents in class ComputedExpression

Parameters:

parentType - The schema type

env - the static context

whole - true if this expression is expected to make the whole content of the type, false if it is expected to make up only a part

Throws:

XPathException - if the expression doesn't match the required content type

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Iterate over the sequence of values

Specified by:

iterate in interface Expression

Overrides:

iterate in class ComputedExpression

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

eval

protected ValueRepresentation eval(XPathContext context)
                            throws XPathException

Evaluate the variable. (This is overridden in a subclass).

Throws:

XPathException

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Evaluate the expression as a singleton

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

Parameters:

context - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

process

public void process(XPathContext context)
             throws XPathException

Process this expression as an instruction, writing results to the current outputter

Specified by:

process in interface Expression

Overrides:

process in class ComputedExpression

Parameters:

context - The dynamic context, giving access to the current node, the current variables, etc.

Throws:

XPathException

getItemType

public ItemType getItemType(TypeHierarchy th)

Determine the data type of the items returned by the expression, if possible

Specified by:

getItemType in interface Expression

Parameters:

th -

Returns:

one of the values Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known in advance)

computeCardinality

public int computeCardinality()

Determine the static cardinality of the expression

Specified by:

computeCardinality in class ComputedExpression

computeSpecialProperties

public int computeSpecialProperties()

Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.

Overrides:

computeSpecialProperties in class ComputedExpression

markTailFunctionCalls

public boolean markTailFunctionCalls(int nameCode,
                                     int arity)

Mark tail function calls

Overrides:

markTailFunctionCalls in class ComputedExpression

Returns:

true if a tail recursive call was found and if this call accounts for the whole of the value.

promote

public Expression promote(PromotionOffer offer)
                   throws XPathException

Promote this expression if possible

Specified by:

promote in interface Expression

Overrides:

promote in class Assignation

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

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
                            throws XPathException

ProcessLeavingTail: called to do the real work of this instruction. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.

Specified by:

processLeavingTail in interface TailCallReturner

Parameters:

context - The dynamic context of the transformation, giving access to the current node, the current variables, etc.

Returns:

null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.

Throws:

XPathException

display

public void display(int level,
                    java.io.PrintStream out,
                    Configuration config)

Diagnostic print of expression structure

Specified by:

display in interface Expression

Parameters:

level - indentation level for this expression

out - Output destination