Package net.sf.saxon.style
Class XSLGeneralVariable
java.lang.Object
net.sf.saxon.tree.linked.NodeImpl
net.sf.saxon.tree.linked.ParentNodeImpl
net.sf.saxon.tree.linked.ElementImpl
net.sf.saxon.style.StyleElement
net.sf.saxon.style.XSLGeneralVariable
- All Implemented Interfaces:
Serializable
,Source
,SourceLocator
,LocationProvider
,SaxonLocator
,PullEvent
,Container
,FingerprintedNode
,Item<NodeInfo>
,MutableNodeInfo
,NamespaceResolver
,NodeInfo
,ValueRepresentation<NodeInfo>
,InstructionInfo
,SiblingCountingNode
,Locator
- Direct Known Subclasses:
XSLVariableDeclaration
,XSLWithParam
This class defines common behaviour across xsl:variable, xsl:param, and xsl:with-param
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected GeneralVariable
protected String
protected boolean
protected boolean
protected boolean
protected boolean
protected SequenceType
protected Expression
protected SlotManager
protected boolean
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, YES_NO
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
protected boolean
protected boolean
protected boolean
void
checkAgainstRequiredType
(SequenceType required) Check the supplied select expression against the required type.int
Get the type of construct.protected ItemType
Determine the type of item returned by this instruction (only relevant if it is an instruction).Get the display name of the variable.Get the QName of the variableprotected void
initializeBinding
(Executable exec, Declaration decl, GeneralVariable var) Initialize - common code called from the compile() method of all subclassesboolean
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 parameterboolean
Test whether this is a required parameter (required="yes")boolean
Test whether this is a tunnel parameter (tunnel="yes")boolean
Determine whether this type of element is allowed to contain a template-bodyvoid
Hook to allow additional validation of a parent element immediately after its children have been validated.void
Set the attribute list for the element.void
Mark this global variable as redundant.protected void
void
validate
(Declaration decl) Check that the stylesheet element is valid.Methods inherited from class net.sf.saxon.style.StyleElement
allocateLocationId, allocatePatternSlots, allocateSlots, bindLocalVariable, bindVariable, checkAttributeValue, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, compile, compileDeclaration, 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, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getPrefixForURI, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, initialise, isId, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setAttributeList, 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, getLineNumber, getPublicId, getSystemId
-
Field Details
-
select
-
requiredType
-
constantText
-
global
protected boolean global -
slotManager
-
assignable
protected boolean assignable -
redundant
protected boolean redundant -
requiredParam
protected boolean requiredParam -
implicitlyRequiredParam
protected boolean implicitlyRequiredParam -
tunnel
protected boolean tunnel -
compiledVariable
-
-
Constructor Details
-
XSLGeneralVariable
public XSLGeneralVariable()
-
-
Method Details
-
getReturnedItemType
Determine the type of item returned by this instruction (only relevant if it is an instruction).- Overrides:
getReturnedItemType
in classStyleElement
- 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 classStyleElement
- 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
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
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
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 classStyleElement
- Throws:
XPathException
- if a static error is detected
-
validate
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 classStyleElement
- Parameters:
decl
- the declaration to be validated- Throws:
XPathException
- if any error is found during validation
-
postValidate
Hook to allow additional validation of a parent element immediately after its children have been validated.- Overrides:
postValidate
in classStyleElement
- Throws:
XPathException
- if any error is found during post-traversal validation
-
checkAgainstRequiredType
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
- if an error is detected
-
initializeBinding
protected void initializeBinding(Executable exec, Declaration decl, GeneralVariable var) throws XPathException Initialize - common code called from the compile() method of all subclasses- Parameters:
exec
- the executabledecl
- this xsl:variable declarationvar
- the representation of the variable declaration in the compiled executable- Throws:
XPathException
- if an error is detected
-
setReferenceCount
-
getConstructType
public int getConstructType()Get the type of construct. This will be a constant in classLocation
. This method is part of theInstructionInfo
interface- Specified by:
getConstructType
in interfaceInstructionInfo
- Overrides:
getConstructType
in classStyleElement
- Returns:
- an integer identifying the kind of construct
-