public class UserFunctionCall extends FunctionCall implements InstructionInfoProvider
argument
locationId, staticProperties
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
Constructor and Description |
---|
UserFunctionCall() |
Modifier and Type | Method and Description |
---|---|
void |
checkArguments(StaticContext env)
Method called during the type checking phase
|
void |
checkFunctionCall(UserFunction compiledFunction,
StaticContext env)
Check the function call against the declared function signature
|
void |
computeArgumentEvaluationModes() |
int |
computeCardinality()
Determine the cardinality of the result
|
void |
display(int level,
java.io.PrintStream out,
Configuration config)
Diagnostic print of expression structure.
|
ValueRepresentation |
dynamicCall(ValueRepresentation[] suppliedArguments,
XPathContext context)
Call the function dynamically.
|
Item |
evaluateItem(XPathContext c)
Call the function, returning the value as an item.
|
Expression[] |
getArguments()
Get the arguments (the expressions supplied in the function call)
|
UserFunction |
getFunction()
Get the function that is being called by this function call
|
int |
getImplementationMethod()
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
|
InstructionInfo |
getInstructionInfo()
Get diagnostic information about this expression
|
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)
Determine the data type of the expression, if possible
|
boolean |
isConfirmed()
Determine whether this function call is confirmed
|
SequenceIterator |
iterate(XPathContext c)
Call the function, returning an iterator over the results.
|
boolean |
markTailFunctionCalls(int nameCode,
int arity)
Mark tail-recursive calls on stylesheet functions.
|
Expression |
optimize(Optimizer opt,
StaticContext env,
ItemType contextItemType)
Perform optimisation of an expression and its subexpressions.
|
Expression |
preEvaluate(StaticContext env)
Pre-evaluate a function at compile time.
|
void |
process(XPathContext context)
Process the function call in push mode
|
void |
setConfirmed(boolean conf)
Set this function as confirmed (the function being called is known to exist) or not
|
void |
setFunction(UserFunction compiledFunction,
StaticContext env)
Create the reference to the function to be called, and validate for consistency
|
void |
setStaticType(SequenceType type)
Set the static type
|
Expression |
simplify(StaticContext env)
Simplify the function call
|
Expression |
typeCheck(StaticContext env,
ItemType contextItemType)
Type-check the expression.
|
checkArgumentCount, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplifyArguments
adoptChildExpression, checkPermittedContents, computeDependencies, computeSpecialProperties, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
public void setStaticType(SequenceType type)
public void setFunction(UserFunction compiledFunction, StaticContext env) throws XPathException
XPathException
public void checkFunctionCall(UserFunction compiledFunction, StaticContext env) throws XPathException
XPathException
public UserFunction getFunction()
public void setConfirmed(boolean conf)
public boolean isConfirmed()
public Expression[] getArguments()
getArguments
in class FunctionCall
public void checkArguments(StaticContext env) throws XPathException
checkArguments
in class FunctionCall
XPathException
public Expression preEvaluate(StaticContext env)
preEvaluate
in class FunctionCall
public ItemType getItemType(TypeHierarchy th)
getItemType
in interface Expression
th
- public int getIntrinsicDependencies()
ComputedExpression
getIntrinsicDependencies
in class ComputedExpression
public int computeCardinality()
computeCardinality
in class ComputedExpression
public Expression simplify(StaticContext env) throws XPathException
simplify
in interface Expression
simplify
in class FunctionCall
env
- the static contextXPathException
- if an error is discovered during expression
rewritingpublic Expression typeCheck(StaticContext env, ItemType contextItemType) throws XPathException
FunctionCall
typeCheck
in interface Expression
typeCheck
in class FunctionCall
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
StaticError
- if an error is discovered during this phase
(typically a type error)XPathException
public Expression optimize(Optimizer opt, StaticContext env, ItemType contextItemType) throws XPathException
FunctionCall
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 interface Expression
optimize
in class FunctionCall
opt
- 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
StaticError
- if an error is discovered during this phase
(typically a type error)XPathException
public void computeArgumentEvaluationModes()
public boolean markTailFunctionCalls(int nameCode, int arity)
markTailFunctionCalls
in class ComputedExpression
public int getImplementationMethod()
ComputedExpression
getImplementationMethod
in interface Expression
getImplementationMethod
in class ComputedExpression
public Item evaluateItem(XPathContext c) throws XPathException
evaluateItem
in interface Expression
evaluateItem
in class ComputedExpression
c
- The context in which the expression is to be evaluatedXPathException
- if any dynamic error occurs evaluating the
expressionpublic SequenceIterator iterate(XPathContext c) throws XPathException
iterate
in interface Expression
iterate
in class ComputedExpression
c
- supplies the context for evaluationXPathException
- if any dynamic error occurs evaluating the
expressionpublic void process(XPathContext context) throws XPathException
process
in interface Expression
process
in class ComputedExpression
context
- XPathException
public ValueRepresentation dynamicCall(ValueRepresentation[] suppliedArguments, XPathContext context) throws XPathException
XPathException
public void display(int level, java.io.PrintStream out, Configuration config)
Expression
display
in interface Expression
display
in class FunctionCall
level
- indentation level for this expressionout
- Output destinationpublic InstructionInfo getInstructionInfo()
getInstructionInfo
in interface InstructionInfoProvider
getInstructionInfo
in class ComputedExpression