Package net.sf.saxon.style

Class XSLGlobalParam

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.XSLGlobalVariable

net.sf.saxon.style.XSLGlobalParam

All Implemented Interfaces:

javax.xml.transform.Source, javax.xml.transform.SourceLocator, GroundedValue, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, Sequence, Location, StylesheetComponent, SteppingNode<NodeImpl>, SiblingCountingNode, org.xml.sax.Locator

public class XSLGlobalParam
extends XSLGlobalVariable

An xsl:param element representing a global parameter (stylesheet parameter) in the stylesheet.
The xsl:param element has mandatory attribute name and optional attributes select, required, as, ...

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.style.StyleElement

StyleElement.OnFailure

Field Summary

Fields inherited from class net.sf.saxon.style.XSLGlobalVariable

compiledVariable, redundant, sourceBinding

Fields inherited from class net.sf.saxon.style.StyleElement

ACTION_COMPILE, ACTION_FIXUP, ACTION_OPTIMIZE, ACTION_PROCESS_ATTRIBUTES, ACTION_TYPECHECK, ACTION_VALIDATE, actionsCompleted, defaultCollationName, defaultMode, defaultXPathNamespace, expandText, extensionNamespaces, 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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor	Description
XSLGlobalParam()

Method Summary

Modifier and Type	Method	Description
void	compileDeclaration(Compilation compilation, ComponentDeclaration decl)	Compile a global xsl:param element: this ensures space is available for local variables declared within this global variable
protected java.util.EnumSet<SourceBinding.BindingProperty>	getPermittedAttributes()
SequenceType	getRequiredType()	Get the static type of the parameter.
Visibility	getVisibility()	Default visibility for xsl:param is public
void	insertBytecodeCandidate(Optimizer opt)
void	validate(ComponentDeclaration decl)	Check that the stylesheet element is valid.

Methods inherited from class net.sf.saxon.style.XSLGlobalVariable

checkCompatibility, fixupReferences, generateByteCode, getActor, getBindingInformation, getCompiledVariable, getObjectName, getSlotManager, getSourceBinding, getSymbolicName, getVariableQName, index, initializeBinding, isAssignable, isDeclaration, isGlobal, isInstruction, mayContainSequenceConstructor, optimize, postValidate, prepareAttributes, setRedundant

Methods inherited from class net.sf.saxon.style.StyleElement

allocateLocation, bindLocalVariable, bindVariable, checkEmpty, checkTopLevel, checkUnknownAttribute, compile, compileError, compileError, compileError, compileError, compileError, compileError, compileErrorInAttribute, compileSequenceConstructor, compileSequenceConstructor, compileWarning, compileWarning, compileWarning, generateId, getAttributeValue, getBaseURI, getCompilation, getConfiguration, getContainingPackage, getContainingSlotManager, getDeclaredVisibility, getDefaultCollationName, getDefaultXPathNamespace, getNamespaceResolver, getPackageData, getPrincipalStylesheetModule, getProperties, getSchemaType, getStaticContext, getStaticContext, getTypeAnnotation, getUsedPackage, getWithParamInstructions, getXslOriginal, hasImplicitBinding, invalidAttribute, isExtensionAttributeAllowed, isExtensionNamespace, isPermittedChild, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeQName, makeRetainedStaticContext, makeSequenceType, markTailCalls, mayContainFallback, mayContainParam, processAllAttributes, processBooleanAttribute, processStandardAttributes, processVersionAttribute, reportAbsence, requireSyntaxExtensions, seesAvuncularVariables, setCompilation, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, validateChildren, validateSubtree, validateValidationAttribute

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, addNamespace, attributes, checkNotNamespaceSensitiveElement, copy, delete, fixupInsertedNamespaces, generateId, getAllNamespaces, getAttributeValue, getColumnNumber, getDeclaredNamespaces, getLineNumber, getNodeKind, getNodeName, getRoot, getSchemaType, getSystemId, getURIForPrefix, initialise, isId, isIdref, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeNamespace, removeTypeAnnotation, rename, replaceStringValue, setAttributeInfo, setAttributes, setLocation, setNamespaceMap, setNilled, setNodeName, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.ParentNodeImpl

addChild, children, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, iterateChildren, removeChild, replaceChildrenAt, setChildren, setRawSequenceNumber

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, effectiveBooleanValue, equals, getDisplayName, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getRawParent, getSiblingPosition, getSuccessorElement, getTreeInfo, getURI, hasFingerprint, head, insertSiblings, isDeleted, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPosition

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.om.GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface net.sf.saxon.om.Item

getLength, itemAt, iterate, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.NodeInfo

children, equals, getGenre, getPublicId, hashCode, isSameNodeInfo, isStreamed, toShortString

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface javax.xml.transform.Source

isEmpty

Constructor Detail

XSLGlobalParam

public XSLGlobalParam()

Method Detail

getPermittedAttributes

protected java.util.EnumSet<SourceBinding.BindingProperty> getPermittedAttributes()

Overrides:

getPermittedAttributes in class XSLGlobalVariable

getVisibility

public Visibility getVisibility()

Default visibility for xsl:param is public

Overrides:

getVisibility in class StyleElement

Returns:

the declared visibility, or "public" if not declared

validate

public void validate(ComponentDeclaration 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 XSLGlobalVariable

Parameters:

decl - the declaration to be validated

Throws:

XPathException - if any error is found during validation

compileDeclaration

public void compileDeclaration(Compilation compilation,
                               ComponentDeclaration decl)
                        throws XPathException

Compile a global xsl:param element: this ensures space is available for local variables declared within this global variable

Overrides:

compileDeclaration in class XSLGlobalVariable

Parameters:

compilation - the compilation episode

decl - the containing top-level declaration, for example xsl:function or xsl:template

Throws:

XPathException - if compilation fails

getRequiredType

public SequenceType getRequiredType()

Get the static type of the parameter. This is the declared type, because we cannot know the actual value in advance.

Overrides:

getRequiredType in class XSLGlobalVariable

Returns:

the declared or inferred static type of the variable

insertBytecodeCandidate

public void insertBytecodeCandidate(Optimizer opt)