A B C D E F G H K M O P R S T U W

## A

AbstractAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead> - Class in org.apache.lucene.search.grouping
  This collector specializes in collecting the most relevant document (group head) for each group that match the query.
AbstractAllGroupHeadsCollector(int) - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
AbstractAllGroupHeadsCollector.GroupHead<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
  Represents a group head.
AbstractAllGroupHeadsCollector.GroupHead(GROUP_VALUE_TYPE, int) - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
AbstractAllGroupHeadsCollector.TemporalResult - Class in org.apache.lucene.search.grouping
  Contains the result of group head retrieval.
AbstractAllGroupHeadsCollector.TemporalResult() - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.TemporalResult
AbstractAllGroupsCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
  A collector that collects all groups that match the query.
AbstractAllGroupsCollector() - Constructor for class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
AbstractFirstPassGroupingCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
  FirstPassGroupingCollector is the first of two passes necessary to collect grouped hits.
AbstractFirstPassGroupingCollector(Sort, int) - Constructor for class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
  Create the first pass collector.
AbstractSecondPassGroupingCollector<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
  SecondPassGroupingCollector is the second of two passes necessary to collect grouped docs.
AbstractSecondPassGroupingCollector(Collection<SearchGroup<GROUP_VALUE_TYPE>>, Sort, Sort, int, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
AbstractSecondPassGroupingCollector.SearchGroupDocs<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
AbstractSecondPassGroupingCollector.SearchGroupDocs(GROUP_VALUE_TYPE, TopDocsCollector<?>) - Constructor for class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
acceptsDocsOutOfOrder() - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector

## 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(java.util.Collection<org.apache.lucene.document.Document>)` or `IndexWriter.updateDocuments(org.apache.lucene.index.Term, java.util.Collection<org.apache.lucene.document.Document>)` API.
BlockGroupingCollector(Sort, int, boolean, Filter) - Constructor for class org.apache.lucene.search.grouping.BlockGroupingCollector
  Create the single pass collector.

## C

clear() - Method in class org.apache.lucene.search.grouping.SentinelIntSet
collect(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
collect(int) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
collect(int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
collect(int) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
collect(int) - Method in class org.apache.lucene.search.grouping.TermAllGroupsCollector
collector - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs
compare(int, int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
  Compares the specified document for a specified comparator against the current most relevant document.
compIDXEnd - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
copyDocGroupValue(GROUP_VALUE_TYPE, GROUP_VALUE_TYPE) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
  Returns a copy of the specified group value by creating a new instance and copying the value from the specified groupValue in the new instance.
copyDocGroupValue(String, String) - Method in class org.apache.lucene.search.grouping.TermFirstPassGroupingCollector
count - Variable in class org.apache.lucene.search.grouping.SentinelIntSet
create(String, Sort) - Static method in class org.apache.lucene.search.grouping.TermAllGroupHeadsCollector
  Creates an `AbstractAllGroupHeadsCollector` instance based on the supplied arguments.
create(String, Sort, int) - Static method in class org.apache.lucene.search.grouping.TermAllGroupHeadsCollector
  Creates an `AbstractAllGroupHeadsCollector` instance based on the supplied arguments.

## D

doc - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead

## E

emptyVal - Variable in class org.apache.lucene.search.grouping.SentinelIntSet
equals(Object) - Method in class org.apache.lucene.search.grouping.SearchGroup
exists(int) - Method in class org.apache.lucene.search.grouping.SentinelIntSet

## F

find(int) - Method in class org.apache.lucene.search.grouping.SentinelIntSet
  returns the slot for this key, or -slot-1 if not found

## G

getCollectedGroupHeads() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
  Returns the collected group heads.
getDocGroupValue(int) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
  Returns the group value for the specified doc.
getDocGroupValue(int) - Method in class org.apache.lucene.search.grouping.TermFirstPassGroupingCollector
getGroupCount() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
  Returns the total number of groups for the executed search.
getGroups() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
  Returns the group values

  This is an unordered collections of group values.
getGroups() - Method in class org.apache.lucene.search.grouping.TermAllGroupsCollector
  Returns the group values

  This is an unordered collections of group values.
getSlot(int) - Method in class org.apache.lucene.search.grouping.SentinelIntSet
  returns the slot for this key
getTopGroups(int, boolean) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
  Returns top groups, starting from offset.
getTopGroups(int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
getTopGroups(Sort, int, int, int, boolean) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
  Returns the grouped results.
groupDocs - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
GroupDocs<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
  Represents one group in the results.
GroupDocs(float, int, ScoreDoc[], GROUP_VALUE_TYPE, Object[]) - Constructor for class org.apache.lucene.search.grouping.GroupDocs
groupHead - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.TemporalResult
groupHeadsSize() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
groupMap - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
groups - Variable in class org.apache.lucene.search.grouping.TopGroups
  Group results in groupSort order
groupSort - Variable in class org.apache.lucene.search.grouping.TopGroups
  How groups are sorted against each other
groupSortValues - Variable in class org.apache.lucene.search.grouping.GroupDocs
  Matches the groupSort passed to `AbstractFirstPassGroupingCollector`.
groupValue - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
groupValue - Variable in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector.SearchGroupDocs
groupValue - Variable in class org.apache.lucene.search.grouping.GroupDocs
  The groupField value for all docs in this group; this may be null if hits did not have the groupField.
groupValue - Variable in class org.apache.lucene.search.grouping.SearchGroup
  The value that defines this group

## H

hash(int) - Method in class org.apache.lucene.search.grouping.SentinelIntSet
hashCode() - Method in class org.apache.lucene.search.grouping.SearchGroup

## K

keys - Variable in class org.apache.lucene.search.grouping.SentinelIntSet

## M

maxScore - Variable in class org.apache.lucene.search.grouping.GroupDocs
  Max score in this group
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) - 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.

## O

org.apache.lucene.search.grouping - package org.apache.lucene.search.grouping
  This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.

## P

put(int) - Method in class org.apache.lucene.search.grouping.SentinelIntSet

## R

rehash() - Method in class org.apache.lucene.search.grouping.SentinelIntSet
rehashCount - Variable in class org.apache.lucene.search.grouping.SentinelIntSet
retrieveGroup(int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
  Returns the group the specified doc belongs to or `null` if no group could be retrieved.
retrieveGroup(int) - Method in class org.apache.lucene.search.grouping.TermSecondPassGroupingCollector
retrieveGroupHeadAndAddIfNotExist(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
  Returns the group head and puts it into `AbstractAllGroupHeadsCollector.temporalResult`.
retrieveGroupHeads(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
retrieveGroupHeads() - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
reversed - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector

## S

scoreDocs - Variable in class org.apache.lucene.search.grouping.GroupDocs
  Hits; this may be `FieldDoc` instances if the withinGroupSort sorted by fields.
SearchGroup<GROUP_VALUE_TYPE> - 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
SentinelIntSet - Class in org.apache.lucene.search.grouping
  A native int set where one value is reserved to mean "EMPTY"
SentinelIntSet(int, int) - Constructor for class org.apache.lucene.search.grouping.SentinelIntSet
setNextReader(IndexReader, int) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
setNextReader(IndexReader, int) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
setNextReader(IndexReader, int) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
setNextReader(IndexReader, int) - Method in class org.apache.lucene.search.grouping.TermAllGroupsCollector
setNextReader(IndexReader, int) - Method in class org.apache.lucene.search.grouping.TermFirstPassGroupingCollector
setNextReader(IndexReader, int) - Method in class org.apache.lucene.search.grouping.TermSecondPassGroupingCollector
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupsCollector
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractFirstPassGroupingCollector
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.AbstractSecondPassGroupingCollector
setScorer(Scorer) - Method in class org.apache.lucene.search.grouping.BlockGroupingCollector
size() - Method in class org.apache.lucene.search.grouping.SentinelIntSet
sortValues - Variable in class org.apache.lucene.search.grouping.SearchGroup
  The sort values used during sorting.
stop - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.TemporalResult

## T

temporalResult - Variable in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector
TermAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead> - Class in org.apache.lucene.search.grouping
  A base implementation of `AbstractAllGroupHeadsCollector` for retrieving the most relevant groups when grouping on a string based group field.
TermAllGroupHeadsCollector(String, int) - Constructor for class org.apache.lucene.search.grouping.TermAllGroupHeadsCollector
TermAllGroupsCollector - Class in org.apache.lucene.search.grouping
  A collector that collects all groups that match the query.
TermAllGroupsCollector(String, int) - Constructor for class org.apache.lucene.search.grouping.TermAllGroupsCollector
  Expert: Constructs a `AbstractAllGroupsCollector`
TermAllGroupsCollector(String) - Constructor for class org.apache.lucene.search.grouping.TermAllGroupsCollector
  Constructs a `AbstractAllGroupsCollector`.
TermFirstPassGroupingCollector - Class in org.apache.lucene.search.grouping
  Concrete implementation of `AbstractFirstPassGroupingCollector` that groups based on field values and more specifically uses `FieldCache.StringIndex` to collect groups.
TermFirstPassGroupingCollector(String, Sort, int) - Constructor for class org.apache.lucene.search.grouping.TermFirstPassGroupingCollector
  Create the first pass collector.
TermSecondPassGroupingCollector - Class in org.apache.lucene.search.grouping
  Concrete implementation of `AbstractSecondPassGroupingCollector` that groups based on field values and more specifically uses `FieldCache.StringIndex` to collect grouped docs.
TermSecondPassGroupingCollector(String, Collection<SearchGroup<String>>, Sort, Sort, int, boolean, boolean, boolean) - Constructor for class org.apache.lucene.search.grouping.TermSecondPassGroupingCollector
TopGroups<GROUP_VALUE_TYPE> - Class in org.apache.lucene.search.grouping
  Represents result returned by a grouping search.
TopGroups(SortField[], SortField[], int, int, GroupDocs<GROUP_VALUE_TYPE>[]) - Constructor for class org.apache.lucene.search.grouping.TopGroups
TopGroups(TopGroups<GROUP_VALUE_TYPE>, Integer) - Constructor for class org.apache.lucene.search.grouping.TopGroups
toString() - Method in class org.apache.lucene.search.grouping.SearchGroup
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.TopGroups
  Number of documents grouped into the topN groups
totalHitCount - Variable in class org.apache.lucene.search.grouping.TopGroups
  Number of documents matching the search
totalHits - Variable in class org.apache.lucene.search.grouping.GroupDocs
  Total hits within this group

## U

updateDocHead(int) - Method in class org.apache.lucene.search.grouping.AbstractAllGroupHeadsCollector.GroupHead
  Updates the current most relevant document with the specified document.

## 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 K M O P R S T U W