Class CompletionWeight
java.lang.Object
org.apache.lucene.search.Weight
org.apache.lucene.search.suggest.document.CompletionWeight
- All Implemented Interfaces:
SegmentCacheable
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.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
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
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)
bulkScorer
(LeafReaderContext context) protected CharSequence
context()
Returns the context of the partial path set bysetNextMatch(IntsRef)
explain
(LeafReaderContext context, int doc) Returns the automaton specified by theCompletionQuery
boolean
This object can be cachedscorer
(LeafReaderContext context) protected void
setNextMatch
(IntsRef pathPrefix) Set for every partial path in the index that matched the query automaton.Methods inherited from class org.apache.lucene.search.Weight
count, getQuery, matches, scorerSupplier
-
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
-
bulkScorer
- Overrides:
bulkScorer
in classWeight
- Throws:
IOException
-
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
-
scorer
- Specified by:
scorer
in classWeight
- Throws:
IOException
-
isCacheable
This object can be cached -
explain
- Specified by:
explain
in classWeight
- Throws:
IOException
-