Package org.basex.query.func

Class StaticFuncCall

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Arr

org.basex.query.func.FuncCall

org.basex.query.func.StaticFuncCall

public final class StaticFuncCall
extends FuncCall

Function call for user-defined functions.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.expr.Arr

exprs

Fields inherited from class org.basex.query.expr.ParseExpr

exprType, info

Constructor Summary

Constructors

Constructor	Description
StaticFuncCall(QNm name, Expr[] args, StaticContext sc, InputInfo info)	Function call constructor.

Method Summary

Modifier and Type	Method	Description
boolean	accept(ASTVisitor visitor)	Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.
Expr	compile(CompileContext cc)	Compiles and optimizes the expression, assigns types and cardinalities.
StaticFuncCall	copy(CompileContext cc, IntObjMap<Var> vm)	Copies an expression.
String	description()	Returns a string description of the expression.
boolean	equals(Object obj)	This function is e.g.
StaticFunc	evalFunc(QueryContext qc)
StaticFunc	func()	Returns the called function if already known.
boolean	has(Flag... flags)	Indicates if an expression has one of the specified compiler properties.
StaticFuncCall	init(StaticFunc sf)	Initializes the function and checks for visibility.
StaticFuncCall	optimize(CompileContext cc)	Optimizes an already compiled expression without recompiling its sub-expressions.
void	plan(QueryPlan plan)	Creates a query plan.
void	plan(QueryString qs)	Creates a query string.
boolean	vacuous()	Tests if this is a vacuous expression (empty sequence or error function).

Methods inherited from class org.basex.query.func.FuncCall

markTailCalls, value

Methods inherited from class org.basex.query.expr.Arr

allAreValues, args, checkUp, copyAll, count, exprSize, flatten, inline, inline, inlineable, mayBePositional, simplifyAll

Methods inherited from class org.basex.query.expr.ParseExpr

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, ebv, item, iter, refineType, seqType, size, test, toArray, toArray, toAtomItem, toB64, toB64, toBin, toBin, toBoolean, toBoolean, toBytes, toBytes, toDouble, toDouble, toElem, toFloat, toFunc, toItem, toItem, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumberOrNull, toQNm, toQNm, toToken, toToken, toTokenOrNull, toZeroToken

Methods inherited from class org.basex.query.expr.Expr

arg, atomItem, atomIter, data, data, ddo, funcType, hasFreeVars, indexAccessible, isSimple, mergeEbv, simplifyFor, typeCheck, uses, visitAll

Methods inherited from class org.basex.query.expr.ExprInfo

toErrorString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StaticFuncCall

public StaticFuncCall(QNm name,
 Expr[] args,
 StaticContext sc,
 InputInfo info)

Function call constructor.

Parameters:

name - function name

args - arguments

sc - static context

info - input info

Method Details

compile

public Expr compile(CompileContext cc)
             throws QueryException

Description copied from class: Expr

Compiles and optimizes the expression, assigns types and cardinalities.

Overrides:

compile in class Arr

Parameters:

cc - compilation context

Returns:

optimized expression

Throws:

QueryException - query exception

optimize

public StaticFuncCall optimize(CompileContext cc)

Description copied from class: Expr

Optimizes an already compiled expression without recompiling its sub-expressions.

Overrides:

optimize in class Expr

Parameters:

cc - compilation context

Returns:

optimized expression

copy

public StaticFuncCall copy(CompileContext cc,
 IntObjMap<Var> vm)

Description copied from class: Expr

Copies an expression. Used for inlining functions, or for copying static queries. It is utilized by VarRef.inline(org.basex.query.InlineContext), FuncItem.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext), Closure.inline(org.basex.query.InlineContext) and StaticFunc.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext).

Specified by:

copy in class Expr

Parameters:

cc - compilation context

vm - mapping from old variable IDs to new variable copies. Required by Closure.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>) and VarRef.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>)

Returns:

copied expression

init

public StaticFuncCall init(StaticFunc sf)
                    throws QueryException

Initializes the function and checks for visibility.

Parameters:

sf - function reference

Returns:

self reference

Throws:

QueryException - query exception

func

public StaticFunc func()

Returns the called function if already known.

Returns:

the function or null

vacuous

public boolean vacuous()

Description copied from class: Expr

Tests if this is a vacuous expression (empty sequence or error function). This check is needed for updating queries.

Overrides:

vacuous in class Expr

Returns:

result of check

has

public boolean has(Flag... flags)

Description copied from class: Expr

Indicates if an expression has one of the specified compiler properties. This method must only be called at compile time. It is invoked to test properties of sub-expressions. It returns true if at least flag matches an expression.

Overrides:

has in class Arr

Parameters:

flags - flags to be checked

Returns:

result of check

accept

public boolean accept(ASTVisitor visitor)

Description copied from class: Expr

Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.

Overrides:

accept in class Arr

Parameters:

visitor - visitor

Returns:

if the walk should be continued

evalFunc

public StaticFunc evalFunc(QueryContext qc)

equals

public boolean equals(Object obj)

Description copied from class: Arr

This function is e.g. called by:

• If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
• CmpR.mergeEbv(Expr, boolean, CompileContext) or CmpSR.mergeEbv(Expr, boolean, CompileContext), in order to merge expressions with identical input.
• CmpG.optimize(CompileContext) or CmpV.optimize(CompileContext), in order to pre-evaluate equality tests.
• CmpG.optimize(CompileContext) or Pos.get(Expr, CmpV.OpV, InputInfo, CompileContext), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Must be overwritten by implementing class.

Overrides:

equals in class Arr

description

public String description()

Description copied from class: ExprInfo

Returns a string description of the expression. This method is only called by error messages. Contrary to the ExprInfo.toString() method, arguments are not included in the output.

Overrides:

description in class ExprInfo

Returns:

result of check

plan

public void plan(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Overrides:

plan in class Arr

Parameters:

plan - expression plan

plan

public void plan(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

plan in class ExprInfo

Parameters:

qs - query string builder