Package org.basex.query.expr.ft

Class FTOptions

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.ft.FTExpr

org.basex.query.expr.ft.FTOptions

public final class FTOptions
extends FTExpr

FTOptions expression.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.expr.ft.FTExpr

exprs

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

exprType, info

Constructor Summary

Constructors

Constructor	Description
FTOptions(InputInfo info, FTExpr expr, FTOpt opt)	Constructor.

Method Summary

Modifier and Type	Method	Description
FTExpr	compile(CompileContext cc)	Compiles and optimizes the expression, assigns types and cardinalities.
FTExpr	copy(CompileContext cc, IntObjMap<Var> vm)	Copies an expression.
boolean	equals(Object obj)	This function is e.g.
FTNode	item(QueryContext qc, InputInfo ii)	This method is called by the sequential full-text evaluation.
FTIter	iter(QueryContext qc)	This method is called by the index-based full-text evaluation.
void	plan(QueryPlan plan)	Creates a query plan.
void	plan(QueryString qs)	Creates a query string.

Methods inherited from class org.basex.query.expr.ft.FTExpr

accept, checkUp, count, exprSize, has, inline, inlineable, optimize, usesExclude, value

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

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

arg, args, atomItem, atomIter, data, data, ddo, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, simplifyFor, typeCheck, uses, vacuous, visitAll

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

description, toErrorString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FTOptions

public FTOptions(InputInfo info,
 FTExpr expr,
 FTOpt opt)

Constructor.

Parameters:

info - input info

expr - expression

opt - full-text options

Method Details

compile

public FTExpr compile(CompileContext cc)
               throws QueryException

Description copied from class: Expr

Compiles and optimizes the expression, assigns types and cardinalities.

Overrides:

compile in class FTExpr

Parameters:

cc - compilation context

Returns:

optimized expression

Throws:

QueryException - query exception

item

public FTNode item(QueryContext qc,
 InputInfo ii)

Description copied from class: FTExpr

This method is called by the sequential full-text evaluation. It always returns an item.

Specified by:

item in class FTExpr

Parameters:

qc - query context

ii - input info (only required by Seq instances, which have no input info)

Returns:

resulting item

iter

public FTIter iter(QueryContext qc)

Description copied from class: FTExpr

This method is called by the index-based full-text evaluation.

Specified by:

iter in class FTExpr

Parameters:

qc - query context

Returns:

resulting item

copy

public FTExpr copy(CompileContext cc,
 IntObjMap<Var> vm)

Description copied from class: Expr

Copies an expression. Used for inlining functions, or for copying static queries. It is utilized by VarRef.inline(org.basex.query.InlineContext), FuncItem.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext), Closure.inline(org.basex.query.InlineContext) and StaticFunc.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext).

Specified by:

copy in class FTExpr

Parameters:

cc - compilation context

vm - mapping from old variable IDs to new variable copies. Required by Closure.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>) and VarRef.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>)

Returns:

copied expression

equals

public boolean equals(Object obj)

Description copied from class: Expr

This function is e.g. called by:

• If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
• CmpR.mergeEbv(Expr, boolean, CompileContext) or CmpSR.mergeEbv(Expr, boolean, CompileContext), in order to merge expressions with identical input.
• CmpG.optimize(CompileContext) or CmpV.optimize(CompileContext), in order to pre-evaluate equality tests.
• CmpG.optimize(CompileContext) or Pos.get(Expr, CmpV.OpV, InputInfo, CompileContext), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Overrides:

equals in class FTExpr

plan

public void plan(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Overrides:

plan in class FTExpr

Parameters:

plan - expression plan

plan

public void plan(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

plan in class ExprInfo

Parameters:

qs - query string builder