Package org.basex.query.func.fn

Class FnError

java.lang.Object

org.basex.query.expr.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.fn.FnError

public final class FnError
extends StandardFunc

Function implementation.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.func.StandardFunc

definition, sc

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

exprs

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

exprType, info

Constructor Summary

Constructors

Constructor	Description
FnError()

Method Summary

Modifier and Type	Method	Description
static StandardFunc	get(QueryException ex, SeqType st, StaticContext sc)	Creates an error function instance.
Item	item(QueryContext qc, InputInfo ii)	Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence.
Iter	iter(QueryContext qc)	Evaluates the expression and returns an iterator on the resulting items.
protected Expr	typeCheck(TypeCheck tc, CompileContext cc)	Tries to push the given type check inside this expression.
boolean	vacuous()	Tests if this is a vacuous expression (empty sequence or error function).

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

checkAdmin, checkArity, checkArity, checkCreate, checkData, checkPath, checkPath, coerceFunc, compileData, copy, data, data, dataLock, dateTimeToMs, description, equals, has, opt, optFirst, optFirst, optimize, plan, plan, serialize, simplifyArgs, toBaseUri, toBindings, toCollation, toDate, toDBNode, toEncodingOrNull, toNodeOrAtomItem, toOptions, toPath, toPath, toQuery, toQuery

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

accept, allAreValues, args, checkUp, compile, copyAll, count, exprSize, flatten, inline, inline, inlineable, mayBePositional, simplifyAll

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

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, ebv, 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, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, simplifyFor, uses, visitAll

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

toErrorString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FnError

public FnError()

Method Details

iter

public Iter iter(QueryContext qc)

Description copied from class: Expr

Evaluates the expression and returns an iterator on the resulting items. The implementation of this method is optional.

Overrides:

iter in class ParseExpr

Parameters:

qc - query context

Returns:

iterator

item

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

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

Throws:

QueryException - query exception

vacuous

public boolean vacuous()

Description copied from class: Expr

Tests if this is a vacuous expression (empty sequence or error function). This check is needed for updating queries.

Overrides:

vacuous in class StandardFunc

Returns:

result of check

typeCheck

protected Expr typeCheck(TypeCheck tc,
 CompileContext cc)

Description copied from class: Expr

Tries to push the given type check inside this expression.

Overrides:

typeCheck in class Expr

Parameters:

tc - type check to push into the expression

cc - compilation context

Returns:

the resulting expression if successful, null otherwise

get

public static StandardFunc get(QueryException ex,
 SeqType st,
 StaticContext sc)

Creates an error function instance.

Parameters:

ex - query exception

st - type of the expression that caused the error message

sc - static context

Returns:

function