Package org.basex.query.func.fn

Class FnSubsequenceWhere

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

public class FnSubsequenceWhere
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
FnSubsequenceWhere()

Method Summary

Modifier and Type	Method	Description
int	hofIndex()	Returns the index of a single higher-order function parameter.
Iter	iter(QueryContext qc)	Evaluates the expression and returns an iterator on the resulting items.
protected Expr	opt(CompileContext cc)	Performs function-specific optimizations.
Value	value(QueryContext qc)	Evaluates the expression and returns the resulting value.

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

arity, checkPerm, coerceFunc, coerceFunc, compileData, copy, dataLock, defined, description, embed, equals, has, hasCTX, hasUPD, invoke, 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, item, refineType, sc, seqType, size, test, 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

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

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

FnSubsequenceWhere

public FnSubsequenceWhere()

Method Detail

iter

public Iter iter(QueryContext qc)
          throws QueryException

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

Throws:

QueryException - query exception

value

public Value value(QueryContext qc)
            throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting value. If this method is not implemented, Expr.item(QueryContext, InputInfo) must be implemented instead.

Overrides:

value in class ParseExpr

Parameters:

qc - query context

Returns:

value

Throws:

QueryException - query exception

opt

protected final Expr opt(CompileContext cc)
                  throws QueryException

Description copied from class: StandardFunc

Performs function-specific optimizations.

Overrides:

opt in class StandardFunc

Parameters:

cc - compilation context

Returns:

optimized or original expression

Throws:

QueryException - query exception

hofIndex

public int hofIndex()

Description copied from class: StandardFunc

Returns the index of a single higher-order function parameter.

Overrides:

hofIndex in class StandardFunc

Returns:

index, -1 if no HOF parameter exists, or Integer#MAX_VALUE if the number cannot be returned or if multiple HOF parameters exist