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, Weight.DefaultScorerSupplier

Field Summary

Fields inherited from class org.apache.lucene.search.Weight

parentQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PhraseWeight(Query query, String field, IndexSearcher searcher, ScoreMode scoreMode)	Expert: Creates PhraseWeight instance

Method Summary

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)	Returns Matches for a specific document, or null if the document does not match the parent query
ScorerSupplier	scorerSupplier(LeafReaderContext context)	Get a ScorerSupplier, which allows knowing the cost of the Scorer before building it.

Methods inherited from class org.apache.lucene.search.Weight

bulkScorer, count, getQuery, scorer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

scorerSupplier

public ScorerSupplier scorerSupplier(LeafReaderContext context)
                              throws IOException

Description copied from class: Weight

Get a ScorerSupplier, which allows knowing the cost of the Scorer before building it. A scorer supplier for the same LeafReaderContext instance may be requested multiple times as part of a single search call.

Note: It must return null if the scorer is null.

Specified by:

scorerSupplier in class Weight

Parameters:

context - the leaf reader context

Returns:

a ScorerSupplier providing the scorer, or null if scorer is null

Throws:

IOException - if an IOException occurs

See Also:

• Scorer
• Weight.DefaultScorerSupplier

explain

public Explanation explain(LeafReaderContext context,
 int doc)
                    throws IOException

Description copied from class: Weight

An explanation of the score computation for the named document.

Specified by:

explain in class Weight

Parameters:

context - the readers context to create the Explanation for.

doc - the document's id relative to the given context's reader

Returns:

an Explanation for the score

Throws:

IOException - if an IOException occurs

matches

public Matches matches(LeafReaderContext context,
 int doc)
                throws IOException

Description copied from class: Weight

Returns Matches for a specific document, or null 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 return MatchesUtils.MATCH_WITH_NO_TERMS

Overrides:

matches in class Weight

Parameters:

context - the reader's context to create the Matches for

doc - the document's id relative to the given context's reader

Throws:

IOException

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf