org.apache.lucene.queries.payloads

Class PayloadScoreQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.queries.payloads.PayloadScoreQuery

All Implemented Interfaces:

Cloneable

public class PayloadScoreQuery
extends SpanQuery

A Query class that uses a PayloadFunction to modify the score of a wrapped SpanQuery NOTE: In order to take advantage of this with the default scoring implementation (DefaultSimilarity), you must override ClassicSimilarity.scorePayload(int, int, int, BytesRef), which returns 1 by default.

See Also:

Similarity.SimScorer.computePayloadFactor(int, int, int, BytesRef)

Constructor Summary

Constructors

Constructor and Description
PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function) Creates a new PayloadScoreQuery that includes the underlying span scores
PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, boolean includeSpanScore) Creates a new PayloadScoreQuery

Method Summary

Methods

Modifier and Type	Method and Description
SpanWeight	createWeight(IndexSearcher searcher, boolean needsScores) Create a SpanWeight for this query
boolean	equals(Object o)
String	getField() Returns the name of the field matched by this query.
int	hashCode()
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.spans.SpanQuery

getTermContexts, getTermContexts, rewrite

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

clone, getBoost, setBoost, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadScoreQuery

public PayloadScoreQuery(SpanQuery wrappedQuery,
                 PayloadFunction function,
                 boolean includeSpanScore)

Creates a new PayloadScoreQuery

Parameters:

wrappedQuery - the query to wrap

function - a PayloadFunction to use to modify the scores

includeSpanScore - include both span score and payload score in the scoring algorithm

PayloadScoreQuery

public PayloadScoreQuery(SpanQuery wrappedQuery,
                 PayloadFunction function)

Creates a new PayloadScoreQuery that includes the underlying span scores

Parameters:

wrappedQuery - the query to wrap

function - a PayloadFunction to use to modify the scores

Method Detail

getField

public String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Specified by:

getField in class SpanQuery

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

createWeight

public SpanWeight createWeight(IndexSearcher searcher,
                      boolean needsScores)
                        throws IOException

Description copied from class: SpanQuery

Create a SpanWeight for this query

Specified by:

createWeight in class SpanQuery

Parameters:

searcher - the IndexSearcher to be searched across

needsScores - if the query needs scores

Returns:

a SpanWeight

Throws:

IOException - on error

equals

public boolean equals(Object o)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query