Package org.apache.lucene.search.grouping

Class GroupDocs<T>

java.lang.Object

org.apache.lucene.search.grouping.GroupDocs<T>

public class GroupDocs<T>
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
final Object[]	groupSortValues	Matches the groupSort passed to FirstPassGroupingCollector.
final T	groupValue	The groupField value for all docs in this group; this may be null if hits did not have the groupField.
final float	maxScore	Max score in this group
final float	score	Overall aggregated score of this group (currently only set by join queries).
final ScoreDoc[]	scoreDocs	Hits; this may be FieldDoc instances if the withinGroupSort sorted by fields.
final TotalHits	totalHits	Total hits within this group

Constructor Summary

Constructors

Constructor	Description
GroupDocs(float score, float maxScore, TotalHits totalHits, ScoreDoc[] scoreDocs, T groupValue, Object[] groupSortValues)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

groupValue

public final T 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

score

public final float score

Overall aggregated score of this group (currently only set by join queries).

scoreDocs

public final ScoreDoc[] scoreDocs

Hits; this may be FieldDoc instances if the withinGroupSort sorted by fields.

totalHits

public final TotalHits totalHits

Total hits within this group

groupSortValues

public final Object[] groupSortValues

Matches the groupSort passed to FirstPassGroupingCollector.

Constructor Details

GroupDocs

public GroupDocs(float score,
 float maxScore,
 TotalHits totalHits,
 ScoreDoc[] scoreDocs,
 T groupValue,
 Object[] groupSortValues)