net.sf.saxon.instruct

Class LocalParam

public final class LocalParam extends GeneralVariable

The compiled form of an xsl:param element within a template in an XSLT stylesheet.

The xsl:param element in XSLT has mandatory attribute name and optional attribute select. It can also be specified as required="yes" or required="no".

This is used only for parameters to XSLT templates. For function calls, the caller of the function places supplied arguments onto the callee's stackframe and the callee does not need to do anything. Global parameters (XQuery external variables) are handled using GlobalParam.

The LocalParam class is also used to represent parameters with the saxon:iterate instruction

Method Summary
ValueRepresentationevaluateVariable(XPathContext c)
Evaluate the variable
voidexplain(ExpressionPresenter out)
Diagnostic print of expression structure.
intgetInstructionNameCode()
Get the name of this instruction for diagnostic and tracing purposes
intgetParameterId()
Get the parameter id, which is essentially an alias for the parameter name, unique within a stylesheet
Iterator<Expression>iterateSubExpressions()
Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)
TailCallprocessLeavingTail(XPathContext context)
Process the local parameter declaration
booleanreplaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpression
voidsetConversion(Expression convertor)
Define a conversion that is to be applied to the supplied parameter value.
voidsetParameterId(int id)
Allocate a number which is essentially an alias for the parameter name, unique within a stylesheet

Method Detail

evaluateVariable

public ValueRepresentation evaluateVariable(XPathContext c)
Evaluate the variable

explain

public void explain(ExpressionPresenter out)
Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

getInstructionNameCode

public int getInstructionNameCode()
Get the name of this instruction for diagnostic and tracing purposes

getParameterId

public int getParameterId()
Get the parameter id, which is essentially an alias for the parameter name, unique within a stylesheet

Returns: the parameter id

iterateSubExpressions

public Iterator<Expression> iterateSubExpressions()
Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)

processLeavingTail

public TailCall processLeavingTail(XPathContext context)
Process the local parameter declaration

replaceSubExpression

public boolean replaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpression

Parameters: original the original subexpression replacement the replacement subexpression

Returns: true if the original subexpression is found

setConversion

public void setConversion(Expression convertor)
Define a conversion that is to be applied to the supplied parameter value.

Parameters: convertor The expression to be applied. This performs type checking, and the basic conversions implied by function calling rules, for example numeric promotion, atomization, and conversion of untyped atomic values to a required type. The conversion uses the actual parameter value as input, referencing it using a VariableReference.

setParameterId

public void setParameterId(int id)
Allocate a number which is essentially an alias for the parameter name, unique within a stylesheet

Parameters: id the parameter id