# Package org.apache.lucene.search.payloads

The payloads package provides Query mechanisms for finding and using payloads.

See: Description

- Class Summary
  Class | Description
  --- | ---
  AveragePayloadFunction | Calculate the final score as the average score of all payloads seen.
  MaxPayloadFunction | Returns the maximum payload score seen, else 1 if there are no payloads on the doc.
  MinPayloadFunction | Calculates the minimum payload seen
  PayloadFunction | An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document.
  PayloadNearQuery | This class is very similar to `SpanNearQuery` except that it factors in the value of the payloads located at each of the positions where the `TermSpans` occurs.
  PayloadSpanUtil | Experimental class to get set of payloads for most standard Lucene queries.
  PayloadTermQuery | 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.

## Package org.apache.lucene.search.payloads Description

The payloads package provides Query mechanisms for finding and using payloads.

The following Query implementations are provided:

1. `PayloadTermQuery` -- Boost a term's score based on the value of the payload located at that term.
2. `PayloadNearQuery` -- A `SpanNearQuery` that factors in the value of the payloads located at each of the positions where the spans occur.

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.