Module org.apache.lucene.queries
Package org.apache.lucene.queries.payloads

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 a PayloadFunction to modify the score of a wrapped SpanQuery

  • Field Details

    • wrappedQuery

      private final SpanQuery wrappedQuery

    • function

      private final PayloadFunction function

    • decoder

      private final PayloadDecoder decoder

    • includeSpanScore

      private final boolean includeSpanScore

  • Constructor Details

    • 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 Details

    • getField

      public 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(IndexSearcher indexSearcher) throws 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.

      Callers are expected to call rewrite multiple times if necessary, until the rewritten query is the same as the original query.

      The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

      However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.

      Overrides:
      rewrite in class Query
      Throws:
      IOException
      See Also:

    • visit

      public void visit(QueryVisitor visitor)
      Description copied from class: Query
      Recurse through the query tree, visiting any child queries.
      Specified by:
      visit in class Query
      Parameters:
      visitor - a QueryVisitor to be called by each query in the tree

    • toString

      public String toString(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 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
      Parameters:
      scoreMode - How the produced scorers will be consumed.
      boost - The boost that is propagated by the parent queries.
      Throws:
      IOException

    • equals

      public boolean equals(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 to those of the other instance. Utility methods are provided for certain repetitive code.

      Specified by:
      equals in class Query
      See Also:

    • 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: