public class CallTemplate extends Instruction implements ITemplateCall
| Modifier and Type | Class and Description |
|---|---|
static class |
CallTemplate.CallTemplatePackage
A CallTemplatePackage is an object that encapsulates the name of a template to be called,
the parameters to be supplied, and the execution context.
|
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, INHERITED_CONTEXT, INSPECTION_CONTEXT, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, NAVIGATION_CONTEXT, NODE_VALUE_CONTEXT, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, W3C_CONSUMING, W3C_FREE_RANGING, W3C_GROUP_CONSUMING, W3C_MOTIONLESS, WATCH_METHOD| Constructor and Description |
|---|
CallTemplate(Template template,
boolean useTailRecursion,
Expression calledTemplateExpression,
NamespaceResolver nsContext)
Construct a CallTemplate instruction.
|
| Modifier and Type | Method and Description |
|---|---|
int |
computeCardinality()
Get the cardinality of the sequence returned by evaluating this instruction
|
Expression |
copy()
Copy an expression.
|
boolean |
createsNewNodes()
Determine whether this instruction creates new nodes.
|
void |
explain(ExpressionPresenter out)
Diagnostic print of expression structure.
|
WithParam[] |
getActualParams()
Get the actual parameters passed to the called template
|
Expression |
getCalledTemplateExpression() |
ExpressionCompiler |
getExpressionCompiler()
Return the compiler of the CallTemplate expression
|
int |
getInstructionNameCode()
Return the name of this instruction.
|
int |
getIntrinsicDependencies()
Determine the intrinsic dependencies of an expression, that is, those which are not derived
from the dependencies of its subexpressions.
|
ItemType |
getItemType(TypeHierarchy th)
Get the item type of the items returned by evaluating this instruction
|
NamespaceResolver |
getNsContext() |
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.
|
Template |
getTargetTemplate()
Get the target template, if known statically
|
Template |
getTargetTemplate(XPathContext context)
Get the template, in the case where it is specified dynamically.
|
WithParam[] |
getTunnelParams()
Get the tunnel parameters passed to the called template
|
Iterator<Expression> |
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)
|
Expression |
optimize(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform optimisation of an expression and its subexpressions.
|
void |
process(XPathContext context)
Process this instruction, without leaving any tail calls.
|
TailCall |
processLeavingTail(XPathContext context)
Process this instruction.
|
protected void |
promoteInst(PromotionOffer offer)
Handle promotion offers, that is, non-local tree rewrites.
|
boolean |
replaceSubExpression(Expression original,
Expression replacement)
Replace one subexpression by a replacement subexpression
|
void |
setActualParameters(WithParam[] actualParams,
WithParam[] tunnelParams)
Set the actual parameters on the call
|
Expression |
simplify(ExpressionVisitor visitor)
Simplify an expression.
|
Expression |
typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Perform type checking of an expression and its subexpressions.
|
boolean |
usesTailRecursion()
Ask whether this is a tail call
|
assembleParams, assembleTunnelParams, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getImplementationMethod, getInstructionName, getIteratorFromProcessMethod, getSourceLocator, isXSLT, iterate, promoteaddToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getColumnNumber, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getIntegerBounds, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getStreamability, getStreamingAdjunct, getSystemId, getSystemId, hasVariableBinding, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, iterateSubExpressionInfo, markTailFunctionCalls, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, toString, typeErrorclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetColumnNumber, getLineNumber, getPublicId, getSystemIdpublic CallTemplate(Template template, boolean useTailRecursion, Expression calledTemplateExpression, NamespaceResolver nsContext)
template - the Template object identifying the template to be called, in the normal
case where this is known staticallyuseTailRecursion - true if the call is potentially tail recursivecalledTemplateExpression - expression to calculate the name of the template to be called
at run-time, this supports the saxon:allow-avt optionnsContext - the static namespace context of the instruction, needed only in the case
where the name of the called template is to be calculated dynamicallypublic Expression getCalledTemplateExpression()
public NamespaceResolver getNsContext()
public void setActualParameters(WithParam[] actualParams, WithParam[] tunnelParams)
actualParams - the parameters that are not tunnel parameterstunnelParams - the tunnel parameterspublic WithParam[] getActualParams()
getActualParams in interface ITemplateCallpublic WithParam[] getTunnelParams()
getTunnelParams in interface ITemplateCallpublic Template getTargetTemplate()
public boolean usesTailRecursion()
public int getInstructionNameCode()
getInstructionNameCode in class Instructionpublic Expression simplify(ExpressionVisitor visitor) throws XPathException
simplify in class Instructionvisitor - an expression visitorXPathException - if an error is discovered during expression
rewritingpublic Expression typeCheck(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
ExpressionThis 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 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.
typeCheck in class Expressionvisitor - an expression visitorcontextItemType - 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_TYPEXPathException - if an error is discovered during this phase
(typically a type error)public Expression optimize(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
ExpressionThis 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.
optimize in class Expressionvisitor - an expression visitorcontextItemType - 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_TYPEXPathException - if an error is discovered during this phase
(typically a type error)public int computeCardinality()
computeCardinality in class Instructionpublic ItemType getItemType(TypeHierarchy th)
getItemType in class Instructionth - the type hierarchy cachepublic Expression copy()
copy in class Expressionpublic int getIntrinsicDependencies()
ExpressiongetIntrinsicDependencies in class Expressionpublic final boolean createsNewNodes()
createsNewNodes in class Instructionpublic Iterator<Expression> iterateSubExpressions()
iterateSubExpressions in class Expressionpublic boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression in class Expressionoriginal - the original subexpressionreplacement - the replacement subexpressionprotected void promoteInst(PromotionOffer offer) throws XPathException
promoteInst in class Instructionoffer - The type of rewrite being offeredXPathExceptionpublic void process(XPathContext context) throws XPathException
process in class Instructioncontext - the dynamic context for this transformationXPathException - if a dynamic error occurspublic TailCall processLeavingTail(XPathContext context) throws XPathException
processLeavingTail in interface TailCallReturnerprocessLeavingTail in class Instructioncontext - the dynamic context for this transformationXPathException - if a dynamic error occurs during the evaluation
of the instructionpublic Template getTargetTemplate(XPathContext context) throws XPathException
context - The dynamic context of the transformationXPathException - if a dynamic error occurs: specifically, if the
template name is computed at run-time (Saxon extension) and the name is invalid
or does not reference a known templatepublic StructuredQName getObjectName()
InstructionInfogetObjectName in interface InstructionInfogetObjectName in class Expressionpublic ExpressionCompiler getExpressionCompiler()
getExpressionCompiler in class Expressionpublic void explain(ExpressionPresenter out)
explain in class Expressionout - the expression presenter used to display the structureCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.