Package org.apache.lucene.search
Class BM25FQuery.BM25FWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.BM25FQuery.BM25FWeight
-
- All Implemented Interfaces:
SegmentCacheable
- Enclosing class:
- BM25FQuery
class BM25FQuery.BM25FWeight extends Weight
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Weight
Weight.DefaultBulkScorer
-
-
Field Summary
Fields Modifier and Type Field Description private IndexSearcher
searcher
private Similarity.SimScorer
simWeight
private TermStates[]
termStates
-
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
-
Constructor Summary
Constructors Constructor Description BM25FWeight(Query query, IndexSearcher searcher, ScoreMode scoreMode, float boost)
-
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(java.util.Set<Term> termSet)
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
private CollectionStatistics
mergeCollectionStatistics(IndexSearcher searcher)
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
-
searcher
private final IndexSearcher searcher
-
termStates
private final TermStates[] termStates
-
simWeight
private final Similarity.SimScorer simWeight
-
-
Constructor Detail
-
BM25FWeight
BM25FWeight(Query query, IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
mergeCollectionStatistics
private CollectionStatistics mergeCollectionStatistics(IndexSearcher searcher) throws java.io.IOException
- Throws:
java.io.IOException
-
extractTerms
public void extractTerms(java.util.Set<Term> termSet)
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
-
matches
public Matches matches(LeafReaderContext context, int doc) throws java.io.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
-
explain
public Explanation explain(LeafReaderContext context, int doc) throws java.io.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:
java.io.IOException
- if anIOException
occurs
-
scorer
public Scorer scorer(LeafReaderContext context) throws java.io.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:
java.io.IOException
- if there is a low-level I/O error
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
true
if the object can be cached against a given leaf
-
-