org.basex.query.func

Class UserFuncs

java.lang.Object

org.basex.data.ExprInfo

org.basex.query.func.UserFuncs

public final class UserFuncs
extends ExprInfo

Container for a user-defined function.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor and Description
UserFuncs()

Method Summary

Methods

Modifier and Type	Method and Description
int	add(UserFunc fun, InputInfo ii) Adds a local function.
void	check() Checks if all functions have been correctly declared, and initializes all function calls.
void	comp(QueryContext ctx) Compiles the functions.
UserFunc[]	funcs() Returns all user-defined functions.
void	funError(QNm name, InputInfo ii) Finds similar function names and throws an error message.
void	plan(Serializer ser) Serializes the expression tree.
java.lang.String	toString()

Methods inherited from class org.basex.data.ExprInfo

description, info

Methods inherited from class java.lang.Object

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

Constructor Detail

UserFuncs

public UserFuncs()

Method Detail

funcs

public UserFunc[] funcs()

Returns all user-defined functions.

Returns:

function array

add

public int add(UserFunc fun,
      InputInfo ii)
        throws QueryException

Adds a local function.

Parameters:

fun - function instance

ii - input info

Returns:

function id

Throws:

QueryException - query exception

check

public void check()
           throws QueryException

Checks if all functions have been correctly declared, and initializes all function calls.

Throws:

QueryException - query exception

comp

public void comp(QueryContext ctx)
          throws QueryException

Compiles the functions.

Parameters:

ctx - query context

Throws:

QueryException - query exception

funError

public void funError(QNm name,
            InputInfo ii)
              throws QueryException

Finds similar function names and throws an error message.

Parameters:

name - function name

ii - input info

Throws:

QueryException - query exception

plan

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

Description copied from class: ExprInfo

Serializes the expression tree.

Specified by:

plan in class ExprInfo

Parameters:

ser - serializer

Throws:

java.io.IOException - I/O exception

toString

public java.lang.String toString()

Specified by:

toString in class ExprInfo