Uses of Class org.apache.lucene.search.grouping.TopGroups (Lucene 10.5.1 grouping API)
Description: use: package: org.apache.lucene.search.grouping, class: TopGroups

# Uses of Class
org.apache.lucene.search.grouping.TopGroups

- ## Uses of TopGroups in org.apache.lucene.search.grouping

  Methods in org.apache.lucene.search.grouping that return TopGroups
  Modifier and Type
  Method
  Description
  `TopGroups<?>`
  BlockGroupingCollector.`getTopGroups(Sort withinGroupSort, int groupOffset, int withinGroupOffset, int maxDocsPerGroup)`
  Returns the grouped results.
  `TopGroups<T>`
  TopGroupsCollector.`getTopGroups(int withinGroupOffset)`
  Get the TopGroups recorded by this collector
  `protected <T> TopGroups<T>`
  GroupingSearch.`groupByDocBlock(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)`
  `protected TopGroups`
  GroupingSearch.`groupByFieldOrFunction(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)`
  `static <T> TopGroups<T>`
  TopGroups.`merge(TopGroups<T>[] shardGroups, Sort groupSort, Sort docSort, int docOffset, int docTopN, TopGroups.ScoreMergeMode scoreMergeMode)`
  Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.
  `static <T> TopGroups<T>`
  TopGroups.`mergeBlockGroups(List<TopGroups<T>> shardGroups, Sort groupSort, int groupOffset, int topNGroups, Sort docSort)`
  Merge TopGroups that are partitioned into blocks per shard.
  `TopGroups<T>`
  BlockGroupingCollectorManager.`reduce(Collection<BlockGroupingCollector> collectors)`
  `TopGroups<T>`
  TopGroupsCollectorManager.`reduce(Collection<TopGroupsCollector<T>> collectors)`
  `<T> TopGroups<T>`
  GroupingSearch.`search(IndexSearcher searcher, Query query, int groupOffset, int groupLimit)`
  Executes a grouped search.
  Methods in org.apache.lucene.search.grouping with parameters of type TopGroups
  Modifier and Type
  Method
  Description
  `static <T> TopGroups<T>`
  TopGroups.`merge(TopGroups<T>[] shardGroups, Sort groupSort, Sort docSort, int docOffset, int docTopN, TopGroups.ScoreMergeMode scoreMergeMode)`
  Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.
  Method parameters in org.apache.lucene.search.grouping with type arguments of type TopGroups
  Modifier and Type
  Method
  Description
  `static <T> TopGroups<T>`
  TopGroups.`mergeBlockGroups(List<TopGroups<T>> shardGroups, Sort groupSort, int groupOffset, int topNGroups, Sort docSort)`
  Merge TopGroups that are partitioned into blocks per shard.
  Constructors in org.apache.lucene.search.grouping with parameters of type TopGroups
  Modifier
  Constructor
  Description
  ``
  `TopGroups(TopGroups<T> oldTopGroups, Integer totalGroupCount)`