Class FunctionSecondPassGroupingCollector

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

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
AbstractSecondPassGroupingCollector<MutableValue>
FunctionSecondPassGroupingCollector
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.Function
Assembly: Lucene.Net.Grouping.dll
Syntax
public class FunctionSecondPassGroupingCollector : AbstractSecondPassGroupingCollector<MutableValue>, IAbstractSecondPassGroupingCollector<MutableValue>, ICollector

Constructors

| Improve this Doc View Source

FunctionSecondPassGroupingCollector(IEnumerable<ISearchGroup<MutableValue>>, Sort, Sort, Int32, Boolean, Boolean, Boolean, ValueSource, IDictionary)

Constructs a FunctionSecondPassGroupingCollector instance.

Declaration
public FunctionSecondPassGroupingCollector(IEnumerable<ISearchGroup<MutableValue>> searchGroups, Sort groupSort, Sort withinGroupSort, int maxDocsPerGroup, bool getScores, bool getMaxScores, bool fillSortFields, ValueSource groupByVS, IDictionary vsContext)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ISearchGroup<MutableValue>> searchGroups

The SearchGroup<TGroupValue> instances collected during the first phase.
Sort groupSort

The group sort
Sort withinGroupSort

The sort inside a group
System.Int32 maxDocsPerGroup

The maximum number of documents to collect inside a group
System.Boolean getScores

Whether to include the scores
System.Boolean getMaxScores

Whether to include the maximum score
System.Boolean fillSortFields

Whether to fill the sort values in WithinGroupSort
ValueSource groupByVS

The ValueSource to group by
System.Collections.IDictionary vsContext

The value source context
Exceptions
Type Condition
System.IO.IOException

When I/O related errors occur

Methods

| Improve this Doc View Source

RetrieveGroup(Int32)

Declaration
protected override AbstractSecondPassGroupingCollector.SearchGroupDocs<MutableValue> RetrieveGroup(int doc)
Parameters
Type Name Description
System.Int32 doc
Returns
Type Description
AbstractSecondPassGroupingCollector.SearchGroupDocs<MutableValue>
Overrides
Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector<Lucene.Net.Util.Mutable.MutableValue>.RetrieveGroup(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.AbstractSecondPassGroupingCollector<Lucene.Net.Util.Mutable.MutableValue>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)

Implements