net.sf.saxon.expr.instruct

Class NamedTemplate

java.lang.Object

net.sf.saxon.expr.instruct.ComponentCode<NamedTemplate>

net.sf.saxon.expr.instruct.NamedTemplate

All Implemented Interfaces:

SourceLocator, Location, InstructionInfo, Locator

public class NamedTemplate
extends ComponentCode<NamedTemplate>

The runtime object corresponding to a named xsl:template element in the stylesheet.

Note that the Template object no longer has precedence information associated with it; this is now only in the Rule object that references this Template. This allows two rules to share the same template, with different precedences. This occurs when a stylesheet module is imported more than once, from different places, with different import precedences.

From Saxon 9.7, the NamedTemplate and TemplateRule objects are separated. A NamedTemplate represents a template with a name attribute; a TemplateRule is a template with a match attribute. If an xsl:template declaration has both attributes, two objects are created.

Field Summary

Fields inherited from class net.sf.saxon.expr.instruct.ComponentCode

body

Constructor Summary

Constructors

Constructor and Description
NamedTemplate() Create a named template

Method Summary

Methods

Modifier and Type	Method and Description
TailCall	expand(XPathContext context) Expand the template.
void	explainProperties(ExpressionPresenter presenter)
void	export(ExpressionPresenter presenter) Output diagnostic explanation to an ExpressionPresenter
int	getComponentKind() Get the kind of component that this represents, using integer constants such as StandardNames.XSL_FUNCTION
int	getConstructType() Get the type of construct.
Expression	getInterpretedBody()
LocalParam	getLocalParam(StructuredQName id) Get the local parameter with a given parameter id
List<LocalParam>	getLocalParams()
StructuredQName	getObjectName() Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc.
ItemType	getRequiredContextItemType()
SequenceType	getRequiredType() Get the required type to be returned by this template
SymbolicName	getSymbolicName() Get the symbolic name of the component
StructuredQName	getTemplateName() Get the name of the template (if it is named)
boolean	hasRequiredParams() Ask whether this template has one or more required parameters
boolean	isMayOmitContextItem()
boolean	isMaySupplyContextItem()
void	setBody(Expression body) Set the expression that forms the body of the template
void	setContextItemRequirements(ItemType type, boolean mayBeOmitted, boolean mayBeSupplied) Set the required context item type.
void	setHasRequiredParams(boolean has) Set whether this template has one or more required parameters
void	setRequiredType(SequenceType type) Set the required type to be returned by this template
void	setTemplateName(StructuredQName templateName) Initialize the template

Methods inherited from class net.sf.saxon.expr.instruct.ComponentCode

allocateAllBindingSlots, allocateBindingSlotsRecursive, getBody, getColumnNumber, getDeclaredVisibility, getDeclaringComponent, getLineNumber, getLocation, getPackageData, getProperties, getProperty, getPublicId, getRetainedStaticContext, getStackFrameMap, getSystemId, makeDeclaringComponent, saveLocation, setDeclaredVisibility, setDeclaringComponent, setLineNumber, setPackageData, setRetainedStaticContext, setStackFrameMap, setSystemId

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedTemplate

public NamedTemplate()

Create a named template

Method Detail

setTemplateName

public void setTemplateName(StructuredQName templateName)

Initialize the template

Parameters:

templateName - the name of the template (if any) performed by apply-imports

setContextItemRequirements

public void setContextItemRequirements(ItemType type,
                              boolean mayBeOmitted,
                              boolean mayBeSupplied)

Set the required context item type. Used when there is an xsl:context-item child element

Parameters:

type - the required context item type

mayBeOmitted - true if the context item may be absent

mayBeSupplied - true if the context item may be supplied

getComponentKind

public int getComponentKind()

Description copied from class: ComponentCode

Get the kind of component that this represents, using integer constants such as StandardNames.XSL_FUNCTION

Specified by:

getComponentKind in class ComponentCode<NamedTemplate>

getSymbolicName

public SymbolicName getSymbolicName()

Description copied from class: ComponentCode

Get the symbolic name of the component

Specified by:

getSymbolicName in class ComponentCode<NamedTemplate>

Returns:

the symbolic name

setBody

public void setBody(Expression body)

Set the expression that forms the body of the template

Overrides:

setBody in class ComponentCode<NamedTemplate>

Parameters:

body - the body of the template

getTemplateName

public StructuredQName getTemplateName()

Get the name of the template (if it is named)

Returns:

the template name, or null if unnamed

getObjectName

public StructuredQName getObjectName()

Get a name identifying the object of the expression, for example a function name, template name, variable name, key name, element name, etc. This is used only where the name is known statically.

Returns:

the QName of the object declared or manipulated by this instruction or expression

setHasRequiredParams

public void setHasRequiredParams(boolean has)

Set whether this template has one or more required parameters

Parameters:

has - true if the template has at least one required parameter

hasRequiredParams

public boolean hasRequiredParams()

Ask whether this template has one or more required parameters

Returns:

true if this template has at least one required parameter

setRequiredType

public void setRequiredType(SequenceType type)

Set the required type to be returned by this template

Parameters:

type - the required type as defined in the "as" attribute on the xsl:template element

getRequiredType

public SequenceType getRequiredType()

Get the required type to be returned by this template

Returns:

the required type as defined in the "as" attribute on the xsl:template element

getRequiredContextItemType

public ItemType getRequiredContextItemType()

isMayOmitContextItem

public boolean isMayOmitContextItem()

isMaySupplyContextItem

public boolean isMaySupplyContextItem()

getLocalParams

public List<LocalParam> getLocalParams()

getLocalParam

public LocalParam getLocalParam(StructuredQName id)

Get the local parameter with a given parameter id

Parameters:

id - the parameter id

Returns:

the local parameter with this id if found, otherwise null

expand

public TailCall expand(XPathContext context)
                throws XPathException

Expand the template. Called when the template is invoked using xsl:call-template. Invoking a template by this method does not change the current template.

Parameters:

context - the XPath dynamic context

Returns:

null if the template exited normally; but if it was a tail call, details of the call that hasn't been made yet and needs to be made by the caller

Throws:

XPathException - if a dynamic error occurs while evaluating the template

getConstructType

public int getConstructType()

Get the type of construct. This will either be the fingerprint of a standard XSLT instruction name (values in StandardNames: all less than 1024) or it will be a constant in class LocationKind.

Returns:

an integer identifying the kind of construct

export

public void export(ExpressionPresenter presenter)

Output diagnostic explanation to an ExpressionPresenter

Specified by:

export in class ComponentCode<NamedTemplate>

Parameters:

presenter - the expression presenter used to generate the XML representation of the structure

explainProperties

public void explainProperties(ExpressionPresenter presenter)

getInterpretedBody

public Expression getInterpretedBody()