Module org.apache.lucene.suggest
Class CompletionWeight
java.lang.Object
org.apache.lucene.search.Weight
org.apache.lucene.search.suggest.document.CompletionWeight
- All Implemented Interfaces:
SegmentCacheable
- Direct Known Subclasses:
ContextQuery.ContextCompletionWeight
,FuzzyCompletionQuery.FuzzyCompletionWeight
Expert: the Weight for CompletionQuery, used to score and explain these queries.
Subclasses can override setNextMatch(IntsRef)
, boost()
and context()
to calculate the boost and extract the context of a matched path prefix.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.Weight
Weight.DefaultBulkScorer, Weight.DefaultScorerSupplier
-
Field Summary
FieldsFields inherited from class org.apache.lucene.search.Weight
parentQuery
-
Constructor Summary
ConstructorsConstructorDescriptionCompletionWeight
(CompletionQuery query, Automaton automaton) Creates a weight forquery
with anautomaton
, using thereader
for index stats -
Method Summary
Modifier and TypeMethodDescriptionprotected float
boost()
Returns the boost of the partial path set bysetNextMatch(IntsRef)
protected CharSequence
context()
Returns the context of the partial path set bysetNextMatch(IntsRef)
explain
(LeafReaderContext context, int doc) An explanation of the score computation for the named document.Returns the automaton specified by theCompletionQuery
boolean
This object can be cachedscorerSupplier
(LeafReaderContext context) Get aScorerSupplier
, which allows knowing the cost of theScorer
before building it.protected void
setNextMatch
(IntsRef pathPrefix) Set for every partial path in the index that matched the query automaton.
-
Field Details
-
completionQuery
-
automaton
-
-
Constructor Details
-
CompletionWeight
Creates a weight forquery
with anautomaton
, using thereader
for index stats- Throws:
IOException
-
-
Method Details
-
getAutomaton
Returns the automaton specified by theCompletionQuery
- Returns:
- query automaton
-
setNextMatch
Set for every partial path in the index that matched the query automaton.Subclasses should override
boost()
andcontext()
to return an appropriate value with respect to the current pathPrefix.- Parameters:
pathPrefix
- the prefix of a matched path
-
boost
protected float boost()Returns the boost of the partial path set bysetNextMatch(IntsRef)
- Returns:
- suggestion query-time boost
-
context
Returns the context of the partial path set bysetNextMatch(IntsRef)
- Returns:
- suggestion context
-
scorerSupplier
Description copied from class:Weight
Get aScorerSupplier
, which allows knowing the cost of theScorer
before building it. A scorer supplier for the sameLeafReaderContext
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 classWeight
- 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:
-
isCacheable
This object can be cached- Returns:
true
if the object can be cached against a given leaf- See Also:
-
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
-