Package com.saxonica.xsltextn.instruct

Class Assign

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.instruct.Instruction

com.saxonica.xsltextn.instruct.Assign

All Implemented Interfaces:

BindingReference, ExportAgent, Locatable, IdentityComparable, Traceable

public class Assign
extends Instruction
implements BindingReference

Compiled instruction deriving from saxon:assign element in stylesheet.

The saxon:assign element has mandatory attribute name and optional attribute expr. It also allows xsl:extension-element-prefixes etc.

Field Summary

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

EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_COST, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD

Constructor Summary

Constructors

Constructor	Description
Assign(Expression select)

Method Summary

Modifier and Type	Method	Description
Expression	copy(RebindingMap rebindings)	Copy an expression.
void	export(ExpressionPresenter out)	Diagnostic print of expression structure.
void	fixup(Binding binding)	Fix up this binding reference to a binding
Elaborator	getElaborator()	Make an elaborator for this expression
int	getInstructionNameCode()	Get the name of this instruction for diagnostic and tracing purposes
int	getIntrinsicDependencies()	Determine the intrinsic dependencies of an expression, that is, those which are not derived from the dependencies of its subexpressions.
Expression	getSelectExpr()
java.lang.Iterable<Operand>	operands()	Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression.
void	setSelectExpr(Expression select)
void	setStaticType(SequenceType type, GroundedValue constantValue, int properties)	Fix up the static type of this variable reference; optionally, supply a constant value for the variable.
Expression	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo)	Perform type checking of an expression and its subexpressions.

Methods inherited from class net.sf.saxon.expr.instruct.Instruction

alwaysCreatesNewNodes, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getExpressionName, getImplementationMethod, getItemType, getNetCost, getSourceLocator, isInstruction, isXSLT, iterate, mayCreateNewNodes, process, someOperandCreatesNewNodes

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

addToPathMap, adoptChildExpression, allowExtractingCommonSubexpressions, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeHashCode, computeStaticProperties, dispatchTailCall, dynamicError, effectiveBooleanValue, equals, explain, getCardinality, getConfiguration, getCost, getDependencies, getEvaluationMethod, getExtraProperty, getIntegerBounds, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, getStreamerName, getTracingTag, hasCompatibleStaticContext, hashCode, hasSpecialProperty, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isEqual, isIdentical, isLiftable, isMultiThreaded, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, makeElaborator, markTailFunctionCalls, operandList, operandSparseList, optimize, optimizeChildren, prepareForStreaming, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, supportsLazyEvaluation, suppressValidation, toPattern, toShortString, toString, typeCheckChildren, typeError, unordered, verifyParentPointers

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.trace.Traceable

gatherProperties

Constructor Detail

Assign

public Assign(Expression select)

Method Detail

setStaticType

public void setStaticType(SequenceType type,
                          GroundedValue constantValue,
                          int properties)

Description copied from interface: BindingReference

Fix up the static type of this variable reference; optionally, supply a constant value for the variable. Also supplies other static properties of the expression to which the variable is bound, for example whether it is an ordered node-set.

Specified by:

setStaticType in interface BindingReference

Parameters:

type - The static type of the variable reference, typically either the declared type of the variable, or the static type of the expression to which the variable is bound

constantValue - if non-null, indicates that the value of the variable is known at compile time, and supplies the value

properties - static properties of the expression to which the variable is bound

setSelectExpr

public void setSelectExpr(Expression select)

getSelectExpr

public Expression getSelectExpr()

operands

public java.lang.Iterable<Operand> operands()

Description copied from class: Expression

Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression.

If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.

Specified by:

operands in class Instruction

Returns:

an iterator containing the sub-expressions of this expression

fixup

public void fixup(Binding binding)

Description copied from interface: BindingReference

Fix up this binding reference to a binding

Specified by:

fixup in interface BindingReference

Parameters:

binding - the Binding to which the variable refers

typeCheck

public Expression typeCheck(ExpressionVisitor visitor,
                            ContextItemStaticInfo contextInfo)
                     throws XPathException

Description copied from class: Expression

Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.

This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.

Overrides:

typeCheck in class Expression

Parameters:

visitor - an expression visitor

contextInfo - Information available statically about the context item: whether it is (possibly) absent; its static type; its streaming posture.

Returns:

the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations

Throws:

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

getIntrinsicDependencies

public int getIntrinsicDependencies()

Description copied from class: Expression

Determine the intrinsic dependencies of an expression, that is, those which are not derived from the dependencies of its subexpressions. For example, position() has an intrinsic dependency on the context position, while (position()+1) does not. The default implementation of the method returns 0, indicating "no dependencies".

Overrides:

getIntrinsicDependencies in class Expression

Returns:

an integer containing bit-significant flags identifying the "intrinsic" dependencies. The flags are documented in class net.sf.saxon.value.StaticProperty

copy

public Expression copy(RebindingMap rebindings)

Copy an expression. This makes a deep copy.

Specified by:

copy in class Expression

Parameters:

rebindings - variables that need to be re-bound

Returns:

the copy of the original expression

getInstructionNameCode

public int getInstructionNameCode()

Get the name of this instruction for diagnostic and tracing purposes

Overrides:

getInstructionNameCode in class Instruction

Returns:

a code identifying the instruction: typically but not always the fingerprint of a name in the XSLT namespace

export

public void export(ExpressionPresenter out)
            throws XPathException

Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

Specified by:

export in interface ExportAgent

Specified by:

export in class Expression

Parameters:

out - the expression presenter used to display the structure

Throws:

XPathException - if the export fails, for example if an expression is found that won't work in the target environment.

getElaborator

public Elaborator getElaborator()

Description copied from class: Expression

Make an elaborator for this expression

Overrides:

getElaborator in class Expression

Returns:

an appropriate Elaborator