Package org.basex.query.expr.ft

Class FTFilter

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

Direct Known Subclasses:

FTContent, FTDistance, FTOrder, FTScope, FTWindow

public abstract class FTFilter
extends FTExpr

Abstract FTFilter 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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	This function is e.g.
protected abstract boolean	filter(QueryContext qc, FTMatch match, FTLexer lexer)	Evaluates the filter expression.
final boolean	indexAccessible(IndexInfo ii)	Checks if an expression can be rewritten to an index access.
final FTNode	item(QueryContext qc, InputInfo ii)	This method is called by the sequential full-text evaluation.
final FTIter	iter(QueryContext qc)	This method is called by the index-based full-text evaluation.

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

accept, checkUp, compile, copy, count, exprSize, has, inline, inlineable, optimize, plan, 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, isSimple, markTailCalls, mergeEbv, simplifyFor, typeCheck, uses, vacuous, visitAll

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

description, plan, toErrorString, toString

Methods inherited from class java.lang.Object

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

Method Details

item

public final 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 (only required by Seq instances, which have no input info)

Returns:

resulting item

Throws:

QueryException - query exception

iter

public final 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

filter

protected abstract boolean filter(QueryContext qc,
 FTMatch match,
 FTLexer lexer)
                           throws QueryException

Evaluates the filter expression.

Parameters:

qc - query context

match - full-text match

lexer - lexer (can be null)

Returns:

result of check

Throws:

QueryException - query exception

indexAccessible

public final 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

Returns:

true if an index can be used

Throws:

QueryException - query exception

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