net.sf.saxon.style
Class XSLGeneralVariable

java.lang.Object
  extended by net.sf.saxon.tree.linked.NodeImpl
      extended by net.sf.saxon.tree.linked.ParentNodeImpl
          extended by net.sf.saxon.tree.linked.ElementImpl
              extended by net.sf.saxon.style.StyleElement
                  extended by net.sf.saxon.style.XSLGeneralVariable
All Implemented Interfaces:
Serializable, Source, SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, ValueRepresentation, InstructionInfo, SiblingCountingNode, Locator
Direct Known Subclasses:
XSLVariableDeclaration, XSLWithParam

public abstract class XSLGeneralVariable
extends StyleElement

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

See Also:
Serialized Form

Field Summary
protected  boolean assignable
           
protected  GeneralVariable compiledVariable
           
protected  String constantText
           
protected  boolean global
           
protected  boolean implicitlyRequiredParam
           
protected  boolean redundant
           
protected  boolean requiredParam
           
protected  SequenceType requiredType
           
protected  Expression select
           
protected  SlotManager slotManager
           
protected  boolean tunnel
           
 
Fields inherited from class net.sf.saxon.style.StyleElement
ACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version
 
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
 
Constructor Summary
XSLGeneralVariable()
           
 
Method Summary
protected  boolean allowsAsAttribute()
           
protected  boolean allowsRequired()
           
protected  boolean allowsTunnelAttribute()
           
protected  boolean allowsValue()
           
 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).
 String getVariableDisplayName()
          Get the display name of the variable.
 StructuredQName getVariableQName()
          Get the QName of the variable
protected  void initializeInstruction(Executable exec, Declaration decl, 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()
          Test whether this is a global variable or parameter
 boolean isRequiredParam()
          Test whether this is a required parameter (required="yes")
 boolean isTunnelParam()
          Test whether this is a tunnel parameter (tunnel="yes")
 boolean mayContainSequenceConstructor()
          Determine whether this type of element is allowed to contain a template-body
 void postValidate()
          Hook to allow additional validation of a parent element immediately after its children have been validated.
 void prepareAttributes()
          Set the attribute list for the element.
 void setRedundant()
          Mark this global variable as redundant.
protected  void setReferenceCount(GeneralVariable var)
           
 void validate(Declaration decl)
          Check that the stylesheet element is valid.
 
Methods inherited from class net.sf.saxon.style.StyleElement
allocateLocationId, allocatePatternSlots, allocateSlots, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compile, compileError, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getColumnNumber, getCommonChildItemType, getContainerGranularity, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getEffectiveVersion, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getPreparedStylesheet, getPrincipalStylesheetModule, getProcessorVersion, getProperties, getProperty, getSchemaType, getStaticContext, getSystemId, getTypeAnnotation, getWithParamInstructions, index, isActionCompleted, isDeclaration, isExcludedNamespace, isExplaining, isExtensionNamespace, isInstruction, isPermittedChild, issueWarning, issueWarning, isTopLevel, isXslt30Processor, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, markTailCalls, mayContainFallback, mayContainParam, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processStandardAttributes, processVersionAttribute, reportAbsence, seesAvuncularVariables, setActionCompleted, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree, xPath10ModeIsEnabled
 
Methods inherited from class net.sf.saxon.tree.linked.ElementImpl
addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getInScopeNamespaceCodes, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getPrefixForURI, getRoot, getSystemId, getTypeAnnotation, getURICodeForPrefix, getURICodeForPrefixCode, getURIForPrefix, gsetAttributeCollection, initialise, isId, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, setLineAndColumn, setLocation, setNameCode, setNamespaceDeclarations, setNamespaceList, setSystemId, setTypeAnnotation
 
Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl
addChild, compact, enumerateChildren, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, insertChildrenAt, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber
 
Methods inherited from class net.sf.saxon.tree.linked.NodeImpl
atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getRawParent, getSiblingPosition, getTypedValue, getURI, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace, setRawParent, setSiblingPosition
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.saxon.trace.InstructionInfo
getLineNumber, getSystemId
 
Methods inherited from interface org.xml.sax.Locator
getColumnNumber, getPublicId
 
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getPublicId
 
Methods inherited from interface net.sf.saxon.om.NodeInfo
hashCode
 

Field Detail

select

protected Expression select

requiredType

protected SequenceType requiredType

constantText

protected String constantText

global

protected boolean global

slotManager

protected SlotManager slotManager

assignable

protected boolean assignable

redundant

protected boolean redundant

requiredParam

protected boolean requiredParam

implicitlyRequiredParam

protected boolean implicitlyRequiredParam

tunnel

protected boolean tunnel

compiledVariable

protected GeneralVariable compiledVariable
Constructor Detail

XSLGeneralVariable

public XSLGeneralVariable()
Method Detail

getReturnedItemType

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

Overrides:
getReturnedItemType in class StyleElement
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.

mayContainSequenceConstructor

public boolean mayContainSequenceConstructor()
Determine whether this type of element is allowed to contain a template-body

Overrides:
mayContainSequenceConstructor in class StyleElement
Returns:
true: yes, it may contain a template-body

allowsAsAttribute

protected boolean allowsAsAttribute()

allowsTunnelAttribute

protected boolean allowsTunnelAttribute()

allowsValue

protected boolean allowsValue()

allowsRequired

protected boolean allowsRequired()

isAssignable

public boolean isAssignable()
Test whether it is permitted to assign to the variable using the saxon:assign extension element.

Returns:
true if the extra attribute saxon:assignable="yes" is present.

isTunnelParam

public boolean isTunnelParam()
Test whether this is a tunnel parameter (tunnel="yes")

Returns:
true if this is a tunnel parameter

isRequiredParam

public boolean isRequiredParam()
Test whether this is a required parameter (required="yes")

Returns:
true if this is a required parameter

isGlobal

public boolean isGlobal()
Test whether this is a global variable or parameter

Returns:
true if this is global

getVariableDisplayName

public String getVariableDisplayName()
Get the display name of the variable.

Returns:
the lexical QName

setRedundant

public void setRedundant()
Mark this global variable as redundant. This is done before prepareAttributes is called.


getVariableQName

public StructuredQName getVariableQName()
Get the QName of the variable

Returns:
the name as a structured QName, or a dummy name if the variable has no name attribute or has an invalid name attribute

prepareAttributes

public void prepareAttributes()
                       throws XPathException
Description copied from class: StyleElement
Set the attribute list for the element. This is called to process the attributes (note the distinction from processAttributes in the superclass). Must be supplied in a subclass

Specified by:
prepareAttributes in class StyleElement
Throws:
XPathException

validate

public void validate(Declaration decl)
              throws XPathException
Description copied from class: StyleElement
Check that the stylesheet element is valid. This is called once for each element, after the entire tree has been built. As well as validation, it can perform first-time initialisation. The default implementation does nothing; it is normally overriden in subclasses.

Overrides:
validate in class StyleElement
Throws:
XPathException

postValidate

public void postValidate()
                  throws XPathException
Hook to allow additional validation of a parent element immediately after its children have been validated.

Overrides:
postValidate in class StyleElement
Throws:
XPathException

checkAgainstRequiredType

public void checkAgainstRequiredType(SequenceType required)
                              throws XPathException
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
Throws:
XPathException

initializeInstruction

protected void initializeInstruction(Executable exec,
                                     Declaration decl,
                                     GeneralVariable var)
                              throws XPathException
Initialize - common code called from the compile() method of all subclasses

Parameters:
exec - the executable
decl -
var - the representation of the variable declaration in the compiled executable
Throws:
XPathException

setReferenceCount

protected void setReferenceCount(GeneralVariable var)

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

Specified by:
getConstructType in interface InstructionInfo
Overrides:
getConstructType in class StyleElement
Returns:
an integer identifying the kind of construct