org.apache.lucene.queries

Class CustomScoreQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.queries.CustomScoreQuery

All Implemented Interfaces:

java.lang.Cloneable

Deprecated.

use FunctionScoreQuery

@Deprecated
public class CustomScoreQuery
extends Query
implements java.lang.Cloneable

Query that sets document score as a programmatic function of several (sub) scores:

1. the score of its subQuery (any query)
2. (optional) the score of its FunctionQuery (or queries).

Subclasses can modify the computation by overriding getCustomScoreProvider(org.apache.lucene.index.LeafReaderContext).

Constructor Summary

Constructors

Constructor and Description
CustomScoreQuery(Query subQuery) Deprecated. Create a CustomScoreQuery over input subQuery.
CustomScoreQuery(Query subQuery, FunctionQuery... scoringQueries) Deprecated. Create a CustomScoreQuery over input subQuery and a FunctionQuery.
CustomScoreQuery(Query subQuery, FunctionQuery scoringQuery) Deprecated. Create a CustomScoreQuery over input subQuery and a FunctionQuery.

Method Summary

Modifier and Type	Method and Description
CustomScoreQuery	clone() Deprecated.
Weight	createWeight(IndexSearcher searcher, boolean needsScores, float boost) Deprecated. Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(java.lang.Object other) Deprecated. Returns true if o is equal to this.
protected CustomScoreProvider	getCustomScoreProvider(LeafReaderContext context) Deprecated. Returns a CustomScoreProvider that calculates the custom scores for the given IndexReader.
Query[]	getScoringQueries() Deprecated. The scoring queries that only affect the score of CustomScoreQuery.
Query	getSubQuery() Deprecated. The sub-query that CustomScoreQuery wraps, affecting both the score and which documents match.
int	hashCode() Deprecated. Returns a hash code value for this object.
java.lang.String	name() Deprecated. A short name of this query, used in toString(String).
Query	rewrite(IndexReader reader) Deprecated. Expert: called to re-write queries into primitive queries.
java.lang.String	toString(java.lang.String field) Deprecated. 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, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomScoreQuery

public CustomScoreQuery(Query subQuery)

Deprecated.

Create a CustomScoreQuery over input subQuery.

Parameters:

subQuery - the sub query whose scored is being customized. Must not be null.

CustomScoreQuery

public CustomScoreQuery(Query subQuery,
                        FunctionQuery scoringQuery)

Deprecated.

Create a CustomScoreQuery over input subQuery and a FunctionQuery.

Parameters:

subQuery - the sub query whose score is being customized. Must not be null.

scoringQuery - a value source query whose scores are used in the custom score computation. This parameter is optional - it can be null.

CustomScoreQuery

public CustomScoreQuery(Query subQuery,
                        FunctionQuery... scoringQueries)

Deprecated.

Create a CustomScoreQuery over input subQuery and a FunctionQuery.

Parameters:

subQuery - the sub query whose score is being customized. Must not be null.

scoringQueries - value source queries whose scores are used in the custom score computation. This parameter is optional - it can be null or even an empty array.

Method Detail

rewrite

public Query rewrite(IndexReader reader)
              throws java.io.IOException

Deprecated.

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.

Overrides:

rewrite in class Query

Throws:

java.io.IOException

clone

public CustomScoreQuery clone()

Deprecated.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString(java.lang.String field)

Deprecated.

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

equals

public boolean equals(java.lang.Object other)

Deprecated.

Returns true if o is equal to this.

Specified by:

equals in class Query

See Also:

Query.sameClassAs(Object), Query.classHash()

hashCode

public int hashCode()

Deprecated.

Returns a hash code value for this object.

Specified by:

hashCode in class Query

See Also:

Query.equals(Object)

getCustomScoreProvider

protected CustomScoreProvider getCustomScoreProvider(LeafReaderContext context)
                                              throws java.io.IOException

Deprecated.

Returns a CustomScoreProvider that calculates the custom scores for the given IndexReader. The default implementation returns a default implementation as specified in the docs of CustomScoreProvider.

Throws:

java.io.IOException

Since:

2.9.2

createWeight

public Weight createWeight(IndexSearcher searcher,
                           boolean needsScores,
                           float boost)
                    throws java.io.IOException

Deprecated.

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

needsScores - True if document scores (Scorer.score()) are needed.

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

Throws:

java.io.IOException

getSubQuery

public Query getSubQuery()

Deprecated.

The sub-query that CustomScoreQuery wraps, affecting both the score and which documents match.

getScoringQueries

public Query[] getScoringQueries()

Deprecated.

The scoring queries that only affect the score of CustomScoreQuery.

name

public java.lang.String name()

Deprecated.

A short name of this query, used in toString(String).