Package net.sf.saxon.expr.instruct

Class TemplateRule

java.lang.Object
net.sf.saxon.expr.instruct.TemplateRule
All Implemented Interfaces:
SourceLocator, ExpressionOwner, Location, InstructionInfo, RuleTarget, Locator
public class TemplateRule extends Object implements RuleTarget, Location, ExpressionOwner, InstructionInfo
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.

From Saxon 9.8, a subclass is used in Saxon-EE

  • Field Details

  • Constructor Details

    • TemplateRule

      public TemplateRule()
      Create a template

  • Method Details

    • 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 absentFocus)
      Set the required context item type. Used when there is an xsl:context-item child element
      Parameters:
      type - the required context item type
      absentFocus - true if the context item is treated as absent even if supplied (use="absent")

    • 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.

    • 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 Location
      Specified by:
      getPublicId in interface Locator
      Specified by:
      getPublicId in interface SourceLocator
      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 Location
      Specified by:
      getSystemId in interface Locator
      Specified by:
      getSystemId in interface SourceLocator
      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 Location
      Specified by:
      getLineNumber in interface Locator
      Specified by:
      getLineNumber in interface SourceLocator
      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 Location
      Specified by:
      getColumnNumber in interface Locator
      Specified by:
      getColumnNumber in interface SourceLocator
      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()

    • isAbsentFocus

      public boolean isAbsentFocus()

    • getLocalParams

      public List<LocalParam> getLocalParams()

    • prepareInitializer

      public void prepareInitializer(Compilation compilation, ComponentDeclaration decl, StructuredQName modeName)
      Prepare for JIT compilation.
      Parameters:
      compilation - the XSLT compilation
      decl - the component declaration of this template rule

    • initialize

      public void initialize() throws XPathException
      Ensure that any first-time initialization has been done. Used in Saxon-EE to do JIT compilation
      Throws:
      XPathException

    • 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.
      Specified by:
      getConstructType in interface InstructionInfo
      Returns:
      an integer identifying the kind of construct

    • export

      public void export(ExpressionPresenter presenter) throws XPathException
      Output diagnostic explanation to an ExpressionPresenter
      Specified by:
      export in interface RuleTarget
      Parameters:
      presenter - the destination for the explanation
      Throws:
      XPathException

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

    • explainProperties

      public void explainProperties(ExpressionPresenter presenter) throws XPathException
      Throws:
      XPathException

    • 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).

    • copyTo

      protected void copyTo(TemplateRule tr)

    • setChildExpression

      public void setChildExpression(Expression expr)
      Specified by:
      setChildExpression in interface ExpressionOwner

    • getObjectName

      public StructuredQName getObjectName()
      Description copied from interface: InstructionInfo
      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.
      Specified by:
      getObjectName in interface InstructionInfo
      Returns:
      the QName of the object declared or manipulated by this instruction or expression

    • getProperty

      public Object getProperty(String name)
      Description copied from interface: InstructionInfo
      Get the value of a particular property of the instruction. Properties of XSLT instructions are generally known by the name of the stylesheet attribute that defines them.
      Specified by:
      getProperty in interface InstructionInfo
      Parameters:
      name - The name of the required property
      Returns:
      The value of the requested property, or null if the property is not available

    • getProperties

      public Iterator<String> getProperties()
      Description copied from interface: InstructionInfo
      Get an iterator over all the properties available. The values returned by the iterator will be of type String, and each string can be supplied as input to the getProperty() method to retrieve the value of the property. The iterator may return properties whose value is null.
      Specified by:
      getProperties in interface InstructionInfo
      Returns:
      an iterator over the properties.