org.basex.query.func

Class JavaMapping

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

Direct Known Subclasses:

JavaFunc, JavaModuleFunc

public abstract class JavaMapping
extends Arr

This class contains common methods for executing Java code and mapping Java objects to XQuery values.

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
protected abstract java.lang.Object	eval(Value[] args) Returns the result of the evaluated Java function.
Iter	iter(QueryContext ctx) Evaluates the expression and returns an iterator on the resulting items.
static Value	toValue(java.lang.Object res) Converts the specified result to an XQuery value.
static Type	type(java.lang.Object o) Returns an appropriate XQuery data type for the specified Java object.
Value	value(QueryContext ctx) Evaluates the expression and returns the resulting value.

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

allAreValues, comp, count, indexEquivalent, plan, removable, remove, toString, uses

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

description, info, toString

Methods inherited from class java.lang.Object

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

Method Detail

iter

public final Iter iter(QueryContext ctx)
                throws QueryException

Description copied from class: Expr

Evaluates the expression and returns an iterator on the resulting items. If this method is not overwritten, Expr.item(org.basex.query.QueryContext, org.basex.util.InputInfo) must be implemented by an expression, as it may be called by this method.

Overrides:

iter in class ParseExpr

Parameters:

ctx - query context

Returns:

resulting item

Throws:

QueryException - query exception

value

public final Value value(QueryContext ctx)
                  throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting value.

Overrides:

value in class ParseExpr

Parameters:

ctx - query context

Returns:

iterator

Throws:

QueryException - query exception

eval

protected abstract java.lang.Object eval(Value[] args)
                                  throws QueryException

Returns the result of the evaluated Java function.

Parameters:

args - arguments

Returns:

arguments

Throws:

QueryException - query exception

toValue

public static Value toValue(java.lang.Object res)
                     throws QueryException

Converts the specified result to an XQuery value.

Parameters:

res - result object

Returns:

value

Throws:

QueryException - query exception

type

public static Type type(java.lang.Object o)

Returns an appropriate XQuery data type for the specified Java object.

Parameters:

o - object

Returns:

xquery type, or null if no appropriate type was found