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
System.Object
GroupDocs<TGroupValue>
Implements
IGroupDocs<TGroupValue>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Search.Grouping
Assembly: Lucene.Net.Grouping.dll
Syntax
public class GroupDocs<TGroupValue> : IGroupDocs<TGroupValue>
Type Parameters
Name Description
TGroupValue

Constructors

| Improve this Doc View Source

GroupDocs(Single, Single, Int32, ScoreDoc[], TGroupValue, Object[])

Declaration
public GroupDocs(float score, float maxScore, int totalHits, ScoreDoc[] scoreDocs, TGroupValue groupValue, object[] groupSortValues)
Parameters
Type Name Description
System.Single score
System.Single maxScore
System.Int32 totalHits
Lucene.Net.Search.ScoreDoc[] scoreDocs
TGroupValue groupValue
System.Object[] groupSortValues

Properties

| Improve this Doc View Source

GroupSortValues

Matches the groupSort passed to AbstractFirstPassGroupingCollector<TGroupValue>.

Declaration
public object[] GroupSortValues { get; }
Property Value
Type Description
System.Object[]
| Improve this Doc View Source

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
| Improve this Doc View Source

MaxScore

Max score in this group

Declaration
public float MaxScore { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Score

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

Declaration
public float Score { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

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
Lucene.Net.Search.ScoreDoc[]
| Improve this Doc View Source

TotalHits

Total hits within this group

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

Implements