Package org.apache.lucene.search
Class PhraseWeight
java.lang.Object
org.apache.lucene.search.Weight
org.apache.lucene.search.PhraseWeight
- All Implemented Interfaces:
SegmentCacheable
Expert: Weight class for phrase matching
-
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
ModifierConstructorDescriptionprotected
PhraseWeight
(Query query, String field, IndexSearcher searcher, ScoreMode scoreMode) Expert: Creates PhraseWeight instance -
Method Summary
Modifier and TypeMethodDescriptionexplain
(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
matches
(LeafReaderContext context, int doc) ReturnsMatches
for a specific document, ornull
if the document does not match the parent queryscorer
(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, count, getQuery, scorerSupplier
-
Constructor Details
-
PhraseWeight
protected PhraseWeight(Query query, String field, IndexSearcher searcher, ScoreMode scoreMode) throws IOException Expert: Creates PhraseWeight instance- Throws:
IOException
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Method Details
-
getStats
- Throws:
IOException
-
getPhraseMatcher
protected abstract PhraseMatcher getPhraseMatcher(LeafReaderContext context, Similarity.SimScorer scorer, boolean exposeOffsets) throws IOException - Throws:
IOException
-
scorer
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
-
explain
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
-
matches
Description copied from class:Weight
ReturnsMatches
for a specific document, ornull
if 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:
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
-
isCacheable
- Returns:
true
if the object can be cached against a given leaf
-