Package org.apache.lucene.search
Class FilterWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.FilterWeight
-
- All Implemented Interfaces:
SegmentCacheable
public abstract class FilterWeight extends Weight
AFilterWeight
contains anotherWeight
and implements all abstract methods by calling the contained weight's method. Note thatFilterWeight
does not override the non-abstractWeight.bulkScorer(LeafReaderContext)
method and subclasses ofFilterWeight
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 Modifier and Type Field Description protected Weight
in
-
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FilterWeight(Query query, Weight weight)
Alternative constructor.protected
FilterWeight(Weight weight)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Explanation
explain(LeafReaderContext context, int doc)
An explanation of the score computation for the named document.void
extractTerms(Set<Term> terms)
Expert: adds all terms occurring in this query to the terms set.boolean
isCacheable(LeafReaderContext ctx)
Matches
matches(LeafReaderContext context, int doc)
ReturnsMatches
for a specific document, ornull
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 returnMatchesUtils.MATCH_WITH_NO_TERMS
Scorer
scorer(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, getQuery, scorerSupplier
-
-
-
-
Field Detail
-
in
protected final Weight in
-
-
Constructor Detail
-
FilterWeight
protected FilterWeight(Weight weight)
Default constructor.
-
FilterWeight
protected FilterWeight(Query query, Weight weight)
Alternative constructor. Use this variant only if theweight
was not obtained via theQuery.createWeight(IndexSearcher, ScoreMode, float)
method of thequery
object.
-
-
Method Detail
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
true
if the object can be cached against a given leaf
-
extractTerms
public void extractTerms(Set<Term> terms)
Description copied from class:Weight
Expert: adds all terms occurring in this query to the terms set. If theWeight
was created withneedsScores == true
then this method will only extract terms which are used for scoring, otherwise it will extract all terms which are used for matching.- Specified by:
extractTerms
in classWeight
-
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 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
public Scorer scorer(LeafReaderContext context) throws 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:
IOException
- if there is a low-level I/O error
-
matches
public Matches matches(LeafReaderContext context, int doc) throws IOException
Description copied from class:Weight
ReturnsMatches
for a specific document, ornull
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 returnMatchesUtils.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
-
-