Class AbstractGroupFacetCollector.GroupedFacetResult

The grouped facet result. Containing grouped facet entries, total count and total missing count.

Inheritance

System.Object

AbstractGroupFacetCollector.GroupedFacetResult

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 GroupedFacetResult

Constructors

GroupedFacetResult(Int32, Int32, Boolean, Int32, Int32)

Declaration

public GroupedFacetResult(int size, int minCount, bool orderByCount, int totalCount, int totalMissingCount)

Parameters

Type	Name	Description
System.Int32	size
System.Int32	minCount
System.Boolean	orderByCount
System.Int32	totalCount
System.Int32	totalMissingCount

Properties

TotalCount

Gets the sum of all facet entries counts.

Declaration

public virtual int TotalCount { get; }

Property Value

Type	Description
System.Int32

TotalMissingCount

Gets the number of groups that didn't have a facet value.

Declaration

public virtual int TotalMissingCount { get; }

Property Value

Type	Description
System.Int32

Methods

AddFacetCount(BytesRef, Int32)

Declaration

public virtual void AddFacetCount(BytesRef facetValue, int count)

Parameters

Type	Name	Description
BytesRef	facetValue
System.Int32	count

GetFacetEntries(Int32, Int32)

Returns a list of facet entries to be rendered based on the specified offset and limit. The facet entries are retrieved from the facet entries collected during merging.

Declaration

public virtual IList<AbstractGroupFacetCollector.FacetEntry> GetFacetEntries(int offset, int limit)

Parameters

Type	Name	Description
System.Int32	offset	The offset in the collected facet entries during merging
System.Int32	limit	The number of facets to return starting from the offset.

Returns

Type	Description
System.Collections.Generic.IList<AbstractGroupFacetCollector.FacetEntry>	a list of facet entries to be rendered based on the specified offset and limit