Class TopSuggestDocs
- java.lang.Object
-
- org.apache.lucene.search.TopDocs
-
- org.apache.lucene.search.suggest.document.TopSuggestDocs
-
public class TopSuggestDocs extends TopDocs
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TopSuggestDocs.SuggestScoreDoc
ScoreDoc
with an additional CharSequence key
-
Field Summary
Fields Modifier and Type Field Description static TopSuggestDocs
EMPTY
Singleton for emptyTopSuggestDocs
-
Constructor Summary
Constructors Constructor Description TopSuggestDocs(TotalHits totalHits, TopSuggestDocs.SuggestScoreDoc[] scoreDocs)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TopSuggestDocs
merge(int topN, TopSuggestDocs[] shardHits)
Returns a new TopSuggestDocs, containing topN results across the provided TopSuggestDocs, sorting by score.TopSuggestDocs.SuggestScoreDoc[]
scoreLookupDocs()
ReturnsTopSuggestDocs.SuggestScoreDoc
s for this instance
-
-
-
Field Detail
-
EMPTY
public static final TopSuggestDocs EMPTY
Singleton for emptyTopSuggestDocs
-
-
Constructor Detail
-
TopSuggestDocs
public TopSuggestDocs(TotalHits totalHits, TopSuggestDocs.SuggestScoreDoc[] scoreDocs)
-
-
Method Detail
-
scoreLookupDocs
public TopSuggestDocs.SuggestScoreDoc[] scoreLookupDocs()
ReturnsTopSuggestDocs.SuggestScoreDoc
s for this instance
-
merge
public static TopSuggestDocs merge(int topN, TopSuggestDocs[] shardHits)
Returns a new TopSuggestDocs, containing topN results across the provided TopSuggestDocs, sorting by score. EachTopSuggestDocs
instance must be sorted. Analogous toTopDocs.merge(int, org.apache.lucene.search.TopDocs[])
forTopSuggestDocs
NOTE: assumes every
shardHit
is already sorted by score
-
-