net.sf.saxon.expr
public abstract class FunctionCall extends Expression
Field Summary | |
---|---|
protected Expression[] | argument
The array of expressions representing the actual parameters
to the function call |
Method Summary | |
---|---|
PathMap.PathMapNodeSet | addExternalFunctionCallToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodes)
Add a representation of this expression to a PathMap. |
protected int | checkArgumentCount(int min, int max, ExpressionVisitor visitor)
Check number of arguments. |
protected abstract void | checkArguments(ExpressionVisitor visitor)
Method supplied by each class of function to check arguments during parsing, when all
the argument expressions have been read |
boolean | equals(Object o)
Determine whether two expressions are equivalent |
void | explain(ExpressionPresenter out)
Diagnostic print of expression structure. |
Expression[] | getArguments()
Get the expressions supplied as actual arguments to the function |
String | getDisplayName()
Get the name of the function for display in messages |
StructuredQName | getFunctionName()
Get the qualified of the function being called |
int | getNumberOfArguments()
Determine the number of actual arguments supplied in the function call |
int | hashCode()
Get hashCode in support of equals() method |
Iterator<Expression> | iterateSubExpressions()
Get the immediate subexpressions of this expression |
Expression | optimize(ExpressionVisitor visitor, ItemType contextItemType)
Perform optimisation of an expression and its subexpressions.
|
Expression | preEvaluate(ExpressionVisitor visitor)
Pre-evaluate a function at compile time. |
Expression | promote(PromotionOffer offer, Expression parent)
Promote this expression if possible |
boolean | replaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpression |
void | setArguments(Expression[] args)
Method called by the expression parser when all arguments have been supplied |
void | setFunctionName(StructuredQName name)
Set the name of the function being called |
Expression | simplify(ExpressionVisitor visitor)
Simplify the function call. |
protected Expression | simplifyArguments(ExpressionVisitor visitor)
Simplify the arguments of the function.
|
String | toString()
The toString() method for an expression attempts to give a representation of the expression
in an XPath-like form, but there is no guarantee that the syntax will actually be true XPath.
|
Expression | typeCheck(ExpressionVisitor visitor, ItemType contextItemType)
Type-check the expression. |
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.
Parameters: pathMap the PathMap to which the expression should be added pathMapNodes the node in the PathMap representing the focus at the point where this expression is called. Set to null if this expression appears at the top level, in which case the expression, if it is registered in the path map at all, must create a new path map root.
Returns: the pathMapNode representing the focus established by this expression, in the case where this expression is the first operand of a path expression or filter expression. For an expression that does navigation, it represents the end of the arc in the path map that describes the navigation route. For other expressions, it is the same as the input pathMapNode.
Parameters: min the minimum number of arguments allowed max the maximum number of arguments allowed visitor an expression visitor
Returns: the actual number of arguments
Throws: net.sf.saxon.trans.XPathException if the number of arguments is out of range
Parameters: visitor the expression visitor
Returns: the array of expressions supplied in the argument list of the function call
Returns: the name of the function as a lexical QName
Returns: the qualified name
Returns: the arity (the number of arguments)
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.
Parameters: visitor an expression visitor contextItemType 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 ITEM_TYPE
Returns: the original expression, rewritten if appropriate to optimize execution
Throws: XPathException if an error is discovered during this phase (typically a type error)
Parameters: visitor an expression visitor
Returns: the result of the early evaluation, or the original expression, or potentially a simplified expression
Parameters: original the original subexpression replacement the replacement subexpression
Returns: true if the original subexpression is found
Parameters: args the expressions contained in the argument list of the function call
Parameters: name the name of the function
Parameters: visitor an expression visitor
Parameters: visitor an expression visitor
Returns: the result of simplifying the arguments of the expression