org.basex.query.expr
Class Func

java.lang.Object
  org.basex.query.ExprInfo
      org.basex.query.expr.Expr
          org.basex.query.expr.Single
              org.basex.query.expr.Func

public final class Func
extends Single

User defined function.

Author:

Workgroup DBIS, University of Konstanz 2005-10, ISC License, Christian Gruen

Nested Class Summary

Nested classes/interfaces inherited from class org.basex.query.expr.Expr

Expr.Use

Field Summary

Var[]	args Arguments.
boolean	decl Declaration flag.
boolean	updating Updating flag.
Var	var Function name, including return type.

Fields inherited from class org.basex.query.expr.Single

expr

Constructor Summary

Func(Var v, Var[] a, boolean d)
Function constructor.

Method Summary

Item	atomic(QueryContext ctx) Evaluates the expression and returns the resulting item or a null reference.
Expr	comp(QueryContext ctx) Optimizes and compiles the expression.
void	plan(Serializer ser) Recursively sends the abstract syntax of this expression to the specified serializer.
String	toString()

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

remove, uses

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

addText, checkCtx, checkDbl, checkItr, duplicates, e, ebv, i, indexAccessible, indexEquivalent, iter, removable, returned, sameAs, size, test, v

Methods inherited from class org.basex.query.ExprInfo

color, info, name

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

var

public Var var

Function name, including return type.

args

public Var[] args

Arguments.

decl

public boolean decl

Declaration flag.

updating

public boolean updating

Updating flag.

Constructor Detail

Func

public Func(Var v,
            Var[] a,
            boolean d)

Function constructor.

Parameters:

v - function name

a - arguments

d - declaration flag

Method Detail

comp

public Expr comp(QueryContext ctx)
          throws QueryException

Description copied from class: Expr

Optimizes and compiles the expression.

Overrides:

comp in class Single

Parameters:

ctx - query context

Returns:

optimized Expression

Throws:

QueryException - query exception

atomic

public Item atomic(QueryContext ctx)
            throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting item or a null reference. If this method is not overwritten, Expr.iter(org.basex.query.QueryContext) must be implemented.

Overrides:

atomic in class Expr

Parameters:

ctx - query context

Returns:

iterator

Throws:

QueryException - query exception

plan

public void plan(Serializer ser)
          throws IOException

Description copied from class: ExprInfo

Recursively sends the abstract syntax of this expression to the specified serializer.

Overrides:

plan in class Single

Parameters:

ser - serializer

Throws:

IOException - I/O exception

toString

public String toString()

Specified by:

toString in class ExprInfo