Class TopDocs

    • Field Detail

      • totalHits

        public TotalHits totalHits
        The total number of hits for the query.
      • scoreDocs

        public ScoreDoc[] scoreDocs
        The top hits for the query.
    • Constructor Detail

      • TopDocs

        public TopDocs​(TotalHits totalHits,
                       ScoreDoc[] scoreDocs)
        Constructs a TopDocs.
    • Method Detail

      • merge

        public static TopDocs merge​(int topN,
                                    TopDocs[] shardHits)
        Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score. Each TopDocs instance must be sorted.
        See Also:
        merge(int, int, TopDocs[])
        WARNING: This API is experimental and might change in incompatible ways in the next release.
      • merge

        public static TopDocs merge​(int start,
                                    int topN,
                                    TopDocs[] shardHits)
        Same as merge(int, TopDocs[]) but also ignores the top start top docs. This is typically useful for pagination.

        docIDs are expected to be in consistent pattern i.e. either all ScoreDocs have their shardIndex set, or all have them as -1 (signifying that all hits belong to same searcher)

        WARNING: This API is experimental and might change in incompatible ways in the next release.
      • merge

        public static TopDocs merge​(int start,
                                    int topN,
                                    TopDocs[] shardHits,
                                    Comparator<ScoreDoc> tieBreaker)
        Same as above, but accepts the passed in tie breaker

        docIDs are expected to be in consistent pattern i.e. either all ScoreDocs have their shardIndex set, or all have them as -1 (signifying that all hits belong to same searcher)

        WARNING: This API is experimental and might change in incompatible ways in the next release.
      • merge

        public static TopFieldDocs merge​(Sort sort,
                                         int start,
                                         int topN,
                                         TopFieldDocs[] shardHits)
        Same as merge(Sort, int, TopFieldDocs[]) but also ignores the top start top docs. This is typically useful for pagination.

        docIDs are expected to be in consistent pattern i.e. either all ScoreDocs have their shardIndex set, or all have them as -1 (signifying that all hits belong to same searcher)

        WARNING: This API is experimental and might change in incompatible ways in the next release.
      • merge

        public static TopFieldDocs merge​(Sort sort,
                                         int start,
                                         int topN,
                                         TopFieldDocs[] shardHits,
                                         Comparator<ScoreDoc> tieBreaker)
        Pass in a custom tie breaker for ordering results
        WARNING: This API is experimental and might change in incompatible ways in the next release.