Package org.basex.query.func.fn

Class FnDoc

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.DynamicFn

org.basex.query.func.fn.Docs

org.basex.query.func.fn.FnDocAvailable

org.basex.query.func.fn.FnDoc

public final class FnDoc
extends FnDocAvailable

Function implementation.

Author:

BaseX Team 2005-23, 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
FnDoc()

Method Summary

Modifier and Type	Method	Description
Item	item(QueryContext qc, InputInfo ii)	Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence.
protected Expr	opt(CompileContext cc)	Performs function specific optimizations.

Methods inherited from class org.basex.query.func.fn.Docs

accept

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

checkPerm, coerceFunc, compileData, copy, dataLock, defined, description, embed, equals, has, optFirst, optFirst, optimize, serialize, simplifyArgs, toBaseUri, toBindings, toCollation, toCollationOrDefault, toContent, toContent, toData, toDate, toDBNode, toEncodingOrNull, toFunction, toFunction, toIO, toIO, toMs, toName, toNodeOrAtomItem, toOptions, toOptions, toPath, toPath, toStr, toString, toXml, toZeroStr, updating, vacuous

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

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

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

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

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

arg, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, optimizePos, simplify, simplifyFor, typeCheck, 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 Detail

FnDoc

public FnDoc()

Method Detail

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 FnDocAvailable

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

opt

protected Expr opt(CompileContext cc)
            throws QueryException

Description copied from class: StandardFunc

Performs function specific optimizations.

Overrides:

opt in class Docs

Parameters:

cc - compilation context

Returns:

optimized or original expression

Throws:

QueryException - query exception