# Uses of Class
org.apache.lucene.queries.payloads.PayloadFunction

Packages that use PayloadFunction
Package
Description
org.apache.lucene.queries.payloads
The payloads package provides Query mechanisms for finding and using payloads.

## Uses of PayloadFunction in org.apache.lucene.queries.payloads

Subclasses of PayloadFunction in org.apache.lucene.queries.payloads
Modifier and Type
Class
Description
`class`
`AveragePayloadFunction`
Calculate the final score as the average score of all payloads seen.
`class`
`MaxPayloadFunction`
Returns the maximum payload score seen, else 1 if there are no payloads on the doc.
`class`
`MinPayloadFunction`
Calculates the minimum payload seen
`class`
`SumPayloadFunction`
Calculate the final score as the sum of scores of all payloads seen.
Constructors in org.apache.lucene.queries.payloads with parameters of type PayloadFunction
Modifier
Constructor
Description
``
`PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder)`
Creates a new PayloadScoreQuery that includes the underlying span scores
``
`PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder, boolean includeSpanScore)`
Creates a new PayloadScoreQuery