Module org.apache.lucene.queryparser

Package org.apache.lucene.queryparser.surround.query

Class RewriteQuery<SQ extends SrndQuery>

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.queryparser.surround.query.RewriteQuery<SQ>

Direct Known Subclasses:

DistanceRewriteQuery, SimpleTermRewriteQuery

abstract class RewriteQuery<SQ extends SrndQuery>
extends Query

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fieldName
protected final BasicQueryFactory	qf
protected final SQ	srndQuery

Constructor Summary

Constructors

Constructor	Description
RewriteQuery(SQ srndQuery, String fieldName, BasicQueryFactory qf)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(RewriteQuery<?> other)
int	hashCode()	Override and implement query hash code properly in a subclass.
abstract Query	rewrite(IndexSearcher indexSearcher)	Expert: called to re-write queries into primitive queries.
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.

Methods inherited from class org.apache.lucene.search.Query

classHash, createWeight, rewrite, sameClassAs, toString, visit

Methods inherited from class java.lang.Object

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

Field Details

srndQuery

protected final SQ extends SrndQuery srndQuery

fieldName

protected final String fieldName

qf

protected final BasicQueryFactory qf

Constructor Details

RewriteQuery

RewriteQuery(SQ srndQuery,
 String fieldName,
 BasicQueryFactory qf)

Method Details

rewrite

public abstract Query rewrite(IndexSearcher indexSearcher)
                       throws IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Callers are expected to call rewrite multiple times if necessary, until the rewritten query is the same as the original query.

The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.

Overrides:

rewrite in class Query

Throws:

IOException

See Also:

• IndexSearcher.rewrite(Query)

toString

public String toString(String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

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)

equals

public boolean equals(Object other)

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()

equalsTo

private boolean equalsTo(RewriteQuery<?> other)