org.apache.solr.spelling
Class AbstractLuceneSpellChecker

java.lang.Object
  org.apache.solr.spelling.SolrSpellChecker
      org.apache.solr.spelling.AbstractLuceneSpellChecker

Direct Known Subclasses:

FileBasedSpellChecker, IndexBasedSpellChecker

public abstract class AbstractLuceneSpellChecker
extends SolrSpellChecker

Abstract base class for all Lucene-based spell checking implementations.

Refer to SpellCheckComponent for more details.

Since:

solr 1.3

Field Summary

protected float	accuracy
static String	ACCURACY
static int	DEFAULT_SUGGESTION_COUNT
protected org.apache.lucene.search.spell.Dictionary	dictionary
protected String	field
static String	FIELD
static String	FIELD_TYPE
protected String	fieldTypeName
protected org.apache.lucene.store.Directory	index
static String	INDEX_DIR
protected String	indexDir
static String	LOCATION
static Logger	LOG
protected String	sourceLocation
protected org.apache.lucene.search.spell.SpellChecker	spellChecker
static String	SPELLCHECKER_ARG_NAME
static String	STRING_DISTANCE

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

analyzer, DEFAULT_DICTIONARY_NAME, DICTIONARY_NAME, name

Constructor Summary

AbstractLuceneSpellChecker()

Method Summary

protected org.apache.lucene.index.IndexReader	determineReader(org.apache.lucene.index.IndexReader reader)
float	getAccuracy()
String	getField()
String	getFieldTypeName()
String	getIndexDir()
String	getSourceLocation()
SpellingResult	getSuggestions(Collection<org.apache.lucene.analysis.Token> tokens, org.apache.lucene.index.IndexReader reader, int count, boolean onlyMorePopular, boolean extendedResults) Get suggestions for the given query.
String	init(org.apache.solr.common.util.NamedList config, SolrCore core)
protected void	initIndex() Initialize the index variable based on the indexDir.
void	reload() Reloads the index.

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

build, getDictionaryName, getQueryAnalyzer, getSuggestions, getSuggestions, getSuggestions

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Logger LOG

SPELLCHECKER_ARG_NAME

public static final String SPELLCHECKER_ARG_NAME

See Also:

Constant Field Values

LOCATION

public static final String LOCATION

See Also:

Constant Field Values

INDEX_DIR

public static final String INDEX_DIR

See Also:

Constant Field Values

ACCURACY

public static final String ACCURACY

See Also:

Constant Field Values

STRING_DISTANCE

public static final String STRING_DISTANCE

See Also:

Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

field

protected String field

fieldTypeName

protected String fieldTypeName

spellChecker

protected org.apache.lucene.search.spell.SpellChecker spellChecker

sourceLocation

protected String sourceLocation

index

protected org.apache.lucene.store.Directory index

dictionary

protected org.apache.lucene.search.spell.Dictionary dictionary

DEFAULT_SUGGESTION_COUNT

public static final int DEFAULT_SUGGESTION_COUNT

See Also:

Constant Field Values

indexDir

protected String indexDir

accuracy

protected float accuracy

FIELD

public static final String FIELD

See Also:

Constant Field Values

Constructor Detail

AbstractLuceneSpellChecker

public AbstractLuceneSpellChecker()

Method Detail

init

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

Overrides:

init in class SolrSpellChecker

getSuggestions

public SpellingResult getSuggestions(Collection<org.apache.lucene.analysis.Token> tokens,
                                     org.apache.lucene.index.IndexReader reader,
                                     int count,
                                     boolean onlyMorePopular,
                                     boolean extendedResults)
                              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:

tokens - The Tokens to be spell checked.

reader - The (optional) IndexReader. If there is not IndexReader, than extendedResults are not possible

count - The maximum number of suggestions to return

onlyMorePopular - TODO

extendedResults - TODO

Throws:

IOException

determineReader

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

reload

public void reload()
            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

initIndex

protected void initIndex()
                  throws IOException

Initialize the index variable based on the indexDir. Does not actually create the spelling index.

Throws:

IOException

getAccuracy

public float getAccuracy()

getField

public String getField()

getFieldTypeName

public String getFieldTypeName()

getIndexDir

public String getIndexDir()

getSourceLocation

public String getSourceLocation()