net.sf.saxon.expr.instruct

Class GlobalParam

java.lang.Object

net.sf.saxon.expr.instruct.ComponentBody

net.sf.saxon.expr.instruct.GlobalVariable

net.sf.saxon.expr.instruct.GlobalParam

All Implemented Interfaces:

SourceLocator, Binding, Container, Declaration, InstructionInfo

public final class GlobalParam
extends GlobalVariable

The compiled form of a global xsl:param element in an XSLT 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 1.0 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. XQuery 1.1 adds standard syntax for defining a default value.

Field Summary

Fields inherited from class net.sf.saxon.expr.instruct.GlobalVariable

references

Fields inherited from class net.sf.saxon.expr.instruct.ComponentBody

body

Constructor Summary

Constructors

Constructor and Description
GlobalParam()

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	evaluateVariable(XPathContext context) Evaluate the variable
Sequence	evaluateVariable(XPathContext context, Component target) Evaluate the variable
boolean	isImplicitlyRequiredParam() Ask whether this variable represents a required parameter
void	setImplicitlyRequiredParam(boolean requiredParam) Indicate that this parameter is implicitly required, because the default value does not match the type

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

actuallyEvaluate, addReference, compile, getBinderySlotNumber, getComponentKind, getConfiguration, getConstructType, getContainerGranularity, getHostLanguage, getIntegerBoundsForVariable, getLocalSlotNumber, getObjectName, getOriginalVariable, getProperties, getProperty, getRequiredType, getSelectExpression, getSelectValue, getUltimateOriginalVariable, getVariableQName, init, isAssignable, isGlobal, isIndexedVariable, isPrivate, isRequiredParam, iterateReferences, lookForCycles, registerReference, setAssignable, setBinderySlotNumber, setContainsLocals, setDependencies, setIndexedVariable, setOriginalVariable, setPrivate, setRequiredParam, setRequiredType, setSelectExpression, setVariableQName, typeCheck

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

allocateAllBindingSlots, allocateBindingSlotsRecursive, getBody, getColumnNumber, getDeclaringComponent, getLineNumber, getLocationProvider, getPackageData, getPublicId, getStackFrameMap, getSystemId, makeDeclaringComponent, setBody, setHostLanguage, setLineNumber, setPackageData, setStackFrameMap, setSystemId

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

getPackageData

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

getLineNumber, getSystemId

Methods inherited from interface javax.xml.transform.SourceLocator

getColumnNumber, getPublicId

Constructor Detail

GlobalParam

public GlobalParam()

Method Detail

setImplicitlyRequiredParam

public void setImplicitlyRequiredParam(boolean requiredParam)

Indicate that this parameter is implicitly required, because the default value does not match the type

Parameters:

requiredParam - true if this is a required parameter

isImplicitlyRequiredParam

public boolean isImplicitlyRequiredParam()

Ask whether this variable represents a required parameter

Returns:

true if this variable represents a required parameter

evaluateVariable

public Sequence evaluateVariable(XPathContext context,
                        Component target)
                          throws XPathException

Evaluate the variable

Overrides:

evaluateVariable in class GlobalVariable

Throws:

XPathException

evaluateVariable

public Sequence evaluateVariable(XPathContext context)
                          throws XPathException

Evaluate the variable

Specified by:

evaluateVariable in interface Binding

Overrides:

evaluateVariable in class GlobalVariable

Parameters:

context - the XPath dynamic evaluation context

Returns:

the result of evaluating the variable

Throws:

XPathException - if an error occurs while evaluating the variable