Class GroupDocs<GROUP_VALUE_TYPE>
- java.lang.Object
-
- org.apache.lucene.search.grouping.GroupDocs<GROUP_VALUE_TYPE>
-
public class GroupDocs<GROUP_VALUE_TYPE> extends Object
Represents one group in the results.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description Object[]
groupSortValues
Matches the groupSort passed toAbstractFirstPassGroupingCollector
.GROUP_VALUE_TYPE
groupValue
The groupField value for all docs in this group; this may be null if hits did not have the groupField.float
maxScore
Max score in this groupScoreDoc[]
scoreDocs
Hits; this may beFieldDoc
instances if the withinGroupSort sorted by fields.int
totalHits
Total hits within this group
-
Constructor Summary
Constructors Constructor Description GroupDocs(float maxScore, int totalHits, ScoreDoc[] scoreDocs, GROUP_VALUE_TYPE groupValue, Object[] groupSortValues)
-
-
-
Field Detail
-
groupValue
public final GROUP_VALUE_TYPE groupValue
The groupField value for all docs in this group; this may be null if hits did not have the groupField.
-
maxScore
public final float maxScore
Max score in this group
-
scoreDocs
public final ScoreDoc[] scoreDocs
Hits; this may beFieldDoc
instances if the withinGroupSort sorted by fields.
-
totalHits
public final int totalHits
Total hits within this group
-
groupSortValues
public final Object[] groupSortValues
Matches the groupSort passed toAbstractFirstPassGroupingCollector
.
-
-
Constructor Detail
-
GroupDocs
public GroupDocs(float maxScore, int totalHits, ScoreDoc[] scoreDocs, GROUP_VALUE_TYPE groupValue, Object[] groupSortValues)
-
-