public abstract class Assignation extends Expression implements Binding
?????? | ????? |
---|---|
protected Expression |
action |
protected SequenceType |
requiredType |
protected Expression |
sequence |
protected int |
slotNumber |
protected StructuredQName |
variableName |
EVALUATE_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, staticProperties
?????? |
---|
Assignation() |
?????? | ????? |
---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap.
|
void |
checkForUpdatingSubexpressions()
Check to ensure that this expression does not contain any inappropriate updating subexpressions.
|
ValueRepresentation |
evaluateVariable(XPathContext context)
Get the value of the range variable
|
protected Binding[] |
extendBindingList(Binding[] in)
Extend an array of variable bindings to include the binding(s) defined in this expression
|
Expression |
getAction()
Get the action expression
|
int |
getLocalSlotNumber()
If this is a local variable held on the local stack frame, return the corresponding slot number.
|
StructuredQName |
getObjectName()
Get a name identifying the object of the expression, for example a function name, template name,
variable name, key name, element name, etc.
|
int |
getRequiredSlots()
Get the number of slots required.
|
SequenceType |
getRequiredType()
Get the declared type of the variable
|
Expression |
getSequence()
Get the "sequence" expression - the one to which the variable is bound
|
java.lang.String |
getVariableName()
Get the display name of the range variable, for diagnostics only
|
StructuredQName |
getVariableQName()
Get the name of the variable
|
boolean |
isAssignable()
Test whether it is permitted to assign to the variable using the saxon:assign
extension element.
|
boolean |
isGlobal()
Indicate whether the binding is local or global.
|
boolean |
isUpdatingExpression()
Determine whether this is an updating expression as defined in the XQuery update specification
|
java.util.Iterator |
iterateSubExpressions()
Get the immediate subexpressions of this expression
|
Expression |
promote(PromotionOffer offer)
Promote this expression if possible
|
protected Expression |
promoteWhereClause(Binding positionBinding)
Promote a WHERE clause whose condition doesn't depend on the variable being bound.
|
void |
refineTypeInformation(ItemType type,
int cardinality,
Value constantValue,
int properties,
ExpressionVisitor visitor,
Assignation currentExpression)
Refine the type information associated with this variable declaration.
|
boolean |
replaceSubExpression(Expression original,
Expression replacement)
Replace one subexpression by a replacement subexpression
|
void |
setAction(Expression action)
Add the "return" or "satisfies" expression, and fix up all references to the
range variable that occur within that expression
|
void |
setRequiredType(SequenceType requiredType)
Set the required type (declared type) of the variable
|
void |
setSequence(Expression sequence)
Set the "sequence" expression - the one to which the variable is bound
|
void |
setSlotNumber(int nr)
Set the slot number for the range variable
|
void |
setVariableQName(StructuredQName variableName)
Set the name of the variable
|
Expression |
simplify(ExpressionVisitor visitor)
Simplify the expression
|
void |
suppressValidation(int validationMode)
Suppress validation on contained element constructors, on the grounds that the parent element
is already performing validation.
|
adoptChildExpression, checkPermittedContents, computeCardinality, computeDependencies, computeSpecialProperties, computeStaticProperties, copy, display, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, evaluatePendingUpdates, explain, explain, findParentOf, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getIntrinsicDependencies, getItemType, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, iterate, iterateEvents, markTailFunctionCalls, optimize, process, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, staticTypeCheck, toString, typeCheck, typeError
protected int slotNumber
protected Expression sequence
protected Expression action
protected StructuredQName variableName
protected SequenceType requiredType
public void setRequiredType(SequenceType requiredType)
requiredType
- the required typepublic void setVariableQName(StructuredQName variableName)
variableName
- the name of the variablepublic StructuredQName getVariableQName()
getVariableQName
???? Binding
public StructuredQName getObjectName()
InstructionInfo
getObjectName
???? InstructionInfo
getObjectName
??? Expression
public SequenceType getRequiredType()
getRequiredType
???? Binding
public int getLocalSlotNumber()
getLocalSlotNumber
???? Binding
public ValueRepresentation evaluateVariable(XPathContext context) throws XPathException
evaluateVariable
???? Binding
context
- the XPath dynamic evaluation contextXPathException
public void setAction(Expression action)
action
- the expression that occurs after the "return" keyword of a "for"
expression, the "satisfies" keyword of "some/every", or the ":=" operator of
a "let" expression.public final boolean isGlobal()
public final boolean isAssignable()
isAssignable
???? Binding
public void checkForUpdatingSubexpressions() throws XPathException
checkForUpdatingSubexpressions
??? Expression
XPathException
- if the expression has a non-permitted updateing subexpressionpublic boolean isUpdatingExpression()
isUpdatingExpression
??? Expression
public Expression getAction()
public void setSequence(Expression sequence)
sequence
- the expression to which the variable is boundpublic Expression getSequence()
public void setSlotNumber(int nr)
nr
- the slot number to be usedpublic int getRequiredSlots()
public Expression simplify(ExpressionVisitor visitor) throws XPathException
simplify
??? Expression
visitor
- an expression visitorXPathException
- if an error is discovered during expression
rewritingpublic Expression promote(PromotionOffer offer) throws XPathException
promote
??? Expression
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 expressionXPathException
- if any error is detectedpublic void suppressValidation(int validationMode)
suppressValidation
??? Expression
validationMode
- the kind of validation being performed on the parent expressionprotected Binding[] extendBindingList(Binding[] in)
in
- a set of variable bindingsprotected Expression promoteWhereClause(Binding positionBinding)
let $i := SEQ return if (C) then R else ()
to the form:
if (C) then (let $i := SEQ return R) else ()
positionBinding
- the binding of the position variable if anypublic java.util.Iterator iterateSubExpressions()
iterateSubExpressions
??? Expression
public boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression
??? Expression
original
- the original subexpressionreplacement
- the replacement subexpressionpublic PathMap.PathMapNodeSet addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
The default implementation of this method assumes that an expression does no navigation other than the navigation done by evaluating its subexpressions, and that the subexpressions are evaluated in the same context as the containing expression. The method must be overridden for any expression where these assumptions do not hold. For example, implementations exist for AxisExpression, ParentExpression, and RootExpression (because they perform navigation), and for the doc(), document(), and collection() functions because they create a new navigation root. Implementations also exist for PathExpression and FilterExpression because they have subexpressions that are evaluated in a different context from the calling expression.
addToPathMap
??? Expression
pathMap
- the PathMap to which the expression should be addedpathMapNodeSet
- the PathMapNodeSet to which the paths embodied in this expression should be addedpublic java.lang.String getVariableName()
public void refineTypeInformation(ItemType type, int cardinality, Value constantValue, int properties, ExpressionVisitor visitor, Assignation currentExpression)
type
- the inferred item type of the expression to which the variable is boundcardinality
- the inferred cardinality of the expression to which the variable is boundconstantValue
- the constant value to which the variable is bound (null if there is no constant value)properties
- other static properties of the expression to which the variable is boundvisitor
- an expression visitor to provide context informationcurrentExpression
- the expression that binds the variable