Package org.apache.lucene.search
Class PhraseWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.PhraseWeight
-
- All Implemented Interfaces:
SegmentCacheable
abstract class PhraseWeight 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 (package private) java.lang.String
field
(package private) ScoreMode
scoreMode
(package private) Similarity
similarity
(package private) Similarity.SimScorer
stats
-
Fields inherited from class org.apache.lucene.search.Weight
parentQuery
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
PhraseWeight(Query query, java.lang.String field, IndexSearcher searcher, ScoreMode scoreMode)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Explanation
explain(LeafReaderContext context, int doc)
An explanation of the score computation for the named document.protected abstract PhraseMatcher
getPhraseMatcher(LeafReaderContext context, Similarity.SimScorer scorer, boolean exposeOffsets)
protected abstract Similarity.SimScorer
getStats(IndexSearcher searcher)
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, extractTerms, getQuery, scorerSupplier
-
-
-
-
Field Detail
-
scoreMode
final ScoreMode scoreMode
-
stats
final Similarity.SimScorer stats
-
similarity
final Similarity similarity
-
field
final java.lang.String field
-
-
Constructor Detail
-
PhraseWeight
protected PhraseWeight(Query query, java.lang.String field, IndexSearcher searcher, ScoreMode scoreMode) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
getStats
protected abstract Similarity.SimScorer getStats(IndexSearcher searcher) throws java.io.IOException
- Throws:
java.io.IOException
-
getPhraseMatcher
protected abstract PhraseMatcher getPhraseMatcher(LeafReaderContext context, Similarity.SimScorer scorer, boolean exposeOffsets) throws java.io.IOException
- Throws:
java.io.IOException
-
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
-
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
-
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
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
true
if the object can be cached against a given leaf
-
-