io.lettuce.core.search

Class SpellCheckResult.Suggestion

java.lang.Object

io.lettuce.core.search.SpellCheckResult.Suggestion

Enclosing class:

SpellCheckResult

public static class SpellCheckResult.Suggestion
extends Object

Represents a spelling suggestion with its score.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getScore() Get the suggestion score.
String	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,
                  String 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 String 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