org.apache.lucene.search.suggest.document

Class SuggestIndexSearcher

java.lang.Object

org.apache.lucene.search.IndexSearcher

org.apache.lucene.search.suggest.document.SuggestIndexSearcher

public class SuggestIndexSearcher
extends IndexSearcher

Adds document suggest capabilities to IndexSearcher

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.IndexSearcher

IndexSearcher.LeafSlice

Field Summary

Fields inherited from class org.apache.lucene.search.IndexSearcher

leafContexts, leafSlices, readerContext

Constructor Summary

Constructors

Constructor and Description
SuggestIndexSearcher(IndexReader reader, Analyzer queryAnalyzer) Creates a searcher with document suggest capabilities for reader.

Method Summary

Methods

Modifier and Type	Method and Description
TopSuggestDocs	suggest(String field, CharSequence key, int num) Calls suggest(String, CharSequence, int, Filter) with no document filter
TopSuggestDocs	suggest(String field, CharSequence key, int num, Filter filter) Suggests at most num documents filtered by filter that completes to key for a suggest field
void	suggest(String field, CharSequence key, int num, Filter filter, TopSuggestDocsCollector collector) Suggests at most num documents filtered by filter that completes to key for a suggest field
void	suggest(String field, CharSequence key, int num, TopSuggestDocsCollector collector) Calls suggest(String, CharSequence, int, Filter, TopSuggestDocsCollector) with no document filter

Methods inherited from class org.apache.lucene.search.IndexSearcher

collectionStatistics, count, createNormalizedWeight, createWeight, doc, doc, doc, explain, explain, getDefaultQueryCache, getDefaultQueryCachingPolicy, getDefaultSimilarity, getIndexReader, getSimilarity, getTopReaderContext, rewrite, search, search, search, search, search, search, search, search, search, search, searchAfter, searchAfter, searchAfter, searchAfter, searchAfter, searchAfter, setDefaultQueryCache, setDefaultQueryCachingPolicy, setQueryCache, setQueryCachingPolicy, setSimilarity, slices, termStatistics, toString, wrapFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SuggestIndexSearcher

public SuggestIndexSearcher(IndexReader reader,
                    Analyzer queryAnalyzer)

Creates a searcher with document suggest capabilities for reader.

Suggestion key is analyzed with queryAnalyzer

Method Detail

suggest

public TopSuggestDocs suggest(String field,
                     CharSequence key,
                     int num)
                       throws IOException

Calls suggest(String, CharSequence, int, Filter) with no document filter

Throws:

IOException

suggest

public void suggest(String field,
           CharSequence key,
           int num,
           TopSuggestDocsCollector collector)
             throws IOException

Calls suggest(String, CharSequence, int, Filter, TopSuggestDocsCollector) with no document filter

Throws:

IOException

suggest

public TopSuggestDocs suggest(String field,
                     CharSequence key,
                     int num,
                     Filter filter)
                       throws IOException

Suggests at most num documents filtered by filter that completes to key for a suggest field

Returns at most Top num document ids with corresponding completion and weight pair

Throws:

IllegalArgumentException - if filter does not provide a random access interface or if field is not a SuggestField

IOException

suggest

public void suggest(String field,
           CharSequence key,
           int num,
           Filter filter,
           TopSuggestDocsCollector collector)
             throws IOException

Suggests at most num documents filtered by filter that completes to key for a suggest field

Collect completions with TopSuggestDocsCollector The completions are collected in order of the suggest field weight. There can be more than one collection of the same document, if the key matches multiple field values of the same document

Throws:

IllegalArgumentException - if filter does not provide a random access interface or if field is not a SuggestField

IOException