Module org.apache.lucene.suggest

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

Class RegexCompletionQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.suggest.document.CompletionQuery

org.apache.lucene.search.suggest.document.RegexCompletionQuery

public class RegexCompletionQuery
extends CompletionQuery

A CompletionQuery which takes a regular expression as the prefix of the query term.

Example usage of querying a prefix of 'sug' and 'sub' as a regular expression against a suggest field 'suggest_field':

  CompletionQuery query = new RegexCompletionQuery(new Term("suggest_field", "su[g|b]"));
 

See RegExp for the supported regular expression syntax

Field Summary

Fields

Modifier and Type	Field	Description
private final int	determinizeWorkLimit
private final int	flags

Constructor Summary

Constructors

Constructor	Description
RegexCompletionQuery(Term term)	Calls RegexCompletionQuery(Term, BitsProducer) with no filter
RegexCompletionQuery(Term term, int flags, int determinizeWorkLimit)	Calls RegexCompletionQuery(Term, int, int, BitsProducer) with no filter
RegexCompletionQuery(Term term, int flags, int determinizeWorkLimit, BitsProducer filter)	Constructs a regular expression completion query
RegexCompletionQuery(Term term, BitsProducer filter)	Calls RegexCompletionQuery(Term, int, int, BitsProducer) enabling all optional regex syntax and determinizeWorkLimit of 10000

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.
int	getDeterminizeWorkLimit()	Get the maximum effort permitted to determinize the automaton
int	getFlags()	Get the regex flags
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

flags

private final int flags

determinizeWorkLimit

private final int determinizeWorkLimit

Constructor Details

RegexCompletionQuery

public RegexCompletionQuery(Term term)

Calls RegexCompletionQuery(Term, BitsProducer) with no filter

RegexCompletionQuery

public RegexCompletionQuery(Term term,
 BitsProducer filter)

Calls RegexCompletionQuery(Term, int, int, BitsProducer) enabling all optional regex syntax and determinizeWorkLimit of 10000

RegexCompletionQuery

public RegexCompletionQuery(Term term,
 int flags,
 int determinizeWorkLimit)

Calls RegexCompletionQuery(Term, int, int, BitsProducer) with no filter

RegexCompletionQuery

public RegexCompletionQuery(Term term,
 int flags,
 int determinizeWorkLimit,
 BitsProducer filter)

Constructs a regular expression completion query

Parameters:

term - query is run against Term.field() and Term.text() is interpreted as a regular expression

flags - used as syntax_flag in RegExp(String, int)

determinizeWorkLimit - used in RegExp.toAutomaton(int)

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

getFlags

public int getFlags()

Get the regex flags

getDeterminizeWorkLimit

public int getDeterminizeWorkLimit()

Get the maximum effort permitted to determinize the automaton

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)

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