Index (Lucene 10.5.1 grouping API)

# Index

A B C D E F G H L M N O R S T U V W
All Classes and Interfaces|All Packages

## A

ACCEPT - Enum constant in enum class org.apache.lucene.search.grouping.GroupSelector.State
addFacetCount(BytesRef, int) - Method in class org.apache.lucene.search.grouping.GroupFacetCollector.GroupedFacetResult
advanceTo(int) - Method in class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
advanceTo(int) - Method in class org.apache.lucene.search.grouping.GroupSelector
  Advance the GroupSelector's iterator to the given document
advanceTo(int) - Method in class org.apache.lucene.search.grouping.LongRangeGroupSelector
advanceTo(int) - Method in class org.apache.lucene.search.grouping.TermGroupSelector
advanceTo(int) - Method in class org.apache.lucene.search.grouping.ValueSourceGroupSelector
AllGroupHeadsCollector<T> - Class in org.apache.lucene.search.grouping
  This collector specializes in collecting the most relevant document (group head) for each group that matches the query.
AllGroupHeadsCollector.GroupHead<T> - Class in org.apache.lucene.search.grouping
  Represents a group head.
AllGroupHeadsCollectorManager<T> - Class in org.apache.lucene.search.grouping
  A `CollectorManager` implementation for `AllGroupHeadsCollector` that collects the most relevant document (group head) for each group across multiple segments and merges the per-segment results into a single `AllGroupHeadsCollectorManager.GroupHeadsResult`.
AllGroupHeadsCollectorManager(Supplier<GroupSelector<T>>, Sort) - Constructor for class org.apache.lucene.search.grouping.AllGroupHeadsCollectorManager
  Creates a new AllGroupHeadsCollectorManager.
AllGroupHeadsCollectorManager.GroupHeadsResult - Class in org.apache.lucene.search.grouping
  Holds the merged group heads and provides access as an `int[]` or `Bits`.
AllGroupsCollector<T> - Class in org.apache.lucene.search.grouping
  A collector that collects all groups that match the query.
AllGroupsCollector(GroupSelector<T>) - Constructor for class org.apache.lucene.search.grouping.AllGroupsCollector
  Create a new AllGroupsCollector
AllGroupsCollectorManager<T> - Class in org.apache.lucene.search.grouping
  A CollectorManager implementation for AllGroupsCollector.
AllGroupsCollectorManager(Supplier<GroupSelector<T>>) - Constructor for class org.apache.lucene.search.grouping.AllGroupsCollectorManager
  Creates a new AllGroupsCollectorManager.
Avg - Enum constant in enum class org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode

## B

BlockGroupingCollector - Class in org.apache.lucene.search.grouping
  BlockGroupingCollector performs grouping with a single pass collector, as long as you are grouping by a doc block field, ie all documents sharing a given group value were indexed as a doc block using the atomic `IndexWriter.addDocuments()` or `IndexWriter.updateDocuments()` API.
BlockGroupingCollector(Sort, int, boolean, Weight) - Constructor for class org.apache.lucene.search.grouping.BlockGroupingCollector
  Create the single pass collector.
BlockGroupingCollectorManager<T> - Class in org.apache.lucene.search.grouping
  A `CollectorManager` for `BlockGroupingCollector` that merges results from multiple collectors into a single `TopGroups`.
BlockGroupingCollectorManager(Sort, int, int, boolean, Weight, Sort, int, int) - Constructor for class org.apache.lucene.search.grouping.BlockGroupingCollectorManager
  Creates a new BlockGroupingCollectorManager.

## C

collect(int) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
collect(int) - Method in class org.apache.lucene.search.grouping.AllGroupsCollector
collect(int) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
collect(int) - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
collect(int) - Method in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
collect(T, int) - Method in class org.apache.lucene.search.grouping.GroupReducer
  Collect a given document into a given group
CollectedSearchGroup<T> - Class in org.apache.lucene.search.grouping
  Expert: representation of a group in `FirstPassGroupingCollector`, tracking the top doc and `FieldComparator` slot.
CollectedSearchGroup() - Constructor for class org.apache.lucene.search.grouping.CollectedSearchGroup
compare(int, int) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Compares the specified document for a specified comparator against the current most relevant document.
compIDXEnd - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
context - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
copyValue() - Method in class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
copyValue() - Method in class org.apache.lucene.search.grouping.GroupSelector
copyValue() - Method in class org.apache.lucene.search.grouping.LongRangeGroupSelector
copyValue() - Method in class org.apache.lucene.search.grouping.TermGroupSelector
copyValue() - Method in class org.apache.lucene.search.grouping.ValueSourceGroupSelector
count() - Method in record class org.apache.lucene.search.grouping.GroupFacetCollector.FacetEntry
  Returns the value of the `count` record component.
counts - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
createSegmentResult() - Method in class org.apache.lucene.search.grouping.GroupFacetCollector
createTermGroupFacetCollector(String, String, boolean, BytesRef, int) - Static method in class org.apache.lucene.search.grouping.TermGroupFacetCollector
  Factory method for creating the right implementation based on the fact whether the facet field contains multiple tokens per documents.
currentValue() - Method in class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
currentValue() - Method in class org.apache.lucene.search.grouping.GroupSelector
  Get the group value of the current document
currentValue() - Method in class org.apache.lucene.search.grouping.LongRangeGroupSelector
currentValue() - Method in class org.apache.lucene.search.grouping.TermGroupSelector
currentValue() - Method in class org.apache.lucene.search.grouping.ValueSourceGroupSelector

## D

disableCaching() - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Disables any enabled cache.
DistinctValuesCollector<T,R> - Class in org.apache.lucene.search.grouping
  A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.
DistinctValuesCollector(GroupSelector<T>, Collection<SearchGroup<T>>, GroupSelector<R>) - Constructor for class org.apache.lucene.search.grouping.DistinctValuesCollector
  Create a DistinctValuesCollector
DistinctValuesCollector.GroupCount<T,R> - Class in org.apache.lucene.search.grouping
  Returned by `DistinctValuesCollector.getGroups()`, representing the value and set of distinct values for the group.
DistinctValuesCollectorManager<T,R> - Class in org.apache.lucene.search.grouping
  A `CollectorManager` implementation for `DistinctValuesCollector` that supports parallel collection and merges results by taking the union of distinct values per group across segments.
DistinctValuesCollectorManager(Supplier<GroupSelector<T>>, Collection<SearchGroup<T>>, Supplier<GroupSelector<R>>) - Constructor for class org.apache.lucene.search.grouping.DistinctValuesCollectorManager
  Creates a new DistinctValuesCollectorManager.
doc - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
docBase - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.AllGroupsCollector
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
DoubleRange - Class in org.apache.lucene.search.grouping
  Represents a contiguous range of double values, with an inclusive minimum and exclusive maximum
DoubleRange(double, double) - Constructor for class org.apache.lucene.search.grouping.DoubleRange
  Creates a new double range, running from `min` inclusive to `max` exclusive
DoubleRangeFactory - Class in org.apache.lucene.search.grouping
  Groups double values into ranges
DoubleRangeFactory(double, double, double) - Constructor for class org.apache.lucene.search.grouping.DoubleRangeFactory
  Creates a new DoubleRangeFactory
DoubleRangeGroupSelector - Class in org.apache.lucene.search.grouping
  A GroupSelector implementation that groups documents by double values
DoubleRangeGroupSelector(DoubleValuesSource, DoubleRangeFactory) - Constructor for class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
  Creates a new DoubleRangeGroupSelector

## E

endFacetOrd - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
equals(Object) - Method in class org.apache.lucene.search.grouping.DoubleRange
equals(Object) - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.apache.lucene.search.grouping.GroupFacetCollector.FacetEntry
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.apache.lucene.search.grouping.LongRange
equals(Object) - Method in class org.apache.lucene.search.grouping.SearchGroup

## F

FacetEntry(BytesRef, int) - Constructor for record class org.apache.lucene.search.grouping.GroupFacetCollector.FacetEntry
  Creates an instance of a `FacetEntry` record class.
facetField - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
facetPrefix - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
finish() - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
finish() - Method in class org.apache.lucene.search.grouping.GroupFacetCollector
FirstPassGroupingCollector<T> - Class in org.apache.lucene.search.grouping
  FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
FirstPassGroupingCollector(GroupSelector<T>, Sort, int) - Constructor for class org.apache.lucene.search.grouping.FirstPassGroupingCollector
  Create the first pass collector.
FirstPassGroupingCollector(GroupSelector<T>, Sort, int, boolean) - Constructor for class org.apache.lucene.search.grouping.FirstPassGroupingCollector
  Create the first pass collector with ignoreDocsWithoutGroupField
FirstPassGroupingCollectorManager<T> - Class in org.apache.lucene.search.grouping
  A CollectorManager implementation for `FirstPassGroupingCollector` that supports parallel collection and merges results across segments.
FirstPassGroupingCollectorManager(Supplier<GroupSelector<T>>, Sort, int, int) - Constructor for class org.apache.lucene.search.grouping.FirstPassGroupingCollectorManager
  Creates a new FirstPassGroupingCollectorManager.
FirstPassGroupingCollectorManager(Supplier<GroupSelector<T>>, Sort, int, int, boolean) - Constructor for class org.apache.lucene.search.grouping.FirstPassGroupingCollectorManager
  Creates a new FirstPassGroupingCollectorManager.

## G

getAllGroupHeads() - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Returns the matching group heads if `GroupingSearch.setAllGroupHeads(boolean)` was set to true or an empty bit set.
getAllMatchingGroups() - Method in class org.apache.lucene.search.grouping.GroupingSearch
  If `GroupingSearch.setAllGroups(boolean)` was set to `true` then all matching groups are returned, otherwise an empty collection is returned.
getCollectedGroupHeads() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
  Returns the collected group heads.
getCollector(T) - Method in class org.apache.lucene.search.grouping.GroupReducer
  Get the Collector for a given group
getComparators() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Returns the field comparators used to determine the group head ordering.
getFacetEntries(int, int) - Method in class org.apache.lucene.search.grouping.GroupFacetCollector.GroupedFacetResult
  Returns a list of facet entries to be rendered based on the specified offset and limit.
getGroupCount() - Method in class org.apache.lucene.search.grouping.AllGroupsCollector
  Returns the total number of groups for the executed search.
getGroups() - Method in class org.apache.lucene.search.grouping.AllGroupsCollector
  Returns the group values
getGroups() - Method in class org.apache.lucene.search.grouping.DistinctValuesCollector
  Returns all unique values for each top N group.
getGroupSelector() - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
getGroupSelector() - Method in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
getRange(double, DoubleRange) - Method in class org.apache.lucene.search.grouping.DoubleRangeFactory
  Finds the DoubleRange that a value should be grouped into
getRange(long, LongRange) - Method in class org.apache.lucene.search.grouping.LongRangeFactory
  Finds the LongRange that a value should be grouped into
getSortValues() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Returns the sort values for this group head.
getTopGroups(int) - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
  Returns top groups, starting from offset.
getTopGroups(int) - Method in class org.apache.lucene.search.grouping.TopGroupsCollector
  Get the TopGroups recorded by this collector
getTopGroups(Sort, int, int, int) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
  Returns the grouped results.
getTotalCount() - Method in class org.apache.lucene.search.grouping.GroupFacetCollector.GroupedFacetResult
  Returns the sum of all facet entries counts.
getTotalMissingCount() - Method in class org.apache.lucene.search.grouping.GroupFacetCollector.GroupedFacetResult
  Returns the number of groups that didn't have a facet value.
groupByDocBlock(IndexSearcher, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
groupByFieldOrFunction(IndexSearcher, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
GroupCount(T, Set<R>) - Constructor for class org.apache.lucene.search.grouping.DistinctValuesCollector.GroupCount
GroupDocs<T> - Record Class in org.apache.lucene.search.grouping
  Represents one group in the results.
GroupDocs(float, float, TotalHits, ScoreDoc[], T, Object[]) - Constructor for record class org.apache.lucene.search.grouping.GroupDocs
  Creates an instance of a `GroupDocs` record class.
GroupedFacetResult(int, int, boolean, int, int) - Constructor for class org.apache.lucene.search.grouping.GroupFacetCollector.GroupedFacetResult
GroupFacetCollector - Class in org.apache.lucene.search.grouping
  Base class for computing grouped facets.
GroupFacetCollector(String, String, BytesRef) - Constructor for class org.apache.lucene.search.grouping.GroupFacetCollector
GroupFacetCollector.FacetEntry - Record Class in org.apache.lucene.search.grouping
  Represents a facet entry with a value and a count.
GroupFacetCollector.GroupedFacetResult - Class in org.apache.lucene.search.grouping
  The grouped facet result.
GroupFacetCollector.SegmentResult - Class in org.apache.lucene.search.grouping
  Contains the local grouped segment counts for a particular segment.
groupField - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
GroupHead(T, int, int) - Constructor for class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Create a new GroupHead for the given value
groupHeadsSize() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
GroupingSearch - Class in org.apache.lucene.search.grouping
  Convenience class to perform grouping in a non distributed environment.
GroupingSearch(String) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
  Constructs a `GroupingSearch` instance that groups documents by index terms using DocValues.
GroupingSearch(ValueSource, Map<Object, Object>) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
  Constructs a `GroupingSearch` instance that groups documents by function using a `ValueSource` instance.
GroupingSearch(GroupSelector<?>) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
  Constructs a `GroupingSearch` instance that groups documents using a `GroupSelector`
GroupingSearch(Query) - Constructor for class org.apache.lucene.search.grouping.GroupingSearch
  Constructor for grouping documents by doc block.
groupReducer - Variable in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
GroupReducer<T,C> - Class in org.apache.lucene.search.grouping
  Concrete implementations of this class define what to collect for individual groups during the second-pass of a grouping search.
GroupReducer() - Constructor for class org.apache.lucene.search.grouping.GroupReducer
groups - Variable in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
groups - Variable in class org.apache.lucene.search.grouping.TopGroups
  Group results in groupSort order
groupSelector - Variable in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
GroupSelector<T> - Class in org.apache.lucene.search.grouping
  Defines a group, for use by grouping collectors
GroupSelector() - Constructor for class org.apache.lucene.search.grouping.GroupSelector
GroupSelector.State - Enum Class in org.apache.lucene.search.grouping
  What to do with the current value
groupSort - Variable in class org.apache.lucene.search.grouping.TopGroups
  How groups are sorted against each other
groupSortValues() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns the value of the `groupSortValues` record component.
groupValue - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
groupValue - Variable in class org.apache.lucene.search.grouping.DistinctValuesCollector.GroupCount
groupValue - Variable in class org.apache.lucene.search.grouping.SearchGroup
  The value that defines this group
groupValue() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns the value of the `groupValue` record component.

## H

hashCode() - Method in class org.apache.lucene.search.grouping.DoubleRange
hashCode() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns a hash code value for this object.
hashCode() - Method in record class org.apache.lucene.search.grouping.GroupFacetCollector.FacetEntry
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.grouping.LongRange
hashCode() - Method in class org.apache.lucene.search.grouping.SearchGroup
heads - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector

## L

LongRange - Class in org.apache.lucene.search.grouping
  Represents a contiguous range of long values, with an inclusive minimum and exclusive maximum
LongRange(long, long) - Constructor for class org.apache.lucene.search.grouping.LongRange
  Creates a new double range, running from `min` inclusive to `max` exclusive
LongRangeFactory - Class in org.apache.lucene.search.grouping
  Groups double values into ranges
LongRangeFactory(long, long, long) - Constructor for class org.apache.lucene.search.grouping.LongRangeFactory
  Creates a new LongRangeFactory
LongRangeGroupSelector - Class in org.apache.lucene.search.grouping
  A GroupSelector implementation that groups documents by long values
LongRangeGroupSelector(LongValuesSource, LongRangeFactory) - Constructor for class org.apache.lucene.search.grouping.LongRangeGroupSelector
  Creates a new LongRangeGroupSelector

## M

max - Variable in class org.apache.lucene.search.grouping.DoubleRange
  The exclusive maximum value of this range
max - Variable in class org.apache.lucene.search.grouping.LongRange
  The exclusive maximum value of this range
maxScore - Variable in class org.apache.lucene.search.grouping.TopGroups
  Highest score across all hits, or `Float.NaN` if scores were not computed.
maxScore() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns the value of the `maxScore` record component.
maxTermPos - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
merge(List<Collection<SearchGroup<T>>>, int, int, Sort) - Static method in class org.apache.lucene.search.grouping.SearchGroup
  Merges multiple collections of top groups, for example obtained from separate index shards.
merge(TopGroups<T>[], Sort, Sort, int, int, TopGroups.ScoreMergeMode) - Static method in class org.apache.lucene.search.grouping.TopGroups
  Merges an array of TopGroups, for example obtained from the second-pass collector across multiple shards.
mergeBlockGroups(List<TopGroups<T>>, Sort, int, int, Sort) - Static method in class org.apache.lucene.search.grouping.TopGroups
  Merge TopGroups that are partitioned into blocks per shard.
mergePos - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
mergeSegmentResults(int, int, boolean) - Method in class org.apache.lucene.search.grouping.GroupFacetCollector
  Returns grouped facet results that were computed over zero or more segments.
mergeTerm - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
min - Variable in class org.apache.lucene.search.grouping.DoubleRange
  The inclusive minimum value of this range
min - Variable in class org.apache.lucene.search.grouping.LongRange
  The inclusive minimum value of this range
missing - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult

## N

needsScores() - Method in class org.apache.lucene.search.grouping.GroupReducer
  Whether or not this reducer requires collected documents to be scored
newCollector() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollectorManager
newCollector() - Method in class org.apache.lucene.search.grouping.AllGroupsCollectorManager
newCollector() - Method in class org.apache.lucene.search.grouping.BlockGroupingCollectorManager
newCollector() - Method in class org.apache.lucene.search.grouping.DistinctValuesCollectorManager
newCollector() - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollectorManager
newCollector() - Method in class org.apache.lucene.search.grouping.GroupReducer
  Creates a new Collector for each group
newCollector() - Method in class org.apache.lucene.search.grouping.TopGroupsCollectorManager
newCollector(GroupSelector<T>, Sort) - Static method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
  Create a new AllGroupHeadsCollector based on the type of within-group Sort required
newGroupHead(int, T, LeafReaderContext, Scorable) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
  Create a new GroupHead for the given group value, initialized with a doc, context and scorer
nextTerm() - Method in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
  Go to next term in this `SegmentResult` in order to retrieve the grouped facet counts.
None - Enum constant in enum class org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode
  Set score to Float.NaN

## O

orderedGroups - Variable in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
org.apache.lucene.search.grouping - package org.apache.lucene.search.grouping
  Grouping.

## R

reduce(Collection<AllGroupHeadsCollector<T>>) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollectorManager
reduce(Collection<AllGroupsCollector<T>>) - Method in class org.apache.lucene.search.grouping.AllGroupsCollectorManager
reduce(Collection<BlockGroupingCollector>) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollectorManager
reduce(Collection<DistinctValuesCollector<T, R>>) - Method in class org.apache.lucene.search.grouping.DistinctValuesCollectorManager
reduce(Collection<FirstPassGroupingCollector<T>>) - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollectorManager
reduce(Collection<TopGroupsCollector<T>>) - Method in class org.apache.lucene.search.grouping.TopGroupsCollectorManager
retrieveGroupHeads() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
retrieveGroupHeads() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollectorManager.GroupHeadsResult
  Returns the group head document IDs as an array.
retrieveGroupHeads(int) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
retrieveGroupHeads(int) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollectorManager.GroupHeadsResult
  Returns the group head document IDs as a `Bits` set of size `maxDoc`, suitable for use as a filter.
reversed - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector

## S

score() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns the value of the `score` record component.
scoreDocs() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns the value of the `scoreDocs` record component.
scoreMode() - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
scoreMode() - Method in class org.apache.lucene.search.grouping.AllGroupsCollector
scoreMode() - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
scoreMode() - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
scoreMode() - Method in class org.apache.lucene.search.grouping.GroupFacetCollector
scoreMode() - Method in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
scorer - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
search(IndexSearcher, Query, int, int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Executes a grouped search.
SearchGroup<T> - Class in org.apache.lucene.search.grouping
  Represents a group that is found during the first pass search.
SearchGroup() - Constructor for class org.apache.lucene.search.grouping.SearchGroup
SecondPassGroupingCollector<T> - Class in org.apache.lucene.search.grouping
  SecondPassGroupingCollector runs over an already collected set of groups, further applying a `GroupReducer` to each group
SecondPassGroupingCollector(GroupSelector<T>, Collection<SearchGroup<T>>, GroupReducer<T, ?>) - Constructor for class org.apache.lucene.search.grouping.SecondPassGroupingCollector
  Create a new SecondPassGroupingCollector
segmentFacetCounts - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
SegmentResult(int[], int, int, int) - Constructor for class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
segmentResults - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
segmentTotalCount - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector
setAllGroupHeads(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Whether to compute all group heads (most relevant document per group) matching the query.
setAllGroups(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Whether to also compute all groups matching the query.
setCaching(int, boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Enables caching for the second pass search.
setCachingInMB(double, boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Enables caching for the second pass search.
setGroupDocsLimit(int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Specifies the number of documents to return inside a group from the specified groupDocsOffset.
setGroupDocsOffset(int) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Specifies the offset for documents inside a group.
setGroups(Collection<SearchGroup<DoubleRange>>) - Method in class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
setGroups(Collection<SearchGroup<LongRange>>) - Method in class org.apache.lucene.search.grouping.LongRangeGroupSelector
setGroups(Collection<SearchGroup<BytesRef>>) - Method in class org.apache.lucene.search.grouping.TermGroupSelector
setGroups(Collection<SearchGroup<MutableValue>>) - Method in class org.apache.lucene.search.grouping.ValueSourceGroupSelector
setGroups(Collection<SearchGroup<T>>) - Method in class org.apache.lucene.search.grouping.GroupReducer
  Define which groups should be reduced.
setGroups(Collection<SearchGroup<T>>) - Method in class org.apache.lucene.search.grouping.GroupSelector
  Set a restriction on the group values returned by this selector
setGroupSort(Sort) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Specifies how groups are sorted.
setIgnoreDocsWithoutGroupField(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Whether to ignore documents that don't have the group field instead of putting them in a null group.
setIncludeMaxScore(boolean) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Whether to include the score of the most relevant document per group.
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Called for each segment
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.GroupReducer
  Called when the parent `SecondPassGroupingCollector` moves to a new segment
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.GroupSelector
  Set the LeafReaderContext
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.LongRangeGroupSelector
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.TermGroupSelector
setNextReader(LeafReaderContext) - Method in class org.apache.lucene.search.grouping.ValueSourceGroupSelector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Called for each segment
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.AllGroupsCollector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.DoubleRangeGroupSelector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.FirstPassGroupingCollector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.GroupFacetCollector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.GroupReducer
  Set the Scorer on all group collectors
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.GroupSelector
  Set the current Scorer
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.LongRangeGroupSelector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.TermGroupSelector
setScorer(Scorable) - Method in class org.apache.lucene.search.grouping.ValueSourceGroupSelector
setSortWithinGroup(Sort) - Method in class org.apache.lucene.search.grouping.GroupingSearch
  Specified how documents inside a group are sorted.
SKIP - Enum constant in enum class org.apache.lucene.search.grouping.GroupSelector.State
sort - Variable in class org.apache.lucene.search.grouping.AllGroupHeadsCollector
sortValues - Variable in class org.apache.lucene.search.grouping.SearchGroup
  The sort values used during sorting.
startFacetOrd - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector

## T

TermGroupFacetCollector - Class in org.apache.lucene.search.grouping
  An implementation of `GroupFacetCollector` that computes grouped facets based on the indexed terms from DocValues.
TermGroupSelector - Class in org.apache.lucene.search.grouping
  A GroupSelector implementation that groups via SortedDocValues
TermGroupSelector(String) - Constructor for class org.apache.lucene.search.grouping.TermGroupSelector
  Create a new TermGroupSelector
TopGroups<T> - Class in org.apache.lucene.search.grouping
  Represents result returned by a grouping search.
TopGroups(TopGroups<T>, Integer) - Constructor for class org.apache.lucene.search.grouping.TopGroups
TopGroups(SortField[], SortField[], int, int, GroupDocs<T>[], float) - Constructor for class org.apache.lucene.search.grouping.TopGroups
TopGroups.ScoreMergeMode - Enum Class in org.apache.lucene.search.grouping
  How the GroupDocs score (if any) should be merged.
TopGroupsCollector<T> - Class in org.apache.lucene.search.grouping
  A second-pass collector that collects the TopDocs for each group, and returns them as a `TopGroups` object
TopGroupsCollector(GroupSelector<T>, Collection<SearchGroup<T>>, Sort, Sort, int, boolean) - Constructor for class org.apache.lucene.search.grouping.TopGroupsCollector
  Create a new TopGroupsCollector
TopGroupsCollectorManager<T> - Class in org.apache.lucene.search.grouping
  A CollectorManager implementation for TopGroupsCollector.
TopGroupsCollectorManager(Supplier<GroupSelector<T>>, Collection<SearchGroup<T>>, Sort, Sort, int, int, boolean) - Constructor for class org.apache.lucene.search.grouping.TopGroupsCollectorManager
  Creates a new TopGroupsCollectorManager.
TopGroupsCollectorManager(Supplier<GroupSelector<T>>, Collection<SearchGroup<T>>, Sort, Sort, int, int, boolean, TopGroups.ScoreMergeMode) - Constructor for class org.apache.lucene.search.grouping.TopGroupsCollectorManager
  Creates a new TopGroupsCollectorManager.
toString() - Method in class org.apache.lucene.search.grouping.DoubleRange
toString() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns a string representation of this record class.
toString() - Method in record class org.apache.lucene.search.grouping.GroupFacetCollector.FacetEntry
  Returns a string representation of this record class.
toString() - Method in class org.apache.lucene.search.grouping.LongRange
toString() - Method in class org.apache.lucene.search.grouping.SearchGroup
total - Variable in class org.apache.lucene.search.grouping.GroupFacetCollector.SegmentResult
Total - Enum constant in enum class org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode
totalGroupCount - Variable in class org.apache.lucene.search.grouping.TopGroups
  The total number of unique groups.
totalGroupedHitCount - Variable in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
totalGroupedHitCount - Variable in class org.apache.lucene.search.grouping.TopGroups
  Number of documents grouped into the topN groups
totalHitCount - Variable in class org.apache.lucene.search.grouping.SecondPassGroupingCollector
totalHitCount - Variable in class org.apache.lucene.search.grouping.TopGroups
  Number of documents matching the search
totalHits() - Method in record class org.apache.lucene.search.grouping.GroupDocs
  Returns the value of the `totalHits` record component.

## U

uniqueValues - Variable in class org.apache.lucene.search.grouping.DistinctValuesCollector.GroupCount
updateDocHead(int) - Method in class org.apache.lucene.search.grouping.AllGroupHeadsCollector.GroupHead
  Updates the current most relevant document with the specified document.

## V

value() - Method in record class org.apache.lucene.search.grouping.GroupFacetCollector.FacetEntry
  Returns the value of the `value` record component.
valueOf(String) - Static method in enum class org.apache.lucene.search.grouping.GroupSelector.State
  Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.lucene.search.grouping.GroupSelector.State
  Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.lucene.search.grouping.TopGroups.ScoreMergeMode
  Returns an array containing the constants of this enum class, in the order they are declared.
ValueSourceGroupSelector - Class in org.apache.lucene.search.grouping
  A GroupSelector that groups via a ValueSource
ValueSourceGroupSelector(ValueSource, Map<Object, Object>) - Constructor for class org.apache.lucene.search.grouping.ValueSourceGroupSelector
  Create a new ValueSourceGroupSelector

## W

withinGroupSort - Variable in class org.apache.lucene.search.grouping.TopGroups
  How docs are sorted within each group

A B C D E F G H L M N O R S T U V W
All Classes and Interfaces|All Packages