Class TermAllGroupHeadsCollector

LUCENENET specific class used to mimic the synatax used to access static members of TermAllGroupHeadsCollector<GH> without specifying its generic closing type. (TermAllGroupHeadsCollector.Create() rather than TermAllGroupHeadsCollector{GH}.Create()).

Inheritance

System.Object

TermAllGroupHeadsCollector

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.Terms

Assembly: Lucene.Net.Grouping.dll

Syntax

public class TermAllGroupHeadsCollector

Methods

Create(String, Sort)

Creates an AbstractAllGroupHeadsCollector instance based on the supplied arguments. This factory method decides with implementation is best suited.

Delegates to Create(String, Sort, Int32) with an initialSize of 128.

Declaration

public static AbstractAllGroupHeadsCollector Create(string groupField, Sort sortWithinGroup)

Parameters

Type	Name	Description
System.String	groupField	The field to group by
Sort	sortWithinGroup	The sort within each group

Returns

Type	Description
AbstractAllGroupHeadsCollector	an AbstractAllGroupHeadsCollector instance based on the supplied arguments

Create(String, Sort, Int32)

Creates an AbstractAllGroupHeadsCollector instance based on the supplied arguments. This factory method decides with implementation is best suited.

Declaration

public static AbstractAllGroupHeadsCollector Create(string groupField, Sort sortWithinGroup, int initialSize)

Parameters

Type	Name	Description
System.String	groupField	The field to group by
Sort	sortWithinGroup	The sort within each group
System.Int32	initialSize	The initial allocation size of the internal int set and group list which should roughly match the total number of expected unique groups. Be aware that the heap usage is 4 bytes * initialSize.

Returns

Type	Description
AbstractAllGroupHeadsCollector	an AbstractAllGroupHeadsCollector instance based on the supplied arguments