org.basex.query.func
Class FNDb
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.StandardFunc
org.basex.query.func.FNDb
public final class FNDb
- extends StandardFunc
Database functions.
- Author:
- BaseX Team 2005-12, BSD License, Christian Gruen, Dimitar Popov
Nested classes/interfaces inherited from class org.basex.query.expr.Expr |
Expr.Flag |
Fields inherited from class org.basex.query.expr.Arr |
expr |
Method Summary |
boolean |
accept(ASTVisitor visitor)
Traverses this expression, notifying the visitor of declared and used variables,
and checking the tree for other recursive properties. |
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. |
boolean |
iterable()
Returns true if the expression is iterable, i.e., if it will not contain any
duplicate nodes and if all nodes will be are sorted. |
static java.lang.String |
toName(java.lang.String str)
Converts the specified info key to an element name. |
Value |
value(QueryContext ctx)
Evaluates the expression and returns the resulting value. |
Methods inherited from class org.basex.query.func.StandardFunc |
atom, bindings, cache, checkData, checkFile, compile, copy, dataLock, dateTimeToMs, description, encoding, has, isFunction, isVacuous, oneOf, opt, optimize, plan, toString |
Methods inherited from class org.basex.query.expr.ParseExpr |
checkAdmin, checkAllUp, checkBinary, checkBln, checkColl, checkCreate, checkCtx, checkDbl, checkDBNode, checkEStr, checkEStr, checkFunc, checkItem, checkItr, checkItr, checkMap, checkNode, checkNode, checkNode, checkNoEmpty, checkNoneUp, checkNoUp, checkQNm, checkStr, checkStr, checkStrBin, checkType, checkWrite, compBln, copyType, ebv, optPre, preEval, size, test, type |
Methods inherited from class org.basex.query.expr.Expr |
addText, compEbv, copy, hasFreeVars, indexAccessible, inlineAll, isEmpty, isItem, isValue, markTailCalls, sameAs, uses, visitAll |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
FNDb
public FNDb(InputInfo ii,
Function f,
Expr... e)
- Constructor.
- Parameters:
ii
- input infof
- function definitione
- arguments
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
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
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 contextii
- input info
- Returns:
- iterator
- Throws:
QueryException
- query exception
toName
public static java.lang.String toName(java.lang.String str)
- Converts the specified info key to an element name.
- Parameters:
str
- string to be converted
- Returns:
- resulting name
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 Arr
- Parameters:
visitor
- visitor
- Returns:
- if the walk should be continued
iterable
public boolean iterable()
- Description copied from class:
Expr
- Returns true if the expression is iterable, i.e., if it will not contain any
duplicate nodes and if all nodes will be are sorted. The return value of this method
is only relevant for node sequences. It is e.g. called by
AxisPath
.
- Overrides:
iterable
in class Expr
- Returns:
- result of check