org.basex.query.func

Class JavaModuleFunc

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.JavaMapping

org.basex.query.func.JavaModuleFunc

public final class JavaModuleFunc
extends JavaMapping

Java function binding.

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

info, size, type

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	description() Returns a string description of the expression.
protected java.lang.Object	eval(Value[] args, QueryContext ctx) Returns the result of the evaluated Java function.
void	plan(FElem plan) Creates an 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.func.JavaMapping

foundArgs, iter, toValue, type, type, value

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

allAreValues, comp, 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, optPre, preEval, size, test, type

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

addPlan, addPlan, info, planAttr, planElem

Methods inherited from class java.lang.Object

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

Method Detail

eval

protected java.lang.Object eval(Value[] args,
                    QueryContext ctx)
                         throws QueryException

Description copied from class: JavaMapping

Returns the result of the evaluated Java function.

Specified by:

eval in class JavaMapping

Parameters:

args - arguments

ctx - query context

Returns:

arguments

Throws:

QueryException - query exception

plan

public void plan(FElem plan)

Description copied from class: ExprInfo

Creates an expression tree.

Overrides:

plan in class Arr

Parameters:

plan - root element

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

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 JavaMapping

Parameters:

u - type/operation to be found

Returns:

result of check