Package org.apache.lucene.search
Class ConstantScoreWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.ConstantScoreWeight
-
- All Implemented Interfaces:
SegmentCacheable
public abstract class ConstantScoreWeight extends Weight
A Weight that has a constant score equal to the boost of the wrapped query. This is typically useful when building queries which do not produce meaningful scores and are mostly useful for filtering.- 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
Constructors Modifier Constructor Description protected
ConstantScoreWeight(Query query, float score)
-
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.protected float
score()
Return the score produced by thisWeight
.-
Methods inherited from class org.apache.lucene.search.Weight
bulkScorer, getQuery, matches, scorer, scorerSupplier
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.SegmentCacheable
isCacheable
-
-
-
-
Constructor Detail
-
ConstantScoreWeight
protected ConstantScoreWeight(Query query, float score)
-
-
Method Detail
-
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
-
score
protected final float score()
Return the score produced by thisWeight
.
-
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
-
-