protected class

BooleanQuery.BooleanWeight

extends Weight
java.lang.Object
   ↳ org.apache.lucene.search.Weight
     ↳ org.apache.lucene.search.BooleanQuery.BooleanWeight

Class Overview

Expert: the Weight for BooleanQuery, used to normalize, score and explain these queries.

NOTE: this API and implementation is subject to change suddenly in the next release.

Summary

Fields
protected Similarity similarity The Similarity implementation.
protected ArrayList<Weight> weights
Public Constructors
BooleanQuery.BooleanWeight(Searcher searcher)
Public Methods
Explanation explain(IndexReader reader, int doc)
An explanation of the score computation for the named document.
Query getQuery()
The query that this concerns.
float getValue()
The weight for this query.
void normalize(float norm)
Assigns the query normalization factor to this.
Scorer scorer(IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)
Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.
boolean scoresDocsOutOfOrder()
Returns true iff this implementation scores docs only out of order.
float sumOfSquaredWeights()
The sum of squared weights of contained query clauses.
[Expand]
Inherited Methods
From class org.apache.lucene.search.Weight
From class java.lang.Object

Fields

protected Similarity similarity

The Similarity implementation.

protected ArrayList<Weight> weights

Public Constructors

public BooleanQuery.BooleanWeight (Searcher searcher)

Throws
IOException

Public Methods

public Explanation explain (IndexReader reader, int doc)

An explanation of the score computation for the named document.

Parameters
reader sub-reader containing the give doc
Returns
  • an Explanation for the score
Throws
IOException

public Query getQuery ()

The query that this concerns.

public float getValue ()

The weight for this query.

public void normalize (float norm)

Assigns the query normalization factor to this.

public Scorer scorer (IndexReader reader, boolean scoreDocsInOrder, boolean topScorer)

Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call scoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.
NOTE: null can be returned if no documents will be scored by this query.

Parameters
reader the IndexReader for which to return the Scorer.
scoreDocsInOrder specifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not support nextDoc() and/or advance(int), therefore it is recommended to request an in-order scorer if use of these methods is required.
topScorer if true, score(Collector) will be called; if false, nextDoc() and/or advance(int) will be called.
Returns
  • a Scorer which scores documents in/out-of order.
Throws
IOException

public boolean scoresDocsOutOfOrder ()

Returns true iff this implementation scores docs only out of order. This method is used in conjunction with Collector's acceptsDocsOutOfOrder and scorer(org.apache.lucene.index.IndexReader, boolean, boolean) to create a matching Scorer instance for a given Collector, or vice versa.

NOTE: the default implementation returns false, i.e. the Scorer scores documents in-order.

public float sumOfSquaredWeights ()

The sum of squared weights of contained query clauses.

Throws
IOException