org.apache.lucene.search.payloads

Class PayloadTermQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.spans.SpanTermQuery

org.apache.lucene.search.payloads.PayloadTermQuery

All Implemented Interfaces:

Cloneable

Deprecated.

use PayloadScoreQuery to wrap SpanTermQuery

public class PayloadTermQuery
extends SpanTermQuery

This class is very similar to SpanTermQuery except that it factors in the value of the payload located at each of the positions where the Term occurs.

NOTE: In order to take advantage of this with the default scoring implementation (DefaultSimilarity), you must override DefaultSimilarity.scorePayload(int, int, int, BytesRef), which returns 1 by default.

Payload scores are aggregated using a pluggable PayloadFunction.

See Also:

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.spans.SpanTermQuery

SpanTermQuery.SpanTermWeight

Field Summary

Fields

Modifier and Type	Field and Description
protected PayloadFunction	function Deprecated.

Fields inherited from class org.apache.lucene.search.spans.SpanTermQuery

term, termContext

Constructor Summary

Constructors

Constructor and Description
PayloadTermQuery(Term term, PayloadFunction function) Deprecated.
PayloadTermQuery(Term term, PayloadFunction function, boolean includeSpanScore) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
SpanWeight	createWeight(IndexSearcher searcher, boolean needsScores) Deprecated. Create a SpanWeight for this query
boolean	equals(Object obj) Deprecated.
int	hashCode() Deprecated.

Methods inherited from class org.apache.lucene.search.spans.SpanTermQuery

getField, getTerm, toString

Methods inherited from class org.apache.lucene.search.spans.SpanQuery

getTermContexts, getTermContexts

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

clone, getBoost, rewrite, setBoost, toString

Methods inherited from class java.lang.Object

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

Field Detail

function

protected PayloadFunction function

Deprecated.

Constructor Detail

PayloadTermQuery

public PayloadTermQuery(Term term,
                PayloadFunction function)

Deprecated.

PayloadTermQuery

public PayloadTermQuery(Term term,
                PayloadFunction function,
                boolean includeSpanScore)

Deprecated.

Method Detail

createWeight

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

Deprecated.

Description copied from class: SpanQuery

Create a SpanWeight for this query

Overrides:

createWeight in class SpanTermQuery

Parameters:

searcher - the IndexSearcher to be searched across

needsScores - if the query needs scores

Returns:

a SpanWeight

Throws:

IOException - on error

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class SpanTermQuery

equals

public boolean equals(Object obj)

Deprecated.

Overrides:

equals in class SpanTermQuery