- 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) BooleanQuery
query
(package private) ScoreMode
scoreMode
(package private) Similarity
similarity
The Similarity implementation.(package private) java.util.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
All Methods Static Methods Instance Methods Concrete Methods 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 aBulkScorer
to score the query and send hits to aCollector
.int
count(LeafReaderContext context)
Counts the number of live documents that match a givenWeight.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)
ReturnsMatches
for a specific document, ornull
if the document does not match the parent queryprivate 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 aScorer
which can iterate in order over all matching documents and assign them a score.ScorerSupplier
scorerSupplier(LeafReaderContext context)
Optional method.
-
-
-
Field Detail
-
similarity
final Similarity similarity
The Similarity implementation.
-
query
final BooleanQuery query
-
weightedClauses
final java.util.ArrayList<BooleanWeight.WeightedBooleanClause> weightedClauses
-
scoreMode
final ScoreMode scoreMode
-
-
Constructor Detail
-
BooleanWeight
BooleanWeight(BooleanQuery query, IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
explain
public Explanation explain(LeafReaderContext context, int doc) throws java.io.IOException
Description copied from class:Weight
An explanation of the score computation for the named document.- Specified by:
explain
in classWeight
- Parameters:
context
- the readers context to create theExplanation
for.doc
- the document's id relative to the given context's reader- Returns:
- an Explanation for the score
- Throws:
java.io.IOException
- if anIOException
occurs
-
matches
public Matches matches(LeafReaderContext context, int doc) throws java.io.IOException
Description copied from class:Weight
ReturnsMatches
for a specific document, ornull
if the document does not match the parent queryA query match that contains no position information (for example, a Point or DocValues query) will return
MatchesUtils.MATCH_WITH_NO_TERMS
-
disableScoring
static BulkScorer disableScoring(BulkScorer scorer)
-
optionalBulkScorer
BulkScorer optionalBulkScorer(LeafReaderContext context) throws java.io.IOException
- Throws:
java.io.IOException
-
requiredBulkScorer
private BulkScorer requiredBulkScorer(LeafReaderContext context) throws java.io.IOException
- Throws:
java.io.IOException
-
booleanScorer
BulkScorer booleanScorer(LeafReaderContext context) throws java.io.IOException
Try to build a boolean scorer for this weight. Returns null ifBooleanScorer
cannot be used.- Throws:
java.io.IOException
-
bulkScorer
public BulkScorer bulkScorer(LeafReaderContext context) throws java.io.IOException
Description copied from class:Weight
Optional method, to return aBulkScorer
to score the query and send hits to aCollector
. Only queries that have a different top-level approach need to override this; the default implementation pulls a normalScorer
and iterates and collects the resulting hits which are not marked as deleted.- Overrides:
bulkScorer
in classWeight
- Parameters:
context
- theLeafReaderContext
for which to return theScorer
.- Returns:
- a
BulkScorer
which scores documents and passes them to a collector. - Throws:
java.io.IOException
- if there is a low-level I/O error
-
count
public int count(LeafReaderContext context) throws java.io.IOException
Description copied from class:Weight
Counts the number of live documents that match a givenWeight.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 exampleWe use this property of the function to count hits in
IndexSearcher.count(Query)
.- Overrides:
count
in classWeight
- Parameters:
context
- theLeafReaderContext
for which to return the count.- Returns:
- integer count of the number of matches
- Throws:
java.io.IOException
- if there is a low-level I/O error
-
reqCount
private int reqCount(LeafReaderContext context) throws java.io.IOException
Return the number of matches of required clauses, or -1 if unknown, or numDocs if there are no required clauses.- Throws:
java.io.IOException
-
optCount
private int optCount(LeafReaderContext context, BooleanClause.Occur occur) throws java.io.IOException
Return the number of matches of optional clauses, or -1 if unknown, or 0 if there are no optional clauses.- Throws:
java.io.IOException
-
scorer
public Scorer scorer(LeafReaderContext context) throws java.io.IOException
Description copied from class:Weight
Returns aScorer
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 haveLeafReader.getLiveDocs()
applied, they need to be checked on top.- Specified by:
scorer
in classWeight
- Parameters:
context
- theLeafReaderContext
for which to return theScorer
.- Returns:
- a
Scorer
which scores documents in/out-of order. - Throws:
java.io.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 java.io.IOException
Description copied from class:Weight
Optional method. Get aScorerSupplier
, which allows to know the cost of theScorer
before building it. The default implementation callsWeight.scorer(org.apache.lucene.index.LeafReaderContext)
and builds aScorerSupplier
wrapper around it.- Overrides:
scorerSupplier
in classWeight
- Throws:
java.io.IOException
- See Also:
Weight.scorer(org.apache.lucene.index.LeafReaderContext)
-
-