net.sf.saxon.style

Class XSLGeneralVariable

public abstract class XSLGeneralVariable extends StyleElement

This class defines common behaviour across xsl:variable, xsl:param, and xsl:with-param

Field Summary
protected boolean	assignable
protected String	constantText
protected boolean	global
protected boolean	redundant
protected boolean	requiredParam
protected SequenceType	requiredType
protected Expression	select
protected SlotManager	slotManager
protected boolean	tunnel

Method Summary
protected boolean	allowsAsAttribute()
protected boolean	allowsRequired()
protected boolean	allowsTunnelAttribute()
protected boolean	allowsValue()
protected void	checkAgainstRequiredType(SequenceType required) Check the supplied select expression against the required type.
int	getConstructType() Get the type of construct.
protected ItemType	getReturnedItemType() Determine the type of item returned by this instruction (only relevant if it is an instruction).
int	getVariableFingerprint() Get the fingerprint of the variable name
String	getVariableName() Get the display name of the variable.
protected void	initializeInstruction(Executable exec, GeneralVariable var) Initialize - common code called from the compile() method of all subclasses
boolean	isAssignable() Test whether it is permitted to assign to the variable using the saxon:assign extension element.
boolean	isGlobal()
boolean	isRequiredParam()
boolean	isTunnelParam()
boolean	mayContainSequenceConstructor() Determine whether this type of element is allowed to contain a template-body
void	prepareAttributes()
void	setRedundant() Mark this global variable as redundant.
protected void	setReferenceCount(GeneralVariable var)
void	validate()

Field Detail

Method Detail

allowsTunnelAttribute

protected boolean allowsTunnelAttribute()

checkAgainstRequiredType

protected void checkAgainstRequiredType(SequenceType required)

Check the supplied select expression against the required type.

Parameters: required The type required by the variable declaration, or in the case of xsl:with-param, the signature of the called template

getConstructType

public int getConstructType()

Get the type of construct. This will be a constant in class Location. This method is part of the InstructionInfo interface

getReturnedItemType

protected ItemType getReturnedItemType()

Determine the type of item returned by this instruction (only relevant if it is an instruction).

Returns: the item type returned. This is null for a variable: we are not interested in the type of the variable, but in what the xsl:variable constributes to the result of the sequence constructor it is part of.

getVariableFingerprint

public int getVariableFingerprint()

Get the fingerprint of the variable name

getVariableName

public String getVariableName()

Get the display name of the variable.

initializeInstruction

protected void initializeInstruction(Executable exec, GeneralVariable var)

Initialize - common code called from the compile() method of all subclasses

isAssignable

public boolean isAssignable()

Test whether it is permitted to assign to the variable using the saxon:assign extension element. This will only be true if the extra attribute saxon:assignable="yes" is present.

isGlobal

public boolean isGlobal()

isRequiredParam

public boolean isRequiredParam()

isTunnelParam

public boolean isTunnelParam()

mayContainSequenceConstructor

public boolean mayContainSequenceConstructor()

Determine whether this type of element is allowed to contain a template-body

Returns: true: yes, it may contain a template-body