AllGroupHeadsCollectorManager.GroupHeadsResult (Lucene 10.5.0 grouping API)
Description: declaration: package: org.apache.lucene.search.grouping, class: AllGroupHeadsCollectorManager, class: GroupHeadsResult

Package org.apache.lucene.search.grouping

# Class AllGroupHeadsCollectorManager.GroupHeadsResult

java.lang.Object
org.apache.lucene.search.grouping.AllGroupHeadsCollectorManager.GroupHeadsResult

Enclosing class:
  `AllGroupHeadsCollectorManager<T>`

public static class AllGroupHeadsCollectorManager.GroupHeadsResult extends Object
Holds the merged group heads and provides access as an `int[]` or `Bits`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int[]`
  `retrieveGroupHeads()`
  Returns the group head document IDs as an array.
  `Bits`
  `retrieveGroupHeads(int maxDoc)`
  Returns the group head document IDs as a `Bits` set of size `maxDoc`, suitable for use as a filter.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Method Details

  - ### retrieveGroupHeads

    public int[] retrieveGroupHeads()
    Returns the group head document IDs as an array.

  - ### retrieveGroupHeads

    public Bits retrieveGroupHeads(int maxDoc)
    Returns the group head document IDs as a `Bits` set of size `maxDoc`, suitable for use as a filter.
    Parameters:
      `maxDoc` - The maxDoc of the top level `IndexReader`.