[Missing <summary> documentation for "N:Lucene.Net.Search.Payloads"]

Classes

  ClassDescription
Public classAveragePayloadFunction
Calculate the final score as the average score of all payloads seen.

Is thread safe and completely reusable.

Public classBoostingTermQuery Obsolete.
The BoostingTermQuery is very similar to the {@link Lucene.Net.Search.Spans.SpanTermQuery} except that it factors in the value of the payload located at each of the positions where the {@link Lucene.Net.Index.Term} occurs.

In order to take advantage of this, you must override {@link Lucene.Net.Search.Similarity#ScorePayload(String, byte[],int,int)} which returns 1 by default.

Payload scores are averaged across term occurrences in the document.

Protected classBoostingTermQuery..::..BoostingTermWeight
Public classMaxPayloadFunction
Returns the maximum payload score seen, else 1 if there are no payloads on the doc.

Is thread safe and completely reusable.

Public classMinPayloadFunction
Calculates the minimum payload seen
Public classPayloadFunction
An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document.
Public classPayloadNearQuery
This class is very similar to {@link Lucene.Net.Search.Spans.SpanNearQuery} except that it factors in the value of the payloads located at each of the positions where the {@link Lucene.Net.Search.Spans.TermSpans} occurs.

In order to take advantage of this, you must override {@link Lucene.Net.Search.Similarity#ScorePayload(String, byte[],int,int)} which returns 1 by default.

Payload scores are aggregated using a pluggable {@link PayloadFunction}.

Public classPayloadNearQuery..::..PayloadNearSpanScorer
Public classPayloadNearQuery..::..PayloadNearSpanWeight
Public classPayloadSpanUtil
Experimental class to get set of payloads for most standard Lucene queries. Operates like Highlighter - IndexReader should only contain doc of interest, best to use MemoryIndex.

WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

Public classPayloadTermQuery
This class is very similar to {@link Lucene.Net.Search.Spans.SpanTermQuery} except that it factors in the value of the payload located at each of the positions where the {@link Lucene.Net.Index.Term} occurs.

In order to take advantage of this, you must override {@link Lucene.Net.Search.Similarity#ScorePayload(String, byte[],int,int)} which returns 1 by default.

Payload scores are aggregated using a pluggable {@link PayloadFunction}.

Protected classPayloadTermQuery..::..PayloadTermWeight
Protected classPayloadTermQuery..::..PayloadTermWeight..::..PayloadTermSpanScorer