A B C D E F G H I J K L M N O P Q R S T U V W 

A

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
Appends a copy of the given BytesRef to this BytesRefArray.
automatic() - Static method in class org.apache.lucene.search.suggest.Sort.BufferSize
Approximately half of the currently available free heap, but no less than Sort.ABSOLUTE_MIN_SORT_BUFFER_SIZE.

B

balancedTree(Object[], Object[], int, int, TernaryTreeNode) - Method in class org.apache.lucene.search.suggest.tst.TSTAutocomplete
Inserting keys in TST in the order middle,small,big (lexicographic measure) recursively creates a balanced tree which reduces insertion and search times significantly.
boost - Variable in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
The boost representing the similarity from the FuzzyTermsEnum (internal similarity score)
bucket - Variable in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
source bucket (weight) of the suggestion
BufferedInputIterator - Class in org.apache.lucene.search.suggest
This wrapper buffers incoming elements.
BufferedInputIterator(InputIterator) - Constructor for class org.apache.lucene.search.suggest.BufferedInputIterator
Creates a new iterator, buffering entries from the specified iterator
BufferingTermFreqIteratorWrapper - Class in org.apache.lucene.search.suggest
This wrapper buffers incoming elements.
BufferingTermFreqIteratorWrapper(TermFreqIterator) - Constructor for class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
Creates a new iterator, buffering entries from the specified iterator
bufferSize - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
read buffer size (in bytes)
build(InputIterator) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
 
build(InputIterator) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
 
build(InputIterator) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
 
build(InputIterator, double) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
Build the suggest index, using up to the specified amount of temporary RAM while building.
build() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder
Builds the final automaton from a list of added entries.
build(InputIterator) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
 
build(InputIterator) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
 
build(InputIterator) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellLookup
 
build(Dictionary) - Method in class org.apache.lucene.search.suggest.Lookup
Build lookup from a dictionary.
build(InputIterator) - Method in class org.apache.lucene.search.suggest.Lookup
Builds up a new internal Lookup representation based on the given InputIterator.
build(InputIterator) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
 
BytesRefArray - Class in org.apache.lucene.search.suggest
A simple append only random-access BytesRef array that stores full copies of the appended bytes in a ByteBlockPool.
BytesRefArray(Counter) - Constructor for class org.apache.lucene.search.suggest.BytesRefArray
Creates a new BytesRefArray with a counter to track allocated bytes
BytesRefSorter - Interface in org.apache.lucene.search.suggest.fst
Collects BytesRef and then allows one to iterate over their sorted order.

C

CHARSEQUENCE_COMPARATOR - Static variable in class org.apache.lucene.search.suggest.Lookup
A simple char-by-char comparator for CharSequence
clear() - Method in class org.apache.lucene.search.suggest.BytesRefArray
Clears this BytesRefArray
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
close() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
 
close() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
Removes any written temporary files.
close() - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesReader
Closes the provided DataInput if it is Closeable.
close() - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesWriter
Closes the provided DataOutput if it is Closeable.
CODEC_NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
Codec name used in the header for the saved model.
CombineSuggestion - Class in org.apache.lucene.search.spell
A suggestion generated by combining one or more original query terms
CombineSuggestion(SuggestWord, int[]) - Constructor for class org.apache.lucene.search.spell.CombineSuggestion
Creates a new CombineSuggestion from a suggestion and an array of term ids (referencing the indexes to the original terms that form this combined suggestion)
compare(SuggestWord, SuggestWord) - Method in class org.apache.lucene.search.spell.SuggestWordFrequencyComparator
 
compare(SuggestWord, SuggestWord) - Method in class org.apache.lucene.search.spell.SuggestWordScoreComparator
 
compareTo(DirectSpellChecker.ScoreTerm) - Method in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
 
compareTo(FSTCompletion.Completion) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
 
compareTo(Lookup.LookupResult) - Method in class org.apache.lucene.search.suggest.Lookup.LookupResult
Compare alphabetically.
convertAutomaton(Automaton) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
Used by subclass to change the lookup automaton, if necessary.
convertAutomaton(Automaton) - Method in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
 
curPos - Variable in class org.apache.lucene.search.suggest.BufferedInputIterator
current buffer position
curPos - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
current buffer position

D

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
The default minimum score to use, if not specified by calling SpellChecker.setAccuracy(float) .
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
The default minimum length of the key passed to AnalyzingSuggester.lookup(java.lang.CharSequence, boolean, int) before any edits are allowed.
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
The default transposition value passed to LevenshteinAutomata
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
Holds a spelling correction for internal usage inside DirectSpellChecker.
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
Implements InputIterator from stored fields.
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.

E

encode(Sort.ByteSequencesWriter, ByteArrayDataOutput, byte[], BytesRef, BytesRef, long) - Method in class org.apache.lucene.search.suggest.SortedInputIterator
encodes an entry (bytes+(payload)+weight) to the provided writer
encode(Sort.ByteSequencesWriter, ByteArrayDataOutput, byte[], BytesRef, long) - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
encodes an entry (bytes+weight) to the provided writer
end() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilter
 
entries - Variable in class org.apache.lucene.search.suggest.BufferedInputIterator
buffered term entries
entries - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
buffered term entries
EQKID - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
Index values for accessing relatives array.
equals(Object) - Method in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
 
equals(Object) - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
 
equals(Object) - Method in class org.apache.lucene.search.spell.LevensteinDistance
 
equals(Object) - Method in class org.apache.lucene.search.spell.NGramDistance
 
EXACT_FIRST - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
Include this flag in the options parameter to AnalyzingSuggester.AnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean) to always return the exact match first, regardless of score.
exist(String) - Method in class org.apache.lucene.search.spell.SpellChecker
Check whether the word exists in the index.
ExternalRefSorter - Class in org.apache.lucene.search.suggest.fst
Builds and iterates over sequences stored on disk.
ExternalRefSorter(Sort) - Constructor for class org.apache.lucene.search.suggest.fst.ExternalRefSorter
Will buffer all sequences to a temporary file and then sort (all on-disk).

F

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
Builds an ngram model from the text sent to FreeTextSuggester.build(org.apache.lucene.search.suggest.InputIterator) and predicts based on the last grams-1 tokens in the request sent to FreeTextSuggester.lookup(java.lang.CharSequence, boolean, int).
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
buffered weights, parallel with BufferedInputIterator.entries
freqs - Variable in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
buffered weights, parallel with BufferingTermFreqIteratorWrapper.entries
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
Creates an FSTCompletion with default options: 10 buckets, exact match promoted to first position and InMemorySorter with a comparator obtained from BytesRef.getUTF8SortedAsUnicodeComparator().
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
An adapter from Lookup API to FSTCompletion.
FSTCompletionLookup() - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
This constructor prepares for creating a suggested FST using the FSTCompletionLookup.build(InputIterator) method.
FSTCompletionLookup(int, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
This constructor prepares for creating a suggested FST using the FSTCompletionLookup.build(InputIterator) method.
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
Implements a fuzzy AnalyzingSuggester.
FuzzySuggester(Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FuzzySuggester
Creates a FuzzySuggester instance initialized with default values.
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
Creates a FuzzySuggester instance.

G

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
Returns the n'th element of this 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
The accuracy (minimum score) to be used, unless overridden in SpellChecker.suggestSimilar(String, int, IndexReader, String, SuggestMode, float), to decide whether a suggestion is included or not.
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
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.
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
 

H

hashCode() - Method in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
 
hashCode() - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
 
hashCode() - Method in class org.apache.lucene.search.spell.LevensteinDistance
 
hashCode() - Method in class org.apache.lucene.search.spell.NGramDistance
 
hasPayloads() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
 
hasPayloads() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
 
hasPayloads() - Method in interface org.apache.lucene.search.suggest.InputIterator
Returns true if the iterator has payloads
hasPayloads() - Method in class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
 
hasPayloads() - Method in class org.apache.lucene.search.suggest.SortedInputIterator
 
HighFrequencyDictionary - Class in org.apache.lucene.search.spell
HighFrequencyDictionary: terms taken from the given field of a Lucene index, which appear in a number of documents above a given threshold.
HighFrequencyDictionary(IndexReader, String, float) - Constructor for class org.apache.lucene.search.spell.HighFrequencyDictionary
Creates a new Dictionary, pulling source terms from the specified field in the provided reader.
highlight(String, Set<String>, String) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
Override this method to customize the Object representing a single highlighted suggestions; the result is set on each Lookup.LookupResult.highlightKey member.
highlightKey - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult
Expert: custom Object to hold the result of a highlighted suggestion.
HIKID - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
Index values for accessing relatives array.

I

incrementToken() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilter
 
indexAnalyzer - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
Analyzer used at index time
indexDictionary(Dictionary, IndexWriterConfig, boolean) - Method in class org.apache.lucene.search.spell.SpellChecker
Indexes the data from the given Dictionary.
InMemorySorter - Class in org.apache.lucene.search.suggest
An BytesRefSorter that keeps all the entries in memory.
InMemorySorter(Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.InMemorySorter
Creates an InMemorySorter, sorting entries by the provided comparator.
input - Variable in class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path
Input of the path so far:
InputIterator - Interface in org.apache.lucene.search.suggest
Interface for enumerating term,weight,payload triples for suggester consumption; currently only AnalyzingSuggester, FuzzySuggester and AnalyzingInfixSuggester support payloads.
InputIterator.InputIteratorWrapper - Class in org.apache.lucene.search.suggest
Wraps a BytesRefIterator as a suggester InputIterator, with all weights set to 1 and carries no payload
InputIterator.InputIteratorWrapper(BytesRefIterator) - Constructor for class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
Creates a new wrapper, wrapping the specified iterator and specifying a weight value of 1 for all terms and nullifies associated payloads.
insert(TernaryTreeNode, CharSequence, Object, int) - Method in class org.apache.lucene.search.suggest.tst.TSTAutocomplete
Inserts a key in TST creating a series of Binary Search Trees at each node.
INTERNAL_LEVENSHTEIN - Static variable in class org.apache.lucene.search.spell.DirectSpellChecker
The default StringDistance, Damerau-Levenshtein distance implemented internally via LevenshteinAutomata.
intersectPrefixPaths(Automaton, FST<T>) - Static method in class org.apache.lucene.search.suggest.analyzing.FSTUtil
Enumerates all minimal prefix paths in the automaton that also intersect the FST, accumulating the FST end node and output for each path.
iterator() - Method in class org.apache.lucene.search.suggest.BytesRefArray
sugar for BytesRefArray.iterator(Comparator) with a null comparator
iterator(Comparator<BytesRef>) - Method in class org.apache.lucene.search.suggest.BytesRefArray
Returns a BytesRefIterator with point in time semantics.
iterator() - Method in interface org.apache.lucene.search.suggest.fst.BytesRefSorter
Sorts the entries added in BytesRefSorter.add(BytesRef) and returns an iterator over all sorted entries.
iterator() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter
 
iterator() - Method in class org.apache.lucene.search.suggest.InMemorySorter
 

J

JaroWinklerDistance - Class in org.apache.lucene.search.spell
Similarity measure for short strings such as person names.
JaroWinklerDistance() - Constructor for class org.apache.lucene.search.spell.JaroWinklerDistance
Creates a new distance metric with the default threshold for the Jaro Winkler bonus (0.7)
JaspellLookup - Class in org.apache.lucene.search.suggest.jaspell
Suggest implementation based on JaSpell.
JaspellLookup() - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellLookup
Creates a new empty trie
JaspellTernarySearchTrie - Class in org.apache.lucene.search.suggest.jaspell
Implementation of a Ternary Search Trie, a data structure for storing String objects that combines the compact size of a binary search tree with the speed of a digital search trie, and is therefore ideal for practical use in sorting and searching data.
JaspellTernarySearchTrie() - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Constructs an empty Ternary Search Trie.
JaspellTernarySearchTrie(Locale) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Constructs an empty Ternary Search Trie, specifying the Locale used for lowercasing.
JaspellTernarySearchTrie(File) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Constructs a Ternary Search Trie and loads data from a File into the Trie.
JaspellTernarySearchTrie(File, boolean) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Constructs a Ternary Search Trie and loads data from a File into the Trie.
JaspellTernarySearchTrie.TSTNode - Class in org.apache.lucene.search.suggest.jaspell
An inner class of Ternary Search Trie that represents a node in the trie.
JaspellTernarySearchTrie.TSTNode(char, JaspellTernarySearchTrie.TSTNode) - Constructor for class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
Constructor method.

K

key - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult
the key's text

L

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
Simple Lookup interface for CharSequence suggestions.
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
A PriorityQueue collecting a fixed size of high priority Lookup.LookupResult
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.

M

matchAlmost(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns a List of keys that almost match the argument key.
matchAlmost(CharSequence, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns a List of keys that almost match the argument key.
matchPrefix(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns an alphabetical List of all keys in the trie that begin with a given prefix.
matchPrefix(CharSequence, int) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns an alphabetical List of all keys in the trie that begin with a given prefix.
MAX_TEMPFILES - Static variable in class org.apache.lucene.search.suggest.Sort
Maximum number of temporary files before doing an intermediate merge.
MB - Static variable in class org.apache.lucene.search.suggest.Sort
Convenience constant for megabytes
megabytes(long) - Static method in class org.apache.lucene.search.suggest.Sort.BufferSize
Creates a Sort.BufferSize in MB.
mergeRounds - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
number of partition merges
mergeTime - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
time spent merging sorted partitions (in milliseconds)
MIN_BUFFER_SIZE_MB - Static variable in class org.apache.lucene.search.suggest.Sort
Minimum recommended buffer size for sorting.

N

next() - Method in class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
 
next() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
 
next() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
 
next() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
 
next() - Method in class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
 
next() - Method in class org.apache.lucene.search.suggest.SortedInputIterator
 
next() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
 
next() - Method in class org.apache.lucene.search.suggest.UnsortedInputIterator
 
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.
numDataNodes() - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns the number of nodes in the trie that have non-null data.
numDataNodes(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns the number of nodes in the subtrie below and including the starting node.
numNodes() - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns the total number of nodes in the trie.
numNodes(JaspellTernarySearchTrie.TSTNode) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Returns the total number of nodes in the subtrie below and including the starting Node.

O

org.apache.lucene.search.spell - package org.apache.lucene.search.spell
Suggest alternate spellings for words.
org.apache.lucene.search.suggest - package org.apache.lucene.search.suggest
Support for Autocomplete/Autosuggest
org.apache.lucene.search.suggest.analyzing - package org.apache.lucene.search.suggest.analyzing
Analyzer based autosuggest.
org.apache.lucene.search.suggest.fst - package org.apache.lucene.search.suggest.fst
Finite-state based autosuggest.
org.apache.lucene.search.suggest.jaspell - package org.apache.lucene.search.suggest.jaspell
JaSpell-based autosuggest.
org.apache.lucene.search.suggest.tst - package org.apache.lucene.search.suggest.tst
Ternary Search Tree based autosuggest.
originalTermIndexes - Variable in class org.apache.lucene.search.spell.CombineSuggestion
The indexes from the passed-in array of terms used to make this word combination

P

PARENT - Static variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
Index values for accessing relatives array.
payload() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
 
payload() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
 
payload() - Method in class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
 
payload() - Method in interface org.apache.lucene.search.suggest.InputIterator
An arbitrary byte[] to record per suggestion.
payload - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult
the key's payload (null if not present)
payload() - Method in class org.apache.lucene.search.suggest.SortedInputIterator
 
payload() - Method in class org.apache.lucene.search.suggest.UnsortedInputIterator
 
payloadField - Variable in class org.apache.lucene.search.suggest.DocumentDictionary
Field to read payload from
payloads - Variable in class org.apache.lucene.search.suggest.BufferedInputIterator
buffered payload entries
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
Creates a dictionary based on a File.
PlainTextDictionary(InputStream) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary
Creates a dictionary based on an inputstream.
PlainTextDictionary(Reader) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary
Creates a dictionary based on a reader.
prefixCompletion(TernaryTreeNode, CharSequence, int) - Method in class org.apache.lucene.search.suggest.tst.TSTAutocomplete
Auto-completes a given prefix query using Depth-First Search with the end of prefix as source node each time finding a new leaf to get a complete key to be added in the suggest list.
PRESERVE_SEP - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
Include this flag in the options parameter to AnalyzingSuggester.AnalyzingSuggester(Analyzer,Analyzer,int,int,int,boolean) to preserve token separators when matching.
put(CharSequence, Object) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Stores a value in the trie.

Q

queryAnalyzer - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
Analyzer used at search time

R

read(BytesRef) - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesReader
Reads the next entry into the provided BytesRef.
read() - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesReader
Reads the next entry and returns it if successful.
reader - Variable in class org.apache.lucene.search.suggest.DocumentDictionary
IndexReader to load documents from
readTime - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
time spent in i/o read (in milliseconds)
relatives - Variable in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie.TSTNode
The relative nodes.
remove(String) - Method in class org.apache.lucene.search.suggest.jaspell.JaspellTernarySearchTrie
Removes the value indexed by key.
reset() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilter
 

S

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
IndexSearcher used for lookups.
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
Sets the accuracy 0 < minScore < 1; default SpellChecker.DEFAULT_ACCURACY
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
Sets the Comparator for the SuggestWordQueue.
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
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.
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
Returns the current size of this 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
Creates a new sorted wrapper, using BytesRef.getUTF8SortedAsUnicodeComparator() for sorting.
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
Creates a new sorted wrapper, using BytesRef.getUTF8SortedAsUnicodeComparator() for sorting.
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
Use the given directory as a spell checker index with a LevensteinDistance as the default StringDistance.
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
Creates a new comparator that will compare by SuggestWord.freq, then by SuggestWord.score, then by SuggestWord.string.
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
Creates a new comparator that will compare by SuggestWord.score, then by SuggestWord.freq, then by SuggestWord.string.

T

tempMergeFiles - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
number of temporary files created when merging partitions
term - Variable in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
The actual spellcheck correction.
termAsString - Variable in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm
The spellcheck correction represented as string, can be null.
TermFreqIterator - Interface in org.apache.lucene.search.spell
Interface for enumerating term,weight pairs.
TermFreqIterator.TermFreqIteratorWrapper - Class in org.apache.lucene.search.spell
Wraps a BytesRefIterator as a TermFreqIterator, with all weights set to 1
TermFreqIterator.TermFreqIteratorWrapper(BytesRefIterator) - Constructor for class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
Creates a new wrapper, wrapping the specified iterator and specifying a weight value of 1 for all terms.
TernaryTreeNode - Class in org.apache.lucene.search.suggest.tst
The class creates a TST node.
TernaryTreeNode() - Constructor for class org.apache.lucene.search.suggest.tst.TernaryTreeNode
Creates a new empty node
TEXT_FIELD_NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
Field name used for the indexed text.
toString() - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
 
toString() - Method in class org.apache.lucene.search.spell.LevensteinDistance
 
toString() - Method in class org.apache.lucene.search.spell.NGramDistance
 
toString() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
 
toString() - Method in class org.apache.lucene.search.suggest.Lookup.LookupResult
 
toString() - Method in class org.apache.lucene.search.suggest.Sort.SortInfo
 
totalTime - Variable in class org.apache.lucene.search.suggest.Sort.SortInfo
total time spent (in milliseconds)
TSTAutocomplete - Class in org.apache.lucene.search.suggest.tst
Ternary Search Trie implementation.
TSTLookup - Class in org.apache.lucene.search.suggest.tst
Suggest implementation based on a Ternary Search Tree
TSTLookup() - Constructor for class org.apache.lucene.search.suggest.tst.TSTLookup
Creates a new TSTLookup with an empty Ternary Search Tree.

U

UnsortedInputIterator - Class in org.apache.lucene.search.suggest
This wrapper buffers the incoming elements and makes sure they are in random order.
UnsortedInputIterator(InputIterator) - Constructor for class org.apache.lucene.search.suggest.UnsortedInputIterator
Creates a new iterator, wrapping the specified iterator and returning elements in a random order.
utf8 - Variable in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
UTF-8 bytes of the suggestion

V

value - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult
the key's weight
valueOf(String) - Static method in enum org.apache.lucene.search.spell.SuggestMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.lucene.search.spell.SuggestMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod
Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_CURRENT - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
Current version of the the saved model file format.
VERSION_START - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
Initial version of the the saved model file format.

W

weight() - Method in class org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper
 
weight() - Method in interface org.apache.lucene.search.spell.TermFreqIterator
A term's weight, higher numbers mean better suggestions.
weight() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
 
weight() - Method in class org.apache.lucene.search.suggest.BufferingTermFreqIteratorWrapper
 
weight() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
 
weight() - Method in class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
 
weight() - Method in interface org.apache.lucene.search.suggest.InputIterator
A term's weight, higher numbers mean better suggestions.
weight() - Method in class org.apache.lucene.search.suggest.SortedInputIterator
 
weight() - Method in class org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper
 
weight() - Method in class org.apache.lucene.search.suggest.UnsortedInputIterator
 
WFSTCompletionLookup - Class in org.apache.lucene.search.suggest.fst
Suggester based on a weighted FST: it first traverses the prefix, then walks the n shortest paths to retrieve top-ranked suggestions.
WFSTCompletionLookup() - Constructor for class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
WFSTCompletionLookup(boolean) - Constructor for class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
Creates a new suggester.
WordBreakSpellChecker - Class in org.apache.lucene.search.spell
A spell checker whose sole function is to offer suggestions by combining multiple terms into one word and/or breaking terms into multiple words.
WordBreakSpellChecker() - Constructor for class org.apache.lucene.search.spell.WordBreakSpellChecker
Creates a new spellchecker with default configuration values
WordBreakSpellChecker.BreakSuggestionSortMethod - Enum in org.apache.lucene.search.spell
Determines the order to list word break suggestions
write(BytesRef) - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesWriter
Writes a BytesRef.
write(byte[]) - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesWriter
Writes a byte array.
write(byte[], int, int) - Method in class org.apache.lucene.search.suggest.Sort.ByteSequencesWriter
Writes a byte array.
A B C D E F G H I J K L M N O P Q R S T U V W 

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.