# 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
  AllGroupHeadsCollector This collector specializes in collecting the most relevant document (group head) for each group that match the query.
  AllGroupHeadsCollector.GroupHead Represents a group head.
  AllGroupHeadsCollector.TemporalResult Contains the result of group head retrieval.
  AllGroupsCollector A collector that collects all groups that match the query.
  CollectedSearchGroup Expert: representation of a group in `FirstPassGroupingCollector`, tracking the top doc and `FieldComparator` slot.
  DistinctValuesCollector.GroupCount Returned by `DistinctValuesCollector.getGroups()`, representing the value and set of distinct values for the group.
  FirstPassGroupingCollector FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
  GroupDocs Represents one group in the results.
  GroupFacetCollector.FacetEntry Represents a facet entry with a value and a count.
  GroupFacetCollector.GroupedFacetResult The grouped facet result.
  GroupFacetCollector.SegmentResult Contains the local grouped segment counts for a particular segment.
  GroupingSearch Convenience class to perform grouping in a non distributed environment.
  SearchGroup Represents a group that is found during the first pass search.
  SecondPassGroupingCollector SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs.
  SecondPassGroupingCollector.SearchGroupDocs
  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
  AllGroupHeadsCollector This collector specializes in collecting the most relevant document (group head) for each group that match the query.
  AllGroupHeadsCollector.GroupHead Represents a group head.
  AllGroupsCollector A collector that collects all groups that match the query.
  DistinctValuesCollector A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
  DistinctValuesCollector.GroupCount Returned by `DistinctValuesCollector.getGroups()`, representing the value and set of distinct values for the group.
  FirstPassGroupingCollector FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
  Grouper A factory object to create first and second-pass collectors, run by a `GroupingSearch`
  SearchGroup Represents a group that is found during the first pass search.
  SecondPassGroupingCollector SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs.
  SecondPassGroupingCollector.SearchGroupDocs

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

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