Class CompletionWeight
- java.lang.Object
-
- org.apache.lucene.search.Weight
-
- org.apache.lucene.search.suggest.document.CompletionWeight
-
- All Implemented Interfaces:
SegmentCacheable
public class CompletionWeight extends Weight
Expert: the Weight for CompletionQuery, used to score and explain these queries.Subclasses can override
setNextMatch(IntsRef)
,boost()
andcontext()
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
Constructors Constructor Description CompletionWeight(CompletionQuery query, Automaton automaton)
Creates a weight forquery
with anautomaton
, using thereader
for index stats
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected float
boost()
Returns the boost of the partial path set bysetNextMatch(IntsRef)
BulkScorer
bulkScorer(LeafReaderContext context)
protected CharSequence
context()
Returns the context of the partial path set bysetNextMatch(IntsRef)
Explanation
explain(LeafReaderContext context, int doc)
Automaton
getAutomaton()
Returns the automaton specified by theCompletionQuery
boolean
isCacheable(LeafReaderContext ctx)
This object can be cachedScorer
scorer(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 Detail
-
CompletionWeight
public CompletionWeight(CompletionQuery query, Automaton automaton) throws IOException
Creates a weight forquery
with anautomaton
, using thereader
for index stats- Throws:
IOException
-
-
Method Detail
-
getAutomaton
public Automaton getAutomaton()
Returns the automaton specified by theCompletionQuery
- Returns:
- query automaton
-
bulkScorer
public BulkScorer bulkScorer(LeafReaderContext context) throws IOException
- Overrides:
bulkScorer
in classWeight
- Throws:
IOException
-
setNextMatch
protected void setNextMatch(IntsRef pathPrefix)
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
protected CharSequence context()
Returns the context of the partial path set bysetNextMatch(IntsRef)
- Returns:
- suggestion context
-
scorer
public Scorer scorer(LeafReaderContext context) throws IOException
- Specified by:
scorer
in classWeight
- Throws:
IOException
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
This object can be cached
-
explain
public Explanation explain(LeafReaderContext context, int doc) throws IOException
- Specified by:
explain
in classWeight
- Throws:
IOException
-
-