PayloadTermQuery

Class Overview

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.

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

Payload scores are aggregated using a pluggable PayloadFunction.

Summary

[Expand] Inherited Fields
From class org.apache.lucene.search.spans.SpanTermQuery protected Term term

[Expand] Inherited Methods
From class org.apache.lucene.search.spans.SpanTermQuery boolean equals(Object obj) void extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set. String getField() Returns the name of the field matched by this query. Spans getSpans(IndexReader reader) Expert: Returns the matches for this query in an index. Term getTerm() Return the term whose spans are matched. int hashCode() String toString(String field) Prints a query to a string, with field assumed to be the default field and omitted.
From class org.apache.lucene.search.spans.SpanQuery Weight createWeight(Searcher searcher) Expert: Constructs an appropriate Weight implementation for this query. abstract String getField() Returns the name of the field matched by this query. abstract Spans getSpans(IndexReader reader) Expert: Returns the matches for this query in an index.
From class org.apache.lucene.search.Query Object clone() Returns a clone of this query. Query combine(Query[] queries) Expert: called when re-writing queries under MultiSearcher. Weight createWeight(Searcher searcher) Expert: Constructs an appropriate Weight implementation for this query. boolean equals(Object obj) void extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set. float getBoost() Gets the boost for this clause. Similarity getSimilarity(Searcher searcher) Expert: Returns the Similarity implementation to be used for this query. int hashCode() static Query mergeBooleanQueries(BooleanQuery... queries) Expert: merges the clauses of a set of BooleanQuery's into a single BooleanQuery. Query rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries. void setBoost(float b) Sets the boost for this query clause to b. String toString() Prints a query to a string. abstract String toString(String field) Prints a query to a string, with field assumed to be the default field and omitted. Weight weight(Searcher searcher) Expert: Constructs and initializes a Weight for a top-level query.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)