## Uses of Interface
org.apache.lucene.search.spell.StringDistance

- Packages that use StringDistance
  Package | Description
  --- | ---
  org.apache.lucene.search.spell | Suggest alternate spellings for words.

- - ### Uses of StringDistance in org.apache.lucene.search.spell

    Classes in org.apache.lucene.search.spell that implement StringDistance
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `JaroWinklerDistance` | Similarity measure for short strings such as person names.
    `class` | `LevenshteinDistance` | Levenshtein edit distance class.
    `class` | `LuceneLevenshteinDistance` | Damerau-Levenshtein (optimal string alignment) implemented in a consistent way as Lucene's FuzzyTermsEnum with the transpositions option enabled.
    `class` | `NGramDistance` | N-Gram version of edit distance based on paper by Grzegorz Kondrak, "N-gram similarity and distance".

    Fields in org.apache.lucene.search.spell declared as StringDistance
    Modifier and Type | Field | Description
    --- | --- | ---
    `static StringDistance` | DirectSpellChecker.`INTERNAL_LEVENSHTEIN` | The default StringDistance, Damerau-Levenshtein distance implemented internally via `LevenshteinAutomata`.

    Methods in org.apache.lucene.search.spell that return StringDistance
    Modifier and Type | Method | Description
    --- | --- | ---
    `StringDistance` | DirectSpellChecker.`getDistance()` | Get the string distance metric in use.
    `StringDistance` | SpellChecker.`getStringDistance()` | Returns the `StringDistance` instance used by this `SpellChecker` instance.

    Methods in org.apache.lucene.search.spell with parameters of type StringDistance
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DirectSpellChecker.`setDistance​(StringDistance distance)` | Set the string distance metric.
    `void` | SpellChecker.`setStringDistance​(StringDistance sd)` | Sets the `StringDistance` implementation for this `SpellChecker` instance.

    Constructors in org.apache.lucene.search.spell with parameters of type StringDistance
    Constructor | Description
    --- | ---
    `SpellChecker​(Directory spellIndex, StringDistance sd)` | Use the given directory as a spell checker index.
    `SpellChecker​(Directory spellIndex, StringDistance sd, Comparator<SuggestWord> comparator)` | Use the given directory as a spell checker index with the given `StringDistance` measure and the given `Comparator` for sorting the results.