Package org.basex.query.expr.ft

Class FTExtension

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

public final class FTExtension
extends FTExpr

FTExtensionSelection expression.

Author:

BaseX Team 2005-24, BSD License, Leo Woerteler

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
FTExtension(InputInfo info, Pragma pragma, FTExpr expr)	Constructor.

Method Summary

Modifier and Type	Method	Description
FTExpr	copy(CompileContext cc, IntObjMap<Var> vm)	Copies an expression.
boolean	equals(Object obj)	This function is e.g. called by: If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
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	toString(QueryString qs)	Creates a query string.
void	toXml(QueryPlan plan)	Creates a query plan.

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

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

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

adoptType, atomValue, checkAllUp, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, data, info, 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, args, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, info, isSimple, markTailCalls, mergeEbv, optimizePos, simplify, 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 Detail

FTExtension

public FTExtension(InputInfo info,
                   Pragma pragma,
                   FTExpr expr)

Constructor.

Parameters:

info - input info (can be null)

pragma - pragma

expr - enclosed FTSelection

Method Detail

item

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

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

Returns:

resulting item

Throws:

QueryException - query exception

iter

public FTIter iter(QueryContext qc)
            throws QueryException

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

Throws:

QueryException - query exception

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), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Overrides:

equals in class FTExpr

toXml

public void toXml(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Overrides:

toXml in class FTExpr

Parameters:

plan - expression plan

toString

public void toString(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

toString in class ExprInfo

Parameters:

qs - query string builder