org.basex.query.ft
Class FTOptions

java.lang.Object
  extended by org.basex.data.ExprInfo
      extended by org.basex.query.expr.Expr
          extended by org.basex.query.expr.ParseExpr
              extended by org.basex.query.ft.FTExpr
                  extended by org.basex.query.ft.FTOptions

public final class FTOptions
extends FTExpr

FTOptions expression.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Nested Class Summary
 
Nested classes/interfaces inherited from class org.basex.query.expr.Expr
Expr.Flag
 
Field Summary
 
Fields inherited from class org.basex.query.ft.FTExpr
expr
 
Fields inherited from class org.basex.query.expr.ParseExpr
info, size, type
 
Constructor Summary
FTOptions(InputInfo ii, FTExpr e, FTOpt o)
          Constructor.
 
Method Summary
 FTExpr compile(QueryContext ctx, VarScope scp)
          Compiles and optimizes the expression, assigns data types and cardinalities.
 FTExpr copy(QueryContext ctx, VarScope scp, IntObjMap<Var> vs)
          Copies an expression.
 FTNode item(QueryContext ctx, InputInfo ii)
          This method is called by the sequential full-text evaluation.
 FTIter iter(QueryContext ctx)
          This method is called by the index-based full-text evaluation.
 void plan(FElem plan)
          Creates an expression tree.
 java.lang.String toString()
           
 
Methods inherited from class org.basex.query.ft.FTExpr
accept, checkUp, count, exprSize, has, indexEquivalent, inline, optimize, removable
 
Methods inherited from class org.basex.query.expr.ParseExpr
checkAdmin, checkAllUp, checkBinary, checkBln, checkColl, checkCreate, checkCtx, checkDbl, checkDBNode, checkEStr, checkEStr, checkFunc, checkItem, checkItr, checkItr, checkMap, checkNode, checkNode, checkNode, checkNoEmpty, checkNoneUp, checkNoUp, checkQNm, checkStr, checkStr, checkStrBin, checkType, checkWrite, compBln, copyType, ebv, optPre, preEval, size, test, type, value
 
Methods inherited from class org.basex.query.expr.Expr
addText, compEbv, copy, hasFreeVars, indexAccessible, inlineAll, isEmpty, isFunction, isItem, isVacuous, isValue, iterable, markTailCalls, sameAs, uses, visitAll
 
Methods inherited from class org.basex.data.ExprInfo
addPlan, addPlan, description, info, planAttr, planElem
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FTOptions

public FTOptions(InputInfo ii,
                 FTExpr e,
                 FTOpt o)
Constructor.

Parameters:
ii - input info
e - expression
o - ft options
Method Detail

compile

public FTExpr compile(QueryContext ctx,
                      VarScope scp)
               throws QueryException
Description copied from class: Expr
Compiles and optimizes the expression, assigns data types and cardinalities.

Overrides:
compile in class FTExpr
Parameters:
ctx - query context
scp - variable scope
Returns:
optimized expression
Throws:
QueryException - query exception

plan

public void plan(FElem plan)
Description copied from class: ExprInfo
Creates an expression tree.

Overrides:
plan in class FTExpr
Parameters:
plan - root element

toString

public java.lang.String toString()
Specified by:
toString in class ExprInfo

item

public FTNode item(QueryContext ctx,
                   InputInfo ii)
Description copied from class: FTExpr
This method is called by the sequential full-text evaluation.

Specified by:
item in class FTExpr
Parameters:
ctx - query context
ii - input info
Returns:
resulting item

iter

public FTIter iter(QueryContext ctx)
Description copied from class: FTExpr
This method is called by the index-based full-text evaluation.

Specified by:
iter in class FTExpr
Parameters:
ctx - query context
Returns:
resulting item

copy

public FTExpr copy(QueryContext ctx,
                   VarScope scp,
                   IntObjMap<Var> vs)
Description copied from class: Expr
Copies an expression. Will be useful for inlining functions, or for copying static queries.

Specified by:
copy in class FTExpr
Parameters:
ctx - query context
scp - variable scope for creating new variables
vs - mapping from old variable IDs to new variable copies
Returns:
copied expression