Class AbstractGroupFacetCollector.GroupedFacetResult

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

Inheritance

object

AbstractGroupFacetCollector.GroupedFacetResult

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 AbstractGroupFacetCollector.GroupedFacetResult

Constructors

GroupedFacetResult(int, int, bool, int, int)

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

Declaration

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

Parameters

Type	Name	Description
int	size
int	minCount
bool	orderByCount
int	totalCount
int	totalMissingCount

Properties

TotalCount

Gets the sum of all facet entries counts.

Declaration

public virtual int TotalCount { get; }

Property Value

Type	Description
int

TotalMissingCount

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

Declaration

public virtual int TotalMissingCount { get; }

Property Value

Type	Description
int

Methods

AddFacetCount(BytesRef, int)

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

Declaration

public virtual void AddFacetCount(BytesRef facetValue, int count)

Parameters

Type	Name	Description
BytesRef	facetValue
int	count

GetFacetEntries(int, int)

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
int	offset	The offset in the collected facet entries during merging
int	limit	The number of facets to return starting from the offset.

Returns

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