Class PayloadFunction
- java.lang.Object
-
- org.apache.lucene.queries.payloads.PayloadFunction
-
- Direct Known Subclasses:
AveragePayloadFunction
,MaxPayloadFunction
,MinPayloadFunction
,SumPayloadFunction
public abstract class PayloadFunction extends Object
An abstract class that defines a way for PayloadScoreQuery instances to transform the cumulative effects of payload scores for a document.- See Also:
for more information
- WARNING: This API is experimental and might change in incompatible ways in the next release.
- This class and its derivations are experimental and subject to change
-
-
Constructor Summary
Constructors Constructor Description PayloadFunction()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract float
currentScore(int docId, String field, int start, int end, int numPayloadsSeen, float currentScore, float currentPayloadScore)
Calculate the score up to this point for this doc and fieldabstract float
docScore(int docId, String field, int numPayloadsSeen, float payloadScore)
Calculate the final score for all the payloads seen so far for this doc/fieldabstract boolean
equals(Object o)
Explanation
explain(int docId, String field, int numPayloadsSeen, float payloadScore)
abstract int
hashCode()
-
-
-
Method Detail
-
currentScore
public abstract float currentScore(int docId, String field, int start, int end, int numPayloadsSeen, float currentScore, float currentPayloadScore)
Calculate the score up to this point for this doc and field- Parameters:
docId
- The current docfield
- The fieldstart
- The start position of the matching Spanend
- The end position of the matching SpannumPayloadsSeen
- The number of payloads seen so farcurrentScore
- The current score so farcurrentPayloadScore
- The score for the current payload- Returns:
- The new current Score
- See Also:
Spans
-
docScore
public abstract float docScore(int docId, String field, int numPayloadsSeen, float payloadScore)
Calculate the final score for all the payloads seen so far for this doc/field- Parameters:
docId
- The current docfield
- The current fieldnumPayloadsSeen
- The total number of payloads seen on this documentpayloadScore
- The raw score for those payloads- Returns:
- The final score for the payloads
-
explain
public Explanation explain(int docId, String field, int numPayloadsSeen, float payloadScore)
-
-