Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.hunspell

Class GeneratingSuggester

java.lang.Object

org.apache.lucene.analysis.hunspell.GeneratingSuggester

class GeneratingSuggester
extends Object

A class that traverses the entire dictionary and applies affix rules to check if those yield correct suggestions similar enough to the given misspelled word

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	GeneratingSuggester.AffixProcessor
private static class	GeneratingSuggester.Weighted<T extends Comparable<T>>

Field Summary

Fields

Modifier and Type	Field	Description
private final Dictionary	dictionary
private final SuggestibleEntryCache	entryCache
private static final int	MAX_GUESSES
private static final int	MAX_ROOT_LENGTH_DIFF
private static final int	MAX_ROOTS
private static final int	MAX_WORDS
private final Hunspell	speller

Constructor Summary

Constructors

Constructor	Description
GeneratingSuggester(Hunspell speller, SuggestibleEntryCache entryCache)

Method Summary

Modifier and Type	Method	Description
private int	affixStripLength(int affixId)
private static int	anyMismatchNgram(int n, String s1, String s2, boolean weighted)
private static int	calcThreshold(String word)
private boolean	checkAffixCondition(int suffixId, char[] word, int offset, int length)
private static int	commonCharacterPositionScore(String s1, String s2)
(package private) static int	commonPrefix(CharSequence s1, CharSequence s2)
private List<String>	expandRoot(Root<String> root, String misspelled)
private List<GeneratingSuggester.Weighted<String>>	expandRoots(String misspelled, List<GeneratingSuggester.Weighted<Root<String>>> roots)
private List<GeneratingSuggester.Weighted<Root<String>>>	findSimilarDictionaryEntries(String word, WordCase originalCase)
private List<String>	getMostRelevantSuggestions(TreeSet<GeneratingSuggester.Weighted<String>> bySimilarity, Set<Suggestion> prevSuggestions)
private boolean	hasCompatibleFlags(Root<?> root, int affixId)
private static int	indexOfSubstring(String haystack, int haystackPos, String needle, int needlePos, int len)
private static boolean	isWorseThan(int score, CharsRef candidate, GeneratingSuggester.Weighted<Root<String>> root)
private static int	lcs(String s1, String s2)
private static int	longerWorsePenalty(int length1, int length2)
(package private) static int	ngramScore(int n, String s1, String s2, boolean weighted)
private void	processAffixes(boolean prefixes, String word, GeneratingSuggester.AffixProcessor processor)
private void	processAffixIds(int affixLength, IntsRef affixIds, GeneratingSuggester.AffixProcessor processor)
private void	processSuggestibleWords(int minLength, int maxLength, BiConsumer<CharsRef,Supplier<IntsRef>> processor)
private TreeSet<GeneratingSuggester.Weighted<String>>	rankBySimilarity(String word, List<GeneratingSuggester.Weighted<String>> expanded)
(package private) List<String>	suggest(String word, WordCase originalCase, Set<Suggestion> prevSuggestions)

Methods inherited from class java.lang.Object

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

Field Details

MAX_ROOTS

private static final int MAX_ROOTS

See Also:

• Constant Field Values

MAX_WORDS

private static final int MAX_WORDS

See Also:

• Constant Field Values

MAX_GUESSES

private static final int MAX_GUESSES

See Also:

• Constant Field Values

MAX_ROOT_LENGTH_DIFF

private static final int MAX_ROOT_LENGTH_DIFF

See Also:

• Constant Field Values

dictionary

private final Dictionary dictionary

speller

private final Hunspell speller

entryCache

private final SuggestibleEntryCache entryCache

Constructor Details

GeneratingSuggester

GeneratingSuggester(Hunspell speller,
 SuggestibleEntryCache entryCache)

Method Details

suggest

List<String> suggest(String word,
 WordCase originalCase,
 Set<Suggestion> prevSuggestions)

findSimilarDictionaryEntries

private List<GeneratingSuggester.Weighted<Root<String>>> findSimilarDictionaryEntries(String word,
 WordCase originalCase)

isWorseThan

private static boolean isWorseThan(int score,
 CharsRef candidate,
 GeneratingSuggester.Weighted<Root<String>> root)

processSuggestibleWords

private void processSuggestibleWords(int minLength,
 int maxLength,
 BiConsumer<CharsRef,Supplier<IntsRef>> processor)

expandRoots

private List<GeneratingSuggester.Weighted<String>> expandRoots(String misspelled,
 List<GeneratingSuggester.Weighted<Root<String>>> roots)

calcThreshold

private static int calcThreshold(String word)

expandRoot

private List<String> expandRoot(Root<String> root,
 String misspelled)

processAffixes

private void processAffixes(boolean prefixes,
 String word,
 GeneratingSuggester.AffixProcessor processor)

processAffixIds

private void processAffixIds(int affixLength,
 IntsRef affixIds,
 GeneratingSuggester.AffixProcessor processor)

hasCompatibleFlags

private boolean hasCompatibleFlags(Root<?> root,
 int affixId)

checkAffixCondition

private boolean checkAffixCondition(int suffixId,
 char[] word,
 int offset,
 int length)

affixStripLength

private int affixStripLength(int affixId)

rankBySimilarity

private TreeSet<GeneratingSuggester.Weighted<String>> rankBySimilarity(String word,
 List<GeneratingSuggester.Weighted<String>> expanded)

getMostRelevantSuggestions

private List<String> getMostRelevantSuggestions(TreeSet<GeneratingSuggester.Weighted<String>> bySimilarity,
 Set<Suggestion> prevSuggestions)

commonPrefix

static int commonPrefix(CharSequence s1,
 CharSequence s2)

ngramScore

static int ngramScore(int n,
 String s1,
 String s2,
 boolean weighted)

longerWorsePenalty

private static int longerWorsePenalty(int length1,
 int length2)

anyMismatchNgram

private static int anyMismatchNgram(int n,
 String s1,
 String s2,
 boolean weighted)

indexOfSubstring

private static int indexOfSubstring(String haystack,
 int haystackPos,
 String needle,
 int needlePos,
 int len)

lcs

private static int lcs(String s1,
 String s2)

commonCharacterPositionScore

private static int commonCharacterPositionScore(String s1,
 String s2)