Class FunctionAllGroupHeadsCollector

An implementation of AbstractAllGroupHeadsCollector for retrieving the most relevant groups when grouping by ValueSource.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
AbstractAllGroupHeadsCollector
AbstractAllGroupHeadsCollector<FunctionAllGroupHeadsCollector.GroupHead>
FunctionAllGroupHeadsCollector
Implements
Inherited Members
Namespace: Lucene.Net.Search.Grouping.Function
Assembly: Lucene.Net.Grouping.dll
Syntax
public class FunctionAllGroupHeadsCollector : AbstractAllGroupHeadsCollector<FunctionAllGroupHeadsCollector.GroupHead>, ICollector

Constructors

| Improve this Doc View Source

FunctionAllGroupHeadsCollector(ValueSource, IDictionary, Sort)

Constructs a FunctionAllGroupHeadsCollector instance.

Declaration
public FunctionAllGroupHeadsCollector(ValueSource groupBy, IDictionary vsContext, Sort sortWithinGroup)
Parameters
Type Name Description
ValueSource groupBy

The ValueSource to group by
IDictionary vsContext

The ValueSource context
Sort sortWithinGroup

The sort within a group

Properties

| Improve this Doc View Source

CollectedGroupHeads

Declaration
protected override ICollection<FunctionAllGroupHeadsCollector.GroupHead> CollectedGroupHeads { get; }
Property Value
Type Description
ICollection<FunctionAllGroupHeadsCollector.GroupHead>
Overrides
Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector<Lucene.Net.Search.Grouping.Function.FunctionAllGroupHeadsCollector.GroupHead>.CollectedGroupHeads

Methods

| Improve this Doc View Source

RetrieveGroupHeadAndAddIfNotExist(Int32)

Declaration
protected override void RetrieveGroupHeadAndAddIfNotExist(int doc)
Parameters
Type Name Description
System.Int32 doc
Overrides
Lucene.Net.Search.Grouping.AbstractAllGroupHeadsCollector<Lucene.Net.Search.Grouping.Function.FunctionAllGroupHeadsCollector.GroupHead>.RetrieveGroupHeadAndAddIfNotExist(System.Int32)
| Improve this Doc View Source

SetNextReader(AtomicReaderContext)

Declaration
public override void SetNextReader(AtomicReaderContext context)
Parameters
Type Name Description
AtomicReaderContext context
Overrides
| Improve this Doc View Source

SetScorer(Scorer)

Declaration
public override void SetScorer(Scorer scorer)
Parameters
Type Name Description
Scorer scorer
Overrides

Implements