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
public class PrefixCompletionQuery extends CompletionQuery
ACompletionQuery
which takes anAnalyzer
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
Fields Modifier and Type Field Description protected CompletionAnalyzer
analyzer
Used to analyze the term text
-
Constructor Summary
Constructors Constructor Description PrefixCompletionQuery(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Weight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(java.lang.Object o)
Override and implement query instance equivalence properly in a subclass.Analyzer
getAnalyzer()
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, sameClassAs, toString
-
-
-
-
Field Detail
-
analyzer
protected final CompletionAnalyzer analyzer
Used to analyze the term text
-
-
Constructor Detail
-
PrefixCompletionQuery
public PrefixCompletionQuery(Analyzer analyzer, Term term)
CallsPrefixCompletionQuery(Analyzer, Term, BitsProducer)
with no filter
-
PrefixCompletionQuery
public PrefixCompletionQuery(Analyzer analyzer, Term term, BitsProducer filter)
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 Detail
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.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
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
java.io.IOException
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries
-
getAnalyzer
public Analyzer getAnalyzer()
Gets the analyzer used to analyze the prefix.
-
equals
public boolean equals(java.lang.Object o)
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 that other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
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.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
-