public class ApplyTemplates extends Instruction implements ITemplateCall, ComponentInvocation
Modifier and Type | Class and Description |
---|---|
protected static class |
ApplyTemplates.ApplyTemplatesPackage
An ApplyTemplatesPackage is an object that encapsulates the sequence of nodes to be processed,
the mode, the parameters to be supplied, and the execution context.
|
Modifier and Type | Field and Description |
---|---|
protected boolean |
implicitSelect |
protected boolean |
inStreamableConstruct |
protected Mode |
mode |
protected RuleManager |
ruleManager |
protected boolean |
useCurrentMode |
protected boolean |
useTailRecursion |
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD
Modifier | Constructor and Description |
---|---|
protected |
ApplyTemplates() |
|
ApplyTemplates(Expression select,
boolean useCurrentMode,
boolean useTailRecursion,
boolean implicitSelect,
boolean inStreamableConstruct,
Mode mode,
RuleManager ruleManager)
Construct an apply-templates instruction
|
Modifier and Type | Method and Description |
---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap.
|
protected TailCall |
apply(XPathContext context,
boolean returnTailCall) |
Expression |
copy(RebindingMap rebindings)
Copy an expression.
|
void |
export(ExpressionPresenter out)
Diagnostic print of expression structure.
|
WithParam[] |
getActualParams()
Get the actual parameters passed to the called template
|
int |
getBindingSlot()
Get the binding slot to be used (for the explicit or implicit reference to the mode).
|
Component |
getFixedTarget()
Get the target component if this is known in advance, that is, if the target component
is private or final, or in some other cases such as xsl:original.
|
int |
getImplementationMethod()
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
|
int |
getInstructionNameCode()
Get the name of this instruction for diagnostic and tracing purposes
|
int |
getIntrinsicDependencies()
Determine the intrinsic dependencies of an expression, that is, those which are not derived
from the dependencies of its subexpressions.
|
Mode |
getMode()
Get the Mode
|
RuleManager |
getRuleManager() |
Expression |
getSelect()
Get the select expression
|
Expression |
getSelectExpression()
Get the select expression
|
java.lang.String |
getStreamerName()
Get the (partial) name of a class that supports streaming of this kind of expression
|
SymbolicName |
getSymbolicName()
Get the symbolic name of the mode that this invocation references
|
Component.M |
getTargetMode(XPathContext context)
Establish the target mode, at run-time.
|
WithParam[] |
getTunnelParams()
Get the tunnel parameters passed to the called template
|
protected void |
init(Expression select,
boolean useCurrentMode,
boolean useTailRecursion,
Mode mode) |
boolean |
isImplicitSelect()
Ask if the select expression was implicit
|
boolean |
mayCreateNewNodes()
Determine whether this instruction creates new nodes.
|
java.lang.Iterable<Operand> |
operands()
Get the immediate sub-expressions of this expression, with information about the relationship
of each expression to its parent expression.
|
Expression |
optimize(ExpressionVisitor visitor,
ContextItemStaticInfo contextInfo)
Perform optimisation of an expression and its subexpressions.
|
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.
|
void |
setActualParams(WithParam[] params) |
void |
setBindingSlot(int slot)
Set the binding slot to be used (for the explicit or implicit reference to the mode).
|
void |
setMode(SimpleMode target)
Set the mode to be used.
|
void |
setSelect(Expression select)
Set the select expression
|
void |
setTunnelParams(WithParam[] params) |
Expression |
simplify()
Simplify an expression.
|
Expression |
typeCheck(ExpressionVisitor visitor,
ContextItemStaticInfo contextInfo)
Perform type checking of an expression and its subexpressions.
|
boolean |
usesCurrentMode()
Ask if mode="#current" was specified
|
boolean |
useTailRecursion()
Ask if tail recursion is to be used
|
alwaysCreatesNewNodes, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getInstructionName, getItemType, getNetCost, getSourceLocator, isInstruction, isXSLT, iterate, someOperandCreatesNewNodes
adoptChildExpression, allowExtractingCommonSubexpressions, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeHashCode, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getCardinality, getConfiguration, getCost, getDependencies, getEvaluationMethod, getExtraProperty, getIntegerBounds, getInterpretedExpression, getLocalRetainedStaticContext, getLocation, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, hasCompatibleStaticContext, hashCode, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isLiftable, isMultiThreaded, isSameExpression, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toShortString, toString, typeCheckChildren, typeError, unordered, verifyParentPointers, verifyParentPointers
protected boolean useCurrentMode
protected boolean useTailRecursion
protected Mode mode
protected boolean implicitSelect
protected boolean inStreamableConstruct
protected RuleManager ruleManager
protected ApplyTemplates()
public ApplyTemplates(Expression select, boolean useCurrentMode, boolean useTailRecursion, boolean implicitSelect, boolean inStreamableConstruct, Mode mode, RuleManager ruleManager)
select
- the select expressionuseCurrentMode
- true if mode="#current" was specifieduseTailRecursion
- true if this instruction is the last in its templateimplicitSelect
- true if the select expression is implicit, that is, if there was no explicit
select expression in the call. This information is used only to make error messages more meaningful.mode
- the mode specified on apply-templatesprotected void init(Expression select, boolean useCurrentMode, boolean useTailRecursion, Mode mode)
public void setMode(SimpleMode target)
target
- the attribute set to be usedpublic WithParam[] getActualParams()
getActualParams
in interface ITemplateCall
public WithParam[] getTunnelParams()
getTunnelParams
in interface ITemplateCall
public void setActualParams(WithParam[] params)
public void setTunnelParams(WithParam[] params)
public java.lang.Iterable<Operand> operands()
Expression
If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.
operands
in class Instruction
public int getInstructionNameCode()
getInstructionNameCode
in class Instruction
public int getImplementationMethod()
getImplementationMethod
in class Instruction
Expression.ITERATE_METHOD
or Expression.EVALUATE_METHOD
or
Expression.PROCESS_METHOD
public Expression simplify() throws XPathException
simplify
in class Expression
XPathException
- if an error is discovered during expression
rewritingpublic Expression typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) throws XPathException
Expression
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.
typeCheck
in class Expression
visitor
- an expression visitorcontextInfo
- Information available statically about the context item: whether it is (possibly)
absent; its static type; its streaming posture.XPathException
- if an error is discovered during this phase
(typically a type error)public Expression optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) throws XPathException
Expression
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.
optimize
in class Expression
visitor
- an expression visitorcontextInfo
- 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
XPathException
- if an error is discovered during this phase
(typically a type error)public int getIntrinsicDependencies()
Expression
getIntrinsicDependencies
in class Expression
public RuleManager getRuleManager()
public Expression copy(RebindingMap rebindings)
copy
in class Expression
rebindings
- public final boolean mayCreateNewNodes()
mayCreateNewNodes
in class Instruction
public void process(XPathContext context) throws XPathException
Instruction
process
in class Instruction
context
- The dynamic context, giving access to the current node,
the current variables, etc.XPathException
- if a dynamic error occurspublic TailCall processLeavingTail(XPathContext context) throws XPathException
Instruction
processLeavingTail
in interface TailCallReturner
processLeavingTail
in class Instruction
context
- The dynamic context of the transformation, giving access to the current node,
the current variables, etc.XPathException
- if a dynamic error occurs during the evaluation
of the instructionprotected TailCall apply(XPathContext context, boolean returnTailCall) throws XPathException
XPathException
public Component.M getTargetMode(XPathContext context)
context
- the dynamic contextpublic Expression getSelectExpression()
public boolean isImplicitSelect()
public boolean useTailRecursion()
public boolean usesCurrentMode()
public Mode getMode()
public Component getFixedTarget()
getFixedTarget
in interface ComponentInvocation
public SymbolicName getSymbolicName()
getSymbolicName
in interface ComponentInvocation
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
The default implementation of this method assumes that an expression does no navigation other than the navigation done by evaluating its subexpressions, and that the subexpressions are evaluated in the same context as the containing expression. The method must be overridden for any expression where these assumptions do not hold. For example, implementations exist for AxisExpression, ParentExpression, and RootExpression (because they perform navigation), and for the doc(), document(), and collection() functions because they create a new navigation root. Implementations also exist for PathExpression and FilterExpression because they have subexpressions that are evaluated in a different context from the calling expression.
addToPathMap
in class Expression
pathMap
- the PathMap to which the expression should be addedpathMapNodeSet
- the PathMapNodeSet to which the paths embodied in this expression should be addedpublic void export(ExpressionPresenter out) throws XPathException
export
in interface ExportAgent
export
in class Expression
out
- output destinationXPathException
- if the export fails, for example if an expression is found that won't work
in the target environment.public Expression getSelect()
public void setSelect(Expression select)
select
- the select expressionpublic void setBindingSlot(int slot)
setBindingSlot
in interface ComponentInvocation
slot
- the offset in the binding vector of the containing package where the target template
can be found.public int getBindingSlot()
getBindingSlot
in interface ComponentInvocation
public java.lang.String getStreamerName()
Expression
getStreamerName
in class Expression
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.