Class PayloadScoreQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.queries.spans.SpanQuery
-
- org.apache.lucene.queries.payloads.PayloadScoreQuery
-
public class PayloadScoreQuery extends SpanQuery
A Query class that uses aPayloadFunctionto modify the score of a wrappedSpanQuery. A wrapped span query is used due to the way that payload values are indexed, seePostingsEnum.PAYLOADS.
-
-
Constructor Summary
Constructors Constructor Description PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder)Creates a new PayloadScoreQuery that includes the underlying span scoresPayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder, boolean includeSpanScore)Creates a new PayloadScoreQuery
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpanWeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)booleanequals(Object other)StringgetField()Returns the name of the field matched by this query.inthashCode()Queryrewrite(IndexSearcher indexSearcher)StringtoString(String field)voidvisit(QueryVisitor visitor)-
Methods inherited from class org.apache.lucene.queries.spans.SpanQuery
getTermStates, getTermStates
-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
-
-
-
Constructor Detail
-
PayloadScoreQuery
public PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder, boolean includeSpanScore)
Creates a new PayloadScoreQuery- Parameters:
wrappedQuery- the query to wrapfunction- a PayloadFunction to use to modify the scoresdecoder- a PayloadDecoder to convert payloads into float valuesincludeSpanScore- include both span score and payload score in the scoring algorithm
-
PayloadScoreQuery
public PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder)
Creates a new PayloadScoreQuery that includes the underlying span scores- Parameters:
wrappedQuery- the query to wrapfunction- a PayloadFunction to use to modify the scores
-
-
Method Detail
-
getField
public String getField()
Description copied from class:SpanQueryReturns the name of the field matched by this query.
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
- Overrides:
rewritein classQuery- Throws:
IOException
-
visit
public void visit(QueryVisitor visitor)
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
- Specified by:
createWeightin classSpanQuery- Throws:
IOException
-
-