redis.clients.jedis.search

Class FTSpellCheckParams

java.lang.Object

redis.clients.jedis.search.FTSpellCheckParams

All Implemented Interfaces:

IParams

public class FTSpellCheckParams
extends java.lang.Object
implements IParams

Constructor Summary

Constructors

Constructor and Description
FTSpellCheckParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
FTSpellCheckParams	dialect(int dialect) Selects the dialect version under which to execute the query.
FTSpellCheckParams	dialectOptional(int dialect) This method will not replace the dialect if it has been already set.
FTSpellCheckParams	distance(int distance) Maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).
FTSpellCheckParams	excludeTerm(java.lang.String dictionary) Specifies an exclusion (EXCLUDE) of a custom dictionary.
FTSpellCheckParams	includeTerm(java.lang.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

Constructor Detail

FTSpellCheckParams

public FTSpellCheckParams()

Method Detail

spellCheckParams

public static FTSpellCheckParams spellCheckParams()

includeTerm

public FTSpellCheckParams includeTerm(java.lang.String dictionary)

Specifies an inclusion (INCLUDE) of a custom dictionary.

excludeTerm

public FTSpellCheckParams excludeTerm(java.lang.String dictionary)

Specifies an 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.

dialectOptional

public FTSpellCheckParams dialectOptional(int dialect)

This method will not replace the dialect if it has been already set.

Parameters:

dialect - dialect

Returns:

this

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams