public class SpellcheckOptions extends Object
SpellcheckOptions
allows modification of query parameters targeting the SpellCheck component is designed to
provide inline query suggestions based on other, similar, terms.Modifier and Type | Method and Description |
---|---|
SpellcheckOptions |
accuracy(float nr)
Specifies an accuracy value to be used by the spell checking implementation to decide whether a result is
worthwhile or not.
|
SpellcheckOptions |
alternativeTermCount(long nr)
The count of suggestions to return for each query term existing in the index and/or dictionary.
|
SpellcheckOptions |
buildDictionary()
If set, Solr creates the dictionary that the SolrSpellChecker will use for spell-checking.
|
boolean |
buildDirectory() |
SpellcheckOptions |
collate()
If set, Solr will take the best suggestion for each token (if one exists) and construct a new query from the
suggestions.
|
SpellcheckOptions |
collateExtendedResults()
Instructs Solr to return an expanded response format detailing the collations found.
|
SpellcheckOptions |
collateParam(String param,
Object value)
This parameter prefix can be used to specify any additional parameters that you wish to the Spellchecker to use
when internally validating collation queries.
|
SpellcheckOptions |
count(long nr)
Specifies the maximum number of spelling suggestions to be returned.
|
SpellcheckOptions |
dictionaries(String... names)
This parameter causes Solr to use the dictionary named in the parameter's argument.
|
SpellcheckOptions |
extendedResults()
Enable the extended response format, which is more complicated but richer.
|
Float |
getAccuracy() |
Long |
getAlternativeTermCount() |
boolean |
getCollate() |
boolean |
getCollateExtendedResults() |
Map<String,Object> |
getCollateParams() |
Long |
getCount() |
String[] |
getDictionary() |
Boolean |
getExtendedResults() |
Long |
getMaxCollationCollectDocs() |
Long |
getMaxCollationEvaluations() |
Long |
getMaxCollations() |
Long |
getMaxCollationTries() |
Long |
getMaxResultsForSuggest() |
boolean |
getOnlyMorePopular() |
Map<String,Object> |
getParams() |
Query |
getQuery()
Get the query to be used for spellchecking.
|
SpellcheckOptions |
maxCollationCollectDocs(long nr)
This parameter specifies the maximum number of documents that should be collect when testing potential collations
against the index.
|
SpellcheckOptions |
maxCollationEvaluations(long evaluations)
This parameter specifies the maximum number of word correction combinations to rank and evaluate prior to deciding
which collation candidates to test against the index.
|
SpellcheckOptions |
maxCollations(long max)
The maximum number of collations to return.
|
SpellcheckOptions |
maxCollationTries(long tries)
This parameter specifies the number of collation possibilities for Solr to try before giving up.
|
SpellcheckOptions |
maxResultsForSuggest(long nr)
The maximum number of hits the request can return in order to both generate spelling suggestions and set the
correctlySpelled element to false.
|
SpellcheckOptions |
onlyMorePopular()
Limits spellcheck responses to queries that are more popular than the original query.
|
static SpellcheckOptions |
spellcheck()
Creates new
SpellcheckOptions . |
static SpellcheckOptions |
spellcheck(Query q)
Creates new
SpellcheckOptions with a given Query . |
public static SpellcheckOptions spellcheck()
SpellcheckOptions
.public static SpellcheckOptions spellcheck(Query q)
SpellcheckOptions
with a given Query
.q
- public Query getQuery()
public SpellcheckOptions buildDictionary()
SpellcheckOptions
public boolean buildDirectory()
public SpellcheckOptions collate()
SpellcheckOptions
public boolean getCollate()
public SpellcheckOptions maxCollations(long max)
max
- public Long getMaxCollations()
public SpellcheckOptions maxCollationTries(long tries)
tries
- public Long getMaxCollationTries()
public SpellcheckOptions maxCollationEvaluations(long evaluations)
evaluations
- public Long getMaxCollationEvaluations()
public SpellcheckOptions extendedResults()
public Boolean getExtendedResults()
public SpellcheckOptions collateExtendedResults()
public boolean getCollateExtendedResults()
public SpellcheckOptions maxCollationCollectDocs(long nr)
nr
- public Long getMaxCollationCollectDocs()
public SpellcheckOptions collateParam(String param, Object value)
param
- value
- public SpellcheckOptions count(long nr)
nr
- public Long getCount()
public SpellcheckOptions dictionaries(String... names)
name
- public String[] getDictionary()
public SpellcheckOptions onlyMorePopular()
public boolean getOnlyMorePopular()
public SpellcheckOptions maxResultsForSuggest(long nr)
nr
- public Long getMaxResultsForSuggest()
public SpellcheckOptions alternativeTermCount(long nr)
nr
- public Long getAlternativeTermCount()
public SpellcheckOptions accuracy(float nr)
nr
- public Float getAccuracy()
Copyright © 2011–2018 Pivotal Software, Inc.. All rights reserved.