org.basex.query.func

Class BaseFuncCall

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

org.basex.query.func.BaseFuncCall

public final class BaseFuncCall
extends UserFuncCall

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

Constructor Summary

Constructors

Constructor and Description
BaseFuncCall(InputInfo ii, QNm nm, Expr[] arg) Function constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Item	item(QueryContext ctx, InputInfo ii) Evaluates the expression and returns the resulting item or a null reference, if the expression yields an empty sequence.
Iter	iter(QueryContext ctx) Evaluates the expression and returns an iterator on the resulting items.
Expr	markTailCalls() Finds and marks tail calls, enabling TCO.
Value	value(QueryContext ctx) Evaluates the expression and returns the resulting value.

Methods inherited from class org.basex.query.func.UserFuncCall

comp, description, init, plan, toString, uses

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

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

addText, compEbv, hasFreeVars, indexAccessible, isEmpty, isFunction, isItem, isVacuous, isValue, iterable, 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

Constructor Detail

BaseFuncCall

public BaseFuncCall(InputInfo ii,
            QNm nm,
            Expr[] arg)

Function constructor.

Parameters:

ii - input info

nm - function name

arg - arguments

Method Detail

item

public Item item(QueryContext ctx,
        InputInfo ii)
          throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting item or a null reference, if the expression yields an empty sequence. If this method is not overwritten, Expr.iter(org.basex.query.QueryContext) must be implemented by an expression, as it may be called by this method.

Overrides:

item in class ParseExpr

Parameters:

ctx - query context

ii - input info

Returns:

iterator

Throws:

QueryException - query exception

value

public 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

iter

public 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

markTailCalls

public Expr markTailCalls()

Description copied from class: Expr

Finds and marks tail calls, enabling TCO.

Overrides:

markTailCalls in class Expr

Returns:

the expression, with tail calls marked