Package org.apache.lucene.search.suggest.document

Support for document suggestion

Class Summary

Class	Description
Completion50PostingsFormat	CompletionPostingsFormat for org.apache.lucene.codecs.lucene50.Lucene50PostingsFormat.
Completion84PostingsFormat	CompletionPostingsFormat for Lucene84PostingsFormat
CompletionAnalyzer	Wraps an Analyzer to provide additional completion-only tuning (e.g.
CompletionFieldsConsumer	Weighted FSTs for any indexed SuggestField is built on CompletionFieldsConsumer.write(Fields,NormsProducer).
CompletionFieldsConsumer.CompletionMetaData
CompletionFieldsConsumer.CompletionTermWriter
CompletionFieldsProducer	Completion index (.cmp) is opened and read at instantiation to read in SuggestField numbers and their FST offsets in the Completion dictionary (.lkp).
CompletionPostingsFormat	A PostingsFormat which supports document suggestion based on indexed SuggestFields.
CompletionQuery	Abstract Query that match documents containing terms with a specified prefix filtered by BitsProducer.
CompletionScorer	Expert: Responsible for executing the query against an appropriate suggester and collecting the results via a collector.
CompletionsTermsReader	Holder for suggester and field-level info for a suggest field
CompletionTerms	Wrapped Terms used by SuggestField and ContextSuggestField to access corresponding suggester and their attributes
CompletionTokenStream	A ConcatenateGraphFilter but we can set the payload and provide access to config options.
CompletionWeight	Expert: the Weight for CompletionQuery, used to score and explain these queries.
ContextQuery	A CompletionQuery that matches documents specified by a wrapped CompletionQuery supporting boosting and/or filtering by specified contexts.
ContextQuery.ContextCompletionWeight
ContextQuery.ContextMetaData	Holder for context value meta data
ContextSuggestField	SuggestField which additionally takes in a set of contexts.
ContextSuggestField.PrefixTokenFilter	The ContextSuggestField.PrefixTokenFilter wraps a TokenStream and adds a set prefixes ahead.
FuzzyCompletionQuery	A CompletionQuery that match documents containing terms within an edit distance of the specified prefix.
FuzzyCompletionQuery.FuzzyCompletionWeight
NRTSuggester	NRTSuggester executes Top N search on a weighted FST specified by a CompletionScorer
NRTSuggester.PayLoadProcessor	Helper to encode/decode payload (surface + PAYLOAD_SEP + docID) output
NRTSuggester.ScoringPathComparator	Compares partial completion paths using CompletionScorer.score(float, float), breaks ties comparing path inputs
NRTSuggesterBuilder	Builder for NRTSuggester
NRTSuggesterBuilder.Entry
PrefixCompletionQuery	A CompletionQuery which takes an Analyzer to analyze the prefix of the query term.
RegexCompletionQuery	A CompletionQuery which takes a regular expression as the prefix of the query term.
SuggestField	Field that indexes a string value and a weight as a weighted completion against a named suggester.
SuggestIndexSearcher	Adds document suggest capabilities to IndexSearcher.
SuggestScoreDocPriorityQueue	Bounded priority queue for TopSuggestDocs.SuggestScoreDocs.
TopSuggestDocs	TopDocs wrapper with an additional CharSequence key per ScoreDoc
TopSuggestDocs.SuggestScoreDoc	ScoreDoc with an additional CharSequence key
TopSuggestDocsCollector	Collector that collects completion and score, along with document id

Enum Summary

Enum	Description
CompletionPostingsFormat.FSTLoadMode	An enum that allows to control if suggester FSTs are loaded into memory or read off-heap