io.lettuce.core.search

Class SpellCheckResult.Suggestion<V>

java.lang.Object

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

Type Parameters:

V - Value type.

Enclosing class:

SpellCheckResult<V>

public static class SpellCheckResult.Suggestion<V>
extends Object

Represents a spelling suggestion with its score.

Constructor Summary

Constructors

Constructor and Description
Suggestion(double score, V suggestion) Create a new spelling suggestion.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getScore() Get the suggestion score.
V	getSuggestion() Get the suggested term.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Suggestion

public Suggestion(double score,
                  V suggestion)

Create a new spelling suggestion.

Parameters:

score - the suggestion score

suggestion - the suggested term

Method Detail

getScore

public double getScore()

Get the suggestion score.

The score is calculated by dividing the number of documents in which the suggested term exists by the total number of documents in the index. Results can be normalized by dividing scores by the highest score.

Returns:

the suggestion score

getSuggestion

public V getSuggestion()

Get the suggested term.

Returns:

the suggested term

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