org.apache.lucene.search.grouping
Class GroupDocs

java.lang.Object
  org.apache.lucene.search.grouping.GroupDocs

public class GroupDocs
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

Comparable[]	groupSortValues Matches the groupSort passed to FirstPassGroupingCollector.
String	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 group
ScoreDoc[]	scoreDocs Hits; this may be FieldDoc instances if the withinGroupSort sorted by fields.
int	totalHits Total hits within this group

Constructor Summary

GroupDocs(float maxScore, int totalHits, ScoreDoc[] scoreDocs, String groupValue, Comparable[] groupSortValues)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

groupValue

public final String 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 be FieldDoc instances if the withinGroupSort sorted by fields.

totalHits

public final int totalHits

Total hits within this group

groupSortValues

public final Comparable[] groupSortValues

Matches the groupSort passed to FirstPassGroupingCollector.

Constructor Detail

GroupDocs

public GroupDocs(float maxScore,
                 int totalHits,
                 ScoreDoc[] scoreDocs,
                 String groupValue,
                 Comparable[] groupSortValues)