net.sf.saxon.expr
Class SuppliedParameterReference

java.lang.Object
  net.sf.saxon.expr.ComputedExpression
      net.sf.saxon.expr.SuppliedParameterReference

All Implemented Interfaces:

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

public class SuppliedParameterReference

extends ComputedExpression

Supplied parameter reference: this is an internal expression used to refer to the value of the n'th parameter supplied on a template call (apply-templates). It is used within a type-checking expression designed to check the consistency of the supplied value with the required type. This type checking is all done at run-time, because the binding of apply-templates to actual template rules is entirely dynamic.

See Also:

Serialized Form

Field Summary

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

SuppliedParameterReference(int slot)
Constructor

Method Summary

int	computeCardinality() Get the static cardinality
void	display(int level, NamePool pool, java.io.PrintStream out) Diagnostic print of expression structure
boolean	equals(java.lang.Object other) Test if this expression is the same as another expression.
Item	evaluateItem(XPathContext c) Evaluate an expression as a single item.
ItemType	getItemType(TypeHierarchy th) Determine the data type of the expression, if possible.
SequenceIterator	iterate(XPathContext c) Get the value of this expression in a given context.
Expression	optimize(Optimizer opt, StaticContext env, ItemType contextItemType) Perform optimisation of an expression and its subexpressions.
Expression	simplify(StaticContext env) Simplify the expression.
Expression	typeCheck(StaticContext env, ItemType contextItemType) Perform type checking of an expression and its subexpressions.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppliedParameterReference

public SuppliedParameterReference(int slot)

Constructor

Parameters:

slot - identifies this parameter

Method Detail

simplify

public Expression simplify(StaticContext env)

Simplify the expression. Does nothing.

Specified by:

simplify in interface Expression

Overrides:

simplify in class ComputedExpression

Returns:

the simplified expression

typeCheck

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

Description copied from interface: Expression

Perform type checking of an expression and its subexpressions.

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.

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:

XPathException

optimize

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

Description copied from interface: Expression

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.

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:

XPathException

getItemType

public ItemType getItemType(TypeHierarchy th)

Determine the data type of the expression, if possible.

Parameters:

th -

Returns:

Type.ITEM, because we don't know the type of the supplied value in advance.

computeCardinality

public int computeCardinality()

Get the static cardinality

Specified by:

computeCardinality in class ComputedExpression

Returns:

ZERO_OR_MORE, because we don't know the type of the supplied value in advance.

equals

public boolean equals(java.lang.Object other)

Test if this expression is the same as another expression. (Note, we only compare expressions that have the same static and dynamic context).

iterate

public SequenceIterator iterate(XPathContext c)
                         throws XPathException

Get the value of this expression in a given context.

Specified by:

iterate in interface Expression

Overrides:

iterate in class ComputedExpression

Parameters:

c - the XPathContext which contains the relevant variable bindings

Returns:

the value of the variable, if it is defined

Throws:

XPathException - if the variable is undefined

evaluateItem

public Item evaluateItem(XPathContext c)
                  throws XPathException

Description copied from class: ComputedExpression

Evaluate an expression as a single item. This always returns either a single Item or null (denoting the empty sequence). No conversion is done. This method should not be used unless the static type of the expression is a subtype of "item" or "item?": that is, it should not be called if the expression may return a sequence. There is no guarantee that this condition will be detected.

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

Parameters:

c - 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

display

public void display(int level,
                    NamePool pool,
                    java.io.PrintStream out)

Diagnostic print of expression structure

Parameters:

level - indentation level for this expression

pool - NamePool used to expand any names appearing in the expression

out - Output destination