Module org.apache.lucene.core

Package org.apache.lucene.search

Class BooleanWeight

java.lang.Object

org.apache.lucene.search.Weight

org.apache.lucene.search.BooleanWeight

All Implemented Interfaces:

SegmentCacheable

final class BooleanWeight
extends Weight

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BooleanWeight.WeightedBooleanClause

Nested classes/interfaces inherited from class org.apache.lucene.search.Weight

Weight.DefaultBulkScorer

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final BooleanQuery	query
(package private) final ScoreMode	scoreMode
(package private) final Similarity	similarity	The Similarity implementation.
(package private) final ArrayList<BooleanWeight.WeightedBooleanClause>	weightedClauses

Fields inherited from class org.apache.lucene.search.Weight

parentQuery

Constructor Summary

Constructors

Constructor	Description
BooleanWeight(BooleanQuery query, IndexSearcher searcher, ScoreMode scoreMode, float boost)

Method Summary

Modifier and Type	Method	Description
(package private) BulkScorer	booleanScorer(LeafReaderContext context)	Try to build a boolean scorer for this weight.
BulkScorer	bulkScorer(LeafReaderContext context)	Optional method, to return a BulkScorer to score the query and send hits to a Collector.
int	count(LeafReaderContext context)	Counts the number of live documents that match a given Weight.parentQuery in a leaf.
(package private) static BulkScorer	disableScoring(BulkScorer scorer)
Explanation	explain(LeafReaderContext context, int doc)	An explanation of the score computation for the named document.
boolean	isCacheable(LeafReaderContext ctx)
Matches	matches(LeafReaderContext context, int doc)	Returns Matches for a specific document, or null if the document does not match the parent query
private int	optCount(LeafReaderContext context, BooleanClause.Occur occur)	Return the number of matches of optional clauses, or -1 if unknown, or 0 if there are no optional clauses.
(package private) BulkScorer	optionalBulkScorer(LeafReaderContext context)
private int	reqCount(LeafReaderContext context)	Return the number of matches of required clauses, or -1 if unknown, or numDocs if there are no required clauses.
private BulkScorer	requiredBulkScorer(LeafReaderContext context)
Scorer	scorer(LeafReaderContext context)	Returns a Scorer which can iterate in order over all matching documents and assign them a score.
ScorerSupplier	scorerSupplier(LeafReaderContext context)	Optional method.

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

getQuery

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

similarity

final Similarity similarity

The Similarity implementation.

query

final BooleanQuery query

weightedClauses

final ArrayList<BooleanWeight.WeightedBooleanClause> weightedClauses

scoreMode

final ScoreMode scoreMode

Constructor Details

BooleanWeight

BooleanWeight(BooleanQuery query,
 IndexSearcher searcher,
 ScoreMode scoreMode,
 float boost)
       throws IOException

Throws:

IOException

Method Details

explain

public Explanation explain(LeafReaderContext context,
 int doc)
                    throws IOException

Description copied from class: Weight

An explanation of the score computation for the named document.

Specified by:

explain in class Weight

Parameters:

context - the readers context to create the Explanation for.

doc - the document's id relative to the given context's reader

Returns:

an Explanation for the score

Throws:

IOException - if an IOException occurs

matches

public Matches matches(LeafReaderContext context,
 int doc)
                throws IOException

Description copied from class: Weight

Returns Matches for a specific document, or null if the document does not match the parent query

A query match that contains no position information (for example, a Point or DocValues query) will return MatchesUtils.MATCH_WITH_NO_TERMS

Overrides:

matches in class Weight

Parameters:

context - the reader's context to create the Matches for

doc - the document's id relative to the given context's reader

Throws:

IOException

disableScoring

static BulkScorer disableScoring(BulkScorer scorer)

optionalBulkScorer

BulkScorer optionalBulkScorer(LeafReaderContext context)
                       throws IOException

Throws:

IOException

requiredBulkScorer

private BulkScorer requiredBulkScorer(LeafReaderContext context)
                               throws IOException

Throws:

IOException

booleanScorer

BulkScorer booleanScorer(LeafReaderContext context)
                  throws IOException

Try to build a boolean scorer for this weight. Returns null if BooleanScorer cannot be used.

Throws:

IOException

bulkScorer

public BulkScorer bulkScorer(LeafReaderContext context)
                      throws IOException

Description copied from class: Weight

Optional method, to return a BulkScorer to score the query and send hits to a Collector. Only queries that have a different top-level approach need to override this; the default implementation pulls a normal Scorer and iterates and collects the resulting hits which are not marked as deleted.

Overrides:

bulkScorer in class Weight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

a BulkScorer which scores documents and passes them to a collector.

Throws:

IOException - if there is a low-level I/O error

count

public int count(LeafReaderContext context)
          throws IOException

Description copied from class: Weight

Counts the number of live documents that match a given Weight.parentQuery in a leaf.

The default implementation returns -1 for every query. This indicates that the count could not be computed in sub-linear time.

Specific query classes should override it to provide other accurate sub-linear implementations (that actually return the count). Look at MatchAllDocsQuery.createWeight(IndexSearcher, ScoreMode, float) for an example

We use this property of the function to count hits in IndexSearcher.count(Query).

Overrides:

count in class Weight

Parameters:

context - the LeafReaderContext for which to return the count.

Returns:

integer count of the number of matches

Throws:

IOException - if there is a low-level I/O error

reqCount

private int reqCount(LeafReaderContext context)
              throws IOException

Return the number of matches of required clauses, or -1 if unknown, or numDocs if there are no required clauses.

Throws:

IOException

optCount

private int optCount(LeafReaderContext context,
 BooleanClause.Occur occur)
              throws IOException

Return the number of matches of optional clauses, or -1 if unknown, or 0 if there are no optional clauses.

Throws:

IOException

scorer

public Scorer scorer(LeafReaderContext context)
              throws IOException

Description copied from class: Weight

Returns a Scorer which can iterate in order over all matching documents and assign them a score.

NOTE: null can be returned if no documents will be scored by this query.

NOTE: The returned Scorer does not have LeafReader.getLiveDocs() applied, they need to be checked on top.

Specified by:

scorer in class Weight

Parameters:

context - the LeafReaderContext for which to return the Scorer.

Returns:

a Scorer which scores documents in/out-of order.

Throws:

IOException - if there is a low-level I/O error

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf

scorerSupplier

public ScorerSupplier scorerSupplier(LeafReaderContext context)
                              throws IOException

Description copied from class: Weight

Optional method. Get a ScorerSupplier, which allows to know the cost of the Scorer before building it. The default implementation calls Weight.scorer(org.apache.lucene.index.LeafReaderContext) and builds a ScorerSupplier wrapper around it.

Overrides:

scorerSupplier in class Weight

Throws:

IOException

See Also:

• Weight.scorer(org.apache.lucene.index.LeafReaderContext)