Package org.apache.solr.spelling

Class FileBasedSpellChecker

java.lang.Object

org.apache.solr.spelling.SolrSpellChecker

org.apache.solr.spelling.AbstractLuceneSpellChecker

org.apache.solr.spelling.FileBasedSpellChecker

public class FileBasedSpellChecker
extends AbstractLuceneSpellChecker

A spell checker implementation that loads words from a text file (one word per line).

Since:

solr 1.3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOURCE_FILE_CHAR_ENCODING
static final String	WORD_FIELD_NAME

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

accuracy, ACCURACY, COMPARATOR_CLASS, DEFAULT_SUGGESTION_COUNT, dictionary, FIELD, FREQ_COMP, index, INDEX_DIR, indexDir, LOCATION, SCORE_COMP, sd, sourceLocation, spellChecker, SPELLCHECKER_ARG_NAME, STRING_DISTANCE

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

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

Constructor Summary

Constructors

Constructor	Description
FileBasedSpellChecker()

Method Summary

Modifier and Type	Method	Description
void	build(SolrCore core, SolrIndexSearcher searcher)	(re)Builds the spelling index.
protected org.apache.lucene.index.IndexReader	determineReader(org.apache.lucene.index.IndexReader reader)	Override to return null, since there is no reader associated with a file based index
String	getCharacterEncoding()
String	init(org.apache.solr.common.util.NamedList<?> config, SolrCore core)

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

getAccuracy, getField, getFieldTypeName, getIndexDir, getSourceLocation, getSpellChecker, getStringDistance, getSuggestions, initIndex, reload

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

getDictionaryName, getQueryAnalyzer, isSuggestionsMayOverlap, mergeSuggestions, modifyRequest

Methods inherited from class java.lang.Object

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

Field Details

SOURCE_FILE_CHAR_ENCODING

public static final String SOURCE_FILE_CHAR_ENCODING

See Also:

• Constant Field Values

WORD_FIELD_NAME

public static final String WORD_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

FileBasedSpellChecker

public FileBasedSpellChecker()

Method Details

init

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

Overrides:

init in class AbstractLuceneSpellChecker

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

determineReader

protected org.apache.lucene.index.IndexReader determineReader(org.apache.lucene.index.IndexReader reader)

Override to return null, since there is no reader associated with a file based index

Overrides:

determineReader in class AbstractLuceneSpellChecker

getCharacterEncoding

public String getCharacterEncoding()