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
System.Object
TopGroups<TGroupValue>
Implements
ITopGroups<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 TopGroups<TGroupValue> : ITopGroups<TGroupValue>
Type Parameters
Name Description
TGroupValue

Constructors

| Improve this Doc View Source

TopGroups(ITopGroups<TGroupValue>, Nullable<Int32>)

Declaration
public TopGroups(ITopGroups<TGroupValue> oldTopGroups, int? totalGroupCount)
Parameters
Type Name Description
ITopGroups<TGroupValue> oldTopGroups
System.Nullable<System.Int32> totalGroupCount
| Improve this Doc View Source

TopGroups(SortField[], SortField[], Int32, Int32, IGroupDocs<TGroupValue>[], Single)

Declaration
public TopGroups(SortField[] groupSort, SortField[] withinGroupSort, int totalHitCount, int totalGroupedHitCount, IGroupDocs<TGroupValue>[] groups, float maxScore)
Parameters
Type Name Description
Lucene.Net.Search.SortField[] groupSort
Lucene.Net.Search.SortField[] withinGroupSort
System.Int32 totalHitCount
System.Int32 totalGroupedHitCount
IGroupDocs<TGroupValue>[] groups
System.Single maxScore

Properties

| Improve this Doc View Source

Groups

Group results in groupSort order

Declaration
public IGroupDocs<TGroupValue>[] Groups { get; }
Property Value
Type Description
IGroupDocs<TGroupValue>[]
| Improve this Doc View Source

GroupSort

How groups are sorted against each other

Declaration
public SortField[] GroupSort { get; }
Property Value
Type Description
Lucene.Net.Search.SortField[]
| Improve this Doc View Source

MaxScore

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

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

TotalGroupCount

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

Declaration
public int? TotalGroupCount { get; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

TotalGroupedHitCount

Number of documents grouped into the topN groups

Declaration
public int TotalGroupedHitCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TotalHitCount

Number of documents matching the search

Declaration
public int TotalHitCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

WithinGroupSort

How docs are sorted within each group

Declaration
public SortField[] WithinGroupSort { get; }
Property Value
Type Description
Lucene.Net.Search.SortField[]

Implements