|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.expr.Expression
net.sf.saxon.expr.instruct.Instruction
net.sf.saxon.expr.instruct.ApplyTemplates
public class ApplyTemplates
An instruction representing an xsl:apply-templates element in the stylesheet
| Field Summary | |
|---|---|
protected WithParam[] |
actualParams
|
protected boolean |
implicitSelect
|
protected Mode |
mode
|
protected Expression |
select
|
protected WithParam[] |
tunnelParams
|
protected boolean |
useCurrentMode
|
protected boolean |
useTailRecursion
|
| Fields inherited from class net.sf.saxon.expr.Expression |
|---|
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD |
| Constructor Summary | |
|---|---|
protected |
ApplyTemplates()
|
|
ApplyTemplates(Expression select,
boolean useCurrentMode,
boolean useTailRecursion,
boolean implicitSelect,
Mode mode)
Construct an apply-templates instructino |
| Method Summary | |
|---|---|
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()
Copy an expression. |
boolean |
createsNewNodes()
Determine whether this instruction creates new nodes. |
void |
explain(ExpressionPresenter out)
Diagnostic print of expression structure. |
protected void |
explainStreaming(ExpressionPresenter out)
|
WithParam[] |
getActualParams()
Get the actual parameters passed to the called template |
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 |
Expression |
getSelectExpression()
Get the select expression |
WithParam[] |
getTunnelParams()
Get the tunnel parameters passed to the called template |
boolean |
hasLoopingSubexpression(Expression child)
Given an expression that is an immediate child of this expression, test whether the evaluation of the parent expression causes the child expression to be evaluated repeatedly |
protected void |
init(Expression select,
boolean useCurrentMode,
boolean useTailRecursion,
Mode mode)
|
boolean |
isImplicitSelect()
Ask if the select expression was implicit |
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 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. |
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 |
usesCurrentMode()
Ask if mode="#current" was specified |
boolean |
useTailRecursion()
Ask if tail recursion is to be used |
| Methods inherited from class net.sf.saxon.expr.instruct.Instruction |
|---|
assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getConstructType, getExpressionName, getInstructionName, getItemType, getIteratorFromProcessMethod, getSourceLocator, isXSLT, iterate, promote |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface javax.xml.transform.SourceLocator |
|---|
getColumnNumber, getLineNumber, getPublicId, getSystemId |
| Field Detail |
|---|
protected Expression select
protected WithParam[] actualParams
protected WithParam[] tunnelParams
protected boolean useCurrentMode
protected boolean useTailRecursion
protected Mode mode
protected boolean implicitSelect
| Constructor Detail |
|---|
protected ApplyTemplates()
public ApplyTemplates(Expression select,
boolean useCurrentMode,
boolean useTailRecursion,
boolean implicitSelect,
Mode mode)
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-templates| Method Detail |
|---|
protected void init(Expression select,
boolean useCurrentMode,
boolean useTailRecursion,
Mode mode)
public void setActualParameters(WithParam[] actualParams,
WithParam[] tunnelParams)
actualParams - represents the contained xsl:with-param elements having tunnel="no" (the default)tunnelParams - represents the contained xsl:with-param elements having tunnel="yes"public int getInstructionNameCode()
getInstructionNameCode in class Instructionpublic int getImplementationMethod()
getImplementationMethod in class InstructionExpression.ITERATE_METHOD or Expression.EVALUATE_METHOD or
Expression.PROCESS_METHOD
public Expression simplify(ExpressionVisitor visitor)
throws XPathException
simplify in class Instructionvisitor - the expression visitor
XPathException - if an error is discovered during expression
rewriting
public 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_TYPE
XPathException - 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_TYPE
XPathException - if an error is discovered during this phase
(typically a type error)public int getIntrinsicDependencies()
Expression
getIntrinsicDependencies in class Expressionpublic Expression copy()
copy in class Expressionpublic final boolean createsNewNodes()
createsNewNodes in class Instruction
public void process(XPathContext context)
throws XPathException
Instruction
process in class Instructioncontext - The dynamic context, giving access to the current node,
the current variables, etc.
XPathException - if a dynamic error occurs
public TailCall processLeavingTail(XPathContext context)
throws XPathException
Instruction
processLeavingTail in interface TailCallReturnerprocessLeavingTail in class Instructioncontext - 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 instruction
protected TailCall apply(XPathContext context,
boolean returnTailCall)
throws XPathException
XPathExceptionpublic Iterator<Expression> iterateSubExpressions()
iterateSubExpressions in class Expressionpublic boolean hasLoopingSubexpression(Expression child)
hasLoopingSubexpression in class Expressionchild - the immediate subexpression
public boolean replaceSubExpression(Expression original,
Expression replacement)
replaceSubExpression in class Expressionoriginal - the original subexpressionreplacement - the replacement subexpression
public Expression getSelectExpression()
public boolean isImplicitSelect()
public boolean useTailRecursion()
public boolean usesCurrentMode()
public Mode getMode()
public WithParam[] getActualParams()
getActualParams in interface ITemplateCallpublic WithParam[] getTunnelParams()
getTunnelParams in interface ITemplateCall
protected void promoteInst(PromotionOffer offer)
throws XPathException
promoteInst in class Instructionoffer - The type of rewrite being offered
XPathException
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 ExpressionpathMap - the PathMap to which the expression should be addedpathMapNodeSet - the PathMapNodeSet to which the paths embodied in this expression should be added
public void explain(ExpressionPresenter out)
explain in class Expressionout - output destinationprotected void explainStreaming(ExpressionPresenter out)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||