|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.saxon.expr.ComputedExpression
net.sf.saxon.instruct.Instruction
net.sf.saxon.instruct.ForEach
Handler for xsl:for-each elements in a stylesheet.
| 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 | |
ForEach(Expression select,
Expression action)
|
|
| Method Summary | |
void |
checkPermittedContents(SchemaType parentType,
StaticContext env,
boolean whole)
Check that any elements and attributes constructed or returned by this expression are acceptable in the content model of a given complex type. |
int |
computeDependencies()
Compute the dependencies of an expression, as the union of the dependencies of its subexpressions. |
boolean |
createsNewNodes()
Determine whether this instruction creates new nodes. |
void |
display(int level,
java.io.PrintStream out,
Configuration config)
Diagnostic print of expression structure. |
Expression |
getActionExpression()
Get the action expression (the content of the for-each) |
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 |
ItemType |
getItemType(TypeHierarchy th)
Determine the data type of the items returned by this expression |
SequenceIterator |
iterate(XPathContext context)
Return an Iterator to iterate over the values of the sequence. |
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) |
SequenceIterator |
map(XPathContext context)
Map one item to a sequence. |
Expression |
optimize(Optimizer opt,
StaticContext env,
ItemType contextItemType)
Perform optimisation of an expression and its subexpressions. |
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 |
Expression |
simplify(StaticContext env)
Simplify an expression. |
Expression |
typeCheck(StaticContext env,
ItemType contextItemType)
Perform type checking of an expression and its subexpressions. |
| Methods inherited from class net.sf.saxon.instruct.Instruction |
appendItem, assembleParams, assembleTunnelParams, computeCardinality, computeSpecialProperties, dynamicError, evaluateAsString, evaluateItem, getInstructionInfo, getSourceLocator, isXSLT, process, promote |
| 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 |
public ForEach(Expression select,
Expression action)
| Method Detail |
public int getInstructionNameCode()
getInstructionNameCode in class Instructionpublic Expression getActionExpression()
public final ItemType getItemType(TypeHierarchy th)
getItemType in interface ExpressiongetItemType in class Instructionth -
public final boolean createsNewNodes()
createsNewNodes in class Instruction
public Expression simplify(StaticContext env)
throws XPathException
simplify in interface Expressionsimplify in class InstructionXPathException - if an error is discovered during expression
rewriting
public Expression typeCheck(StaticContext env,
ItemType 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 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.
typeCheck in interface Expressionenv - the static context of the expressioncontextItemType - 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
public Expression optimize(Optimizer opt,
StaticContext env,
ItemType 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 interface Expressionopt - 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 expressioncontextItemType - 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
XPathExceptionpublic int computeDependencies()
computeDependencies in class ComputedExpression
protected void promoteInst(PromotionOffer offer)
throws XPathException
promoteInst in class Instructionoffer - The type of rewrite being offered
XPathExceptionpublic java.util.Iterator iterateSubExpressions()
iterateSubExpressions in interface ExpressioniterateSubExpressions in class ComputedExpression
public boolean replaceSubExpression(Expression original,
Expression replacement)
replaceSubExpression in interface ContainerreplaceSubExpression in class ComputedExpressionoriginal - the original subexpressionreplacement - the replacement subexpression
public int getImplementationMethod()
getImplementationMethod in interface ExpressiongetImplementationMethod in class Instruction
public void checkPermittedContents(SchemaType parentType,
StaticContext env,
boolean whole)
throws XPathException
checkPermittedContents in interface ExpressioncheckPermittedContents in class ComputedExpressionXPathException
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
public SequenceIterator iterate(XPathContext context)
throws XPathException
iterate in interface Expressioniterate in class Instructioncontext - supplies the context for evaluation
XPathException - if any dynamic error occurs evaluating the
expression
public SequenceIterator map(XPathContext context)
throws XPathException
map in interface ContextMappingFunctioncontext - The processing context. This is supplied only for mapping constructs that
set the context node, position, and size. Otherwise it is null.
XPathException
public void display(int level,
java.io.PrintStream out,
Configuration config)
display in interface Expressionlevel - indentation level for this expressionout - config -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||