Class FunctionFirstPassGroupingCollector

Concrete implementation of AbstractFirstPassGroupingCollector<TGroupValue> that groups based on ValueSource instances.

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

Constructors

| Improve this Doc View Source

FunctionFirstPassGroupingCollector(ValueSource, IDictionary, Sort, Int32)

Creates a first pass collector.

Declaration
public FunctionFirstPassGroupingCollector(ValueSource groupByVS, IDictionary vsContext, Sort groupSort, int topNGroups)
Parameters
Type Name Description
ValueSource groupByVS

The ValueSource instance to group by
IDictionary vsContext

The ValueSource context
Sort groupSort

The Sort used to sort the groups. The top sorted document within each group according to groupSort, determines how that group sorts against other groups. This must be non-null, ie, if you want to groupSort by relevance use RELEVANCE.
System.Int32 topNGroups

How many top groups to keep.

Methods

| Improve this Doc View Source

CopyDocGroupValue(MutableValue, MutableValue)

Declaration
protected override MutableValue CopyDocGroupValue(MutableValue groupValue, MutableValue reuse)
Parameters
Type Name Description
MutableValue groupValue
MutableValue reuse
Returns
Type Description
MutableValue
Overrides
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<Lucene.Net.Util.Mutable.MutableValue>.CopyDocGroupValue(Lucene.Net.Util.Mutable.MutableValue, Lucene.Net.Util.Mutable.MutableValue)
| Improve this Doc View Source

GetDocGroupValue(Int32)

Declaration
protected override MutableValue GetDocGroupValue(int doc)
Parameters
Type Name Description
System.Int32 doc
Returns
Type Description
MutableValue
Overrides
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<Lucene.Net.Util.Mutable.MutableValue>.GetDocGroupValue(System.Int32)
| Improve this Doc View Source

SetNextReader(AtomicReaderContext)

Declaration
public override void SetNextReader(AtomicReaderContext context)
Parameters
Type Name Description
AtomicReaderContext context
Overrides
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<Lucene.Net.Util.Mutable.MutableValue>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)

Implements