org.apache.lucene.search.payloads
Class PayloadFunction
java.lang.Object
org.apache.lucene.search.payloads.PayloadFunction
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- AveragePayloadFunction, MaxPayloadFunction, MinPayloadFunction
public abstract class PayloadFunction
- extends Object
- implements Serializable
An abstract class that defines a way for Payload*Query instances to transform
the cumulative effects of payload scores for a document.
- See Also:
for more information
,
Serialized Form- 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
Method Summary |
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)
|
Explanation |
explain(int docId,
int numPayloadsSeen,
float payloadScore)
|
abstract int |
hashCode()
|
PayloadFunction
public PayloadFunction()
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,
int numPayloadsSeen,
float payloadScore)
hashCode
public abstract int hashCode()
- Overrides:
hashCode
in class Object
equals
public abstract boolean equals(Object o)
- Overrides:
equals
in class Object
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.