Package org.basex.query.func.fn

Class FnContainsToken

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

public final class FnContainsToken
extends StandardFunc

Function implementation.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Field Summary

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

definition

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
FnContainsToken()

Method Summary

Modifier and Type	Method	Description
boolean	indexAccessible(IndexInfo ii)	Checks if an expression can be rewritten to an index access.
Bln	item(QueryContext qc, InputInfo ii)	Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence.
boolean	test(QueryContext qc, InputInfo ii, long pos)	Computes the effective boolean value for this expression.

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

arity, checkPerm, coerceFunc, coerceFunc, compileData, copy, dataLock, defined, description, embed, equals, has, hasCTX, hasUPD, hofIndex, invoke, opt, optFirst, optFirst, optimize, refineFunc, serialize, simplifyArgs, test, toBaseUri, toBindings, toCollation, toCollation, toContent, toContent, toData, toDate, toDBNode, toEncodingOrNull, toEncodingOrNull, toFunction, toFunction, toFunctionOrNull, toGregorian, toIO, toIO, toMs, toName, toNodeOrAtomItem, toOptions, toOptions, toOptions, toPath, toPath, toSerializerOptions, toStr, toString, toXml, toZeroStr, vacuous

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

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

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

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

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

arg, atomItem, atomIter, ddo, funcType, hasFreeVars, info, 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

FnContainsToken

public FnContainsToken()

Method Detail

item

public Bln 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 (can be null); required for those Value instances that have no input info)

Returns:

item or Empty.VALUE

Throws:

QueryException - query exception

test

public boolean test(QueryContext qc,
                    InputInfo ii,
                    long pos)
             throws QueryException

Description copied from class: Expr

Computes the effective boolean value for this expression.

Overrides:

test in class ParseExpr

Parameters:

qc - query context

ii - input info (can be null); required for those Value instances that have no input info)

pos - position of context item (if 0, perform EBV test)

Returns:

item

Throws:

QueryException - query exception

indexAccessible

public boolean indexAccessible(IndexInfo ii)
                        throws QueryException

Description copied from class: Expr

Checks if an expression can be rewritten to an index access. If so, the index expression will be bound to IndexInfo.expr. This method will be called by the Path expression.

Overrides:

indexAccessible in class Expr

Parameters:

ii - index info (can be null)

Returns:

true if an index can be used

Throws:

QueryException - query exception