org.basex.util.ft

Class FTOpt

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.util.ft.FTOpt

public final class FTOpt
extends ExprInfo

This class contains all full-text options.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
FTCase	cs Case (can be null).
int	errors Levenshtein error (ignored if -1).
Language	ln Language (can be null).
StemDir	sd Stemming dictionary (can be null).
StopWords	sw Stop words (can be null).
ThesQuery	th Thesaurus (can be null).

Constructor Summary

Constructors

Constructor and Description
FTOpt()

Method Summary

Modifier and Type	Method and Description
FTOpt	assign(FTOpt opt) Adopts the options of the specified argument.
FTOpt	assign(MetaData md) Assigns the full-text options from the specified database meta data.
FTOpt	copy() Creates a copy of the full-text options.
boolean	equals(Object obj)
boolean	is(FTFlag flag) Returns the specified flag.
boolean	isSet(FTFlag flag) Tests if the specified flag has been set.
void	plan(QueryPlan plan) Creates a query plan.
void	plan(QueryString qs) Creates a query string.
void	set(FTFlag flag, boolean value) Sets the specified flag.

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

Field Detail

cs

public FTCase cs

Case (can be null).

sd

public StemDir sd

Stemming dictionary (can be null).

sw

public StopWords sw

Stop words (can be null).

th

public ThesQuery th

Thesaurus (can be null).

ln

public Language ln

Language (can be null).

errors

public int errors

Levenshtein error (ignored if -1).

Constructor Detail

FTOpt

public FTOpt()

Method Detail

assign

public FTOpt assign(FTOpt opt)

Adopts the options of the specified argument.

Parameters:

opt - parent full-text options

Returns:

self reference

assign

public FTOpt assign(MetaData md)

Assigns the full-text options from the specified database meta data.

Parameters:

md - meta data

Returns:

self reference

set

public void set(FTFlag flag,
                boolean value)

Sets the specified flag.

Parameters:

flag - flag to be set

value - value

isSet

public boolean isSet(FTFlag flag)

Tests if the specified flag has been set.

Parameters:

flag - flag index

Returns:

true if flag has been set

is

public boolean is(FTFlag flag)

Returns the specified flag.

Parameters:

flag - flag index

Returns:

flag

copy

public FTOpt copy()

Creates a copy of the full-text options.

Returns:

copy

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

plan

public void plan(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Specified by:

plan in class ExprInfo

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