- GB - Static variable in class org.apache.lucene.search.suggest.Sort
-
Convenience constant for gigabytes
- get(CharSequence) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
Returns the weight associated with an input string,
or null if it does not exist.
- get(BytesRef, int) - Method in class org.apache.lucene.search.suggest.BytesRefArray
-
- get(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
Returns the bucket (weight) as a Long for the provided key if it exists,
otherwise null if it does not.
- get(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
-
Returns the weight associated with an input string,
or null if it does not exist.
- get(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
-
Returns the value for the specified key, or null
if the key does not exist.
- get(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Retrieve the object indexed by a key.
- get(CharSequence) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
-
Returns the value for the specified key, or null
if the key does not exist.
- getAccuracy() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the minimal accuracy from the StringDistance for a match
- getAccuracy() - Method in class org.apache.lucene.search.spell.SpellChecker
-
- getAndIncrement(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Retrieve the Float indexed by key, increment it by one unit
and store the new Float.
- getBucket(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Returns the bucket assigned to a given key (if found) or -1 if
no exact match exists.
- getBucketCount() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Returns the bucket count (discretization thresholds).
- getComparator() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the current comparator in use.
- getComparator() - Method in class org.apache.lucene.search.spell.SpellChecker
-
Gets the comparator in use for ranking suggestions.
- getComparator() - Method in class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
-
- getComparator() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
-
- getComparator() - Method in interface org.apache.lucene.search.suggest.fst.BytesRefSorter
-
Comparator used to determine the sort order of entries.
- getComparator() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
-
- getComparator() - Method in class org.apache.lucene.search.suggest.InMemorySorter
-
- getComparator() - Method in class org.apache.lucene.search.suggest.Sort
-
Returns the comparator in use to sort entries
- getComparator() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
-
- getDistance() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the string distance metric in use.
- 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.LuceneLevenshteinDistance
-
- 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.
- getFST() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Returns the internal automaton.
- getFullPrefixPaths(List<FSTUtil.Path<PairOutputs.Pair<Long, BytesRef>>>, Automaton, FST<PairOutputs.Pair<Long, BytesRef>>) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
Returns all prefix paths to initialize the search.
- getFullPrefixPaths(List<FSTUtil.Path<PairOutputs.Pair<Long, BytesRef>>>, Automaton, FST<PairOutputs.Pair<Long, BytesRef>>) - Method in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
- getKey(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Returns the key that indexes the node argument.
- getLowerCaseTerms() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
true if the spellchecker should lowercase terms
- getMaxChanges() - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Returns the maximum number of changes to perform on the input
- getMaxCombineWordLength() - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Returns the maximum length of a combined suggestion
- getMaxEdits() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the maximum number of Levenshtein edit-distances to draw
candidate terms from.
- getMaxEvaluations() - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Returns the maximum number of word combinations to evaluate.
- getMaxInspections() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the maximum number of top-N inspections per suggestion
- getMaxQueryFrequency() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the maximum threshold of documents a query term can appear in order
to provide suggestions.
- getMinBreakWordLength() - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Returns the minimum size of a broken word
- getMinPrefix() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the minimal number of characters that must match exactly
- getMinQueryLength() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the minimum length of a query term needed to return suggestions
- getMinSuggestionFrequency() - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Returns the minimum frequency a term must have
to be part of a suggestion.
- getNode(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Returns the node indexed by key, or null if that node doesn't
exist.
- getNode(CharSequence, JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Returns the node indexed by key, or null if that node doesn't
exist.
- getOrCreateNode(CharSequence) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Returns the node indexed by key, creating that node if it doesn't exist,
and creating any required intermediate nodes if they don't exist.
- getResults() - Method in class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue
-
Returns the top N results in descending order.
- getStringDistance() - Method in class org.apache.lucene.search.spell.SpellChecker
-
- getThreshold() - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
-
Returns the current value of the threshold used for adding the Winkler bonus.
- getThresholdFrequency() - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Get the minimal threshold of documents a term must appear for a match
- 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.HighFrequencyDictionary
-
- getWordsIterator() - Method in class org.apache.lucene.search.spell.LuceneDictionary
-
- getWordsIterator() - Method in class org.apache.lucene.search.spell.PlainTextDictionary
-
- getWordsIterator() - Method in class org.apache.lucene.search.suggest.FileDictionary
-
- score - Variable in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
-
The similarity score.
- score - Variable in class org.apache.lucene.search.spell.SuggestWord
-
the score of the word
- SEPARATOR_TERM - Static variable in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Term that can be used to prohibit adjacent terms from being combined
- setAccuracy(float) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the minimal accuracy required (default: 0.5f) from a StringDistance
for a suggestion match.
- setAccuracy(float) - Method in class org.apache.lucene.search.spell.SpellChecker
-
- setComparator(Comparator<SuggestWord>) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the comparator for sorting suggestions.
- setComparator(Comparator<SuggestWord>) - Method in class org.apache.lucene.search.spell.SpellChecker
-
- setDistance(StringDistance) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the string distance metric.
- setLowerCaseTerms(boolean) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
True if the spellchecker should lowercase terms (default: true)
- setMatchAlmostDiff(int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Sets the number of characters by which words can differ from target word
when calling the matchAlmost method.
- setMaxChanges(int) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
The maximum numbers of changes (word breaks or combinations) to make on the
original term(s).
- setMaxCombineWordLength(int) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
The maximum length of a suggestion made by combining 1 or more original
terms.
- setMaxEdits(int) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Sets the maximum number of Levenshtein edit-distances to draw
candidate terms from.
- setMaxEvaluations(int) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
The maximum number of word combinations to evaluate.
- setMaxInspections(int) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the maximum number of top-N inspections (default: 5) per suggestion.
- setMaxQueryFrequency(float) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the maximum threshold (default: 0.01f) of documents a query term can
appear in order to provide suggestions.
- setMinBreakWordLength(int) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
The minimum length to break words down to.
- setMinPrefix(int) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Sets the minimal number of initial characters (default: 1)
that must match exactly.
- setMinQueryLength(int) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the minimum length of a query term (default: 4) needed to return suggestions.
- setMinSuggestionFrequency(int) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
The minimum frequency a term must have to be included as part of a
suggestion.
- setNumReturnValues(int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Sets the default maximum number of values returned from the
matchPrefix and matchAlmost methods.
- 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
-
- setThreshold(float) - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
-
Sets the threshold used to determine when Winkler bonus should be used.
- setThresholdFrequency(float) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Set the minimal threshold of documents a term must appear for a match.
- size() - Method in class org.apache.lucene.search.suggest.BytesRefArray
-
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
Returns byte size of the underlying FST.
- Sort - Class in org.apache.lucene.search.suggest
-
On-disk sorting of byte arrays.
- Sort() - Constructor for class org.apache.lucene.search.suggest.Sort
-
Defaults constructor.
- Sort(Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.Sort
-
Defaults constructor with a custom comparator.
- Sort(Comparator<BytesRef>, Sort.BufferSize, File, int) - Constructor for class org.apache.lucene.search.suggest.Sort
-
All-details constructor.
- sort(File, File) - Method in class org.apache.lucene.search.suggest.Sort
-
Sort input to output, explicit hint for the buffer size.
- Sort.BufferSize - Class in org.apache.lucene.search.suggest
-
A bit more descriptive unit for constructors.
- Sort.ByteSequencesReader - Class in org.apache.lucene.search.suggest
-
Utility class to read length-prefixed byte[] entries from an input.
- Sort.ByteSequencesReader(File) - Constructor for class org.apache.lucene.search.suggest.Sort.ByteSequencesReader
-
Constructs a ByteSequencesReader from the provided File
- Sort.ByteSequencesReader(DataInput) - Constructor for class org.apache.lucene.search.suggest.Sort.ByteSequencesReader
-
Constructs a ByteSequencesReader from the provided DataInput
- Sort.ByteSequencesWriter - Class in org.apache.lucene.search.suggest
-
Utility class to emit length-prefixed byte[] entries to an output stream for sorting.
- Sort.ByteSequencesWriter(File) - Constructor for class org.apache.lucene.search.suggest.Sort.ByteSequencesWriter
-
Constructs a ByteSequencesWriter to the provided File
- Sort.ByteSequencesWriter(DataOutput) - Constructor for class org.apache.lucene.search.suggest.Sort.ByteSequencesWriter
-
Constructs a ByteSequencesWriter to the provided DataOutput
- Sort.SortInfo - Class in org.apache.lucene.search.suggest
-
Sort info (debugging mostly).
- Sort.SortInfo() - Constructor for class org.apache.lucene.search.suggest.Sort.SortInfo
-
create a new SortInfo (with empty statistics) for debugging
- SortedTermFreqIteratorWrapper - Class in org.apache.lucene.search.suggest
-
This wrapper buffers incoming elements and makes sure they are sorted based on given comparator.
- SortedTermFreqIteratorWrapper(TermFreqIterator) - Constructor for class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
-
- SortedTermFreqIteratorWrapper(TermFreqIterator, Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
-
Creates a new sorted wrapper, sorting by BytesRef
(ascending) then cost (ascending).
- sortKeys(JaspellTernarySearchTrie.TSTNode, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Returns keys sorted in alphabetical order.
- sortPartition(int) - Method in class org.apache.lucene.search.suggest.Sort
-
Sort a single partition in-memory.
- sortTime - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
-
time spent sorting data (in milliseconds)
- 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
-
- SpellChecker(Directory, StringDistance, Comparator<SuggestWord>) - Constructor for class org.apache.lucene.search.spell.SpellChecker
-
Use the given directory as a spell checker index with the given
StringDistance measure
and the given
Comparator for sorting the results.
- splitchar - Variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
-
The char used in the split.
- state - Variable in class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path
-
Node in the automaton where path ends:
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
-
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
-
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.Lookup
-
Persist the constructed lookup data to a directory.
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
-
- string - Variable in class org.apache.lucene.search.spell.SuggestWord
-
the suggested word
- StringDistance - Interface in org.apache.lucene.search.spell
-
Interface for string distances.
- suggestion - Variable in class org.apache.lucene.search.spell.CombineSuggestion
-
The word combination suggestion
- SuggestMode - Enum in org.apache.lucene.search.spell
-
Set of strategies for suggesting related terms
- suggestSimilar(Term, int, IndexReader) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
- suggestSimilar(Term, int, IndexReader, SuggestMode) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
- suggestSimilar(Term, int, IndexReader, SuggestMode, float) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Suggest similar words.
- suggestSimilar(Term, int, IndexReader, int, int, float, CharsRef) - Method in class org.apache.lucene.search.spell.DirectSpellChecker
-
Provide spelling corrections based on several parameters.
- suggestSimilar(String, int) - Method in class org.apache.lucene.search.spell.SpellChecker
-
Suggest similar words.
- suggestSimilar(String, int, float) - Method in class org.apache.lucene.search.spell.SpellChecker
-
Suggest similar words.
- suggestSimilar(String, int, IndexReader, String, SuggestMode) - Method in class org.apache.lucene.search.spell.SpellChecker
-
- suggestSimilar(String, int, IndexReader, String, SuggestMode, float) - Method in class org.apache.lucene.search.spell.SpellChecker
-
Suggest similar words (optionally restricted to a field of an index).
- SuggestWord - Class in org.apache.lucene.search.spell
-
SuggestWord, used in suggestSimilar method in SpellChecker class.
- SuggestWord() - Constructor for class org.apache.lucene.search.spell.SuggestWord
-
Creates a new empty suggestion with null text.
- suggestWordBreaks(Term, int, IndexReader, SuggestMode, WordBreakSpellChecker.BreakSuggestionSortMethod) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Generate suggestions by breaking the passed-in term into multiple words.
- suggestWordCombinations(Term[], int, IndexReader, SuggestMode) - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker
-
Generate suggestions by combining one or more of the passed-in terms into
single words.
- SuggestWordFrequencyComparator - Class in org.apache.lucene.search.spell
-
Frequency first, then score.
- SuggestWordFrequencyComparator() - Constructor for class org.apache.lucene.search.spell.SuggestWordFrequencyComparator
-
- SuggestWordQueue - Class in org.apache.lucene.search.spell
-
Sorts SuggestWord instances
- SuggestWordQueue(int) - Constructor for class org.apache.lucene.search.spell.SuggestWordQueue
-
- SuggestWordQueue(int, Comparator<SuggestWord>) - Constructor for class org.apache.lucene.search.spell.SuggestWordQueue
-
Specify the size of the queue and the comparator to use for sorting.
- SuggestWordScoreComparator - Class in org.apache.lucene.search.spell
-
Score first, then frequency
- SuggestWordScoreComparator() - Constructor for class org.apache.lucene.search.spell.SuggestWordScoreComparator
-