net.sf.saxon.instruct

Class GlobalParam

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.instruct.Instruction

net.sf.saxon.instruct.GeneralVariable

net.sf.saxon.instruct.GlobalVariable

net.sf.saxon.instruct.GlobalParam

All Implemented Interfaces:

Serializable, SourceLocator, Binding, Container, Expression, TailCallReturner, InstructionInfoProvider

public final class GlobalParam
extends GlobalVariable

The compiled form of a global xsl:param element in the stylesheet or an external variable declared in the prolog of a Query.
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". In standard XQuery external variables are always required, and no default value can be specified; but Saxon provides an extension pragma that allows a query to specify a default.

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.saxon.instruct.GeneralVariable

nameCode, referenceCount, requiredType, select

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
GlobalParam()

Method Summary

Modifier and Type	Method and Description
ValueRepresentation	evaluateVariable(XPathContext context) Evaluate the variable
int	getInstructionNameCode() Get the name of this instruction for diagnostic and tracing purposes

Methods inherited from class net.sf.saxon.instruct.GlobalVariable

getExecutable, getHostLanguage, getInstructionInfo, getSelectValue, isGlobal, lookForCycles, processLeavingTail, setContainsLocals, setExecutable, setHostLanguage

Methods inherited from class net.sf.saxon.instruct.GeneralVariable

display, evaluateItem, getCardinality, getItemType, getLocalSlotNumber, getNameCode, getRequiredType, getSelectExpression, getSlotNumber, getVariableFingerprint, getVariableName, init, isAssignable, isRequiredParam, isTunnelParam, iterate, iterateSubExpressions, optimize, promoteInst, setAssignable, setNameCode, setReferenceCount, setRequiredParam, setRequiredType, setSelectExpression, setSlotNumber, setTunnel, setVariableName, simplify, typeCheck

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

appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, createsNewNodes, dynamicError, evaluateAsString, getImplementationMethod, getSourceLocator, isXSLT, process, promote

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

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, dynamicError, effectiveBooleanValue, getColumnNumber, getConstructType, getDependencies, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, suppressValidation, typeError, typeError

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.expr.Container

getLocationProvider

Methods inherited from interface javax.xml.transform.SourceLocator

getColumnNumber, getLineNumber, getPublicId, getSystemId

Constructor Detail

GlobalParam

public GlobalParam()

Method Detail

getInstructionNameCode

public int getInstructionNameCode()

Get the name of this instruction for diagnostic and tracing purposes

Overrides:

getInstructionNameCode in class GeneralVariable

evaluateVariable

public ValueRepresentation evaluateVariable(XPathContext context)
                                     throws XPathException

Evaluate the variable

Specified by:

evaluateVariable in interface Binding

Overrides:

evaluateVariable in class GlobalVariable

Throws:

XPathException