Interface IGroupDocs<TGroupValue>

LUCENENET specific interface used to apply covariance to TGroupValue to simulate Java's wildcard generics.

Namespace: Lucene.Net.Search.Grouping
Assembly: Lucene.Net.Grouping.dll
Syntax
public interface IGroupDocs<out TGroupValue>
Type Parameters
Name Description
TGroupValue

Properties

| Improve this Doc View Source

GroupSortValues

Matches the groupSort passed to AbstractFirstPassGroupingCollector<TGroupValue>.

Declaration
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
TGroupValue GroupValue { get; }
Property Value
Type Description
TGroupValue
| Improve this Doc View Source

MaxScore

Max score in this group

Declaration
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
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
ScoreDoc[] ScoreDocs { get; }
Property Value
Type Description
Lucene.Net.Search.ScoreDoc[]
| Improve this Doc View Source

TotalHits

Total hits within this group

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