Module org.apache.lucene.suggest
Class PrefixCompletionQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.suggest.document.CompletionQuery
org.apache.lucene.search.suggest.document.PrefixCompletionQuery
- Direct Known Subclasses:
FuzzyCompletionQuery
A
CompletionQuery
which takes an Analyzer
to analyze the prefix of the query
term.
Example usage of querying an analyzed prefix 'sugg' against a field 'suggest_field' is as follows:
CompletionQuery query = new PrefixCompletionQuery(analyzer, new Term("suggest_field", "sugg"));
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final CompletionAnalyzer
Used to analyze the term text -
Constructor Summary
ConstructorsConstructorDescriptionPrefixCompletionQuery
(Analyzer analyzer, Term term) CallsPrefixCompletionQuery(Analyzer, Term, BitsProducer)
with no filterPrefixCompletionQuery
(Analyzer analyzer, Term term, BitsProducer filter) Constructs an analyzed prefix completion query -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.Gets the analyzer used to analyze the prefix.int
hashCode()
Override and implement query hash code properly in a subclass.void
visit
(QueryVisitor visitor) Recurse through the query tree, visiting any child queries.Methods inherited from class org.apache.lucene.search.suggest.document.CompletionQuery
getField, getFilter, getTerm, rewrite, toString
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
Field Details
-
analyzer
Used to analyze the term text
-
-
Constructor Details
-
PrefixCompletionQuery
CallsPrefixCompletionQuery(Analyzer, Term, BitsProducer)
with no filter -
PrefixCompletionQuery
Constructs an analyzed prefix completion query- Parameters:
analyzer
- used to analyze the providedTerm.text()
term
- query is run againstTerm.field()
andTerm.text()
is analyzed withanalyzer
filter
- used to query on a sub set of documents
-
-
Method Details
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
- Parameters:
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries. -
getAnalyzer
Gets the analyzer used to analyze the prefix. -
equals
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly.Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.
-
hashCode
public int hashCode()Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.
-