public abstract class

PayloadFunction

extends Object
implements Serializable
java.lang.Object
   ↳ org.apache.lucene.search.payloads.PayloadFunction
Known Direct Subclasses

Class Overview

An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document.

Summary

Public Constructors
PayloadFunction()
Public Methods
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
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
abstract boolean equals(Object o)
abstract int hashCode()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PayloadFunction ()

Public Methods

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 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
See Also

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 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

public abstract boolean equals (Object o)

public abstract int hashCode ()