## Uses of Class
org.apache.lucene.search.TopFieldDocs

- Packages that use TopFieldDocs
  Package | Description
  --- | ---
  org.apache.lucene.search | Code to search indices.

- - ### Uses of TopFieldDocs in org.apache.lucene.search

    Methods in org.apache.lucene.search that return TopFieldDocs
    Modifier and Type | Method and Description
    --- | ---
    `static TopFieldDocs` | TopDocs.`merge(Sort sort, int start, int topN, TopFieldDocs[] shardHits, boolean setShardIndex)` Same as `TopDocs.merge(Sort, int, TopFieldDocs[])` but also ignores the top `start` top docs.
    `static TopFieldDocs` | TopDocs.`merge(Sort sort, int topN, TopFieldDocs[] shardHits)` Returns a new TopFieldDocs, containing topN results across the provided TopFieldDocs, sorting by the specified `Sort`.
    `TopFieldDocs` | IndexSearcher.`search(Query query, int n, Sort sort)` Search implementation with arbitrary sorting.
    `TopFieldDocs` | IndexSearcher.`search(Query query, int n, Sort sort, boolean doDocScores)` Search implementation with arbitrary sorting, plus control over whether hit scores and max score should be computed.
    `TopFieldDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, int numHits, Sort sort, boolean doDocScores)` Finds the top `n` hits for `query` where all results are after a previous result (`after`), allowing control over whether hit scores and max score should be computed.
    `TopFieldDocs` | TopFieldCollector.`topDocs()`

    Methods in org.apache.lucene.search that return types with arguments of type TopFieldDocs
    Modifier and Type | Method and Description
    --- | ---
    `static CollectorManager<TopFieldCollector,TopFieldDocs>` | TopFieldCollector.`createSharedManager(Sort sort, int numHits, FieldDoc after, int totalHitsThreshold)` Create a CollectorManager which uses a shared hit counter to maintain number of hits and a shared `MaxScoreAccumulator` to propagate the minimum score accross segments if the primary sort is by relevancy.

    Methods in org.apache.lucene.search with parameters of type TopFieldDocs
    Modifier and Type | Method and Description
    --- | ---
    `static TopFieldDocs` | TopDocs.`merge(Sort sort, int start, int topN, TopFieldDocs[] shardHits, boolean setShardIndex)` Same as `TopDocs.merge(Sort, int, TopFieldDocs[])` but also ignores the top `start` top docs.
    `static TopFieldDocs` | TopDocs.`merge(Sort sort, int topN, TopFieldDocs[] shardHits)` Returns a new TopFieldDocs, containing topN results across the provided TopFieldDocs, sorting by the specified `Sort`.

Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.