Class ApplyTemplates

java.lang.Object
net.sf.saxon.expr.ComputedExpression
net.sf.saxon.instruct.Instruction
net.sf.saxon.instruct.ApplyTemplates
All Implemented Interfaces:
Serializable, SourceLocator, Container, Expression, TailCallReturner, InstructionInfoProvider
public class ApplyTemplates extends Instruction
An instruction representing an xsl:apply-templates element in the stylesheet
See Also:

  • Constructor Details

    • ApplyTemplates

      public ApplyTemplates(Expression select, boolean useCurrentMode, boolean useTailRecursion, Mode mode, boolean backwardsCompatible, boolean implicitSelect)

  • Method Details

    • setActualParameters

      public void setActualParameters(WithParam[] actualParams, WithParam[] tunnelParams)
      Set the actual parameters on the call

    • getInstructionNameCode

      public int getInstructionNameCode()
      Get the name of this instruction for diagnostic and tracing purposes
      Overrides:
      getInstructionNameCode in class Instruction

    • getInstructionInfo

      public InstructionInfo getInstructionInfo()
      Set additional trace properties appropriate to the kind of instruction. This implementation adds the mode attribute
      Specified by:
      getInstructionInfo in interface InstructionInfoProvider
      Overrides:
      getInstructionInfo in class Instruction

    • simplify

      public Expression simplify(StaticContext env) throws XPathException
      Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression).
      Specified by:
      simplify in interface Expression
      Specified by:
      simplify in class Instruction
      Parameters:
      env - the static context
      Returns:
      the simplified expression
      Throws:
      XPathException - if an error is discovered during expression rewriting

    • typeCheck

      public Expression typeCheck(StaticContext env, ItemType contextItemType) throws XPathException
      Description copied from interface: Expression
      Perform type checking of an expression and its subexpressions. This is the second phase of static optimization.

      This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

      This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared.

      If the implementation returns a value other than "this", then it is required to ensure that the parent pointer and location information in the returned expression have been set up correctly. It should not rely on the caller to do this, although for historical reasons many callers do so.

      Parameters:
      env - the static context of the expression
      contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
      Returns:
      the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
      Throws:
      XPathException

    • optimize

      public Expression optimize(Optimizer opt, StaticContext env, ItemType contextItemType) throws XPathException
      Description copied from interface: Expression
      Perform optimisation of an expression and its subexpressions. This is the third and final phase of static optimization.

      This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.

      Parameters:
      opt - the optimizer in use. This provides access to supporting functions; it also allows different optimization strategies to be used in different circumstances.
      env - the static context of the expression
      contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
      Returns:
      the original expression, rewritten if appropriate to optimize execution
      Throws:
      XPathException

    • createsNewNodes

      public final boolean createsNewNodes()
      Determine whether this instruction creates new nodes. This implementation returns true (which is almost invariably the case, so it's not worth doing any further analysis to find out more precisely).
      Overrides:
      createsNewNodes in class Instruction

    • process

      public void process(XPathContext context) throws XPathException
      Description copied from class: Instruction
      Process the instruction, without returning any tail calls
      Specified by:
      process in interface Expression
      Overrides:
      process in class Instruction
      Parameters:
      context - The dynamic context, giving access to the current node, the current variables, etc.
      Throws:
      XPathException

    • processLeavingTail

      public TailCall processLeavingTail(XPathContext context) throws XPathException
      Description copied from class: Instruction
      ProcessLeavingTail: called to do the real work of this instruction. This method must be implemented in each subclass. The results of the instruction are written to the current Receiver, which can be obtained via the Controller.
      Specified by:
      processLeavingTail in interface TailCallReturner
      Specified by:
      processLeavingTail in class Instruction
      Parameters:
      context - The dynamic context of the transformation, giving access to the current node, the current variables, etc.
      Returns:
      null if the instruction has completed execution; or a TailCall indicating a function call or template call that is delegated to the caller, to be made after the stack has been unwound so as to save stack space.
      Throws:
      XPathException

    • applyTemplates

      public static TailCall applyTemplates(SequenceIterator iterator, Mode mode, ParameterSet parameters, ParameterSet tunnelParameters, XPathContextMajor context, boolean backwardsCompatible, int locationId) throws XPathException
      Process selected nodes using the handlers registered for a particular mode.
      Parameters:
      iterator - an Iterator over the nodes to be processed, in the correct (sorted) order
      mode - Identifies the processing mode. It should match the mode defined when the element handler was registered using setHandler with a mode parameter. Set this parameter to null to invoke the default mode.
      parameters - A ParameterSet containing the parameters to the handler/template being invoked. Specify null if there are no parameters.
      tunnelParameters - A ParameterSet containing the parameters to the handler/template being invoked. Specify null if there are no parameters.
      context - A newly-created context object
      locationId -
      Returns:
      a TailCall returned by the last template to be invoked, or null, indicating that there are no outstanding tail calls.
      Throws:
      XPathException - if any dynamic error occurs

    • defaultAction

      public static void defaultAction(NodeInfo node, ParameterSet parameters, ParameterSet tunnelParams, XPathContext context, boolean backwardsCompatible, int locationId) throws XPathException
      Perform the built-in template action for a given node.
      Parameters:
      node - the node to be processed
      parameters - the parameters supplied to apply-templates
      tunnelParams - the tunnel parameters to be passed through
      backwardsCompatible - true if in 1.0 mode (currently makes no difference)
      locationId - location of the instruction (apply-templates, apply-imports etc) that caused the built-in template to be invoked
      Throws:
      XPathException - if any dynamic error occurs

    • iterateSubExpressions

      public Iterator iterateSubExpressions()
      Get all the XPath expressions associated with this instruction (in XSLT terms, the expression present on attributes of the instruction, as distinct from the child instructions in a sequence construction)
      Specified by:
      iterateSubExpressions in interface Expression
      Overrides:
      iterateSubExpressions in class ComputedExpression
      Returns:
      an iterator containing the sub-expressions of this expression

    • replaceSubExpression

      public boolean replaceSubExpression(Expression original, Expression replacement)
      Replace one subexpression by a replacement subexpression
      Specified by:
      replaceSubExpression in interface Container
      Overrides:
      replaceSubExpression in class ComputedExpression
      Parameters:
      original - the original subexpression
      replacement - the replacement subexpression
      Returns:
      true if the original subexpression is found

    • getSelectExpression

      public Expression getSelectExpression()
      Get the select expression

    • promoteInst

      protected void promoteInst(PromotionOffer offer) throws XPathException
      Handle promotion offers, that is, non-local tree rewrites.
      Overrides:
      promoteInst in class Instruction
      Parameters:
      offer - The type of rewrite being offered
      Throws:
      XPathException

    • display

      public void display(int level, PrintStream out, Configuration config)
      Diagnostic print of expression structure. The expression is written to the System.err output stream
      Parameters:
      level - indentation level for this expression
      out -
      config -