Class GroupDocs<TGroupValue>

Represents one group in the results.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
object
GroupDocs<TGroupValue>
Implements
IGroupDocs<TGroupValue>
Inherited Members
Namespace: Lucene.Net.Search.Grouping
Assembly: Lucene.Net.Grouping.dll
Syntax
public class GroupDocs<TGroupValue> : IGroupDocs<TGroupValue>
Type Parameters
Name Description
TGroupValue

Constructors

GroupDocs(float, float, int, ScoreDoc[], TGroupValue, object[])

Represents one group in the results.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration
public GroupDocs(float score, float maxScore, int totalHits, ScoreDoc[] scoreDocs, TGroupValue groupValue, object[] groupSortValues)
Parameters
Type Name Description
float score
float maxScore
int totalHits
ScoreDoc[] scoreDocs
TGroupValue groupValue
object[] groupSortValues

Properties

GroupSortValues

Matches the groupSort passed to AbstractFirstPassGroupingCollector<TGroupValue>.

Declaration
public object[] GroupSortValues { get; }
Property Value
Type Description
object[]

GroupValue

The groupField value for all docs in this group; this may be null if hits did not have the groupField.

Declaration
public TGroupValue GroupValue { get; }
Property Value
Type Description
TGroupValue

MaxScore

Max score in this group

Declaration
public float MaxScore { get; }
Property Value
Type Description
float

Score

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

Declaration
public float Score { get; }
Property Value
Type Description
float

ScoreDocs

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

Declaration
public ScoreDoc[] ScoreDocs { get; }
Property Value
Type Description
ScoreDoc[]

TotalHits

Total hits within this group

Declaration
public int TotalHits { get; }
Property Value
Type Description
int

Implements