public class PayloadScoreQuery extends SpanQuery
PayloadFunction
to modify the score of a wrapped SpanQueryModifier and Type | Class and Description |
---|---|
private class |
PayloadScoreQuery.PayloadSpans |
private class |
PayloadScoreQuery.PayloadSpanScorer |
private class |
PayloadScoreQuery.PayloadSpanWeight |
Modifier and Type | Field and Description |
---|---|
private PayloadDecoder |
decoder |
private PayloadFunction |
function |
private boolean |
includeSpanScore |
private SpanQuery |
wrappedQuery |
Constructor and Description |
---|
PayloadScoreQuery(SpanQuery wrappedQuery,
PayloadFunction function,
PayloadDecoder decoder)
Creates a new PayloadScoreQuery that includes the underlying span scores
|
PayloadScoreQuery(SpanQuery wrappedQuery,
PayloadFunction function,
PayloadDecoder decoder,
boolean includeSpanScore)
Creates a new PayloadScoreQuery
|
Modifier and Type | Method and Description |
---|---|
SpanWeight |
createWeight(IndexSearcher searcher,
ScoreMode scoreMode,
float boost)
Expert: Constructs an appropriate Weight implementation for this query.
|
boolean |
equals(java.lang.Object other)
Override and implement query instance equivalence properly in a subclass.
|
private boolean |
equalsTo(PayloadScoreQuery other) |
java.lang.String |
getField()
Returns the name of the field matched by this query.
|
int |
hashCode()
Override and implement query hash code properly in a subclass.
|
Query |
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.
|
java.lang.String |
toString(java.lang.String field)
Prints a query to a string, with
field assumed to be the
default field and omitted. |
void |
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries
|
getTermStates, getTermStates
classHash, sameClassAs, toString
private final SpanQuery wrappedQuery
private final PayloadFunction function
private final PayloadDecoder decoder
private final boolean includeSpanScore
public PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder, boolean includeSpanScore)
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 algorithmpublic PayloadScoreQuery(SpanQuery wrappedQuery, PayloadFunction function, PayloadDecoder decoder)
wrappedQuery
- the query to wrapfunction
- a PayloadFunction to use to modify the scorespublic java.lang.String getField()
SpanQuery
public Query rewrite(IndexReader reader) throws java.io.IOException
Query
public void visit(QueryVisitor visitor)
Query
public java.lang.String toString(java.lang.String field)
Query
field
assumed to be the
default field and omitted.public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.IOException
Query
Only implemented by primitive queries, which re-write to themselves.
createWeight
in class SpanQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.java.io.IOException
public boolean equals(java.lang.Object other)
Query
QueryCache
works properly.
Typically a query will be equal to another only if it's an instance of
the same class and its document-filtering properties are identical that other
instance. Utility methods are provided for certain repetitive code.equals
in class Query
Query.sameClassAs(Object)
,
Query.classHash()
private boolean equalsTo(PayloadScoreQuery other)
public int hashCode()
Query
QueryCache
works properly.hashCode
in class Query
Query.equals(Object)