net.sf.saxon.style
Class XSLTemplate

java.lang.Object
  extended by net.sf.saxon.tree.NodeImpl
      extended by net.sf.saxon.tree.ParentNodeImpl
          extended by net.sf.saxon.tree.ElementImpl
              extended by net.sf.saxon.style.StyleElement
                  extended by net.sf.saxon.style.XSLTemplate
All Implemented Interfaces:
java.io.Serializable, javax.xml.transform.Source, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, PullEvent, Container, FingerprintedNode, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, SiblingCountingNode, ValueRepresentation, StylesheetProcedure, InstructionInfo, org.xml.sax.Locator

public final class XSLTemplate
extends StyleElement
implements StylesheetProcedure

An xsl:template element in the style sheet.

See Also:
Serialized Form

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.ElementImpl
attributeList, nameCode, namespaceList, typeCode
 
Fields inherited from class net.sf.saxon.tree.ParentNodeImpl
children, 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
 
Constructor Summary
XSLTemplate()
           
 
Method Summary
 Expression compile(Executable exec)
          Compile: this registers the template with the rule manager, and ensures space is available for local variables
 Template getCompiledTemplate()
          Get the compiled template
 int getConstructType()
          Get the type of construct.
protected  ItemType getReturnedItemType()
          Determine the type of item returned by this template
 SlotManager getSlotManager()
          Get associated Procedure (for details of stack frame)
 StructuredQName getTemplateName()
          Return the name of this template.
protected  void index(XSLStylesheet top)
          Method supplied by declaration elements to add themselves to a stylesheet-level index
protected  boolean isPermittedChild(StyleElement child)
          Specify that xsl:param is a permitted child
 boolean markTailCalls()
          Mark tail-recursive calls on templates and functions.
protected  boolean mayContainParam(java.lang.String attName)
          Determine whether this type of element is allowed to contain an xsl:param element
 boolean mayContainSequenceConstructor()
          Determine whether this type of element is allowed to contain a template-body
 void optimize()
          Optimize the stylesheet construct
 void postValidate()
          Hook to allow additional validation of a parent element immediately after its children have been validated.
 void 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, allocatePatternSlots, allocateSlots, backwardsCompatibleModeIsEnabled, bindVariable, checkEmpty, checkSortComesFirst, checkTopLevel, checkUnknownAttribute, checkWithinTemplate, compileError, compileError, compileError, compileError, compileSequenceConstructor, compileWarning, compileWarning, definesExcludedNamespace, definesExtensionElement, fallbackProcessing, fixupReferences, forwardsCompatibleModeIsEnabled, getAllStylesheetFunctions, getAttributeSets, getAttributeValue, getColumnNumber, getCommonChildItemType, getContainerGranularity, getContainingSlotManager, getContainingStylesheet, getDefaultCollationName, getDefaultXPathNamespace, getExecutable, getHostLanguage, getLastChildInstruction, getLineNumber, getLocationProvider, getNamespaceResolver, getObjectName, getPrecedence, getPreparedStylesheet, getPrincipalStylesheet, getProperties, getProperty, getSchemaType, getStaticContext, getStylesheetFunction, getSystemId, getTypeAnnotation, getVersion, getWithParamInstructions, isExcludedNamespace, isExplaining, isExtensionNamespace, isInstruction, issueWarning, issueWarning, isTopLevel, makeAttributeValueTemplate, makeExpression, makeExpressionVisitor, makeNamespaceContext, makePattern, makeQName, makeSequenceType, makeSortKeys, makeTraceInstruction, mayContainFallback, processAllAttributes, processAttributes, processDefaultCollationAttribute, processDefaultXPathNamespaceAttribute, processExcludedNamespaces, processExtensionElementAttribute, processStandardAttributes, processVersionAttribute, replaceSubExpression, reportAbsence, seesAvuncularVariables, setObjectName, setValidationError, substituteFor, typeCheck, typeCheck, undeclaredNamespaceError, validateChildren, validateSubtree
 
Methods inherited from class net.sf.saxon.tree.ElementImpl
addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getInScopeNamespaceCodes, getLineNumber, getNameCode, getNodeKind, getPrefixForURI, getRoot, getSystemId, getTypeAnnotation, getURICodeForPrefix, getURICodeForPrefixCode, getURIForPrefix, initialise, isId, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setLineAndColumn, setLocation, setNameCode, setNamespaceDeclarations, setSystemId, setTypeAnnotation
 
Methods inherited from class net.sf.saxon.tree.ParentNodeImpl
addChild, compact, enumerateChildren, getFirstChild, getLastChild, getNthChild, getNumberOfChildren, getSequenceNumber, getStringValue, getStringValueCS, hasChildNodes, insertChildren, insertChildrenAt, removeChild, replaceChildrenAt, useChildrenArray
 
Methods inherited from class net.sf.saxon.tree.NodeImpl
atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getTypedValue, getURI, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace
 
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, getPublicId
 
Methods inherited from interface net.sf.saxon.om.NodeInfo
hashCode
 

Constructor Detail

XSLTemplate

public XSLTemplate()
Method Detail

mayContainSequenceConstructor

public boolean mayContainSequenceConstructor()
Determine whether this type of element is allowed to contain a template-body

Overrides:
mayContainSequenceConstructor in class StyleElement
Returns:
true: yes, it may contain a template-body

mayContainParam

protected boolean mayContainParam(java.lang.String attName)
Description copied from class: StyleElement
Determine whether this type of element is allowed to contain an xsl:param element

Overrides:
mayContainParam in class StyleElement
Parameters:
attName - if null, the method tests whether an xsl:param child is allowed. If non-null, it tests whether an xsl:param child with the given attribute name is allowed
Returns:
true if this element is allowed to contain an xsl:param

isPermittedChild

protected boolean isPermittedChild(StyleElement child)
Specify that xsl:param is a permitted child

Overrides:
isPermittedChild in class StyleElement
Parameters:
child - the child that may or may not be permitted
Returns:
true if the child is permitted.

getTemplateName

public StructuredQName getTemplateName()
Return the name of this template. Note that this may be called before prepareAttributes has been called.

Returns:
the name of the template as a Structured QName.

getReturnedItemType

protected ItemType getReturnedItemType()
Determine the type of item returned by this template

Overrides:
getReturnedItemType in class StyleElement
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 class StyleElement
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 class StyleElement
Throws:
XPathException

postValidate

public void postValidate()
                  throws XPathException
Description copied from class: StyleElement
Hook to allow additional validation of a parent element immediately after its children have been validated.

Overrides:
postValidate in class StyleElement
Throws:
XPathException

index

protected void index(XSLStylesheet top)
              throws XPathException
Description copied from class: StyleElement
Method supplied by declaration elements to add themselves to a stylesheet-level index

Overrides:
index in class StyleElement
Parameters:
top - the outermost XSLStylesheet element
Throws:
XPathException

markTailCalls

public boolean markTailCalls()
Mark tail-recursive calls on templates and functions.

Overrides:
markTailCalls in class StyleElement
Returns:
true if one or more tail calls were identified

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 class StyleElement
Parameters:
exec - the Executable
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

optimize

public void optimize()
              throws XPathException
Description copied from interface: StylesheetProcedure
Optimize the stylesheet construct

Specified by:
optimize in interface StylesheetProcedure
Throws:
XPathException

getSlotManager

public SlotManager getSlotManager()
Get associated Procedure (for details of stack frame)

Specified by:
getSlotManager in interface StylesheetProcedure
Returns:
the associated SlotManager object

getCompiledTemplate

public Template getCompiledTemplate()
Get the compiled template

Returns:
the compiled template

getConstructType

public int getConstructType()
Get the type of construct. This will be a constant in class Location. This method is part of the InstructionInfo interface

Specified by:
getConstructType in interface InstructionInfo
Overrides:
getConstructType in class StyleElement
Returns:
an integer identifying the kind of construct