Class XSLTemplate
- All Implemented Interfaces:
Source, SourceLocator, LocationProvider, SaxonLocator, Container, FingerprintedNode, Item, NodeInfo, ValueRepresentation, StylesheetProcedure, InstructionInfo, Locator
An xsl:template element in the style sheet.
-
Field Summary
Fields inherited from class StyleElement
defaultCollationName, defaultXPathNamespace, extensionNamespaces, REPORT_ALWAYS, REPORT_IF_INSTANTIATED, REPORT_UNLESS_FALLBACK_AVAILABLE, REPORT_UNLESS_FORWARDS_COMPATIBLE, reportingCircumstances, staticContext, validationError, versionFields inherited from class ElementWithAttributes
attributeList, namespaceListFields inherited from class ElementImpl
nameCode, rootFields inherited from class ParentNodeImpl
sequenceFields inherited from class NodeImpl
index, NODE_LETTER, parentFields inherited from interface NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACESFields inherited from interface ValueRepresentation
EMPTY_VALUE_ARRAY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidallocateSlots(Expression exp) Allocate space for range variables within predicates in the match pattern.compile(Executable exec) Compile: this registers the template with the rule manager, and ensures space is available for local variablesGet the compiled templateintGet the type of construct.protected ItemTypeDetermine the type of item returned by this templateGet associated Procedure (for details of stack frame)intReturn the fingerprint for the name of this template.protected booleanisPermittedChild(StyleElement child) Specify that xsl:param is a permitted childvoidMark tail-recursive calls on templates and functions.booleanDetermine whether this type of element is allowed to contain a template-bodyvoidSet the attribute list for the element.voidvalidate()Check that the stylesheet element is valid.Methods inherited from class 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, validateSubtreeMethods inherited from class ElementWithAttributes
copy, getAttributeList, getAttributeValue, getDeclaredNamespaces, getInScopeNamespaceCodes, getPrefixForURI, getURICodeForPrefix, getURIForPrefix, initialise, iteratePrefixes, sendNamespaceDeclarations, setNamespaceDeclarationsMethods inherited from class ElementImpl
generateId, getBaseURI, getDocumentRoot, getNameCode, getNodeKind, getRoot, getSystemId, setNameCode, setSystemIdMethods inherited from class ParentNodeImpl
addChild, compact, enumerateChildren, getFirstChild, getLastChild, getNthChild, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, useChildrenArrayMethods inherited from class NodeImpl
atomize, compareOrder, equals, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getTypeAnnotation, getTypedValue, getURI, hashCode, isSameNodeInfo, iterateAxis, iterateAxisMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface InstructionInfo
getSystemIdMethods inherited from interface Locator
getColumnNumber, getPublicIdMethods inherited from interface SourceLocator
getColumnNumber, getPublicId, getSystemId
-
Constructor Details
-
XSLTemplate
public XSLTemplate()
-
-
Method Details
-
mayContainSequenceConstructor
public boolean mayContainSequenceConstructor()Determine whether this type of element is allowed to contain a template-body- Overrides:
mayContainSequenceConstructorin classStyleElement- Returns:
- true: yes, it may contain a template-body
-
isPermittedChild
Specify that xsl:param is a permitted child- Overrides:
isPermittedChildin 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
Determine the type of item returned by this template- Overrides:
getReturnedItemTypein classStyleElement- Returns:
- the item type returned
-
prepareAttributes
Description copied from class:StyleElementSet 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:
prepareAttributesin classStyleElement- Throws:
XPathException
-
validate
Description copied from class:StyleElementCheck 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:
validatein classStyleElement- Throws:
XPathException
-
markTailCalls
public void markTailCalls()Mark tail-recursive calls on templates and functions.- Overrides:
markTailCallsin classStyleElement
-
compile
Compile: this registers the template with the rule manager, and ensures space is available for local variables- Specified by:
compilein 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
Get associated Procedure (for details of stack frame)- Specified by:
getSlotManagerin interfaceStylesheetProcedure- Returns:
- the associated SlotManager object
-
allocateSlots
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:
allocateSlotsin 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
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 theInstructionInfointerface- Specified by:
getConstructTypein interfaceInstructionInfo- Overrides:
getConstructTypein classStyleElement
-