net.sf.saxon.instruct
Class ApplyTemplates

java.lang.Object
  |
  +--net.sf.saxon.expr.ComputedExpression
        |
        +--net.sf.saxon.instruct.Instruction
              |
              +--net.sf.saxon.instruct.ApplyTemplates
All Implemented Interfaces:
Container, Expression, InstructionInfoProvider, java.io.Serializable, javax.xml.transform.SourceLocator

public class ApplyTemplates
extends Instruction

An instruction representing an xsl:apply-templates element in the stylesheet

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
 
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
 
Constructor Summary
ApplyTemplates(Expression select, WithParam[] actualParams, WithParam[] tunnelParams, boolean useCurrentMode, boolean useTailRecursion, Mode mode)
           
 
Method Summary
 Expression analyze(StaticContext env, ItemType contextItemType)
          Perform static analysis of an expression and its subexpressions.
static TailCall applyTemplates(SequenceIterator iterator, Mode mode, ParameterSet parameters, ParameterSet tunnelParameters, XPathContextMajor context)
          Process selected nodes using the handlers registered for a particular mode.
static void defaultAction(NodeInfo node, ParameterSet parameters, ParameterSet tunnelParams, XPathContext context)
          Perform the built-in template action for a given node.
 void display(int level, NamePool pool, java.io.PrintStream out)
          Diagnostic print of expression structure.
 InstructionInfo getInstructionInfo()
          Set additional trace properties appropriate to the kind of instruction.
 int getInstructionNameCode()
          Get the name of this instruction for diagnostic and tracing purposes
 java.util.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)
 void process(XPathContext context)
          Process the instruction, without returning any tail calls
 TailCall processLeavingTail(XPathContext context)
          ProcessLeavingTail: called to do the real work of this instruction.
protected  void promoteInst(PromotionOffer offer)
          Handle promotion offers, that is, non-local tree rewrites.
 Expression simplify(StaticContext env)
          Simplify an expression.
 
Methods inherited from class net.sf.saxon.instruct.Instruction
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getImplementationMethod, getItemType, getSourceLocator, iterate, promote
 
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, computeDependencies, computeStaticProperties, dynamicError, dynamicError, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getIntrinsicDependencies, getLineNumber, getLocationId, getParentExpression, getPublicId, getSpecialProperties, getSystemId, markTailFunctionCalls, resetStaticProperties, setLocationId, setParentExpression, typeError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
 

Constructor Detail

ApplyTemplates

public ApplyTemplates(Expression select,
                      WithParam[] actualParams,
                      WithParam[] tunnelParams,
                      boolean useCurrentMode,
                      boolean useTailRecursion,
                      Mode mode)
Method Detail

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
Returns:
the simplified expression
Throws:
XPathException - if an error is discovered during expression rewriting

analyze

public Expression analyze(StaticContext env,
                          ItemType contextItemType)
                   throws XPathException
Perform static analysis of an expression and its subexpressions.

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 will only be accurately known if they have been explicitly declared.

Specified by:
analyze in interface Expression
Specified by:
analyze in class Instruction
Parameters:
env - the static context of the expression
Returns:
the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
Throws:
XPathException - if an error is discovered during this phase (typically a type error)

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

applyTemplates

public static TailCall applyTemplates(SequenceIterator iterator,
                                      Mode mode,
                                      ParameterSet parameters,
                                      ParameterSet tunnelParameters,
                                      XPathContextMajor context)
                               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
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)
                          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
Throws:
XPathException - if any dynamic error occurs

iterateSubExpressions

public java.util.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

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,
                    NamePool pool,
                    java.io.PrintStream out)
Diagnostic print of expression structure. The expression is written to the System.err output stream

Parameters:
level - indentation level for this expression
out -
pool - NamePool used to expand any names appearing in the expression