public class TopDocs extends Object
IndexSearcher.search(Query,int)
.Modifier and Type | Field and Description |
---|---|
ScoreDoc[] |
scoreDocs
The top hits for the query.
|
int |
totalHits
The total number of hits for the query.
|
Constructor and Description |
---|
TopDocs(int totalHits,
ScoreDoc[] scoreDocs,
float maxScore) |
Modifier and Type | Method and Description |
---|---|
float |
getMaxScore()
Returns the maximum score value encountered.
|
static TopDocs |
merge(int start,
int topN,
TopDocs[] shardHits,
boolean setShardIndex)
Same as
merge(int, TopDocs[]) but also ignores the top
start top docs. |
static TopDocs |
merge(int topN,
TopDocs[] shardHits)
Returns a new TopDocs, containing topN results across
the provided TopDocs, sorting by score.
|
static TopFieldDocs |
merge(Sort sort,
int start,
int topN,
TopFieldDocs[] shardHits,
boolean setShardIndex)
Same as
merge(Sort, int, TopFieldDocs[]) but also ignores the top
start top docs. |
static TopFieldDocs |
merge(Sort sort,
int topN,
TopFieldDocs[] shardHits)
Returns a new TopFieldDocs, containing topN results across
the provided TopFieldDocs, sorting by the specified
Sort . |
void |
setMaxScore(float maxScore)
Sets the maximum score value encountered.
|
public int totalHits
public ScoreDoc[] scoreDocs
public TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore)
public float getMaxScore()
Float.NaN
.public void setMaxScore(float maxScore)
public static TopDocs merge(int topN, TopDocs[] shardHits)
TopDocs
instance must be sorted.merge(int, int, TopDocs[], boolean)
public static TopDocs merge(int start, int topN, TopDocs[] shardHits, boolean setShardIndex)
merge(int, TopDocs[])
but also ignores the top
start
top docs. This is typically useful for pagination.
Note: If setShardIndex
is true, this method will assume the incoming order of shardHits
reflects
each shard's index and will fill the ScoreDoc.shardIndex
, otherwise
it must already be set for all incoming ScoreDoc
s, which can be useful when doing multiple reductions
(merges) of TopDocs.public static TopFieldDocs merge(Sort sort, int topN, TopFieldDocs[] shardHits)
Sort
. Each of the TopDocs must have been sorted by
the same Sort, and sort field values must have been
filled (ie, fillFields=true
must be
passed to TopFieldCollector.create(org.apache.lucene.search.Sort, int, boolean, boolean, boolean)
).merge(Sort, int, int, TopFieldDocs[], boolean)
public static TopFieldDocs merge(Sort sort, int start, int topN, TopFieldDocs[] shardHits, boolean setShardIndex)
merge(Sort, int, TopFieldDocs[])
but also ignores the top
start
top docs. This is typically useful for pagination.
Note: If setShardIndex
is true, this method will assume the incoming order of shardHits
reflects
each shard's index and will fill the ScoreDoc.shardIndex
, otherwise
it must already be set for all incoming ScoreDoc
s, which can be useful when doing multiple reductions
(merges) of TopDocs.Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.