Package net.sf.saxon.style
Class XSLTemplate
- java.lang.Object
-
- All Implemented Interfaces:
javax.xml.transform.Source
,javax.xml.transform.SourceLocator
,LocationProvider
,SaxonLocator
,Container
,FingerprintedNode
,Item
,NodeInfo
,ValueRepresentation
,StylesheetProcedure
,InstructionInfo
,org.xml.sax.Locator
public final class XSLTemplate extends StyleElement implements StylesheetProcedure
An xsl:template element in the style sheet.
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.style.StyleElement
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.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, NODE_LETTER, parent
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description XSLTemplate()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
allocateSlots(Expression exp)
Allocate space for range variables within predicates in the match pattern.Expression
compile(Executable exec)
Compile: this registers the template with the rule manager, and ensures space is available for local variablesTemplate
getCompiledTemplate()
Get the compiled templateint
getConstructType()
Get the type of construct.protected ItemType
getReturnedItemType()
Determine the type of item returned by this templateSlotManager
getSlotManager()
Get associated Procedure (for details of stack frame)int
getTemplateFingerprint()
Return the fingerprint for the name of this template.protected boolean
isPermittedChild(StyleElement child)
Specify that xsl:param is a permitted childvoid
markTailCalls()
Mark tail-recursive calls on templates and functions.boolean
mayContainSequenceConstructor()
Determine whether this type of element is allowed to contain a template-bodyvoid
prepareAttributes()
Set the attribute list for the element.void
validate()
Check that the stylesheet element is valid.-
Methods inherited from class net.sf.saxon.style.StyleElement
allocateLocationId, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAttributeSets, getAttributeValue, getCommonChildItemType, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectFingerprint, getObjectNameCode, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTargetNamePool, getTypeAnnotation, getVersion, getWithParamInstructions, isExcludedNamespace, isExplaining, isExtensionNamespace, isInstruction, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeNameCode, makeNamespaceContext, makePattern, makeSequenceType, makeSortKeys, makeTraceInstruction, mayContainFallback, postValidate, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processVersionAttribute, replaceSubExpression, reportAbsence, setLineNumber, setObjectNameCode, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree
-
Methods inherited from class net.sf.saxon.tree.ElementWithAttributes
copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, sendNamespaceDeclarations, 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, getNthChild, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, useChildrenArray
-
Methods inherited from class net.sf.saxon.tree.NodeImpl
atomize, compareOrder, equals, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxis
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.trace.InstructionInfo
getSystemId
-
-
-
-
Method Detail
-
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
-
isPermittedChild
protected boolean isPermittedChild(StyleElement child)
Specify that xsl:param is a permitted child- Overrides:
isPermittedChild
in classStyleElement
-
getTemplateFingerprint
public int getTemplateFingerprint()
Return the fingerprint for the name of this template. Note that this may be called before prepareAttributes has been called.
-
getReturnedItemType
protected ItemType getReturnedItemType()
Determine the type of item returned by this template- Overrides:
getReturnedItemType
in classStyleElement
- Returns:
- the item type returned
-
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 classStyleElement
- Throws:
XPathException
-
validate
public void validate() 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 classStyleElement
- Throws:
XPathException
-
markTailCalls
public void markTailCalls()
Mark tail-recursive calls on templates and functions.- Overrides:
markTailCalls
in classStyleElement
-
compile
public Expression compile(Executable exec) throws XPathException
Compile: this registers the template with the rule manager, and ensures space is available for local variables- Specified by:
compile
in classStyleElement
- 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
-
getSlotManager
public SlotManager getSlotManager()
Get associated Procedure (for details of stack frame)- Specified by:
getSlotManager
in interfaceStylesheetProcedure
- Returns:
- the associated SlotManager object
-
allocateSlots
public void allocateSlots(Expression exp)
Allocate space for range variables within predicates in the match pattern. The xsl:template element has no XPath expressions among its attributes, so if this method is called on this object it can only be because there are variables used in the match pattern. We work out how many slots are needed for the match pattern in each template rule, and then apply-templates can allocate a stack frame that is large enough for the most demanding match pattern in the entire stylesheet.- Overrides:
allocateSlots
in classStyleElement
- Parameters:
exp
- The expression containing range variables. This will be a predicate within a match pattern, or possibly an argument to id() or key() used in a match pattern.
-
getCompiledTemplate
public Template getCompiledTemplate()
Get the compiled template
-
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
-
-