net.sf.saxon.style

Class XSLLocalParam

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

net.sf.saxon.style.XSLLocalParam

All Implemented Interfaces:

javax.xml.transform.Source, javax.xml.transform.SourceLocator, ActiveSource, GroundedValue, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, Sequence, Location, SteppingNode, SiblingCountingNode, org.xml.sax.Locator

public class XSLLocalParam
extends XSLGeneralVariable

An xsl:param element representing a local parameter (template or function 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.XSLGeneralVariable

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, YES_NO

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

NODE_LETTER

Constructor Summary

Constructors

Constructor and Description
XSLLocalParam()

Method Summary

Modifier and Type	Method and Description
Expression	compile(Compilation exec, ComponentDeclaration decl) Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.
void	fixupReferences() Fix up references from XPath expressions.
SourceBinding	getBindingInformation(StructuredQName name) Ask whether this element contains a binding for a variable with a given name; and if it does, return the source binding information
LocalParam	getCompiledParam()
SequenceType	getRequiredType() Get the static type of the parameter.
int	getSlotNumber() Get the slot number allocated to this variable (its position in the stackframe)
boolean	isRequiredParam()
boolean	isTunnelParam()
protected void	prepareAttributes() Set the attribute list for the element.
void	prepareTemplateSignatureAttributes()
void	validate(ComponentDeclaration decl) Check that the variable is not already declared, and allocate a slot number

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

getObjectName, getSourceBinding, getVariableQName, isGlobal, mayContainSequenceConstructor, postValidate

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

allocateLocation, arrayToSequence, bindLocalVariable, bindVariable, checkEmpty, checkTopLevel, checkUnknownAttribute, compileDeclaration, 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, getVisibility, getWithParamInstructions, getXslOriginal, hasImplicitBinding, index, invalidAttribute, isDeclaration, isExtensionAttributeAllowed, isExtensionNamespace, isInstruction, isNo, isPermittedChild, isSchemaAware, issueWarning, issueWarning, isTopLevel, isWithinDeclaredStreamableConstruct, isYes, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeQName, makeRetainedStaticContext, makeSequenceType, mapToSequence, markTailCalls, mayContainFallback, mayContainParam, processAllAttributes, processAttributes, processBooleanAttribute, processStandardAttributes, processVersionAttribute, reportAbsence, requireXslt40, seesAvuncularVariables, setCompilation, setInstructionLocation, 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, isIdRefNode, 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, compact, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getRawSequenceNumber, getSequenceNumber, getUnicodeStringValue, hasChildNodes, insertChildren, insertChildrenAt, 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, hashCode, head, insertSiblings, isDeleted, iterateAxis, iterateAxis, newBuilder, replace, saveLocation, setRawParent, setSiblingPosition

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

asActiveSource, children, children, deliver, getGenre, getPublicId, isSameNodeInfo, isStreamed, toShortString

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

getLength, getStringValue, itemAt, iterate, reduce, subsequence

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

asIterable, concatenate, containsNode, materialize

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

makeRepeatable

Constructor Detail

XSLLocalParam

public XSLLocalParam()

Method Detail

getBindingInformation

public SourceBinding getBindingInformation(StructuredQName name)

Ask whether this element contains a binding for a variable with a given name; and if it does, return the source binding information

Overrides:

getBindingInformation in class StyleElement

Parameters:

name - the variable name

Returns:

the binding information if this element binds a variable of this name; otherwise null

getSlotNumber

public int getSlotNumber()

Get the slot number allocated to this variable (its position in the stackframe)

Returns:

the allocated slot number

prepareAttributes

protected void 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 class StyleElement

prepareTemplateSignatureAttributes

public void prepareTemplateSignatureAttributes()
                                        throws XPathException

Throws:

XPathException

validate

public void validate(ComponentDeclaration decl)
              throws XPathException

Description copied from class: XSLGeneralVariable

Check that the variable is not already declared, and allocate a slot number

Overrides:

validate in class XSLGeneralVariable

Parameters:

decl - the declaration being validated. A single XSLVariableDeclaration object may represent multiple declarations if it appears in a stylesheet module that is included/imported more than once

Throws:

XPathException - if any error is found during validation

isTunnelParam

public boolean isTunnelParam()

isRequiredParam

public boolean isRequiredParam()

fixupReferences

public void fixupReferences()
                     throws XPathException

Description copied from class: StyleElement

Fix up references from XPath expressions. Overridden for function declarations and variable declarations

Overrides:

fixupReferences in class StyleElement

Throws:

XPathException - if any references cannot be fixed up.

compile

public Expression compile(Compilation exec,
                          ComponentDeclaration decl)
                   throws XPathException

Description copied from class: StyleElement

Compile the instruction on the stylesheet tree into an executable instruction for use at run-time.

Overrides:

compile in class StyleElement

Parameters:

exec - the compilation episode

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

Returns:

either a ComputedExpression, or null. The value null is returned when compiling an instruction that returns a no-op, or when compiling a top-level object such as an xsl:template that compiles into something other than an instruction.

Throws:

XPathException - if validation fails

getCompiledParam

public LocalParam getCompiledParam()

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.

Returns:

the declared type (or @code {item()*} if no type is declared)