Package org.apache.solr.spelling

Class DirectSolrSpellChecker

java.lang.Object

org.apache.solr.spelling.SolrSpellChecker

org.apache.solr.spelling.DirectSolrSpellChecker

public class DirectSolrSpellChecker
extends SolrSpellChecker

Spellchecker implementation that uses DirectSpellChecker

Requires no auxiliary index or data structure.

Supported options:

• field: Used as the source of terms.
• distanceMeasure: Sets DirectSpellChecker.setDistance(StringDistance). Note: to set the default DirectSpellChecker.INTERNAL_LEVENSHTEIN, use "internal".
• accuracy: Sets DirectSpellChecker.setAccuracy(float).
• maxEdits: Sets DirectSpellChecker.setMaxEdits(int).
• minPrefix: Sets DirectSpellChecker.setMinPrefix(int).
• maxInspections: Sets DirectSpellChecker.setMaxInspections(int).
• comparatorClass: Sets DirectSpellChecker.setComparator(Comparator). Note: score-then-frequency can be specified as "score" and frequency-then-score can be specified as "freq".
• thresholdTokenFrequency: sets DirectSpellChecker.setThresholdFrequency(float).
• minQueryLength: sets DirectSpellChecker.setMinQueryLength(int).
• maxQueryLength: sets DirectSpellChecker.setMaxQueryLength(int).
• maxQueryFrequency: sets DirectSpellChecker.setMaxQueryFrequency(float).

See Also:

• DirectSpellChecker

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCURACY
static final String	COMPARATOR_CLASS
static final float	DEFAULT_ACCURACY
static final int	DEFAULT_MAXEDITS
static final int	DEFAULT_MAXINSPECTIONS
static final float	DEFAULT_MAXQUERYFREQUENCY
static final int	DEFAULT_MAXQUERYLENGTH
static final int	DEFAULT_MINPREFIX
static final int	DEFAULT_MINQUERYLENGTH
static final float	DEFAULT_THRESHOLD_TOKEN_FREQUENCY
static final String	FREQ_COMP
static final String	INTERNAL_DISTANCE
static final String	MAXEDITS
static final String	MAXINSPECTIONS
static final String	MAXQUERYFREQUENCY
static final String	MAXQUERYLENGTH
static final String	MINPREFIX
static final String	MINQUERYLENGTH
static final String	SCORE_COMP
static final String	STRING_DISTANCE
static final String	THRESHOLD_TOKEN_FREQUENCY

Fields inherited from class org.apache.solr.spelling.SolrSpellChecker

analyzer, DEFAULT_DICTIONARY_NAME, DICTIONARY_NAME, field, FIELD, FIELD_TYPE, fieldTypeName, name

Constructor Summary

Constructors

Constructor	Description
DirectSolrSpellChecker()

Method Summary

Modifier and Type	Method	Description
void	build(SolrCore core, SolrIndexSearcher searcher)	(re)Builds the spelling index.
float	getAccuracy()	Get the value of SpellingParams.SPELLCHECK_ACCURACY if supported.
org.apache.lucene.search.spell.StringDistance	getStringDistance()	Get the distance implementation used by this spellchecker, or NULL if not applicable.
SpellingResult	getSuggestions(SpellingOptions options)	Get suggestions for the given query.
String	init(org.apache.solr.common.util.NamedList<?> config, SolrCore core)
SpellingResult	mergeSuggestions(SpellCheckMergeData mergeData, int numSug, int count, boolean extendedResults)	Integrate spelling suggestions from the various shards in a distributed environment.
void	modifyRequest(ResponseBuilder rb, ShardRequest sreq)	modify the shard request to be used in a distributed environment.
void	reload(SolrCore core, SolrIndexSearcher searcher)	Reloads the index.

Methods inherited from class org.apache.solr.spelling.SolrSpellChecker

getDictionaryName, getQueryAnalyzer, isSuggestionsMayOverlap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMPARATOR_CLASS

public static final String COMPARATOR_CLASS

See Also:

• Constant Field Values

SCORE_COMP

public static final String SCORE_COMP

See Also:

• Constant Field Values

FREQ_COMP

public static final String FREQ_COMP

See Also:

• Constant Field Values

STRING_DISTANCE

public static final String STRING_DISTANCE

See Also:

• Constant Field Values

ACCURACY

public static final String ACCURACY

See Also:

• Constant Field Values

THRESHOLD_TOKEN_FREQUENCY

public static final String THRESHOLD_TOKEN_FREQUENCY

See Also:

• Constant Field Values

INTERNAL_DISTANCE

public static final String INTERNAL_DISTANCE

See Also:

• Constant Field Values

DEFAULT_ACCURACY

public static final float DEFAULT_ACCURACY

See Also:

• Constant Field Values

DEFAULT_THRESHOLD_TOKEN_FREQUENCY

public static final float DEFAULT_THRESHOLD_TOKEN_FREQUENCY

See Also:

• Constant Field Values

MAXEDITS

public static final String MAXEDITS

See Also:

• Constant Field Values

DEFAULT_MAXEDITS

public static final int DEFAULT_MAXEDITS

See Also:

• Constant Field Values

MINPREFIX

public static final String MINPREFIX

See Also:

• Constant Field Values

DEFAULT_MINPREFIX

public static final int DEFAULT_MINPREFIX

See Also:

• Constant Field Values

MAXINSPECTIONS

public static final String MAXINSPECTIONS

See Also:

• Constant Field Values

DEFAULT_MAXINSPECTIONS

public static final int DEFAULT_MAXINSPECTIONS

See Also:

• Constant Field Values

MINQUERYLENGTH

public static final String MINQUERYLENGTH

See Also:

• Constant Field Values

DEFAULT_MINQUERYLENGTH

public static final int DEFAULT_MINQUERYLENGTH

See Also:

• Constant Field Values

MAXQUERYLENGTH

public static final String MAXQUERYLENGTH

See Also:

• Constant Field Values

DEFAULT_MAXQUERYLENGTH

public static final int DEFAULT_MAXQUERYLENGTH

See Also:

• Constant Field Values

MAXQUERYFREQUENCY

public static final String MAXQUERYFREQUENCY

See Also:

• Constant Field Values

DEFAULT_MAXQUERYFREQUENCY

public static final float DEFAULT_MAXQUERYFREQUENCY

See Also:

• Constant Field Values

Constructor Details

DirectSolrSpellChecker

public DirectSolrSpellChecker()

Method Details

init

public String init(org.apache.solr.common.util.NamedList<?> config,
 SolrCore core)

Overrides:

init in class SolrSpellChecker

reload

public void reload(SolrCore core,
 SolrIndexSearcher searcher)
            throws IOException

Description copied from class: SolrSpellChecker

Reloads the index. Useful if an external process is responsible for building the spell checker.

Specified by:

reload in class SolrSpellChecker

Throws:

IOException - If there is a low-level I/O error.

build

public void build(SolrCore core,
 SolrIndexSearcher searcher)
           throws IOException

Description copied from class: SolrSpellChecker

(re)Builds the spelling index. May be a NOOP if the implementation doesn't require building, or can't be rebuilt.

Specified by:

build in class SolrSpellChecker

Throws:

IOException

getSuggestions

public SpellingResult getSuggestions(SpellingOptions options)
                              throws IOException

Description copied from class: SolrSpellChecker

Get suggestions for the given query. Tokenizes the query using a field appropriate Analyzer. The SpellingResult.getSuggestions() suggestions must be ordered by best suggestion first.

Specified by:

getSuggestions in class SolrSpellChecker

Parameters:

options - The SpellingOptions to use

Returns:

The SpellingResult suggestions

Throws:

IOException - if there is an error producing suggestions

modifyRequest

public void modifyRequest(ResponseBuilder rb,
 ShardRequest sreq)

Description copied from class: SolrSpellChecker

modify the shard request to be used in a distributed environment.

Overrides:

modifyRequest in class SolrSpellChecker

mergeSuggestions

public SpellingResult mergeSuggestions(SpellCheckMergeData mergeData,
 int numSug,
 int count,
 boolean extendedResults)

Description copied from class: SolrSpellChecker

Integrate spelling suggestions from the various shards in a distributed environment.

Overrides:

mergeSuggestions in class SolrSpellChecker

getAccuracy

public float getAccuracy()

Description copied from class: SolrSpellChecker

Get the value of SpellingParams.SPELLCHECK_ACCURACY if supported. Otherwise throws UnsupportedOperationException.

Overrides:

getAccuracy in class SolrSpellChecker

getStringDistance

public org.apache.lucene.search.spell.StringDistance getStringDistance()

Description copied from class: SolrSpellChecker

Get the distance implementation used by this spellchecker, or NULL if not applicable.

Overrides:

getStringDistance in class SolrSpellChecker