Index (Lucene 10.0.0 suggest API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

accept(int, Bits) - Method in class org.apache.lucene.search.suggest.document.CompletionScorer: Returns true if a document with docID is accepted, false if the docID maps to a deleted document or has been filtered out
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.
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) - Method in class org.apache.lucene.search.suggest.InMemorySorter
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, Set<BytesRef>, long, BytesRef) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Adds a new suggestion.
addAllContexts() - Method in class org.apache.lucene.search.suggest.document.ContextQuery: Add all contexts with a boost of 1f
addContext(CharSequence) - Method in class org.apache.lucene.search.suggest.document.ContextQuery: Adds an exact context with default boost of 1
addContext(CharSequence, float) - Method in class org.apache.lucene.search.suggest.document.ContextQuery: Adds an exact context with boost
addContext(CharSequence, float, boolean) - Method in class org.apache.lucene.search.suggest.document.ContextQuery: Adds a context with boost, set exact to false if the context is a prefix of any indexed contexts
addContextToQuery(BooleanQuery.Builder, BytesRef, BooleanClause.Occur) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: This method is handy as we do not need access to internal fields such as CONTEXTS_FIELD_NAME in order to build queries However, here may not be its best location.
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.
analyzer - Variable in class org.apache.lucene.search.suggest.document.PrefixCompletionQuery: Used to analyze the term text
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(Directory, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Create a new instance, loading from a previously built AnalyzingInfixSuggester directory, if it exists.
AnalyzingInfixSuggester(Directory, Analyzer, Analyzer, int, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Create a new instance, loading from a previously built AnalyzingInfixSuggester directory, if it exists.
AnalyzingInfixSuggester(Directory, Analyzer, Analyzer, int, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Create a new instance, loading from a previously built AnalyzingInfixSuggester directory, if it exists.
AnalyzingInfixSuggester(Directory, Analyzer, Analyzer, int, boolean, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Create a new instance, loading from a previously built AnalyzingInfixSuggester 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(Directory, String, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester: Calls AnalyzingSuggester(analyzer, analyzer, EXACT_FIRST | PRESERVE_SEP, 256, -1, true)
AnalyzingSuggester(Directory, String, Analyzer, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester: Calls AnalyzingSuggester(indexAnalyzer, queryAnalyzer, EXACT_FIRST | PRESERVE_SEP, 256, -1, true)
AnalyzingSuggester(Directory, String, Analyzer, Analyzer, int, int, int, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester: Creates a new suggester.
AUTO - Enum constant in enum class org.apache.lucene.search.suggest.document.CompletionPostingsFormat.FSTLoadMode: Automatically make the decision if FSTs are read from disk depending if the segment read from an MMAPDirectory

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.
BitsProducer - Class in org.apache.lucene.search.suggest: A producer of Bits per segment.
BitsProducer() - Constructor for class org.apache.lucene.search.suggest.BitsProducer: Sole constructor, typically invoked by sub-classes.
BlendedInfixSuggester - Class in org.apache.lucene.search.suggest.analyzing: Extension of the AnalyzingInfixSuggester which transforms the weight after search to take into account the position of the searched term into the indexed text.
BlendedInfixSuggester(Directory, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester: Create a new instance, loading from a previously built directory, if it exists.
BlendedInfixSuggester(Directory, Analyzer, Analyzer, int, BlendedInfixSuggester.BlenderType, int, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester: Create a new instance, loading from a previously built directory, if it exists.
BlendedInfixSuggester(Directory, Analyzer, Analyzer, int, BlendedInfixSuggester.BlenderType, int, Double, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester: Create a new instance, loading from a previously built directory, if it exists.
BlendedInfixSuggester.BlenderType - Enum Class in org.apache.lucene.search.suggest.analyzing: The different types of blender.
boost - Variable in class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm: The boost representing the similarity from the FuzzyTermsEnum (internal similarity score)
boost() - Method in class org.apache.lucene.search.suggest.document.CompletionWeight: Returns the boost of the partial path set by CompletionWeight.setNextMatch(IntsRef)
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
build() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder: Builds the final automaton from a list of added entries.
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.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) - 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.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
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.
BytesRefSorter - Interface in org.apache.lucene.search.suggest.fst: Collects BytesRef and then allows one to iterate over their sorted order.

C

calculateCoefficient(int) - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester: Calculate the weight coefficient based on the position of the first matching word.
CHARSEQUENCE_COMPARATOR - Static variable in class org.apache.lucene.search.suggest.Lookup: A simple char-by-char comparator for CharSequence
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.ByteSequenceIterator
close() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter: Close the writer and remove any temporary files.
CODEC_NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: Codec name used in the header for the saved model.
collect(int) - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Ignored
collect(int, CharSequence, CharSequence, float) - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Called for every matched completion, similar to LeafCollector.collect(int) but for completions.
CombineSuggestion - Record Class in org.apache.lucene.search.spell: A suggestion generated by combining one or more original query terms
CombineSuggestion(SuggestWord, int[]) - Constructor for record class org.apache.lucene.search.spell.CombineSuggestion: Creates an instance of a CombineSuggestion record class.
commit() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Commits all pending changes made to this suggester to disk.
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(TopSuggestDocs.SuggestScoreDoc) - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc
compareTo(FSTCompletion.Completion) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion: Completions are equal when their FSTCompletion.Completion.utf8 images are equal (bucket is not compared).
compareTo(Lookup.LookupResult) - Method in class org.apache.lucene.search.suggest.Lookup.LookupResult: Compare alphabetically.
Completion50PostingsFormat - Class in org.apache.lucene.search.suggest.document: CompletionPostingsFormat for org.apache.lucene.backward_codecs.lucene50.Lucene50PostingsFormat.
Completion50PostingsFormat() - Constructor for class org.apache.lucene.search.suggest.document.Completion50PostingsFormat: Creates a Completion50PostingsFormat that will load the completion FST on-heap.
Completion50PostingsFormat(CompletionPostingsFormat.FSTLoadMode) - Constructor for class org.apache.lucene.search.suggest.document.Completion50PostingsFormat: Creates a Completion50PostingsFormat that will use the provided fstLoadMode to determine if the completion FST should be loaded on or off heap.
Completion84PostingsFormat - Class in org.apache.lucene.search.suggest.document: CompletionPostingsFormat for org.apache.lucene.backward_codecs.lucene84.Lucene84PostingsFormat.
Completion84PostingsFormat() - Constructor for class org.apache.lucene.search.suggest.document.Completion84PostingsFormat: Creates a Completion84PostingsFormat that will load the completion FST on-heap.
Completion84PostingsFormat(CompletionPostingsFormat.FSTLoadMode) - Constructor for class org.apache.lucene.search.suggest.document.Completion84PostingsFormat: Creates a Completion84PostingsFormat that will use the provided fstLoadMode to determine if the completion FST should be loaded on or off heap.
Completion90PostingsFormat - Class in org.apache.lucene.search.suggest.document: CompletionPostingsFormat for org.apache.lucene.backward_codecs.lucene90.Lucene90PostingsFormat.
Completion90PostingsFormat() - Constructor for class org.apache.lucene.search.suggest.document.Completion90PostingsFormat: Creates a Completion90PostingsFormat that will load the completion FST on-heap.
Completion90PostingsFormat(CompletionPostingsFormat.FSTLoadMode) - Constructor for class org.apache.lucene.search.suggest.document.Completion90PostingsFormat: Creates a Completion90PostingsFormat that will use the provided fstLoadMode to determine if the completion FST should be loaded on or off heap.
Completion912PostingsFormat - Class in org.apache.lucene.search.suggest.document: CompletionPostingsFormat for Lucene912PostingsFormat
Completion912PostingsFormat() - Constructor for class org.apache.lucene.search.suggest.document.Completion912PostingsFormat: Creates a Completion912PostingsFormat that will load the completion FST on-heap.
Completion912PostingsFormat(CompletionPostingsFormat.FSTLoadMode) - Constructor for class org.apache.lucene.search.suggest.document.Completion912PostingsFormat: Creates a Completion912PostingsFormat that will use the provided fstLoadMode to determine if the completion FST should be loaded on or off heap.
Completion99PostingsFormat - Class in org.apache.lucene.search.suggest.document: CompletionPostingsFormat for org.apache.lucene.backward_codecs.lucene99.Lucene99PostingsFormat.
Completion99PostingsFormat() - Constructor for class org.apache.lucene.search.suggest.document.Completion99PostingsFormat: Creates a Completion99PostingsFormat that will load the completion FST on-heap.
Completion99PostingsFormat(CompletionPostingsFormat.FSTLoadMode) - Constructor for class org.apache.lucene.search.suggest.document.Completion99PostingsFormat: Creates a Completion99PostingsFormat that will use the provided fstLoadMode to determine if the completion FST should be loaded on or off heap.
CompletionAnalyzer - Class in org.apache.lucene.search.suggest.document: Wraps an Analyzer to provide additional completion-only tuning (e.g.
CompletionAnalyzer(Analyzer) - Constructor for class org.apache.lucene.search.suggest.document.CompletionAnalyzer: Calls CompletionAnalyzer(org.apache.lucene.analysis.Analyzer, boolean, boolean, int) preserving token separation, position increments and no limit on graph expansions
CompletionAnalyzer(Analyzer, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.document.CompletionAnalyzer: Calls CompletionAnalyzer(org.apache.lucene.analysis.Analyzer, boolean, boolean, int) with no limit on graph expansions
CompletionAnalyzer(Analyzer, boolean, boolean, int) - Constructor for class org.apache.lucene.search.suggest.document.CompletionAnalyzer: Wraps an analyzer to convert its output token stream to an automaton
CompletionAnalyzer(Analyzer, int) - Constructor for class org.apache.lucene.search.suggest.document.CompletionAnalyzer: Calls CompletionAnalyzer(org.apache.lucene.analysis.Analyzer, boolean, boolean, int) preserving token separation and position increments
Completion Dictionary - Search tag in class org.apache.lucene.search.suggest.document.CompletionPostingsFormat: Section
Completion Index - Search tag in class org.apache.lucene.search.suggest.document.CompletionPostingsFormat: Section
CompletionPostingsFormat - Class in org.apache.lucene.search.suggest.document: A PostingsFormat which supports document suggestion based on indexed SuggestFields.
CompletionPostingsFormat(String) - Constructor for class org.apache.lucene.search.suggest.document.CompletionPostingsFormat: Used only by core Lucene at read-time via Service Provider instantiation
CompletionPostingsFormat(String, CompletionPostingsFormat.FSTLoadMode) - Constructor for class org.apache.lucene.search.suggest.document.CompletionPostingsFormat: Creates a CompletionPostingsFormat that will use the provided fstLoadMode to determine if the completion FST should be loaded on or off heap.
CompletionPostingsFormat.FSTLoadMode - Enum Class in org.apache.lucene.search.suggest.document: An enum that allows to control if suggester FSTs are loaded into memory or read off-heap
CompletionQuery - Class in org.apache.lucene.search.suggest.document: Abstract Query that match documents containing terms with a specified prefix filtered by BitsProducer.
CompletionQuery(Term, BitsProducer) - Constructor for class org.apache.lucene.search.suggest.document.CompletionQuery: Creates a base Completion query against a term with a filter to scope the documents
CompletionScorer - Class in org.apache.lucene.search.suggest.document: Expert: Responsible for executing the query against an appropriate suggester and collecting the results via a collector.
CompletionScorer(CompletionWeight, NRTSuggester, LeafReader, Bits, boolean, Automaton) - Constructor for class org.apache.lucene.search.suggest.document.CompletionScorer: Creates a scorer for a field-specific suggester scoped by acceptDocs
CompletionsTermsReader - Class in org.apache.lucene.search.suggest.document: Holder for suggester and field-level info for a suggest field
CompletionTerms - Class in org.apache.lucene.search.suggest.document: Wrapped Terms used by SuggestField and ContextSuggestField to access corresponding suggester and their attributes
CompletionTokenStream - Class in org.apache.lucene.search.suggest.document: A ConcatenateGraphFilter but we can set the payload and provide access to config options.
CompletionWeight - Class in org.apache.lucene.search.suggest.document: Expert: the Weight for CompletionQuery, used to score and explain these queries.
CompletionWeight(CompletionQuery, Automaton) - Constructor for class org.apache.lucene.search.suggest.document.CompletionWeight: Creates a weight for query with an automaton, using the reader for index stats
context - Variable in class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc: Context for the completion
context() - Method in class org.apache.lucene.search.suggest.document.CompletionWeight: Returns the context of the partial path set by CompletionWeight.setNextMatch(IntsRef)
CONTEXT_SEPARATOR - Static variable in class org.apache.lucene.search.suggest.document.ContextSuggestField: Separator used between context value and the suggest field value
ContextQuery - Class in org.apache.lucene.search.suggest.document: A CompletionQuery that matches documents specified by a wrapped CompletionQuery supporting boosting and/or filtering by specified contexts.
ContextQuery(CompletionQuery) - Constructor for class org.apache.lucene.search.suggest.document.ContextQuery: Constructs a context completion query that matches documents specified by query.
contexts - Variable in class org.apache.lucene.search.suggest.Lookup.LookupResult: the key's contexts (null if not present)
contexts() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
contexts() - Method in class org.apache.lucene.search.suggest.document.ContextSuggestField: Expert: Sub-classes can inject contexts at index-time
contexts() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
contexts() - Method in interface org.apache.lucene.search.suggest.InputIterator: A term's contexts context can be used to filter suggestions.
contexts() - Method in class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
contexts() - Method in class org.apache.lucene.search.suggest.SortedInputIterator
contexts() - Method in class org.apache.lucene.search.suggest.UnsortedInputIterator
CONTEXTS_FIELD_NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Field name used for the indexed context, as a StringField and a SortedSetDVField, for filtering.
contextSets - Variable in class org.apache.lucene.search.suggest.BufferedInputIterator: buffered context set entries
contextsField - Variable in class org.apache.lucene.search.suggest.DocumentDictionary: Field to read contexts from
ContextSuggestField - Class in org.apache.lucene.search.suggest.document: SuggestField which additionally takes in a set of contexts.
ContextSuggestField(String, String, int, CharSequence...) - Constructor for class org.apache.lucene.search.suggest.document.ContextSuggestField: Creates a context-enabled suggest field
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
cost() - Method in class org.apache.lucene.search.suggest.document.CompletionScorer
create(TokenStream) - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory
createResults(IndexSearcher, TopFieldDocs, int, CharSequence, boolean, Set<String>, String) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Create the results based on the search hits.
createResults(IndexSearcher, TopFieldDocs, int, CharSequence, boolean, Set<String>, String) - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.suggest.document.ContextQuery
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.suggest.document.PrefixCompletionQuery
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.search.suggest.document.RegexCompletionQuery
curPos - Variable in class org.apache.lucene.search.suggest.BufferedInputIterator: current buffer position
CUSTOM - Enum constant in enum class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester.BlenderType: Application dependent; override BlendedInfixSuggester.calculateCoefficient(int) to compute it.

D

decode(BytesRef, ByteArrayDataInput) - Method in class org.apache.lucene.search.suggest.SortedInputIterator: decodes the weight at the current position
decodeContexts(BytesRef, ByteArrayDataInput) - Method in class org.apache.lucene.search.suggest.SortedInputIterator: decodes the contexts 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_ALL_TERMS_REQUIRED - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Default boolean clause option for multiple terms matching (all terms required).
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_CLOSE_INDEXWRITER_ON_BUILD - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Default option to close the IndexWriter once the index has been built.
DEFAULT_COMPARATOR - Static variable in class org.apache.lucene.search.spell.SuggestWordQueue: Default comparator: score then frequency.
DEFAULT_FIELD_DELIMITER - Static variable in class org.apache.lucene.search.suggest.FileDictionary: Tab-delimited fields are most common thus the default, but one can override this via the constructor
DEFAULT_GRAMS - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: By default we use a bigram model.
DEFAULT_HIGHLIGHT - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Default higlighting option.
DEFAULT_MAX_EDITS - Static variable in class org.apache.lucene.search.suggest.analyzing.FuzzySuggester: The default maximum number of edits for fuzzy suggestions.
DEFAULT_MAX_EDITS - Static variable in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: 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, java.util.Set<org.apache.lucene.util.BytesRef>, boolean, int) before any edits are allowed.
DEFAULT_MIN_FUZZY_LENGTH - Static variable in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: The default minimum length of the key 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_NON_FUZZY_PREFIX - Static variable in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: The default prefix length where edits are not allowed.
DEFAULT_NUM_FACTOR - Static variable in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester: Default factor
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_TRANSPOSITIONS - Static variable in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: 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.
DEFAULT_UNICODE_AWARE - Static variable in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Measure maxEdits, minFuzzyLength, transpositions and nonFuzzyPrefix parameters in Unicode code points (actual letters) instead of bytes.
delegatePostingsFormat() - Method in class org.apache.lucene.search.suggest.document.Completion50PostingsFormat
delegatePostingsFormat() - Method in class org.apache.lucene.search.suggest.document.Completion84PostingsFormat
delegatePostingsFormat() - Method in class org.apache.lucene.search.suggest.document.Completion90PostingsFormat
delegatePostingsFormat() - Method in class org.apache.lucene.search.suggest.document.Completion912PostingsFormat
delegatePostingsFormat() - Method in class org.apache.lucene.search.suggest.document.Completion99PostingsFormat
delegatePostingsFormat() - Method in class org.apache.lucene.search.suggest.document.CompletionPostingsFormat: Concrete implementation should specify the delegating postings format
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.
docBase - Variable in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Document base offset for the current Leaf
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, payload (optional) and contexts (optional) information taken from stored/indexed 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 corresponding terms and payloadField for the corresponding payloads for the entry.
DocumentDictionary(IndexReader, String, 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 corresponding terms, payloadField for the corresponding payloads for the entry and contextsField for associated contexts.
DocumentDictionary.DocumentInputIterator - Class in org.apache.lucene.search.suggest: Implements InputIterator from stored fields.
DocumentInputIterator(boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator: Creates an iterator over term, weight and payload fields from the lucene index.
DocumentValueSourceDictionary - Class in org.apache.lucene.search.suggest: Dictionary with terms and optionally payload and optionally contexts information taken from stored fields in a Lucene index.
DocumentValueSourceDictionary(IndexReader, String, LongValuesSource) - Constructor for class org.apache.lucene.search.suggest.DocumentValueSourceDictionary: Creates a new dictionary with the contents of the fields named field for the terms and uses the weightsValueSource supplied to determine the score.
DocumentValueSourceDictionary(IndexReader, String, LongValuesSource, String) - Constructor for class org.apache.lucene.search.suggest.DocumentValueSourceDictionary: Creates a new dictionary with the contents of the fields named field for the terms, payloadField for the corresponding payloads and uses the weightsValueSource supplied to determine the score.
DocumentValueSourceDictionary(IndexReader, String, LongValuesSource, String, String) - Constructor for class org.apache.lucene.search.suggest.DocumentValueSourceDictionary: Creates a new dictionary with the contents of the fields named field for the terms, payload for the corresponding payloads, contexts for the associated contexts and uses the weightsValueSource supplied to determine the score.
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector
doSkipDuplicates() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Returns true if duplicates are filtered out

E

EMPTY - Static variable in class org.apache.lucene.search.suggest.document.TopSuggestDocs: Singleton for empty TopSuggestDocs
EMPTY - Static variable in interface org.apache.lucene.search.suggest.InputIterator: Singleton InputIterator that iterates over 0 BytesRefs.
encode(OfflineSorter.ByteSequencesWriter, ByteArrayDataOutput, byte[], BytesRef, BytesRef, Set<BytesRef>, long) - Method in class org.apache.lucene.search.suggest.SortedInputIterator: encodes an entry (bytes+(contexts)+(payload)+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
equals(Object) - Method in record class org.apache.lucene.search.spell.CombineSuggestion: Indicates whether some other object is "equal to" this one.
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.LevenshteinDistance
equals(Object) - Method in class org.apache.lucene.search.spell.LuceneLevenshteinDistance
equals(Object) - Method in class org.apache.lucene.search.spell.NGramDistance
equals(Object) - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.apache.lucene.search.suggest.document.ContextQuery
equals(Object) - Method in class org.apache.lucene.search.suggest.document.PrefixCompletionQuery
equals(Object) - Method in class org.apache.lucene.search.suggest.document.RegexCompletionQuery
equals(Object) - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc
EXACT_FIRST - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester: Include this flag in the options parameter to AnalyzingSuggester(Directory,String,Analyzer,Analyzer,int,int,int,boolean) to always return the exact match first, regardless of score.
EXACT_TEXT_FIELD_NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Field name used for the indexed text, as a StringField, for exact lookup.
exist(String) - Method in class org.apache.lucene.search.spell.SpellChecker: Check whether the word exists in the index.
explain(LeafReaderContext, int) - Method in class org.apache.lucene.search.suggest.document.CompletionWeight
ExternalRefSorter - Class in org.apache.lucene.search.suggest.fst: An implementation of a BytesRefSorter that allows appending BytesRefs to an OfflineSorter and returns a Closeable ExternalRefSorter.ByteSequenceIterator that iterates over sequences stored on disk.
ExternalRefSorter(OfflineSorter) - Constructor for class org.apache.lucene.search.suggest.fst.ExternalRefSorter: Will buffer all sequences to a temporary file and then sort (all on-disk).
ExternalRefSorter.ByteSequenceIterator - Class in org.apache.lucene.search.suggest.fst: Iterates over BytesRefs in a file, closes the reader when the iterator is exhausted.

F

F_WORD - Static variable in class org.apache.lucene.search.spell.SpellChecker: Field name for each word in the ngram index.
FIELD_TYPE - Static variable in class org.apache.lucene.search.suggest.document.SuggestField: Default field type for suggest field
fieldsConsumer(SegmentWriteState) - Method in class org.apache.lucene.search.suggest.document.CompletionPostingsFormat
fieldsProducer(SegmentReadState) - Method in class org.apache.lucene.search.suggest.document.CompletionPostingsFormat
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(InputStream, String) - 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.
FileDictionary(Reader, String) - Constructor for class org.apache.lucene.search.suggest.FileDictionary: Creates a dictionary based on a reader.
finish() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector
finishQuery(BooleanQuery.Builder, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Subclass can override this to tweak the Query before searching.
FORMAT_SNOWBALL - Static variable in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: multiple words may be specified on each line, trailing comments start with "|"
FORMAT_WORDSET - Static variable in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: the default format, one word per line, whole line comments start with "#"
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
FSTCompletion - Class in org.apache.lucene.search.suggest.fst: Finite state automata based implementation of "autocomplete" functionality.
FSTCompletion(FST<Object>) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletion: Defaults to higher weights first and exact first.
FSTCompletion(FST<Object>, boolean, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletion: Constructs an FSTCompletion, specifying higherWeightsFirst and exactFirst.
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 Comparator.naturalOrder().
FSTCompletionBuilder(int, BytesRefSorter, double) - 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 should only be used to read a previously saved suggester.
FSTCompletionLookup(Directory, String) - 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(Directory, String, 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(Directory, String, FSTCompletion, boolean) - Constructor for class org.apache.lucene.search.suggest.fst.FSTCompletionLookup: This constructor takes a pre-built automaton.
fstNode() - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Returns the value of the fstNode record component.
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> - Record Class in org.apache.lucene.search.suggest.analyzing: Holds a pair (automaton, fst) of states and accumulated output in the intersected machine.
FuzzyCompletionQuery - Class in org.apache.lucene.search.suggest.document: A CompletionQuery that match documents containing terms within an edit distance of the specified prefix.
FuzzyCompletionQuery(Analyzer, Term) - Constructor for class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Calls FuzzyCompletionQuery(Analyzer, Term, BitsProducer) with no filter
FuzzyCompletionQuery(Analyzer, Term, BitsProducer) - Constructor for class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Calls FuzzyCompletionQuery(Analyzer, Term, BitsProducer, int, boolean, int, int, boolean, int) with defaults for maxEdits, transpositions, nonFuzzyPrefix, minFuzzyLength, unicodeAware and determinizeWorkLimit See FuzzyCompletionQuery.DEFAULT_MAX_EDITS, FuzzyCompletionQuery.DEFAULT_TRANSPOSITIONS, FuzzyCompletionQuery.DEFAULT_NON_FUZZY_PREFIX, FuzzyCompletionQuery.DEFAULT_MIN_FUZZY_LENGTH, FuzzyCompletionQuery.DEFAULT_UNICODE_AWARE and Operations.DEFAULT_DETERMINIZE_WORK_LIMIT for defaults
FuzzyCompletionQuery(Analyzer, Term, BitsProducer, int, boolean, int, int, boolean, int) - Constructor for class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Constructs an analyzed fuzzy prefix completion query
FuzzySuggester - Class in org.apache.lucene.search.suggest.analyzing: Implements a fuzzy AnalyzingSuggester.
FuzzySuggester(Directory, String, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FuzzySuggester: Creates a FuzzySuggester instance initialized with default values.
FuzzySuggester(Directory, String, Analyzer, Analyzer) - Constructor for class org.apache.lucene.search.suggest.analyzing.FuzzySuggester: Creates a FuzzySuggester instance with an index and query analyzer initialized with default values.
FuzzySuggester(Directory, String, 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

get() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Returns at most num Top scoring TopSuggestDocss
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(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.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.
getAnalyzer() - Method in class org.apache.lucene.search.suggest.document.PrefixCompletionQuery: Gets the analyzer used to analyze the prefix.
getAutomaton() - Method in class org.apache.lucene.search.suggest.document.CompletionWeight: Returns the automaton specified by the CompletionQuery
getBits(LeafReaderContext) - Method in class org.apache.lucene.search.suggest.BitsProducer: Return Bits for the given leaf.
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).
getChildResources() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
getChildResources() - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
getChildResources() - Method in class org.apache.lucene.search.suggest.document.CompletionsTermsReader
getChildResources() - Method in class org.apache.lucene.search.suggest.document.NRTSuggester
getChildResources() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
getChildResources() - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
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 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
getCount() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
getCount() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
getCount() - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
getCount() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
getCount() - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
getCount() - Method in class org.apache.lucene.search.suggest.Lookup: Get the number of entries the lookup was built with
getCount() - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
getCountToCollect() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Returns the number of results to be collected
getDeterminizeWorkLimit() - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Get the maximum effort to use determinizing
getDeterminizeWorkLimit() - Method in class org.apache.lucene.search.suggest.document.RegexCompletionQuery: Get the maximum effort permitted to determinize the automaton
getDirectory(Path) - 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.LevenshteinDistance
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.
getEntryIterator() - Method in interface org.apache.lucene.search.spell.Dictionary: Returns an iterator over all the entries
getEntryIterator() - Method in class org.apache.lucene.search.spell.HighFrequencyDictionary
getEntryIterator() - Method in class org.apache.lucene.search.spell.LuceneDictionary
getEntryIterator() - Method in class org.apache.lucene.search.spell.PlainTextDictionary
getEntryIterator() - Method in class org.apache.lucene.search.suggest.DocumentDictionary
getEntryIterator() - Method in class org.apache.lucene.search.suggest.DocumentValueSourceDictionary
getEntryIterator() - Method in class org.apache.lucene.search.suggest.FileDictionary
getField() - Method in class org.apache.lucene.search.suggest.document.CompletionQuery: Returns the field name this query should be run against
getFilter() - Method in class org.apache.lucene.search.suggest.document.CompletionQuery: Returns a BitsProducer.
getFlags() - Method in class org.apache.lucene.search.suggest.document.RegexCompletionQuery: Get the regex flags
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(Analyzer, IndexWriterConfig.OpenMode) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Override this to customize index settings, e.g.
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.
getMaxEdits() - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Get the maximum edit distance for fuzzy matches
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.
getMaxQueryLength() - Method in class org.apache.lucene.search.spell.DirectSpellChecker: Get the maximum length of a query term to return suggestions
getMaxWeight() - Method in class org.apache.lucene.search.suggest.document.CompletionTerms: Returns the maximum weight of all entries in the weighted FST
getMinBreakWordLength() - Method in class org.apache.lucene.search.spell.WordBreakSpellChecker: Returns the minimum size of a broken word
getMinFuzzyLength() - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Get the minimum length of a term considered for matching
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.
getMinWeight() - Method in class org.apache.lucene.search.suggest.document.CompletionTerms: Returns the minimum weight of all entries in the weighted FST
getNonFuzzyPrefix() - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Get the length of a prefix where no edits are permitted
getResults() - Method in class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue: Returns the top N results in descending order.
getStopWords() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: Returns the configured stopword set
getStringDistance() - Method in class org.apache.lucene.search.spell.SpellChecker: Returns the StringDistance instance used by this SpellChecker instance.
getTerm() - Method in class org.apache.lucene.search.suggest.document.CompletionQuery: Returns the term to be queried against
getTextFieldType() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Subclass can override this method to change the field type of the text field e.g.
getTextFieldType() - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester
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
getType() - Method in class org.apache.lucene.search.suggest.document.CompletionTerms: Returns the type of FST, either SuggestField.TYPE or ContextSuggestField.TYPE
getWeight(Document, int) - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator: Returns the value of the weightField for the current document.
getWrappedAnalyzer(String) - Method in class org.apache.lucene.search.suggest.document.CompletionAnalyzer

H

hasContexts() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
hasContexts() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
hasContexts() - Method in interface org.apache.lucene.search.suggest.InputIterator: Returns true if the iterator has contexts
hasContexts() - Method in class org.apache.lucene.search.suggest.InputIterator.InputIteratorWrapper
hasContexts() - Method in class org.apache.lucene.search.suggest.SortedInputIterator
hashCode() - Method in record class org.apache.lucene.search.spell.CombineSuggestion: Returns a hash code value for this object.
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.LevenshteinDistance
hashCode() - Method in class org.apache.lucene.search.spell.LuceneLevenshteinDistance
hashCode() - Method in class org.apache.lucene.search.spell.NGramDistance
hashCode() - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.suggest.document.ContextQuery
hashCode() - Method in class org.apache.lucene.search.suggest.document.PrefixCompletionQuery
hashCode() - Method in class org.apache.lucene.search.suggest.document.RegexCompletionQuery
hashCode() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc
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.

I

Implementation details - Search tag in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder: Section
incrementToken() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilter
incrementToken() - Method in class org.apache.lucene.search.suggest.document.CompletionTokenStream
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.
inform(ResourceLoader) - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory
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.
innerQuery - Variable in class org.apache.lucene.search.suggest.document.ContextQuery: Inner completion query
input() - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Returns the value of the input record component.
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
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.
isCacheable(LeafReaderContext) - Method in class org.apache.lucene.search.suggest.document.CompletionWeight: This object can be cached
isIgnoreCase() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: Whether or not to ignore case
isTranspositions() - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Return whether transpositions count as a single edit
isUnicodeAware() - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery: Return true if lengths are measured in unicode code-points rather than bytes
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)

K

key - Variable in class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc: Matched completion key
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
LevenshteinDistance - Class in org.apache.lucene.search.spell: Levenshtein edit distance class.
LevenshteinDistance() - Constructor for class org.apache.lucene.search.spell.LevenshteinDistance: Optimized to run a bit faster than the static getDistance().
LINEAR_COEF - Static variable in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester: Coefficient used for linear blending
load(InputStream) - Method in class org.apache.lucene.search.suggest.Lookup: Calls Lookup.load(DataInput) after converting InputStream to DataInput
load(DataInput) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
load(DataInput) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
load(DataInput) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
load(DataInput) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
load(DataInput) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
load(DataInput) - Method in class org.apache.lucene.search.suggest.Lookup: Discard current lookup data and load it from a previously saved copy.
load(DataInput) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
load(IndexInput, CompletionPostingsFormat.FSTLoadMode) - Static method in class org.apache.lucene.search.suggest.document.NRTSuggester: Loads a NRTSuggester from IndexInput on or off-heap depending on the provided fstLoadMode
lookup(CharSequence) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion: Lookup suggestions to key and return a stream of matching completions.
lookup(CharSequence, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
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, int) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: Lookup, without any context.
lookup(CharSequence, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion: Lookup suggestions to key.
lookup(CharSequence, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Lookup, without any context.
lookup(CharSequence, Map<BytesRef, BooleanClause.Occur>, 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, Map<BytesRef, BooleanClause.Occur>, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.Lookup: Look up a key and return possible completion for this key.
lookup(CharSequence, Set<BytesRef>, boolean, int) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
lookup(CharSequence, Set<BytesRef>, int) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: Retrieve suggestions.
lookup(CharSequence, Set<BytesRef>, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Lookup, with context but without booleans.
lookup(CharSequence, Set<BytesRef>, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester
lookup(CharSequence, BooleanQuery, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: This is an advanced method providing the capability to send down to the suggester any arbitrary lucene query to be used to filter the result of the suggester
lookup(CharSequence, BooleanQuery, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester
lookup(CharSequence, BooleanQuery, int, boolean, boolean) - Method in class org.apache.lucene.search.suggest.Lookup: Look up a key and return possible completion for this key.
lookup(CompletionScorer, Bits, TopSuggestDocsCollector) - Method in class org.apache.lucene.search.suggest.document.NRTSuggester: Collects at most TopSuggestDocsCollector.getCountToCollect() completions that match the provided CompletionScorer.
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.LookupPriorityQueue - Class in org.apache.lucene.search.suggest: A PriorityQueue collecting a fixed size of high priority Lookup.LookupResult
Lookup.LookupResult - Class in org.apache.lucene.search.suggest: Result of a lookup.
LookupPriorityQueue(int) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupPriorityQueue: Creates a new priority queue of the specified size.
LookupResult(CharSequence, long) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult: Create a new result from a key+weight pair.
LookupResult(CharSequence, long, Set<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult: Create a new result from a key+weight+contexts triple.
LookupResult(CharSequence, long, BytesRef) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult: Create a new result from a key+weight+payload triple.
LookupResult(CharSequence, long, BytesRef, Set<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult: Create a new result from a key+weight+payload+contexts triple.
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.
LookupResult(CharSequence, Object, long, BytesRef, Set<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.Lookup.LookupResult: Create a new result from a key+highlightKey+weight+payload+contexts 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

maxWeight - Variable in class org.apache.lucene.search.suggest.document.CompletionsTermsReader: Maximum entry weight for the suggester
merge(int, TopSuggestDocs[]) - Static method in class org.apache.lucene.search.suggest.document.TopSuggestDocs: Returns a new TopSuggestDocs, containing topN results across the provided TopSuggestDocs, sorting by score.
minWeight - Variable in class org.apache.lucene.search.suggest.document.CompletionsTermsReader: Minimum entry weight for the suggester

N

NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: SPI name
next() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
next() - Method in class org.apache.lucene.search.suggest.DocumentDictionary.DocumentInputIterator
next() - Method in class org.apache.lucene.search.suggest.fst.ExternalRefSorter.ByteSequenceIterator
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.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() - Constructor for class org.apache.lucene.search.spell.NGramDistance: Creates an N-Gram distance measure using n-grams of size 2.
NGramDistance(int) - Constructor for class org.apache.lucene.search.spell.NGramDistance: Creates an N-Gram distance measure using n-grams of the specified size.
NRTSuggester - Class in org.apache.lucene.search.suggest.document: NRTSuggester executes Top N search on a weighted FST specified by a CompletionScorer
NUM_CHANGES_THEN_MAX_FREQUENCY - Enum constant in enum class org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod: Sort by Number of word breaks, then by the Maximum of all the component term's frequencies
NUM_CHANGES_THEN_SUMMED_FREQUENCY - Enum constant in enum class org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod: Sort by Number of word breaks, then by the Sum of all the component term's frequencies

O

OFF_HEAP - Enum constant in enum class org.apache.lucene.search.suggest.document.CompletionPostingsFormat.FSTLoadMode: Always read FSTs from disk.
ON_HEAP - Enum constant in enum class org.apache.lucene.search.suggest.document.CompletionPostingsFormat.FSTLoadMode: Never read FSTs from disk ie.
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.document - package org.apache.lucene.search.suggest.document: Support for document suggestion
org.apache.lucene.search.suggest.fst - package org.apache.lucene.search.suggest.fst: Finite-state based autosuggest.
org.apache.lucene.search.suggest.tst - package org.apache.lucene.search.suggest.tst: Ternary Search Tree based autosuggest.
originalTermIndexes() - Method in record class org.apache.lucene.search.spell.CombineSuggestion: Returns the value of the originalTermIndexes record component.
output() - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Returns the value of the output record component.

P

Path(int, FST.Arc<T>, T, IntsRefBuilder) - Constructor for record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Creates an instance of a Path record class.
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.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() - 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(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.
PlainTextDictionary(Path) - Constructor for class org.apache.lucene.search.spell.PlainTextDictionary: Creates a dictionary based on a Path.
POSITION_EXPONENTIAL_RECIPROCAL - Enum constant in enum class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester.BlenderType: weight/pow(1+position, exponent)
POSITION_LINEAR - Enum constant in enum class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester.BlenderType: weight*(1 - 0.10*position)
POSITION_RECIPROCAL - Enum constant in enum class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester.BlenderType: weight/(1+position)
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.
PrefixCompletionQuery - Class in org.apache.lucene.search.suggest.document: A CompletionQuery which takes an Analyzer to analyze the prefix of the query term.
PrefixCompletionQuery(Analyzer, Term) - Constructor for class org.apache.lucene.search.suggest.document.PrefixCompletionQuery: Calls PrefixCompletionQuery(Analyzer, Term, BitsProducer) with no filter
PrefixCompletionQuery(Analyzer, Term, BitsProducer) - Constructor for class org.apache.lucene.search.suggest.document.PrefixCompletionQuery: Constructs an analyzed prefix completion query
PRESERVE_SEP - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester: Include this flag in the options parameter to AnalyzingSuggester(Directory,String,Analyzer,Analyzer,int,int,int,boolean) to preserve token separators when matching.
preservePositionIncrements() - Method in class org.apache.lucene.search.suggest.document.CompletionAnalyzer: Returns true if position increments are preserved when converting the token stream to an automaton
preserveSep() - Method in class org.apache.lucene.search.suggest.document.CompletionAnalyzer: Returns true if separation between tokens are preserved when converting the token stream to an automaton

Q

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

R

ramBytesUsed() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester: Returns byte size of the underlying FST.
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: Returns byte size of the underlying FST.
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.document.CompletionsTermsReader
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.document.ContextQuery
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.document.NRTSuggester
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup: Returns byte size of the underlying FST.
ramBytesUsed() - Method in class org.apache.lucene.search.suggest.tst.TSTLookup: Returns byte size of the underlying TST
reader - Variable in class org.apache.lucene.search.suggest.DocumentDictionary: IndexReader to load documents from
refresh() - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Reopens the underlying searcher; it's best to "batch up" many additions/updates, and then call refresh once in the end.
RegexCompletionQuery - Class in org.apache.lucene.search.suggest.document: A CompletionQuery which takes a regular expression as the prefix of the query term.
RegexCompletionQuery(Term) - Constructor for class org.apache.lucene.search.suggest.document.RegexCompletionQuery: Calls RegexCompletionQuery(Term, BitsProducer) with no filter
RegexCompletionQuery(Term, int, int) - Constructor for class org.apache.lucene.search.suggest.document.RegexCompletionQuery: Calls RegexCompletionQuery(Term, int, int, BitsProducer) with no filter
RegexCompletionQuery(Term, int, int, BitsProducer) - Constructor for class org.apache.lucene.search.suggest.document.RegexCompletionQuery: Constructs a regular expression completion query
RegexCompletionQuery(Term, BitsProducer) - Constructor for class org.apache.lucene.search.suggest.document.RegexCompletionQuery: Calls RegexCompletionQuery(Term, int, int, BitsProducer) enabling all optional regex syntax and determinizeWorkLimit of 10000
reset() - Method in class org.apache.lucene.search.suggest.analyzing.SuggestStopFilter
rewrite(IndexSearcher) - Method in class org.apache.lucene.search.suggest.document.CompletionQuery
Runtime behavior and performance characteristic - Search tag in class org.apache.lucene.search.suggest.fst.FSTCompletionBuilder: Section

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
score(float, float) - Method in class org.apache.lucene.search.suggest.document.CompletionScorer: Returns the score for a matched completion based on the query time boost and the index time weight.
score(LeafCollector, Bits, int, int) - Method in class org.apache.lucene.search.suggest.document.CompletionScorer
scoreLookupDocs() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocs: Returns TopSuggestDocs.SuggestScoreDocs for this instance
scoreMode() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Ignored
scorerSupplier(LeafReaderContext) - Method in class org.apache.lucene.search.suggest.document.CompletionWeight
ScoreTerm() - Constructor for class org.apache.lucene.search.spell.DirectSpellChecker.ScoreTerm: Constructor.
searcherMgr - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: IndexSearcher used for lookups.
searcherMgrLock - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Used to manage concurrent access to searcherMgr
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)
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.
setMaxQueryLength(int) - Method in class org.apache.lucene.search.spell.DirectSpellChecker: Set the maximum length of a query term to return 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.
setNextMatch(IntsRef) - Method in class org.apache.lucene.search.suggest.document.CompletionWeight: Set for every partial path in the index that matched the query automaton.
setPayload(BytesRef) - Method in class org.apache.lucene.search.suggest.document.CompletionTokenStream: Sets a payload available throughout successive token stream enumeration
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.
SortedInputIterator - Class in org.apache.lucene.search.suggest: This wrapper buffers incoming elements and makes sure they are sorted based on given comparator.
SortedInputIterator(Directory, String, InputIterator) - Constructor for class org.apache.lucene.search.suggest.SortedInputIterator: Creates a new sorted wrapper, using natural order for sorting.
SortedInputIterator(Directory, String, InputIterator, Comparator<BytesRef>) - Constructor for class org.apache.lucene.search.suggest.SortedInputIterator: Creates a new sorted wrapper, sorting by BytesRef (ascending) then cost (ascending).
SpellChecker - Class in org.apache.lucene.search.spell: Spell Checker class (Main class).
(initially inspired by the David Spencer code).
SpellChecker(Directory) - Constructor for class org.apache.lucene.search.spell.SpellChecker: Use the given directory as a spell checker index with a LevenshteinDistance as the default StringDistance.
SpellChecker(Directory, StringDistance) - Constructor for class org.apache.lucene.search.spell.SpellChecker: Use the given directory as a spell checker index.
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.
state() - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Returns the value of the state record component.
store(OutputStream) - Method in class org.apache.lucene.search.suggest.Lookup: Calls Lookup.store(DataOutput) after converting OutputStream to DataOutput
store(DataOutput) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester
store(DataOutput) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingSuggester
store(DataOutput) - Method in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester
store(DataOutput) - Method in class org.apache.lucene.search.suggest.fst.FSTCompletionLookup
store(DataOutput) - Method in class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
store(DataOutput) - Method in class org.apache.lucene.search.suggest.Lookup: Persist the constructed lookup data to a directory.
store(DataOutput) - Method in class org.apache.lucene.search.suggest.tst.TSTLookup
storedFields - Variable in class org.apache.lucene.search.suggest.DocumentDictionary: StoredFields for this reader
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.
suggest(CompletionQuery, int, boolean) - Method in class org.apache.lucene.search.suggest.document.SuggestIndexSearcher: Returns top n completion hits for query
suggest(CompletionQuery, TopSuggestDocsCollector) - Method in class org.apache.lucene.search.suggest.document.SuggestIndexSearcher: Lower-level suggest API.
SUGGEST_ALWAYS - Enum constant in enum class org.apache.lucene.search.spell.SuggestMode: Always attempt to offer suggestions (however, other parameters may limit suggestions.
SUGGEST_MORE_POPULAR - Enum constant in enum class org.apache.lucene.search.spell.SuggestMode: Return only suggested words that are as frequent or more frequent than the searched word
SUGGEST_WHEN_NOT_IN_INDEX - Enum constant in enum class org.apache.lucene.search.spell.SuggestMode: Generate suggestions only for terms not in the index (default)
suggester() - Method in class org.apache.lucene.search.suggest.document.CompletionsTermsReader: Returns the suggester for a field, if not loaded already, loads the appropriate suggester from CompletionDictionary
suggester() - Method in class org.apache.lucene.search.suggest.document.CompletionTerms: Returns a NRTSuggester for the field or null if no FST was indexed for this field
SuggestField - Class in org.apache.lucene.search.suggest.document: Field that indexes a string value and a weight as a weighted completion against a named suggester.
SuggestField(String, String, int) - Constructor for class org.apache.lucene.search.suggest.document.SuggestField: Creates a SuggestField
SuggestIndexSearcher - Class in org.apache.lucene.search.suggest.document: Adds document suggest capabilities to IndexSearcher.
SuggestIndexSearcher(IndexReader) - Constructor for class org.apache.lucene.search.suggest.document.SuggestIndexSearcher: Creates a searcher with document suggest capabilities for reader.
suggestion() - Method in record class org.apache.lucene.search.spell.CombineSuggestion: Returns the value of the suggestion record component.
SuggestMode - Enum Class in org.apache.lucene.search.spell: Set of strategies for suggesting related terms
SuggestScoreDoc(int, CharSequence, CharSequence, float) - Constructor for class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc: Creates a SuggestScoreDoc instance
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: Calls suggestSimilar(word, numSug, ir, suggestMode, field, this.accuracy)
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).
suggestSimilar(Term, int, IndexReader) - Method in class org.apache.lucene.search.spell.DirectSpellChecker: Calls suggestSimilar(term, numSug, ir, SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX)
suggestSimilar(Term, int, IndexReader, int, int, float, CharsRefBuilder) - Method in class org.apache.lucene.search.spell.DirectSpellChecker: Provide spelling corrections based on several parameters.
suggestSimilar(Term, int, IndexReader, SuggestMode) - Method in class org.apache.lucene.search.spell.DirectSpellChecker: Calls suggestSimilar(term, numSug, ir, suggestMode, this.accuracy)
suggestSimilar(Term, int, IndexReader, SuggestMode, float) - Method in class org.apache.lucene.search.spell.DirectSpellChecker: Suggest similar words.
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.
SuggestStopFilterFactory - Class in org.apache.lucene.search.suggest.analyzing: Factory for SuggestStopFilter.
SuggestStopFilterFactory() - Constructor for class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: Default ctor for compatibility with SPI
SuggestStopFilterFactory(Map<String, String>) - Constructor for class org.apache.lucene.search.suggest.analyzing.SuggestStopFilterFactory: Creates a new StopFilterFactory
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: Use the SuggestWordQueue.DEFAULT_COMPARATOR
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

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.
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.
TEXTGRAMS_FIELD_NAME - Static variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: edgegrams for searching short prefixes without Prefix Query that's controlled by AnalyzingInfixSuggester.minPrefixChars
toAutomaton() - Method in class org.apache.lucene.search.suggest.document.CompletionTokenStream: Delegates to...At
toAutomaton(boolean) - Method in class org.apache.lucene.search.suggest.document.CompletionTokenStream: Delegates to...
tokenStream(Analyzer, TokenStream) - Method in class org.apache.lucene.search.suggest.document.SuggestField
TopSuggestDocs - Class in org.apache.lucene.search.suggest.document: TopDocs wrapper with an additional CharSequence key per ScoreDoc
TopSuggestDocs(TotalHits, TopSuggestDocs.SuggestScoreDoc[]) - Constructor for class org.apache.lucene.search.suggest.document.TopSuggestDocs: TopDocs wrapper with TopSuggestDocs.SuggestScoreDoc instead of ScoreDoc
TopSuggestDocs.SuggestScoreDoc - Class in org.apache.lucene.search.suggest.document: ScoreDoc with an additional CharSequence key
TopSuggestDocsCollector - Class in org.apache.lucene.search.suggest.document: Collector that collects completion and score, along with document id
TopSuggestDocsCollector(int, boolean) - Constructor for class org.apache.lucene.search.suggest.document.TopSuggestDocsCollector: Sole constructor
toString() - Method in record class org.apache.lucene.search.spell.CombineSuggestion: Returns a string representation of this record class.
toString() - Method in class org.apache.lucene.search.spell.JaroWinklerDistance
toString() - Method in class org.apache.lucene.search.spell.LevenshteinDistance
toString() - Method in class org.apache.lucene.search.spell.NGramDistance
toString() - Method in class org.apache.lucene.search.spell.SuggestWord
toString() - Method in record class org.apache.lucene.search.suggest.analyzing.FSTUtil.Path: Returns a string representation of this record class.
toString() - Method in class org.apache.lucene.search.suggest.document.TopSuggestDocs.SuggestScoreDoc
toString() - Method in class org.apache.lucene.search.suggest.fst.FSTCompletion.Completion
toString() - Method in class org.apache.lucene.search.suggest.Lookup.LookupResult
toString(String) - Method in class org.apache.lucene.search.suggest.document.CompletionQuery
toString(String) - Method in class org.apache.lucene.search.suggest.document.ContextQuery
toString(String) - Method in class org.apache.lucene.search.suggest.document.FuzzyCompletionQuery
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.
TSTLookup(Directory, String) - Constructor for class org.apache.lucene.search.suggest.tst.TSTLookup: Creates a new TSTLookup, for building.
type - Variable in class org.apache.lucene.search.suggest.document.CompletionsTermsReader: type of suggester (context-enabled or not)
type() - Method in class org.apache.lucene.search.suggest.document.ContextSuggestField
type() - Method in class org.apache.lucene.search.suggest.document.SuggestField: Returns a byte to denote the type of the field

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.
update(BytesRef, Set<BytesRef>, long, BytesRef) - Method in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Updates a previous suggestion, matching the exact same text as before.
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 class org.apache.lucene.search.spell.SuggestMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester.BlenderType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.lucene.search.suggest.document.CompletionPostingsFormat.FSTLoadMode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.lucene.search.spell.SuggestMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.lucene.search.suggest.analyzing.BlendedInfixSuggester.BlenderType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.lucene.search.suggest.document.CompletionPostingsFormat.FSTLoadMode: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION_CURRENT - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: Current version of the saved model file format.
VERSION_START - Static variable in class org.apache.lucene.search.suggest.analyzing.FreeTextSuggester: Initial version of the saved model file format.
visit(QueryVisitor) - Method in class org.apache.lucene.search.suggest.document.ContextQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.suggest.document.PrefixCompletionQuery
visit(QueryVisitor) - Method in class org.apache.lucene.search.suggest.document.RegexCompletionQuery

W

weight - Variable in class org.apache.lucene.search.suggest.document.CompletionScorer: weight that created this scorer
weight() - Method in class org.apache.lucene.search.suggest.BufferedInputIterator
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.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(Directory, String) - Constructor for class org.apache.lucene.search.suggest.fst.WFSTCompletionLookup: Calls WFSTCompletionLookup(null,null,true)
WFSTCompletionLookup(Directory, String, 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 Class in org.apache.lucene.search.spell: Determines the order to list word break suggestions
wrapComponents(String, Analyzer.TokenStreamComponents) - Method in class org.apache.lucene.search.suggest.document.CompletionAnalyzer
wrapTokenStream(TokenStream) - Method in class org.apache.lucene.search.suggest.document.ContextSuggestField
wrapTokenStream(TokenStream) - Method in class org.apache.lucene.search.suggest.document.SuggestField: Wraps a stream with a CompletionTokenStream.
writer - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Used for ongoing NRT additions/updates.
writerLock - Variable in class org.apache.lucene.search.suggest.analyzing.AnalyzingInfixSuggester: Used to manage concurrent access to writer

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values