net.sf.saxon.expr.instruct

Class TemplateRule

java.lang.Object

net.sf.saxon.expr.instruct.TemplateRule

All Implemented Interfaces:

SourceLocator, Location, RuleTarget, Locator

public class TemplateRule
extends Object
implements RuleTarget, Location

The runtime object corresponding to an 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 old Template class is split into NamedTemplate and TemplateRule.

Constructor Summary

Constructors

Constructor and Description
TemplateRule() Create a template

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(XPathContextMajor context) Process the template, without returning any tail calls.
TailCall	applyLeavingTail(XPathContext context) Process this template, with the possibility of returning a tail call package if the template contains any tail calls that are to be performed by the caller.
TemplateRule	copy() Create a copy of a template rule.
void	explainProperties(ExpressionPresenter presenter)
void	export(ExpressionPresenter presenter) Output diagnostic explanation to an ExpressionPresenter
Expression	getBody()
int	getColumnNumber() Get the column number.
int	getComponentKind()
int	getConstructType() Get the type of construct.
int	getContainerGranularity()
Expression	getInterpretedBody()
TemplateInversion	getInversion()
int	getLineNumber() Get the line number.
LocalParam	getLocalParam(StructuredQName id) Get the local parameter with a given parameter id
List<LocalParam>	getLocalParams()
Pattern	getMatchPattern() Get the match pattern used with this template
PackageData	getPackageData()
String	getPublicId() Get the Public ID
ItemType	getRequiredContextItemType()
SequenceType	getRequiredType() Get the required type to be returned by this template
List<Rule>	getRules() Get the rules that use this template.
SlotManager	getStackFrameMap()
String	getSystemId() Get the system ID.
boolean	hasRequiredParams() Ask whether this template has one or more required parameters
boolean	isActuallyStreamable(boolean allowExtensions, List<String> reasons) Ask whether this template satisfies the rules for a guaranteed streamable template
boolean	isDeclaredStreamable() Ask whether or not this template is declared as streamable
boolean	isMayOmitContextItem()
boolean	isMaySupplyContextItem()
void	makeInversion() Generate the inversion of the expression comprising the body of a template rules.
void	registerRule(Rule rule) Register a rule for which this is the target
Location	saveLocation() Get an immutable copy of this Location object.
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	setDeclaredStreamable(boolean streamable) Say whether or not this template is declared as streamable
void	setHasRequiredParams(boolean has) Set whether this template has one or more required parameters
void	setLineNumber(int line)
void	setMatchPattern(Pattern pattern) Set the match pattern used with this template
void	setPackageData(PackageData data)
void	setRequiredType(SequenceType type) Set the required type to be returned by this template
void	setStackFrameMap(SlotManager map)
void	setSystemId(String id)
void	updateSlaveCopies() Update the properties of template rules that have been marked as slave copies of this one (typically the same template, but in a different mode).

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateRule

public TemplateRule()

Create a template

Method Detail

setMatchPattern

public void setMatchPattern(Pattern pattern)

Set the match pattern used with this template

Parameters:

pattern - the match pattern (may be null for a named template)

getBody

public Expression getBody()

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()

getMatchPattern

public Pattern getMatchPattern()

Get the match pattern used with this template

Returns:

the match pattern, or null if this is a named template with no match pattern. In the case of a template rule whose pattern is a union pattern, this will be the original union pattern; the individual Rule objects contain the branches of the union pattern.

setBody

public void setBody(Expression body)

Set the expression that forms the body of the template

Parameters:

body - the body of the template

setStackFrameMap

public void setStackFrameMap(SlotManager map)

getStackFrameMap

public SlotManager getStackFrameMap()

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

registerRule

public void registerRule(Rule rule)

Register a rule for which this is the target

Specified by:

registerRule in interface RuleTarget

Parameters:

rule - a rule in which this is the target

getRules

public List<Rule> getRules()

Get the rules that use this template. For a template with no match pattern, this will be an empty list. For a union pattern, there will be one rule for each branch of the union.

Returns:

the rules corresponding to this template.

setDeclaredStreamable

public void setDeclaredStreamable(boolean streamable)

Say whether or not this template is declared as streamable

Parameters:

streamable - true if the template belongs to a streamable mode; set to false if it does not belong to a streamable mode, or if it is found that the template is not actually streamable, and fallback to non-streaming has been requested.

isDeclaredStreamable

public boolean isDeclaredStreamable()

Ask whether or not this template is declared as streamable

Returns:

true if the template belongs to a streamable mode; false if it does not belong to a streamable mode, or if it is found that the template is not actually streamable, and fallback to non-streaming has been requested.

getContainerGranularity

public int getContainerGranularity()

getPackageData

public PackageData getPackageData()

setPackageData

public void setPackageData(PackageData data)

getPublicId

public String getPublicId()

Description copied from interface: Location

Get the Public ID

Specified by:

getPublicId in interface SourceLocator

Specified by:

getPublicId in interface Location

Specified by:

getPublicId in interface Locator

Returns:

usually null

getSystemId

public String getSystemId()

Description copied from interface: Location

Get the system ID. This should be the system identifier of an XML external entity; if a stylesheet module comprises multiple external entities, the distinction should be retained. This means, for example, that an instruction in a stylesheet can have a different system identifier from its parent instruction. However, SAX parsers only provide location information at the element level, so when part of an XPath expression is in a different external entity from other parts of the same expression, this distinction is lost.

The system identifier of a node is in general not the same as its base URI. The base URI is affected by xml:base attributes; the system identifier is not.

Specified by:

getSystemId in interface SourceLocator

Specified by:

getSystemId in interface Location

Specified by:

getSystemId in interface Locator

Returns:

the system ID, or null if the information is not available.

setSystemId

public void setSystemId(String id)

getLineNumber

public int getLineNumber()

Description copied from interface: Location

Get the line number. This line number is relative to the external entity identified by the system identifier. Line numbers start at 1. The value may be an approximation; SAX parsers only provide line number information at the level of element nodes.

Specified by:

getLineNumber in interface SourceLocator

Specified by:

getLineNumber in interface Location

Specified by:

getLineNumber in interface Locator

Returns:

the line number, or -1 if the information is not available.

setLineNumber

public void setLineNumber(int line)

getColumnNumber

public int getColumnNumber()

Description copied from interface: Location

Get the column number. This column number is relative to the line identified by the line number. Column numbers start at 1.

Specified by:

getColumnNumber in interface SourceLocator

Specified by:

getColumnNumber in interface Location

Specified by:

getColumnNumber in interface Locator

Returns:

the column number, or -1 if the information is not available.

saveLocation

public Location saveLocation()

Get an immutable copy of this Location object. By default Location objects may be mutable, so they should not be saved for later use. The result of this operation holds the same location information, but in an immutable form.

Specified by:

saveLocation in interface Location

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

apply

public void apply(XPathContextMajor context)
           throws XPathException

Process the template, without returning any tail calls. This path is used by xsl:apply-imports and xsl:next-match

Parameters:

context - The dynamic context, giving access to the current node,

Throws:

XPathException - if a dynamic error occurs while evaluating the template

applyLeavingTail

public TailCall applyLeavingTail(XPathContext context)
                          throws XPathException

Process this template, with the possibility of returning a tail call package if the template contains any tail calls that are to be performed by the caller.

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.

export

public void export(ExpressionPresenter presenter)

Output diagnostic explanation to an ExpressionPresenter

Specified by:

export in interface RuleTarget

Parameters:

presenter - the destination for the explanation

explainProperties

public void explainProperties(ExpressionPresenter presenter)

getInterpretedBody

public Expression getInterpretedBody()

copy

public TemplateRule copy()

Create a copy of a template rule. This is needed when copying a rule from the "omniMode" (mode=#all) to a specific mode. Because we want the rules to be chained in the right order within the mode object, we create the copy as soon as we know it is needed. The problem is that at this stage many of the properties of the template rule are still uninitialised. So we mark the new copy as a slave of the original, and at the end of the compilation process we update all the slave copies to match the properties of the original.

updateSlaveCopies

public void updateSlaveCopies()

Update the properties of template rules that have been marked as slave copies of this one (typically the same template, but in a different mode).

isActuallyStreamable

public boolean isActuallyStreamable(boolean allowExtensions,
                           List<String> reasons)

Ask whether this template satisfies the rules for a guaranteed streamable template

Parameters:

allowExtensions - if true, the method tests for streamability against the Saxon rules rather than the W3C rules

reasons - the caller may supply a list which on return will contain explanations for why the template is not streamable, suitable for inclusion in error messages

Returns:

true if the template is within the (Saxon or W3C) definition of guaranteed streamable

makeInversion

public void makeInversion()
                   throws XPathException

Generate the inversion of the expression comprising the body of a template rules. Supported in Saxon-EE only

Throws:

XPathException

getInversion

public TemplateInversion getInversion()