| java.lang.Object | ||
| ↳ | org.apache.lucene.search.payloads.PayloadFunction | |
| ↳ | org.apache.lucene.search.payloads.MaxPayloadFunction | |
Class Overview
Returns the maximum payload score seen, else 1 if there are no payloads on the doc.
Is thread safe and completely reusable.Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Calculate the score up to this point for this doc and field
| |||||||||||
Calculate the final score for all the payloads seen so far for this doc/field
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.search.payloads.PayloadFunction
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public MaxPayloadFunction ()
Public Methods
public 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 doc |
|---|---|
| field | The field |
| start | The start position of the matching Span |
| end | The end position of the matching Span |
| numPayloadsSeen | The number of payloads seen so far |
| currentScore | The current score so far |
| currentPayloadScore | The score for the current payload |
Returns
- The new current Score
public 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 doc |
|---|---|
| field | The current field |
| numPayloadsSeen | The total number of payloads seen on this document |
| payloadScore | The raw score for those payloads |
Returns
- The final score for the payloads