Package org.apache.lucene.search
Class FilterWeight
java.lang.Object
org.apache.lucene.search.Weight
org.apache.lucene.search.FilterWeight
- All Implemented Interfaces:
SegmentCacheable
A
FilterWeight
contains another Weight
and implements all abstract methods by
calling the contained weight's method.
Note that FilterWeight
does not override the non-abstract Weight.bulkScorer(LeafReaderContext)
method and subclasses of FilterWeight
must provide
their bulkScorer implementation if required.
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.Weight
Weight.DefaultBulkScorer
-
Field Summary
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
Constructor Summary
ModifierConstructorDescriptionprotected
FilterWeight
(Query query, Weight weight) Alternative constructor.protected
FilterWeight
(Weight weight) Default constructor. -
Method Summary
Modifier and TypeMethodDescriptionexplain
(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 queryscorer
(LeafReaderContext context) Returns aScorer
which can iterate in order over all matching documents and assign them a score.Methods inherited from class org.apache.lucene.search.Weight
bulkScorer, count, getQuery, scorerSupplier
-
Field Details
-
in
-
-
Constructor Details
-
FilterWeight
Default constructor. -
FilterWeight
Alternative constructor. Use this variant only if theweight
was not obtained via theQuery.createWeight(IndexSearcher, ScoreMode, float)
method of thequery
object.
-
-
Method Details
-
isCacheable
- Returns:
true
if the object can be cached against a given leaf
-
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
-
scorer
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:
IOException
- if there is a low-level I/O error
-
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
-