net.sf.saxon.style
Class XSLGeneralVariable

java.lang.Object
  extended by net.sf.saxon.om.AbstractNode
      extended by net.sf.saxon.tree.NodeImpl
          extended by net.sf.saxon.tree.ParentNodeImpl
              extended by net.sf.saxon.tree.ElementImpl
                  extended by net.sf.saxon.tree.ElementWithAttributes
                      extended by net.sf.saxon.style.StyleElement
                          extended by net.sf.saxon.style.XSLGeneralVariable
All Implemented Interfaces:
DOMLocator, Source, SourceLocator, Item, NodeInfo, Element, NamedNodeMap, Node, Locator
Direct Known Subclasses:
SaxonAssign, SQLColumn, XSLVariableDeclaration, XSLWithParam

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  Procedure procedure
           
protected  boolean redundant
           
protected  boolean requiredParam
           
protected  SequenceType requiredType
           
protected  Expression select
           
protected  boolean tunnel
           
protected  int variableFingerprint
           
 
Fields inherited from class net.sf.saxon.style.StyleElement
defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, version
 
Fields inherited from class net.sf.saxon.tree.ElementWithAttributes
attributeList, namespaceList
 
Fields inherited from class net.sf.saxon.tree.ElementImpl
nameCode, root
 
Fields inherited from class net.sf.saxon.tree.ParentNodeImpl
sequence
 
Fields inherited from class net.sf.saxon.tree.NodeImpl
index, parent
 
Fields inherited from class net.sf.saxon.om.AbstractNode
NODE_LETTER
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, LOCAL_NAMESPACES, NO_NAMESPACES
 
Constructor Summary
XSLGeneralVariable()
           
 
Method Summary
protected  boolean allowsAsAttribute()
           
protected  boolean allowsNameAttribute()
           
protected  boolean allowsRequired()
           
protected  boolean allowsTunnelAttribute()
           
protected  boolean allowsValue()
           
protected  void checkAgainstRequiredType(SequenceType required)
          Method called for parameters of call-template to check the type of the actual parameter against the type of the required parameter
 Procedure getProcedure()
          Get associated Procedure (for details of stack frame, if this is a global variable containing local variable declarations)
protected  ItemType getReturnedItemType()
          Determine the type of item returned by this instruction (only relevant if it is an instruction).
protected  Expression getSelectExpression()
           
 int getVariableFingerprint()
          Get the fingerprint of the variable name
 String getVariableName()
          Get the display name of the variable.
protected  void initializeInstruction(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 isTunnelParam()
           
 boolean mayContainTemplateBody()
          Determine whether this type of element is allowed to contain a template-body
 void prepareAttributes()
          Set the attribute list for the element.
 void setRedundant()
          Mark this global variable as redundant.
protected  void setSelectExpression(Expression select)
           
 void validate()
          Check that the stylesheet element is valid.
 
Methods inherited from class net.sf.saxon.style.StyleElement
allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compile, compileChildren, compileError, compileError, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getCommonChildItemType, getConfiguration, getContainingStyleSheet, getContextItemType, getDefaultXPathNamespace, getLastChildInstruction, getLineNumber, getOwningProcedure, getPrecedence, getPreparedStyleSheet, getPrincipalStyleSheet, getSchemaType, getStyleSheetFunction, getTargetNamePool, getTypeAnnotation, getURIForPrefix, getVariableBinding, getVersion, getWithParamInstructions, isExcludedNamespace, isExtensionNamespace, isInstruction, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeNameCode, makeNamespaceContext, makePattern, makeSequenceType, makeSortKeys, markTailCalls, mayContainFallback, postValidate, processAllAttributes, processAttributes, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, reportAbsence, setLineNumber, setValidationError, substituteFor, typeCheck, typeCheck, validateChildren, validateSubtree
 
Methods inherited from class net.sf.saxon.tree.ElementWithAttributes
addNamespaceNodes, copy, getAttribute, getAttributeList, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getLength, getNamedItem, getNamedItemNS, getNamespaceCodes, getPrefixForURI, getURICodeForPrefix, hasAttribute, hasAttributeNS, hasAttributes, initialise, item, outputNamespaceNodes, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamedItem, removeNamedItemNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setNamedItem, setNamedItemNS, setNamespaceDeclarations
 
Methods inherited from class net.sf.saxon.tree.ElementImpl
generateId, getBaseURI, getDocumentRoot, getNameCode, getNodeKind, getRoot, getSystemId, setNameCode, setSystemId
 
Methods inherited from class net.sf.saxon.tree.ParentNodeImpl
addChild, compact, enumerateChildren, getFirstChild, getLastChild, getNodeValue, getNthChild, getSequenceNumber, getStringValue, hasChildNodes, useChildrenArray
 
Methods inherited from class net.sf.saxon.tree.NodeImpl
compareOrder, copy, getDisplayName, getDocumentElement, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getURI, isSameNode, iterateAxis, iterateAxis
 
Methods inherited from class net.sf.saxon.om.AbstractNode
appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getChildNodes, getColumnNumber, getData, getDoctype, getDocumentNumber, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getLocalName, getName, getNamespaceURI, getNodeName, getNodeType, getOwnerDocument, getOwnerElement, getParentNode, getPublicId, getSpecified, getTagName, getTypeAnnotation, getTypedValue, getValue, importNode, insertBefore, insertData, isSupported, normalize, removeChild, replaceChild, replaceData, setData, setNodeValue, setPrefix, setValue, splitText, substringData, supports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.xml.sax.Locator
getColumnNumber, getPublicId, getSystemId
 
Methods inherited from interface org.w3c.dom.Element
getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
 

Field Detail

variableFingerprint

protected int variableFingerprint

select

protected Expression select

requiredType

protected SequenceType requiredType

constantText

protected String constantText

global

protected boolean global

procedure

protected Procedure procedure

assignable

protected boolean assignable

redundant

protected boolean redundant

requiredParam

protected boolean requiredParam

tunnel

protected boolean tunnel
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 EMPTY 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.

mayContainTemplateBody

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

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

allowsNameAttribute

protected boolean allowsNameAttribute()

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. This will only be true if the extra attribute saxon:assignable="yes" is present.


isTunnelParam

public boolean isTunnelParam()

getVariableName

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


getSelectExpression

protected Expression getSelectExpression()

setSelectExpression

protected void setSelectExpression(Expression select)

setRedundant

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


getVariableFingerprint

public int getVariableFingerprint()
Get the fingerprint of the variable name


prepareAttributes

public void prepareAttributes()
                       throws TransformerConfigurationException
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:
TransformerConfigurationException

validate

public void validate()
              throws TransformerConfigurationException
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:
TransformerConfigurationException

checkAgainstRequiredType

protected void checkAgainstRequiredType(SequenceType required)
                                 throws TransformerConfigurationException
Method called for parameters of call-template to check the type of the actual parameter against the type of the required parameter

Parameters:
required - The type required by the signature of the called template
Throws:
TransformerConfigurationException

initializeInstruction

protected void initializeInstruction(GeneralVariable var)
                              throws TransformerConfigurationException
Initialize - common code called from the compile() method of all subclasses

Throws:
TransformerConfigurationException

getProcedure

public Procedure getProcedure()
Get associated Procedure (for details of stack frame, if this is a global variable containing local variable declarations)