# Package org.apache.lucene.queries.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 PayloadScoreQuery instances to transform the cumulative effects of payload scores for a document.
  PayloadNearQuery | Deprecated use `PayloadScoreQuery` to wrap `SpanNearQuery`
  PayloadScoreQuery | A Query class that uses a `PayloadFunction` to modify the score of a wrapped SpanQuery NOTE: In order to take advantage of this with the default scoring implementation (`DefaultSimilarity`), you must override `ClassicSimilarity.scorePayload(int, int, int, BytesRef)`, which returns 1 by default.
  PayloadTermQuery | Deprecated use `PayloadScoreQuery` to wrap `SpanTermQuery`
  SpanNearPayloadCheckQuery | Deprecated Use `SpanPayloadCheckQuery`
  SpanPayloadCheckQuery | Only return those matches that have a specific payload at the given position.

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

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

The following Query implementations are provided:

1. `PayloadScoreQuery` -- For all terms matched by a SpanQuery, boost the score based on the value of the payload located at those terms.

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