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
AFilterWeightcontains anotherWeightand implements all abstract methods by calling the contained weight's method.Note that
FilterWeightdoes not override the non-abstractWeight.bulkScorer(LeafReaderContext)method and subclasses ofFilterWeightmust 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 Weightin-
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFilterWeight(Query query, Weight weight)Alternative constructor.protectedFilterWeight(Weight weight)Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Explanationexplain(LeafReaderContext context, int doc)An explanation of the score computation for the named document.booleanisCacheable(LeafReaderContext ctx)Matchesmatches(LeafReaderContext context, int doc)ReturnsMatchesfor a specific document, ornullif the document does not match the parent queryScorerscorer(LeafReaderContext context)Returns aScorerwhich 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 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 theweightwas not obtained via theQuery.createWeight(IndexSearcher, ScoreMode, float)method of thequeryobject.
-
-
Method Detail
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
trueif the object can be cached against a given leaf
-
explain
public Explanation explain(LeafReaderContext context, int doc) throws IOException
Description copied from class:WeightAn explanation of the score computation for the named document.- Specified by:
explainin classWeight- Parameters:
context- the readers context to create theExplanationfor.doc- the document's id relative to the given context's reader- Returns:
- an Explanation for the score
- Throws:
IOException- if anIOExceptionoccurs
-
scorer
public Scorer scorer(LeafReaderContext context) throws IOException
Description copied from class:WeightReturns aScorerwhich 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
Scorerdoes not haveLeafReader.getLiveDocs()applied, they need to be checked on top.- Specified by:
scorerin classWeight- Parameters:
context- theLeafReaderContextfor which to return theScorer.- Returns:
- a
Scorerwhich 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:WeightReturnsMatchesfor a specific document, ornullif 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:
matchesin classWeight- Parameters:
context- the reader's context to create theMatchesfordoc- the document's id relative to the given context's reader- Throws:
IOException
-
-