Package org.apache.lucene.queries.payloads
The payloads package provides Query mechanisms for finding and using payloads.
The following Query implementations are provided:
PayloadScoreQuery-- For all terms matched by a SpanQuery, boost the score based on the value of the payload located at those terms.
-
Interface Summary Interface Description PayloadDecoder Defines a way of converting payloads to float values, for use byPayloadScoreQueryPayloadMatcher Defines an interface for testing if two payloads should be consider to match -
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 seenPayloadFunction An abstract class that defines a way for PayloadScoreQuery instances to transform the cumulative effects of payload scores for a document.PayloadMatcherFactory Creates a payload matcher object based on a payload type and an operation.PayloadScoreQuery A Query class that uses aPayloadFunctionto modify the score of a wrapped SpanQuerySpanPayloadCheckQuery Only return those matches that have a specific payload at the given position.SumPayloadFunction Calculate the final score as the sum of scores of all payloads seen. -
Enum Summary Enum Description SpanPayloadCheckQuery.MatchOperation The payload type.SpanPayloadCheckQuery.PayloadType The payload type.