Class TopSuggestDocsCollector
- java.lang.Object
-
- org.apache.lucene.search.SimpleCollector
-
- org.apache.lucene.search.suggest.document.TopSuggestDocsCollector
-
- All Implemented Interfaces:
Collector,LeafCollector
public class TopSuggestDocsCollector extends SimpleCollector
Collectorthat collects completion and score, along with document idNon scoring collector that collect completions in order of their pre-computed scores.
NOTE: One document can be collected multiple times if a document is matched for multiple unique completions for a given query
Subclasses should only override
collect(int, CharSequence, CharSequence, float).NOTE:
SimpleCollector.setScorer(org.apache.lucene.search.Scorable)andcollect(int)is not used- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected intdocBaseDocument base offset for the current Leaf
-
Constructor Summary
Constructors Constructor Description TopSuggestDocsCollector(int num, boolean skipDuplicates)Sole constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcollect(int doc)Ignoredvoidcollect(int docID, CharSequence key, CharSequence context, float score)Called for every matched completion, similar toLeafCollector.collect(int)but for completions.protected voiddoSetNextReader(LeafReaderContext context)protected booleandoSkipDuplicates()Returns true if duplicates are filtered outvoidfinish()TopSuggestDocsget()Returns at mostnumTop scoringTopSuggestDocssintgetCountToCollect()Returns the number of results to be collectedScoreModescoreMode()Ignored-
Methods inherited from class org.apache.lucene.search.SimpleCollector
getLeafCollector, setScorer
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.LeafCollector
collect, competitiveIterator
-
-
-
-
Method Detail
-
doSkipDuplicates
protected boolean doSkipDuplicates()
Returns true if duplicates are filtered out
-
getCountToCollect
public int getCountToCollect()
Returns the number of results to be collected
-
doSetNextReader
protected void doSetNextReader(LeafReaderContext context) throws IOException
- Overrides:
doSetNextReaderin classSimpleCollector- Throws:
IOException
-
finish
public void finish() throws IOException- Throws:
IOException
-
collect
public void collect(int docID, CharSequence key, CharSequence context, float score) throws IOExceptionCalled for every matched completion, similar toLeafCollector.collect(int)but for completions.NOTE: collection at the leaf level is guaranteed to be in descending order of score
- Throws:
IOException
-
get
public TopSuggestDocs get() throws IOException
Returns at mostnumTop scoringTopSuggestDocss- Throws:
IOException
-
collect
public void collect(int doc) throws IOExceptionIgnored- Specified by:
collectin interfaceLeafCollector- Specified by:
collectin classSimpleCollector- Throws:
IOException
-
scoreMode
public ScoreMode scoreMode()
Ignored
-
-