- ABSOLUTE_MIN_SORT_BUFFER_SIZE - Static variable in class org.apache.lucene.search.suggest.Sort
-
Absolute minimum required buffer size for sorting.
- add(BytesRef) - Method in interface org.apache.lucene.search.suggest.fst.BytesRefSorter
-
Adds a single suggestion entry (possibly compound with its bucket).
- add(BytesRef) - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
-
- add(BytesRef, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
-
Appends a single suggestion and its weight to the internal buffers.
- add(BytesRef) - Method in class org.apache.lucene.search.suggest.InMemorySorter
-
- add(CharSequence, Object) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
-
Adds a new node if key already exists,
otherwise replaces its value.
- add(CharSequence, Object) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
-
Adds a new node if key already exists,
otherwise replaces its value.
- addNonMatch(StringBuilder, String) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Called while highlighting a single result, to append a
non-matching chunk of text from the suggestion to the
provided fragments list.
- addPrefixMatch(StringBuilder, String, String, String) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Called while highlighting a single result, to append a
matched prefix token, to the provided fragments list.
- addWholeMatch(StringBuilder, String, String) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Called while highlighting a single result, to append
the whole matched token to the provided fragments list.
- ALPHA - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
The constant used for backoff smoothing; during
lookup, this means that if a given trigram did not
occur, and we backoff to the bigram, the overall score
will be 0.4 times what the bigram model would have
assigned.
- AnalyzingInfixSuggester - Class in org.apache.lucene.search.suggest.analyzing
-
Analyzes the input text and then suggests matches based
on prefix matches to any tokens in the indexed text.
- AnalyzingInfixSuggester(Version, File, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Create a new instance, loading from a previously built
directory, if it exists.
- AnalyzingInfixSuggester(Version, File, Analyzer, Analyzer, int) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Create a new instance, loading from a previously built
directory, if it exists.
- AnalyzingSuggester - Class in org.apache.lucene.search.suggest.analyzing
-
Suggester that first analyzes the surface form, adds the
analyzed form to a weighted FST, and then does the same
thing at lookup time.
- AnalyzingSuggester(Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
- AnalyzingSuggester(Analyzer, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
- AnalyzingSuggester(Analyzer, Analyzer, int, int, int, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
Creates a new suggester.
- append(BytesRef) - Method in class org.apache.lucene.search.suggest.BytesRefArray
-
- automatic() - Static method in class org.apache.lucene.search.suggest.Sort.BufferSize
-
- data - Variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
-
The key to the node.
- decode(BytesRef, ByteArrayDataInput) - Method in class org.apache.lucene.search.suggest.SortedInputIterator
-
decodes the weight at the current position
- decode(BytesRef, ByteArrayDataInput) - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
-
decodes the weight at the current position
- decodePayload(BytesRef, ByteArrayDataInput) - Method in class org.apache.lucene.search.suggest.SortedInputIterator
-
decodes the payload at the current position
- DEFAULT_ACCURACY - Static variable in class org.apache.lucene.search.spell.SpellChecker
-
- DEFAULT_BUCKETS - Static variable in class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Default number of buckets.
- DEFAULT_BUCKETS - Static variable in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
-
Default number of buckets.
- DEFAULT_COMPARATOR - Static variable in class org.apache.lucene.search.spell.SuggestWordQueue
-
Default comparator: score then frequency.
- DEFAULT_COMPARATOR - Static variable in class org.apache.lucene.search.suggest.Sort
-
Default comparator: sorts in binary (codepoint) order
- DEFAULT_GRAMS - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
By default we use a bigram model.
- DEFAULT_MAX_EDITS - Static variable in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
The default maximum number of edits for fuzzy
suggestions.
- DEFAULT_MIN_FUZZY_LENGTH - Static variable in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
- DEFAULT_MIN_PREFIX_CHARS - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Default minimum number of leading characters before
PrefixQuery is used (4).
- DEFAULT_NON_FUZZY_PREFIX - Static variable in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
The default prefix length where edits are not allowed.
- DEFAULT_SEPARATOR - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
The default character used to join multiple tokens
into a single ngram token.
- DEFAULT_TRANSPOSITIONS - Static variable in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
- DEFAULT_UNICODE_AWARE - Static variable in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
Measure maxEdits, minFuzzyLength, transpositions and nonFuzzyPrefix
parameters in Unicode code points (actual letters)
instead of bytes.
- defaultTempDir() - Static method in class org.apache.lucene.search.suggest.Sort
-
Returns the default temporary directory.
- Dictionary - Interface in org.apache.lucene.search.spell
-
A simple interface representing a Dictionary.
- DirectSpellChecker - Class in org.apache.lucene.search.spell
-
Simple automaton-based spellchecker.
- DirectSpellChecker() - Constructor for class org.apache.lucene.search.spell.DirectSpellChecker
-
Creates a DirectSpellChecker with default configuration values
- DirectSpellChecker.ScoreTerm - Class in org.apache.lucene.search.spell
-
- DirectSpellChecker.ScoreTerm() - Constructor for class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
-
Constructor.
- docfreq - Variable in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
-
The df of the spellcheck correction.
- DocumentDictionary - Class in org.apache.lucene.search.suggest
-
Dictionary with terms, weights and optionally payload information
taken from stored fields in a Lucene index.
- DocumentDictionary(IndexReader, String, String) - Constructor for class org.apache.lucene.search.suggest.DocumentDictionary
-
Creates a new dictionary with the contents of the fields named field
for the terms and weightField for the weights that will be used for
the corresponding terms.
- DocumentDictionary(IndexReader, String, String, String) - Constructor for class org.apache.lucene.search.suggest.DocumentDictionary
-
Creates a new dictionary with the contents of the fields named field
for the terms, weightField for the weights that will be used for the
the corresponding terms and payloadField for the corresponding payloads
for the entry.
- DocumentDictionary.DocumentInputIterator - Class in org.apache.lucene.search.suggest
-
- DocumentDictionary.DocumentInputIterator(boolean) - Constructor for class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
-
Creates an iterator over term, weight and payload fields from the lucene
index.
- DocumentExpressionDictionary - Class in org.apache.lucene.search.suggest
-
Dictionary with terms and optionally payload information
taken from stored fields in a Lucene index.
- DocumentExpressionDictionary(IndexReader, String, String, Set<SortField>) - Constructor for class org.apache.lucene.search.suggest.DocumentExpressionDictionary
-
Creates a new dictionary with the contents of the fields named field
for the terms and computes the corresponding weights of the term by compiling the
user-defined weightExpression using the sortFields
bindings.
- DocumentExpressionDictionary(IndexReader, String, String, Set<SortField>, String) - Constructor for class org.apache.lucene.search.suggest.DocumentExpressionDictionary
-
Creates a new dictionary with the contents of the fields named field
for the terms, payloadField for the corresponding payloads
and computes the corresponding weights of the term by compiling the
user-defined weightExpression using the sortFields
bindings.
- F_WORD - Static variable in class org.apache.lucene.search.spell.SpellChecker
-
Field name for each word in the ngram index.
- FileDictionary - Class in org.apache.lucene.search.suggest
-
Dictionary represented by a text file.
- FileDictionary(InputStream) - Constructor for class org.apache.lucene.search.suggest.FileDictionary
-
Creates a dictionary based on an inputstream.
- FileDictionary(Reader) - Constructor for class org.apache.lucene.search.suggest.FileDictionary
-
Creates a dictionary based on a reader.
- finishQuery(BooleanQuery, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Subclass can override this to tweak the Query before
searching.
- FreeTextSuggester - Class in org.apache.lucene.search.suggest.analyzing
-
- FreeTextSuggester(Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
Instantiate, using the provided analyzer for both
indexing and lookup, using bigram model by default.
- FreeTextSuggester(Analyzer, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
Instantiate, using the provided indexing and lookup
analyzers, using bigram model by default.
- FreeTextSuggester(Analyzer, Analyzer, int) - Constructor for class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
Instantiate, using the provided indexing and lookup
analyzers, with the specified model (2
= bigram, 3 = trigram, etc.).
- FreeTextSuggester(Analyzer, Analyzer, int, byte) - Constructor for class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
Instantiate, using the provided indexing and lookup
analyzers, and specified model (2 = bigram, 3 =
trigram ,etc.).
- freq - Variable in class org.apache.lucene.search.spell.SuggestWord
-
The freq of the word
- freqs - Variable in class org.apache.lucene.search.suggest.BufferedInputIterator
-
- freqs - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
-
- FSTCompletion - Class in org.apache.lucene.search.suggest.fst
-
Finite state automata based implementation of "autocomplete" functionality.
- FSTCompletion(FST<Object>, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Constructs an FSTCompletion, specifying higherWeightsFirst and exactFirst.
- FSTCompletion(FST<Object>) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Defaults to higher weights first and exact first.
- FSTCompletion.Completion - Class in org.apache.lucene.search.suggest.fst
-
A single completion for a given key.
- FSTCompletionBuilder - Class in org.apache.lucene.search.suggest.fst
-
Finite state automata based implementation of "autocomplete" functionality.
- FSTCompletionBuilder() - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
-
- FSTCompletionBuilder(int, BytesRefSorter, int) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
-
Creates an FSTCompletion with the specified options.
- FSTCompletionLookup - Class in org.apache.lucene.search.suggest.fst
-
- FSTCompletionLookup() - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
- FSTCompletionLookup(int, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
- FSTCompletionLookup(FSTCompletion, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
This constructor takes a pre-built automaton.
- fstNode - Variable in class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path
-
Node in the FST where path ends:
- FSTUtil - Class in org.apache.lucene.search.suggest.analyzing
-
Exposes a utility method to enumerate all paths
intersecting an
Automaton with an
FST.
- FSTUtil.Path<T> - Class in org.apache.lucene.search.suggest.analyzing
-
Holds a pair (automaton, fst) of states and accumulated output in the intersected machine.
- FSTUtil.Path(State, FST.Arc<T>, T, IntsRef) - Constructor for class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path
-
Sole constructor.
- FuzzySuggester - Class in org.apache.lucene.search.suggest.analyzing
-
- FuzzySuggester(Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
- FuzzySuggester(Analyzer, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
Creates a
FuzzySuggester instance with an index & a query analyzer initialized with default values.
- FuzzySuggester(Analyzer, Analyzer, int, int, int, boolean, int, boolean, int, int, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
-
- 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(CharSequence) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
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.BufferedInputIterator
-
- getComparator() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
-
- getComparator() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
-
- 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.InputIterator.InputIteratorWrapper
-
- 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.SortedInputIterator
-
- getComparator() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
-
- getDirectory(File) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Subclass can override to choose a specific
Directory implementation.
- 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
-
- getIndexWriterConfig(Version, Analyzer) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Override this to customize index settings, e.g.
- getKey(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
-
Returns the key that indexes the node argument.
- getLastTokenQuery(String) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
This is called if the last token isn't ended
(e.g.
- 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
- getWeight(int) - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
-
Return the suggestion weight for this document
- 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.DocumentDictionary
-
- getWordsIterator() - Method in class org.apache.lucene.search.suggest.DocumentExpressionDictionary
-
- getWordsIterator() - Method in class org.apache.lucene.search.suggest.FileDictionary
-
- lessThan(SuggestWord, SuggestWord) - Method in class org.apache.lucene.search.spell.SuggestWordQueue
-
- lessThan(Lookup.LookupResult, Lookup.LookupResult) - Method in class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue
-
- 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().
- lines - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
-
number of lines of data read
- load(InputStream) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
- load(InputStream) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
- load(InputStream) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
- load(InputStream) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
- load(InputStream) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
-
- load(InputStream) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
-
- load(InputStream) - Method in class org.apache.lucene.search.suggest.Lookup
-
Discard current lookup data and load it from a previously saved copy.
- load(InputStream) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
-
- LOKID - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
-
Index values for accessing relatives array.
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
- lookup(CharSequence, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
Retrieve suggestions, specifying whether all terms
must match (allTermsRequired) and whether the hits
should be highlighted (doHighlight).
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
- lookup(CharSequence, int) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
Retrieve suggestions.
- lookup(CharSequence, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion
-
Lookup suggestions to key.
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
-
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
-
- Lookup - Class in org.apache.lucene.search.suggest
-
- Lookup() - Constructor for class org.apache.lucene.search.suggest.Lookup
-
Sole constructor.
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.Lookup
-
Look up a key and return possible completion for this key.
- lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
-
- Lookup.LookupPriorityQueue - Class in org.apache.lucene.search.suggest
-
- Lookup.LookupPriorityQueue(int) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue
-
Creates a new priority queue of the specified size.
- Lookup.LookupResult - Class in org.apache.lucene.search.suggest
-
Result of a lookup.
- Lookup.LookupResult(CharSequence, long) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult
-
Create a new result from a key+weight pair.
- Lookup.LookupResult(CharSequence, long, BytesRef) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult
-
Create a new result from a key+weight+payload triple.
- Lookup.LookupResult(CharSequence, Object, long, BytesRef) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult
-
Create a new result from a key+highlightKey+weight+payload triple.
- 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
-
Creates a new Dictionary, pulling source terms from
the specified field in the provided reader
- LuceneLevenshteinDistance - Class in org.apache.lucene.search.spell
-
Damerau-Levenshtein (optimal string alignment) implemented in a consistent
way as Lucene's FuzzyTermsEnum with the transpositions option enabled.
- LuceneLevenshteinDistance() - Constructor for class org.apache.lucene.search.spell.LuceneLevenshteinDistance
-
Creates a new comparator, mimicing the behavior of Lucene's internal
edit distance.
- 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
- searcher - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
-
- 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.AnalyzingInfixSuggester
-
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
Returns byte size of the underlying FST.
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
Returns byte size of the underlying FST.
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
-
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
-
Returns byte size of the underlying FST.
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
-
Returns byte size of the underlying TST.
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.Lookup
-
Get the size of the underlying lookup implementation in memory
- sizeInBytes() - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
-
Returns byte size of the underlying TST
- 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
- SortedInputIterator - Class in org.apache.lucene.search.suggest
-
This wrapper buffers incoming elements and makes sure they are sorted based on given comparator.
- SortedInputIterator(InputIterator) - Constructor for class org.apache.lucene.search.suggest.SortedInputIterator
-
- SortedInputIterator(InputIterator, Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.SortedInputIterator
-
Creates a new sorted wrapper, sorting by BytesRef
(ascending) then cost (ascending).
- 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.AnalyzingInfixSuggester
-
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
-
- store(OutputStream) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
-
- 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).
- SuggestStopFilter - Class in org.apache.lucene.search.suggest.analyzing
-
Like
StopFilter except it will not remove the
last token if that token was not followed by some token
separator.
- SuggestStopFilter(TokenStream, CharArraySet) - Constructor for class org.apache.lucene.search.suggest.analyzing.SuggestStopFilter
-
Sole constructor.
- 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
-