io.lettuce.core.search

Class SpellCheckResult<V>

java.lang.Object

io.lettuce.core.search.SpellCheckResult<V>

Type Parameters:

V - Value type.

public class SpellCheckResult<V>
extends Object

Represents the result of a Redis FT.SPELLCHECK command.

Contains a list of misspelled terms from the query, each with their spelling suggestions. The misspelled terms are ordered by their order of appearance in the query.

Since:

6.8

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpellCheckResult.MisspelledTerm<V> Represents a misspelled term and its spelling suggestions.
static class	SpellCheckResult.Suggestion<V> Represents a spelling suggestion with its score.

Constructor Summary

Constructors

Constructor and Description
SpellCheckResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getMisspelledTermCount() Get the number of misspelled terms.
List<SpellCheckResult.MisspelledTerm<V>>	getMisspelledTerms() Get the list of misspelled terms with their suggestions.
int	hashCode()
boolean	hasMisspelledTerms() Check if there are any misspelled terms.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpellCheckResult

public SpellCheckResult()

Method Detail

getMisspelledTerms

public List<SpellCheckResult.MisspelledTerm<V>> getMisspelledTerms()

Get the list of misspelled terms with their suggestions.

Returns:

the list of misspelled terms

hasMisspelledTerms

public boolean hasMisspelledTerms()

Check if there are any misspelled terms.

Returns:

true if there are misspelled terms

getMisspelledTermCount

public int getMisspelledTermCount()

Get the number of misspelled terms.

Returns:

the number of misspelled terms

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object