Package org.basex.query.func

Class FuncLit

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Single

org.basex.query.func.FuncLit

All Implemented Interfaces:

Scope

public final class FuncLit
extends Single
implements Scope

A named function literal.

Author:

BaseX Team 2005-21, BSD License, Leo Woerteler

Field Summary

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

expr

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

exprType, info

Method Summary

Modifier and Type	Method	Description
boolean	accept(ASTVisitor visitor)	Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.
void	comp(CompileContext cc)	Compiles the expression contained in this scope.
Expr	compile(CompileContext cc)	Compiles and optimizes the expression, assigns types and cardinalities.
boolean	compiled()	Checks if this scope has already been compiled.
Expr	copy(CompileContext cc, IntObjMap<Var> vm)	Copies an expression.
boolean	equals(Object obj)	This function is e.g.
Item	item(QueryContext qc, InputInfo ii)	Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence.
void	plan(QueryString qs)	Creates a query string.
boolean	visit(ASTVisitor visitor)	Traverses this scope with the given ASTVisitor.

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

checkUp, count, exprSize, has, inline, inlineable, optimize, plan

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

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, ebv, iter, refineType, seqType, size, test, toArray, toArray, toAtomItem, toB64, toB64, toBin, toBin, toBoolean, toBoolean, toBytes, toBytes, toDouble, toDouble, toElem, toFloat, toFunc, toItem, toItem, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumberOrNull, toQNm, toQNm, toToken, toToken, toTokenOrNull, toZeroToken, value

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

arg, args, atomItem, atomIter, data, data, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, simplifyFor, typeCheck, uses, vacuous, visitAll

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

description, toErrorString, toString

Methods inherited from class java.lang.Object

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

Method Details

comp

public void comp(CompileContext cc)

Description copied from interface: Scope

Compiles the expression contained in this scope.

Specified by:

comp in interface Scope

Parameters:

cc - compilation context

compile

public Expr compile(CompileContext cc)
             throws QueryException

Description copied from class: Expr

Compiles and optimizes the expression, assigns types and cardinalities.

Overrides:

compile in class Single

Parameters:

cc - compilation context

Returns:

optimized expression

Throws:

QueryException - query exception

item

public Item item(QueryContext qc,
 InputInfo ii)

Description copied from class: Expr

Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence. If this method is not implemented, Expr.value(QueryContext) must be implemented instead.

Overrides:

item in class ParseExpr

Parameters:

qc - query context

ii - input info (only required by Seq instances, which have no input info)

Returns:

item or Empty.VALUE

copy

public Expr copy(CompileContext cc,
 IntObjMap<Var> vm)

Description copied from class: Expr

Copies an expression. Used for inlining functions, or for copying static queries. It is utilized by VarRef.inline(org.basex.query.InlineContext), FuncItem.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext), Closure.inline(org.basex.query.InlineContext) and StaticFunc.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext).

Specified by:

copy in class Expr

Parameters:

cc - compilation context

vm - mapping from old variable IDs to new variable copies. Required by Closure.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>) and VarRef.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>)

Returns:

copied expression

visit

public boolean visit(ASTVisitor visitor)

Description copied from interface: Scope

Traverses this scope with the given ASTVisitor.

Specified by:

visit in interface Scope

Parameters:

visitor - visitor

Returns:

continue flag

accept

public boolean accept(ASTVisitor visitor)

Description copied from class: Expr

Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.

Overrides:

accept in class Single

Parameters:

visitor - visitor

Returns:

if the walk should be continued

compiled

public boolean compiled()

Description copied from interface: Scope

Checks if this scope has already been compiled.

Specified by:

compiled in interface Scope

Returns:

result of check

equals

public boolean equals(Object obj)

Description copied from class: Single

This function is e.g. called by:

• If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
• CmpR.mergeEbv(Expr, boolean, CompileContext) or CmpSR.mergeEbv(Expr, boolean, CompileContext), in order to merge expressions with identical input.
• CmpG.optimize(CompileContext) or CmpV.optimize(CompileContext), in order to pre-evaluate equality tests.
• CmpG.optimize(CompileContext) or Pos.get(Expr, CmpV.OpV, InputInfo, CompileContext), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Must be overwritten by implementing class.

Overrides:

equals in class Single

plan

public void plan(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

plan in class ExprInfo

Parameters:

qs - query string builder