Class CompletionQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.suggest.document.CompletionQuery
-
- Direct Known Subclasses:
ContextQuery,PrefixCompletionQuery,RegexCompletionQuery
public abstract class CompletionQuery extends Query
AbstractQuerythat match documents containing terms with a specified prefix filtered byBitsProducer. This should be used to query against anySuggestFields orContextSuggestFields of documents.Use
SuggestIndexSearcher.suggest(CompletionQuery, int, boolean)to execute any query that provides a concrete implementation of this query. Example below shows using this query to retrieve the top 5 documents.SuggestIndexSearcher searcher = new SuggestIndexSearcher(reader); TopSuggestDocs suggestDocs = searcher.suggest(query, 5);
This query rewrites to an appropriateCompletionQuerydepending on the type (SuggestFieldorContextSuggestField) of the field the query is run against.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCompletionQuery(Term term, BitsProducer filter)Creates a base Completion query against atermwith afilterto scope the documents
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetField()Returns the field name this query should be run againstBitsProducergetFilter()Returns aBitsProducer.TermgetTerm()Returns the term to be queried againstQueryrewrite(IndexSearcher indexSearcher)StringtoString(String field)-
Methods inherited from class org.apache.lucene.search.Query
classHash, createWeight, equals, hashCode, rewrite, sameClassAs, toString, visit
-
-
-
-
Constructor Detail
-
CompletionQuery
protected CompletionQuery(Term term, BitsProducer filter)
Creates a base Completion query against atermwith afilterto scope the documents
-
-
Method Detail
-
getFilter
public BitsProducer getFilter()
Returns aBitsProducer. Only suggestions matching the returned bits will be returned.
-
getField
public String getField()
Returns the field name this query should be run against
-
getTerm
public Term getTerm()
Returns the term to be queried against
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
- Overrides:
rewritein classQuery- Throws:
IOException
-
-