org.apache.lucene.search.payloads

Class BoostingTermQuery

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.BoostingTermQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BoostingTermQuery
extends SpanTermQuery

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

In order to take advantage of this, you must override Similarity.scorePayload(String, byte[],int,int) which returns 1 by default.

Payload scores are averaged across term occurrences in the document.

See Also:

Similarity.scorePayload(String, byte[], int, int), Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoostingTermQuery(Term term)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Returns true iff o is equal to this.

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

extractTerms, getField, getSpans, getTerm, getTerms, hashCode, toString

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

clone, combine, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, weight

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BoostingTermQuery

public BoostingTermQuery(Term term)

Method Detail

equals

public boolean equals(java.lang.Object o)

Description copied from class: SpanTermQuery

Returns true iff o is equal to this.

Overrides:

equals in class SpanTermQuery