# Uses of Package
org.apache.lucene.search.grouping

- Packages that use org.apache.lucene.search.grouping
  Package | Description
  --- | ---
  org.apache.lucene.search.grouping | Grouping.
  org.apache.lucene.search.grouping.function | Support for grouping by `ValueSource`.
  org.apache.lucene.search.grouping.term | Support for grouping by indexed terms via `DocValues`.

- Classes in org.apache.lucene.search.grouping used by org.apache.lucene.search.grouping
  Class and Description
  AbstractAllGroupHeadsCollector.GroupHead Represents a group head.
  AbstractAllGroupHeadsCollector.TemporalResult Contains the result of group head retrieval.
  AbstractDistinctValuesCollector.GroupCount Returned by `AbstractDistinctValuesCollector.getGroups()`, representing the value and set of distinct values for the group.
  AbstractGroupFacetCollector.FacetEntry Represents a facet entry with a value and a count.
  AbstractGroupFacetCollector.GroupedFacetResult The grouped facet result.
  AbstractGroupFacetCollector.SegmentResult Contains the local grouped segment counts for a particular segment.
  AbstractSecondPassGroupingCollector.SearchGroupDocs
  CollectedSearchGroup Expert: representation of a group in `AbstractFirstPassGroupingCollector`, tracking the top doc and `FieldComparator` slot.
  GroupDocs Represents one group in the results.
  GroupingSearch Convenience class to perform grouping in a non distributed environment.
  SearchGroup Represents a group that is found during the first pass search.
  TopGroups Represents result returned by a grouping search.
  TopGroups.ScoreMergeMode How the GroupDocs score (if any) should be merged.

- Classes in org.apache.lucene.search.grouping used by org.apache.lucene.search.grouping.function
  Class and Description
  AbstractAllGroupHeadsCollector This collector specializes in collecting the most relevant document (group head) for each group that match the query.
  AbstractAllGroupHeadsCollector.GroupHead Represents a group head.
  AbstractAllGroupsCollector A collector that collects all groups that match the query.
  AbstractDistinctValuesCollector A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
  AbstractDistinctValuesCollector.GroupCount Returned by `AbstractDistinctValuesCollector.getGroups()`, representing the value and set of distinct values for the group.
  AbstractFirstPassGroupingCollector FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
  AbstractSecondPassGroupingCollector SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs.
  AbstractSecondPassGroupingCollector.SearchGroupDocs
  SearchGroup Represents a group that is found during the first pass search.

- Classes in org.apache.lucene.search.grouping used by org.apache.lucene.search.grouping.term
  Class and Description
  AbstractAllGroupHeadsCollector This collector specializes in collecting the most relevant document (group head) for each group that match the query.
  AbstractAllGroupHeadsCollector.GroupHead Represents a group head.
  AbstractAllGroupsCollector A collector that collects all groups that match the query.
  AbstractDistinctValuesCollector A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
  AbstractDistinctValuesCollector.GroupCount Returned by `AbstractDistinctValuesCollector.getGroups()`, representing the value and set of distinct values for the group.
  AbstractFirstPassGroupingCollector FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
  AbstractGroupFacetCollector Base class for computing grouped facets.
  AbstractSecondPassGroupingCollector SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs.
  AbstractSecondPassGroupingCollector.SearchGroupDocs
  SearchGroup Represents a group that is found during the first pass search.

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