C

clearIndex() - Method in class org.apache.lucene.search.spell.SpellChecker

Removes all terms from the spell check index.

close() - Method in class org.apache.lucene.search.spell.SpellChecker

Close the IndexSearcher used by this SpellChecker

D

Dictionary - Interface in org.apache.lucene.search.spell

A simple interface representing a Dictionary.

E

exist(String) - Method in class org.apache.lucene.search.spell.SpellChecker

Check whether the word exists in the index.

F

F_WORD - Static variable in class org.apache.lucene.search.spell.SpellChecker

Field name for each word in the ngram index.

G

getDistance(String, String) - Method in class org.apache.lucene.search.spell.JaroWinklerDistance

 

getDistance(String, String) - Method in class org.apache.lucene.search.spell.LevensteinDistance

 

getDistance(String, String) - Method in class org.apache.lucene.search.spell.NGramDistance

 

getDistance(String, String) - Method in interface org.apache.lucene.search.spell.StringDistance

Returns a float between 0 and 1 based on how similar the specified strings are to one another.

getStringDistance() - Method in class org.apache.lucene.search.spell.SpellChecker

Returns the StringDistance instance used by this SpellChecker instance.

getThreshold() - Method in class org.apache.lucene.search.spell.JaroWinklerDistance

Returns the current value of the threshold used for adding the Winkler bonus.

getWordsIterator() - Method in interface org.apache.lucene.search.spell.Dictionary

Return all words present in the dictionary

getWordsIterator() - Method in class org.apache.lucene.search.spell.LuceneDictionary

 

getWordsIterator() - Method in class org.apache.lucene.search.spell.PlainTextDictionary

 

I

indexDictionary(Dictionary, int, int) - Method in class org.apache.lucene.search.spell.SpellChecker

Indexes the data from the given Dictionary.

indexDictionary(Dictionary) - Method in class org.apache.lucene.search.spell.SpellChecker

Indexes the data from the given Dictionary.

J

JaroWinklerDistance - Class in org.apache.lucene.search.spell

 

JaroWinklerDistance() - Constructor for class org.apache.lucene.search.spell.JaroWinklerDistance

 

L

LevensteinDistance - Class in org.apache.lucene.search.spell

Levenstein edit distance class.

LevensteinDistance() - Constructor for class org.apache.lucene.search.spell.LevensteinDistance

Optimized to run a bit faster than the static getDistance().

LuceneDictionary - Class in org.apache.lucene.search.spell

Lucene Dictionary: terms taken from the given field of a Lucene index.

LuceneDictionary(IndexReader, String) - Constructor for class org.apache.lucene.search.spell.LuceneDictionary

 

N

NGramDistance - Class in org.apache.lucene.search.spell

N-Gram version of edit distance based on paper by Grzegorz Kondrak, "N-gram similarity and distance".

NGramDistance(int) - Constructor for class org.apache.lucene.search.spell.NGramDistance

Creates an N-Gram distance measure using n-grams of the specified size.

NGramDistance() - Constructor for class org.apache.lucene.search.spell.NGramDistance

Creates an N-Gram distance measure using n-grams of size 2.

O

org.apache.lucene.search.spell - package org.apache.lucene.search.spell

Suggest alternate spellings for words.

P

PlainTextDictionary - Class in org.apache.lucene.search.spell

Dictionary represented by a text file.

PlainTextDictionary(File) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary

 

PlainTextDictionary(InputStream) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary

 

PlainTextDictionary(Reader) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary

Creates a dictionary based on a reader.

S

setAccuracy(float) - Method in class org.apache.lucene.search.spell.SpellChecker

Sets the accuracy 0 < minScore < 1; default 0.5

setSpellIndex(Directory) - Method in class org.apache.lucene.search.spell.SpellChecker

Use a different index as the spell checker index or re-open the existing index if spellIndex is the same value as given in the constructor.

setStringDistance(StringDistance) - Method in class org.apache.lucene.search.spell.SpellChecker

Sets the StringDistance implementation for this SpellChecker instance.

setThreshold(float) - Method in class org.apache.lucene.search.spell.JaroWinklerDistance

Sets the threshold used to determine when Winkler bonus should be used.

SpellChecker - Class in org.apache.lucene.search.spell

Spell Checker class (Main class)
(initially inspired by the David Spencer code).

SpellChecker(Directory, StringDistance) - Constructor for class org.apache.lucene.search.spell.SpellChecker

Use the given directory as a spell checker index.

SpellChecker(Directory) - Constructor for class org.apache.lucene.search.spell.SpellChecker

Use the given directory as a spell checker index with a LevensteinDistance as the default StringDistance.

StringDistance - Interface in org.apache.lucene.search.spell

Interface for string distances.

suggestSimilar(String, int) - Method in class org.apache.lucene.search.spell.SpellChecker

Suggest similar words.

suggestSimilar(String, int, IndexReader, String, boolean) - Method in class org.apache.lucene.search.spell.SpellChecker

Suggest similar words (optionally restricted to a field of an index).