Package redis.clients.jedis.search

Class FTSpellCheckParams

java.lang.Object

redis.clients.jedis.search.FTSpellCheckParams

All Implemented Interfaces:

IParams

public class FTSpellCheckParams
extends Object
implements IParams

Field Summary

Fields

Modifier and Type	Field	Description
private Integer	dialect
private Integer	distance
private Collection<Map.Entry<String,Rawable>>	terms

Constructor Summary

Constructors

Constructor	Description
FTSpellCheckParams()

Method Summary

Modifier and Type	Method	Description
void	addParams(CommandArguments args)
private FTSpellCheckParams	addTerm(String dictionary, Rawable type)	Specifies an inclusion (INCLUDE) or exclusion (EXCLUDE) of a custom dictionary.
FTSpellCheckParams	dialect(int dialect)	Selects the dialect version under which to execute the query.
FTSpellCheckParams	distance(int distance)	Maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).
FTSpellCheckParams	excludeTerm(String dictionary)	Specifies an exclusion (EXCLUDE) of a custom dictionary.
FTSpellCheckParams	includeTerm(String dictionary)	Specifies an inclusion (INCLUDE) of a custom dictionary.
static FTSpellCheckParams	spellCheckParams()

Methods inherited from class java.lang.Object

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

Field Details

terms

private Collection<Map.Entry<String,Rawable>> terms

distance

private Integer distance

dialect

private Integer dialect

Constructor Details

FTSpellCheckParams

public FTSpellCheckParams()

Method Details

spellCheckParams

public static FTSpellCheckParams spellCheckParams()

includeTerm

public FTSpellCheckParams includeTerm(String dictionary)

Specifies an inclusion (INCLUDE) of a custom dictionary.

excludeTerm

public FTSpellCheckParams excludeTerm(String dictionary)

Specifies an exclusion (EXCLUDE) of a custom dictionary.

addTerm

private FTSpellCheckParams addTerm(String dictionary,
 Rawable type)

Specifies an inclusion (INCLUDE) or exclusion (EXCLUDE) of a custom dictionary.

distance

public FTSpellCheckParams distance(int distance)

Maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).

dialect

public FTSpellCheckParams dialect(int dialect)

Selects the dialect version under which to execute the query.

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams