org.basex.query.func

Class UserFuncCall

java.lang.Object

org.basex.data.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Arr

org.basex.query.func.UserFuncCall

Direct Known Subclasses:

BaseFuncCall

public abstract class UserFuncCall
extends Arr

Function call for user-defined functions.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Nested Class Summary

Nested classes/interfaces inherited from class org.basex.query.expr.Expr

Expr.Use

Field Summary

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

expr

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

input, size, type

Method Summary

Methods

Modifier and Type	Method and Description
Expr	comp(QueryContext ctx) Compiles and optimizes the expression, assigns data types and cardinalities.
java.lang.String	description() Returns a string description of the expression.
void	init(UserFunc f) Initializes the function call after all functions have been declared.
void	plan(Serializer ser) Serializes the expression tree.
java.lang.String	toString()
boolean	uses(Expr.Use u) Indicates if an expression uses the specified type or operation.

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

allAreValues, count, indexEquivalent, removable, remove, toString

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

checkBln, checkColl, checkCreate, checkCtx, checkDbl, checkDBNode, checkEStr, checkEStr, checkIO, checkItem, checkItr, checkItr, checkMap, checkNode, checkNoEmpty, checkStr, checkType, checkUp, checkUp, checkWrite, compBln, ebv, item, iter, optPre, preEval, size, test, type, value

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

addText, compEbv, hasFreeVars, indexAccessible, isEmpty, isFunction, isItem, isVacuous, isValue, iterable, markTailCalls, sameAs

Methods inherited from class org.basex.data.ExprInfo

info

Methods inherited from class java.lang.Object

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

Method Detail

init

public void init(UserFunc f)

Initializes the function call after all functions have been declared.

Parameters:

f - function reference

comp

public Expr comp(QueryContext ctx)
          throws QueryException

Description copied from class: Expr

Compiles and optimizes the expression, assigns data types and cardinalities.

Overrides:

comp in class Arr

Parameters:

ctx - query context

Returns:

optimized expression

Throws:

QueryException - query exception

uses

public boolean uses(Expr.Use u)

Description copied from class: Expr

Indicates if an expression uses the specified type or operation. This method is called by numerous Expr.comp(org.basex.query.QueryContext) methods to test the properties of sub-expressions. It will return true as soon as at least one test is successful.

Overrides:

uses in class Arr

Parameters:

u - type/operation to be found

Returns:

result of check

plan

public void plan(Serializer ser)
          throws java.io.IOException

Description copied from class: ExprInfo

Serializes the expression tree.

Overrides:

plan in class Arr

Parameters:

ser - serializer

Throws:

java.io.IOException - I/O exception

description

public java.lang.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

toString

public java.lang.String toString()

Specified by:

toString in class ExprInfo