public class SpellCheckResponse
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
class |
SpellCheckResponse.Collation |
class |
SpellCheckResponse.Correction |
static class |
SpellCheckResponse.Suggestion |
Modifier and Type | Field and Description |
---|---|
private java.util.List<SpellCheckResponse.Collation> |
collations |
private boolean |
correctlySpelled |
(package private) java.util.Map<java.lang.String,SpellCheckResponse.Suggestion> |
suggestionMap |
private java.util.List<SpellCheckResponse.Suggestion> |
suggestions |
Constructor and Description |
---|
SpellCheckResponse(NamedList<java.lang.Object> spellInfo) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCollatedResult()
Return the first collated query string.
|
java.util.List<SpellCheckResponse.Collation> |
getCollatedResults()
Return all collations.
|
java.lang.String |
getFirstSuggestion(java.lang.String token) |
SpellCheckResponse.Suggestion |
getSuggestion(java.lang.String token) |
java.util.Map<java.lang.String,SpellCheckResponse.Suggestion> |
getSuggestionMap() |
java.util.List<SpellCheckResponse.Suggestion> |
getSuggestions() |
boolean |
isCorrectlySpelled() |
private boolean correctlySpelled
private java.util.List<SpellCheckResponse.Collation> collations
private java.util.List<SpellCheckResponse.Suggestion> suggestions
java.util.Map<java.lang.String,SpellCheckResponse.Suggestion> suggestionMap
public SpellCheckResponse(NamedList<java.lang.Object> spellInfo)
public boolean isCorrectlySpelled()
public java.util.List<SpellCheckResponse.Suggestion> getSuggestions()
public java.util.Map<java.lang.String,SpellCheckResponse.Suggestion> getSuggestionMap()
public SpellCheckResponse.Suggestion getSuggestion(java.lang.String token)
public java.lang.String getFirstSuggestion(java.lang.String token)
public java.lang.String getCollatedResult()
Return the first collated query string. For convenience and backwards-compatibility. Use getCollatedResults() for full data.
public java.util.List<SpellCheckResponse.Collation> getCollatedResults()
Return all collations. Will include # of hits and misspelling-to-correction details if "spellcheck.collateExtendedResults was true.