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

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

    Subclasses of SearchGroup in org.apache.lucene.search.grouping
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CollectedSearchGroup<T>` Expert: representation of a group in `FirstPassGroupingCollector`, tracking the top doc and `FieldComparator` slot.

    Fields in org.apache.lucene.search.grouping with type parameters of type SearchGroup
    Modifier and Type | Field and Description
    --- | ---
    `protected Collection<SearchGroup<T>>` | SecondPassGroupingCollector.`groups`

    Methods in org.apache.lucene.search.grouping that return types with arguments of type SearchGroup
    Modifier and Type | Method and Description
    --- | ---
    `Collection<SearchGroup<T>>` | FirstPassGroupingCollector.`getTopGroups(int groupOffset, boolean fillFields)` Returns top groups, starting from offset.
    `static <T> Collection<SearchGroup<T>>` | SearchGroup.`merge(List<Collection<SearchGroup<T>>> topGroups, int offset, int topN, Sort groupSort)` Merges multiple collections of top groups, for example obtained from separate index shards.

    Method parameters in org.apache.lucene.search.grouping with type arguments of type SearchGroup
    Modifier and Type | Method and Description
    --- | ---
    `static <T> Collection<SearchGroup<T>>` | SearchGroup.`merge(List<Collection<SearchGroup<T>>> topGroups, int offset, int topN, Sort groupSort)` Merges multiple collections of top groups, for example obtained from separate index shards.
    `void` | TermGroupSelector.`setGroups(Collection<SearchGroup<BytesRef>> searchGroups)`
    `void` | ValueSourceGroupSelector.`setGroups(Collection<SearchGroup<MutableValue>> searchGroups)`
    `abstract void` | GroupSelector.`setGroups(Collection<SearchGroup<T>> groups)` Set a restriction on the group values returned by this selector If the selector is positioned on a document whose group value is not contained within this set, then `GroupSelector.advanceTo(int)` will return `GroupSelector.State.SKIP`
    `void` | GroupReducer.`setGroups(Collection<SearchGroup<T>> groups)` Define which groups should be reduced.

    Constructor parameters in org.apache.lucene.search.grouping with type arguments of type SearchGroup
    Constructor and Description
    `DistinctValuesCollector(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, GroupSelector<R> valueSelector)` Create a DistinctValuesCollector
    `SecondPassGroupingCollector(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, GroupReducer<T,?> reducer)` Create a new SecondPassGroupingCollector
    `TopGroupsCollector(GroupSelector<T> groupSelector, Collection<SearchGroup<T>> groups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, boolean getScores, boolean getMaxScores, boolean fillSortFields)` Create a new TopGroupsCollector

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