Package org.apache.lucene.search
Class PhraseWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.PhraseWeight
-
- All Implemented Interfaces:
SegmentCacheable
public abstract class PhraseWeight extends Weight
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
Constructors Modifier Constructor Description protectedPhraseWeight(Query query, String field, IndexSearcher searcher, ScoreMode scoreMode)Expert: Creates PhraseWeight instance
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Explanationexplain(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)booleanisCacheable(LeafReaderContext ctx)Matchesmatches(LeafReaderContext context, int doc)ReturnsMatchesfor a specific document, ornullif the document does not match the parent queryScorerscorer(LeafReaderContext context)Returns aScorerwhich 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 Detail
-
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 Detail
-
getStats
protected abstract Similarity.SimScorer getStats(IndexSearcher searcher) throws IOException
- Throws:
IOException
-
getPhraseMatcher
protected abstract PhraseMatcher getPhraseMatcher(LeafReaderContext context, Similarity.SimScorer scorer, boolean exposeOffsets) throws IOException
- Throws:
IOException
-
scorer
public Scorer scorer(LeafReaderContext context) throws IOException
Description copied from class:WeightReturns aScorerwhich 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
Scorerdoes not haveLeafReader.getLiveDocs()applied, they need to be checked on top.- Specified by:
scorerin classWeight- Parameters:
context- theLeafReaderContextfor which to return theScorer.- Returns:
- a
Scorerwhich scores documents in/out-of order. - Throws:
IOException- if there is a low-level I/O error
-
explain
public Explanation explain(LeafReaderContext context, int doc) throws IOException
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
public Matches matches(LeafReaderContext context, int doc) throws IOException
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
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
trueif the object can be cached against a given leaf
-
-