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

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

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

  Methods in org.apache.lucene.search.grouping that return GroupingSearch
  Modifier and Type
  Method
  Description
  `GroupingSearch`
  GroupingSearch.`disableCaching()`
  Disables any enabled cache.
  `GroupingSearch`
  GroupingSearch.`setAllGroupHeads(boolean allGroupHeads)`
  Whether to compute all group heads (most relevant document per group) matching the query.
  `GroupingSearch`
  GroupingSearch.`setAllGroups(boolean allGroups)`
  Whether to also compute all groups matching the query.
  `GroupingSearch`
  GroupingSearch.`setCaching(int maxDocsToCache, boolean cacheScores)`
  Enables caching for the second pass search.
  `GroupingSearch`
  GroupingSearch.`setCachingInMB(double maxCacheRAMMB, boolean cacheScores)`
  Enables caching for the second pass search.
  `GroupingSearch`
  GroupingSearch.`setGroupDocsLimit(int groupDocsLimit)`
  Specifies the number of documents to return inside a group from the specified groupDocsOffset.
  `GroupingSearch`
  GroupingSearch.`setGroupDocsOffset(int groupDocsOffset)`
  Specifies the offset for documents inside a group.
  `GroupingSearch`
  GroupingSearch.`setGroupSort(Sort groupSort)`
  Specifies how groups are sorted.
  `GroupingSearch`
  GroupingSearch.`setIgnoreDocsWithoutGroupField(boolean ignoreDocsWithoutGroupField)`
  Whether to ignore documents that don't have the group field instead of putting them in a null group.
  `GroupingSearch`
  GroupingSearch.`setIncludeMaxScore(boolean includeMaxScore)`
  Whether to include the score of the most relevant document per group.
  `GroupingSearch`
  GroupingSearch.`setSortWithinGroup(Sort sortWithinGroup)`
  Specified how documents inside a group are sorted.