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, Weight.DefaultScorerSupplier -
Field Summary
Fields inherited from class org.apache.lucene.search.Weight
parentQuery -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPhraseWeight(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 PhraseMatchergetPhraseMatcher(LeafReaderContext context, Similarity.SimScorer scorer, boolean exposeOffsets) protected abstract Similarity.SimScorergetStats(IndexSearcher searcher) booleanmatches(LeafReaderContext context, int doc) ReturnsMatchesfor a specific document, ornullif the document does not match the parent queryscorerSupplier(LeafReaderContext context) Get aScorerSupplier, which allows knowing the cost of theScorerbefore building it.Methods inherited from class org.apache.lucene.search.Weight
bulkScorer, count, getQuery, scorer
-
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
-
scorerSupplier
Description copied from class:WeightGet aScorerSupplier, which allows knowing the cost of theScorerbefore building it. A scorer supplier for the sameLeafReaderContextinstance may be requested multiple times as part of a single search call.Note: It must return null if the scorer is null.
- Specified by:
scorerSupplierin classWeight- Parameters:
context- the leaf reader context- Returns:
- a
ScorerSupplierproviding the scorer, or null if scorer is null - Throws:
IOException- if an IOException occurs- See Also:
-
explain
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
-
matches
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
-
isCacheable
- Returns:
trueif the object can be cached against a given leaf
-