org.apache.solr.client.solrj.response
Class SpellCheckResponse

java.lang.Object
  extended by org.apache.solr.client.solrj.response.SpellCheckResponse

public class SpellCheckResponse
extends Object

Encapsulates responses from SpellCheckComponent

Since:
solr 1.3

Nested Class Summary
 class SpellCheckResponse.Collation
           
 class SpellCheckResponse.Correction
           
static class SpellCheckResponse.Suggestion
           
 
Constructor Summary
SpellCheckResponse(NamedList<NamedList<Object>> spellInfo)
           
 
Method Summary
 String getCollatedResult()
           Return the first collated query string.
 List<SpellCheckResponse.Collation> getCollatedResults()
           Return all collations.
 String getFirstSuggestion(String token)
           
 SpellCheckResponse.Suggestion getSuggestion(String token)
           
 Map<String,SpellCheckResponse.Suggestion> getSuggestionMap()
           
 List<SpellCheckResponse.Suggestion> getSuggestions()
           
 boolean isCorrectlySpelled()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpellCheckResponse

public SpellCheckResponse(NamedList<NamedList<Object>> spellInfo)
Method Detail

isCorrectlySpelled

public boolean isCorrectlySpelled()

getSuggestions

public List<SpellCheckResponse.Suggestion> getSuggestions()

getSuggestionMap

public Map<String,SpellCheckResponse.Suggestion> getSuggestionMap()

getSuggestion

public SpellCheckResponse.Suggestion getSuggestion(String token)

getFirstSuggestion

public String getFirstSuggestion(String token)

getCollatedResult

public String getCollatedResult()

Return the first collated query string. For convenience and backwards-compatibility. Use getCollatedResults() for full data.

Returns:
first collated query string

getCollatedResults

public List<SpellCheckResponse.Collation> getCollatedResults()

Return all collations. Will include # of hits and misspelling-to-correction details if "spellcheck.collateExtendedResults was true.

Returns:
all collations


Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.