Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PayloadScoreQuery javadoc update w.r.t. SpanQuery use (#13731)

This commit is contained in:
Christine Poerschke 2024-09-12 11:23:22 +01:00 committed by GitHub
parent 74e3c44063
commit ef577ea43a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lucene/queries/src/java/org/apache/lucene/queries/payloads/PayloadScoreQuery.java
View File

@ -39,7 +39,11 @@ import org.apache.lucene.search.ScoreMode;
import org.apache.lucene.search.ScorerSupplier;
import org.apache.lucene.util.BytesRef;
/** A Query class that uses a {@link PayloadFunction} to modify the score of a wrapped SpanQuery */
/**
* A Query class that uses a {@link PayloadFunction} to modify the score of a wrapped {@link
* SpanQuery}. A wrapped span query is used due to the way that payload values are indexed, see
* {@link PostingsEnum#PAYLOADS}.
*/
public class PayloadScoreQuery extends SpanQuery {
private final SpanQuery wrappedQuery;