java.lang.Object
org.apache.lucene.search.Weight
org.apache.lucene.search.BooleanWeight
- All Implemented Interfaces:
SegmentCacheable
Expert: the Weight for BooleanQuery, used to normalize, score and explain these queries.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.apache.lucene.search.Weight
Weight.DefaultBulkScorer, Weight.DefaultScorerSupplier
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final BooleanQuery
(package private) final ScoreMode
(package private) final Similarity
The Similarity implementation.(package private) final ArrayList
<BooleanWeight.WeightedBooleanClause> Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
Constructor Summary
ConstructorsConstructorDescriptionBooleanWeight
(BooleanQuery query, IndexSearcher searcher, ScoreMode scoreMode, float boost) -
Method Summary
Modifier and TypeMethodDescriptionint
count
(LeafReaderContext context) Counts the number of live documents that match a givenWeight.parentQuery
in a leaf.explain
(LeafReaderContext context, int doc) An explanation of the score computation for the named document.boolean
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.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.scorerSupplier
(LeafReaderContext context) Get aScorerSupplier
, which allows knowing the cost of theScorer
before building it.Methods inherited from class org.apache.lucene.search.Weight
bulkScorer, getQuery, scorer
-
Field Details
-
similarity
The Similarity implementation. -
query
-
weightedClauses
-
scoreMode
-
-
Constructor Details
-
BooleanWeight
BooleanWeight(BooleanQuery query, IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException - Throws:
IOException
-
-
Method Details
-
explain
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:
IOException
- if anIOException
occurs
-
matches
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
- Overrides:
matches
in classWeight
- Parameters:
context
- the reader's context to create theMatches
fordoc
- the document's id relative to the given context's reader- Throws:
IOException
-
count
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:
IOException
- if there is a low-level I/O error
-
reqCount
Return the number of matches of required clauses, or -1 if unknown, or numDocs if there are no required clauses.- Throws:
IOException
-
optCount
Return the number of matches of optional clauses, or -1 if unknown, or 0 if there are no optional clauses.- Throws:
IOException
-
isCacheable
- Returns:
true
if the object can be cached against a given leaf
-
scorerSupplier
Description copied from class:Weight
Get aScorerSupplier
, which allows knowing the cost of theScorer
before building it. A scorer supplier for the sameLeafReaderContext
instance may be requested multiple times as part of a single search call.Note: It must return null if the scorer is null.
- Specified by:
scorerSupplier
in classWeight
- Parameters:
context
- the leaf reader context- Returns:
- a
ScorerSupplier
providing the scorer, or null if scorer is null - Throws:
IOException
- if an IOException occurs- See Also:
-