Module org.apache.lucene.suggest

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

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

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

Fields

Modifier and Type	Field	Description
protected final CompletionAnalyzer	analyzer	Used to analyze the term text

Constructor Summary

Constructors

Constructor	Description
PrefixCompletionQuery(Analyzer analyzer, Term term)	Calls PrefixCompletionQuery(Analyzer, Term, BitsProducer) with no filter
PrefixCompletionQuery(Analyzer analyzer, Term term, BitsProducer filter)	Constructs an analyzed prefix completion query

Method Summary

Modifier and Type	Method	Description
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(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, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

analyzer

protected final CompletionAnalyzer analyzer

Used to analyze the term text

Constructor Details

PrefixCompletionQuery

public PrefixCompletionQuery(Analyzer analyzer,
 Term term)

Calls PrefixCompletionQuery(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 provided Term.text()

term - query is run against Term.field() and Term.text() is analyzed with analyzer

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 class Query

Parameters:

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

IOException

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries.

Specified by:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

getAnalyzer

public Analyzer getAnalyzer()

Gets the analyzer used to analyze the prefix.

equals

public boolean equals(Object o)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache 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.

Specified by:

equals in class Query

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 that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)