Class TermGroupFacetCollector

An implementation of AbstractGroupFacetCollector that computes grouped facets based on the indexed terms from the Lucene.Net.Search.FieldCache.

Note

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

Inheritance
System.Object
AbstractGroupFacetCollector
TermGroupFacetCollector
Implements
Lucene.Net.Search.ICollector
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 abstract class TermGroupFacetCollector : AbstractGroupFacetCollector, ICollector

Methods

| Improve this Doc View Source

CreateTermGroupFacetCollector(String, String, Boolean, BytesRef, Int32)

Factory method for creating the right implementation based on the fact whether the facet field contains multiple tokens per documents.

Declaration
public static TermGroupFacetCollector CreateTermGroupFacetCollector(string groupField, string facetField, bool facetFieldMultivalued, BytesRef facetPrefix, int initialSize)
Parameters
Type Name Description
System.String groupField

The group field
System.String facetField

The facet field
System.Boolean facetFieldMultivalued

Whether the facet field has multiple tokens per document
Lucene.Net.Util.BytesRef facetPrefix

The facet prefix a facet entry should start with to be included.
System.Int32 initialSize

The initial allocation size of the internal int set and group facet 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
TermGroupFacetCollector

TermGroupFacetCollector implementation

Implements

Lucene.Net.Search.ICollector