org.basex.query.func

Class Functions

java.lang.Object

org.basex.util.hash.TokenSet

org.basex.query.func.Functions

All Implemented Interfaces:

java.lang.Iterable<byte[]>

public final class Functions
extends TokenSet

This class provides access to statically available functions.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.util.hash.TokenSet

CAP, keys, size

Method Summary

Methods

Modifier and Type	Method and Description
void	error(QNm name, InputInfo ii) Throws an error if one of the pre-defined functions is similar to the specified function name.
static Functions	get() Returns the singleton instance.
StandardFunc	get(byte[] name, byte[] uri, Expr[] args, QueryContext ctx, InputInfo ii) Returns the specified function.
static TypedFunc	get(QNm name, Expr[] args, boolean dyn, QueryContext ctx, InputInfo ii) Returns an instance of the specified function, or null.
static FItem	get(QNm name, long arity, boolean dyn, QueryContext ctx, InputInfo ii) Returns the specified function literal.
protected void	rehash() Resizes the hash table.

Methods inherited from class org.basex.util.hash.TokenSet

add, delete, id, iterator, key, keys, read, size, toString, write

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Functions get()

Returns the singleton instance.

Returns:

instance

get

public StandardFunc get(byte[] name,
               byte[] uri,
               Expr[] args,
               QueryContext ctx,
               InputInfo ii)
                 throws QueryException

Returns the specified function.

Parameters:

name - function name

uri - function uri

args - optional arguments

ctx - query context

ii - input info

Returns:

function instance

Throws:

QueryException - query exception

get

public static FItem get(QNm name,
        long arity,
        boolean dyn,
        QueryContext ctx,
        InputInfo ii)
                 throws QueryException

Returns the specified function literal.

Parameters:

name - function name

arity - number of arguments

dyn - dynamic invocation flag

ctx - query context

ii - input info

Returns:

literal function expression

Throws:

QueryException - query exception

get

public static TypedFunc get(QNm name,
            Expr[] args,
            boolean dyn,
            QueryContext ctx,
            InputInfo ii)
                     throws QueryException

Returns an instance of the specified function, or null.

Parameters:

name - name of the function

args - optional arguments

dyn - compile-/run-time flag

ctx - query context

ii - input info

Returns:

function instance

Throws:

QueryException - query exception

error

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

Throws an error if one of the pre-defined functions is similar to the specified function name.

Parameters:

name - function name

ii - input info

Throws:

QueryException - query exception

rehash

protected void rehash()

Description copied from class: TokenSet

Resizes the hash table.

Overrides:

rehash in class TokenSet