org.apache.lucene.queries.payloads

Class PayloadScoreQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.queries.payloads.PayloadScoreQuery

public class PayloadScoreQuery
extends SpanQuery

A Query class that uses a PayloadFunction to modify the score of a wrapped SpanQuery

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	PayloadScoreQuery.PayloadSpans
private class	PayloadScoreQuery.PayloadSpanScorer
private class	PayloadScoreQuery.PayloadSpanWeight

Field Summary

Fields

Modifier and Type	Field and Description
private PayloadDecoder	decoder
private PayloadFunction	function
private boolean	includeSpanScore
private SpanQuery	wrappedQuery

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.apache.lucene.search.spans.SpanQuery

getTermStates, getTermStates

Methods inherited from class org.apache.lucene.search.Query

classHash, sameClassAs, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

wrappedQuery

private final SpanQuery wrappedQuery

function

private final PayloadFunction function

decoder

private final PayloadDecoder decoder

includeSpanScore

private final boolean includeSpanScore

Constructor Detail

PayloadScoreQuery

public PayloadScoreQuery(SpanQuery wrappedQuery,
                         PayloadFunction function,
                         PayloadDecoder decoder,
                         boolean includeSpanScore)

Creates a new PayloadScoreQuery

Parameters:

wrappedQuery - the query to wrap

function - a PayloadFunction to use to modify the scores

decoder - a PayloadDecoder to convert payloads into float values

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

function - a PayloadFunction to use to modify the scores

Method Detail

getField

public java.lang.String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Specified by:

getField in class SpanQuery

rewrite

public Query rewrite(IndexReader reader)
              throws java.io.IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Overrides:

rewrite in class Query

Throws:

java.io.IOException

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries

Overrides:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

toString

public java.lang.String toString(java.lang.String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

createWeight

public SpanWeight createWeight(IndexSearcher searcher,
                               ScoreMode scoreMode,
                               float boost)
                        throws java.io.IOException

Description copied from class: Query

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Specified by:

createWeight in class SpanQuery

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that 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.

Specified by:

equals in class Query

See Also:

Query.sameClassAs(Object), Query.classHash()

equalsTo

private boolean equalsTo(PayloadScoreQuery other)

hashCode

public int hashCode()

Description copied from class: Query

Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

Query.equals(Object)