Class TopGroups<TGroupValue>

Represents result returned by a grouping search.

Note

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

Inheritance

object

TopGroups<TGroupValue>

Implements

ITopGroups<TGroupValue>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search.Grouping

Assembly: Lucene.Net.Grouping.dll

Syntax

public class TopGroups<TGroupValue> : ITopGroups<TGroupValue>

Type Parameters

Name	Description
TGroupValue

Constructors

TopGroups(ITopGroups<TGroupValue>, int?)

Represents result returned by a grouping search.

Note

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

Declaration

public TopGroups(ITopGroups<TGroupValue> oldTopGroups, int? totalGroupCount)

Parameters

Type	Name	Description
ITopGroups<TGroupValue>	oldTopGroups
int?	totalGroupCount

TopGroups(SortField[], SortField[], int, int, IGroupDocs<TGroupValue>[], float)

Represents result returned by a grouping search.

Note

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

Declaration

public TopGroups(SortField[] groupSort, SortField[] withinGroupSort, int totalHitCount, int totalGroupedHitCount, IGroupDocs<TGroupValue>[] groups, float maxScore)

Parameters

Type	Name	Description
SortField[]	groupSort
SortField[]	withinGroupSort
int	totalHitCount
int	totalGroupedHitCount
IGroupDocs<TGroupValue>[]	groups
float	maxScore

Properties

GroupSort

How groups are sorted against each other

Declaration

public SortField[] GroupSort { get; }

Property Value

Type	Description
SortField[]

Groups

Group results in groupSort order

Declaration

public IGroupDocs<TGroupValue>[] Groups { get; }

Property Value

Type	Description
IGroupDocs<TGroupValue>[]

MaxScore

Highest score across all hits, or NaN if scores were not computed.

Declaration

public float MaxScore { get; }

Property Value

Type	Description
float

TotalGroupCount

The total number of unique groups. If null this value is not computed.

Declaration

public int? TotalGroupCount { get; }

Property Value

Type	Description
int?

TotalGroupedHitCount

Number of documents grouped into the topN groups

Declaration

public int TotalGroupedHitCount { get; }

Property Value

Type	Description
int

TotalHitCount

Number of documents matching the search

Declaration

public int TotalHitCount { get; }

Property Value

Type	Description
int

WithinGroupSort

How docs are sorted within each group

Declaration

public SortField[] WithinGroupSort { get; }

Property Value

Type	Description
SortField[]

Implements

ITopGroups<TGroupValue>