Module org.apache.lucene.core

Package org.apache.lucene.search

Class BooleanScorerSupplier

java.lang.Object

org.apache.lucene.search.ScorerSupplier

org.apache.lucene.search.BooleanScorerSupplier

final class BooleanScorerSupplier
extends ScorerSupplier

Field Summary

Fields

Modifier and Type	Field	Description
private long	cost
private final int	maxDoc
private final int	minShouldMatch
private final ScoreMode	scoreMode
private final Map<BooleanClause.Occur,Collection<ScorerSupplier>>	subs
private boolean	topLevelScoringClause

Constructor Summary

Constructors

Constructor	Description
BooleanScorerSupplier(Weight weight, Map<BooleanClause.Occur,Collection<ScorerSupplier>> subs, ScoreMode scoreMode, int minShouldMatch, int maxDoc)

Method Summary

Modifier and Type	Method	Description
(package private) BulkScorer	booleanScorer()
BulkScorer	bulkScorer()	Optional method: Get a scorer that is optimized for bulk-scoring.
private long	computeCost()
long	cost()	Get an estimate of the Scorer that would be returned by ScorerSupplier.get(long).
(package private) static BulkScorer	disableScoring(BulkScorer scorer)
private Scorer	excl(Scorer main, Collection<ScorerSupplier> prohibited, long leadCost)
(package private) BulkScorer	filteredOptionalBulkScorer()
Scorer	get(long leadCost)	Get the Scorer.
private Scorer	getInternal(long leadCost)
private Scorer	opt(Collection<ScorerSupplier> optional, int minShouldMatch, ScoreMode scoreMode, long leadCost, boolean topLevelScoringClause)
(package private) BulkScorer	optionalBulkScorer()
private Scorer	req(Collection<ScorerSupplier> requiredNoScoring, Collection<ScorerSupplier> requiredScoring, long leadCost, boolean topLevelScoringClause)	Create a new scorer for the given required clauses.
private BulkScorer	requiredBulkScorer()
void	setTopLevelScoringClause()	Inform this ScorerSupplier that its returned scorers produce scores that get passed to the collector, as opposed to partial scores that then need to get combined (e.g.

Methods inherited from class java.lang.Object

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

Field Details

subs

private final Map<BooleanClause.Occur,Collection<ScorerSupplier>> subs

scoreMode

private final ScoreMode scoreMode

minShouldMatch

private final int minShouldMatch

maxDoc

private final int maxDoc

cost

private long cost

topLevelScoringClause

private boolean topLevelScoringClause

Constructor Details

BooleanScorerSupplier

BooleanScorerSupplier(Weight weight,
 Map<BooleanClause.Occur,Collection<ScorerSupplier>> subs,
 ScoreMode scoreMode,
 int minShouldMatch,
 int maxDoc)

Method Details

computeCost

private long computeCost()

setTopLevelScoringClause

public void setTopLevelScoringClause()
                              throws IOException

Description copied from class: ScorerSupplier

Inform this ScorerSupplier that its returned scorers produce scores that get passed to the collector, as opposed to partial scores that then need to get combined (e.g. summed up). Note that this method also gets called if scores are not requested, e.g. because the score mode is ScoreMode.COMPLETE_NO_SCORES, so implementations should look at both the score mode and this boolean to know whether to prepare for reacting to Scorable.setMinCompetitiveScore(float) calls.

Overrides:

setTopLevelScoringClause in class ScorerSupplier

Throws:

IOException

cost

public long cost()

Description copied from class: ScorerSupplier

Get an estimate of the Scorer that would be returned by ScorerSupplier.get(long). This may be a costly operation, so it should only be called if necessary.

Specified by:

cost in class ScorerSupplier

See Also:

• DocIdSetIterator.cost()

get

public Scorer get(long leadCost)
           throws IOException

Description copied from class: ScorerSupplier

Get the Scorer. This may not return null and must be called at most once.

Specified by:

get in class ScorerSupplier

Parameters:

leadCost - Cost of the scorer that will be used in order to lead iteration. This can be interpreted as an upper bound of the number of times that DocIdSetIterator.nextDoc(), DocIdSetIterator.advance(int) and TwoPhaseIterator.matches() will be called. Under doubt, pass Long.MAX_VALUE, which will produce a Scorer that has good iteration capabilities.

Throws:

IOException

getInternal

private Scorer getInternal(long leadCost)
                    throws IOException

Throws:

IOException

bulkScorer

public BulkScorer bulkScorer()
                      throws IOException

Description copied from class: ScorerSupplier

Optional method: Get a scorer that is optimized for bulk-scoring. The default implementation iterates matches from the Scorer but some queries can have more efficient approaches for matching all hits.

Overrides:

bulkScorer in class ScorerSupplier

Throws:

IOException

booleanScorer

BulkScorer booleanScorer()
                  throws IOException

Throws:

IOException

disableScoring

static BulkScorer disableScoring(BulkScorer scorer)

optionalBulkScorer

BulkScorer optionalBulkScorer()
                       throws IOException

Throws:

IOException

filteredOptionalBulkScorer

BulkScorer filteredOptionalBulkScorer()
                               throws IOException

Throws:

IOException

requiredBulkScorer

private BulkScorer requiredBulkScorer()
                               throws IOException

Throws:

IOException

req

private Scorer req(Collection<ScorerSupplier> requiredNoScoring,
 Collection<ScorerSupplier> requiredScoring,
 long leadCost,
 boolean topLevelScoringClause)
            throws IOException

Create a new scorer for the given required clauses. Note that requiredScoring is a subset of required containing required clauses that should participate in scoring.

Throws:

IOException

excl

private Scorer excl(Scorer main,
 Collection<ScorerSupplier> prohibited,
 long leadCost)
             throws IOException

Throws:

IOException

opt

private Scorer opt(Collection<ScorerSupplier> optional,
 int minShouldMatch,
 ScoreMode scoreMode,
 long leadCost,
 boolean topLevelScoringClause)
            throws IOException

Throws:

IOException