Class FunctionSecondPassGroupingCollector<TMutableValue>

Concrete implementation of AbstractSecondPassGroupingCollector<TGroupValue> that groups based on Lucene.Net.Queries.Function.ValueSource instances.

Note

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

Inheritance
System.Object
AbstractSecondPassGroupingCollector<TMutableValue>
FunctionSecondPassGroupingCollector<TMutableValue>
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.Function
Assembly: Lucene.Net.Grouping.dll
Syntax
public class FunctionSecondPassGroupingCollector<TMutableValue> : AbstractSecondPassGroupingCollector<TMutableValue>, IAbstractSecondPassGroupingCollector<TMutableValue>, ICollector where TMutableValue : MutableValue
Type Parameters
Name Description
TMutableValue

Constructors

| Improve this Doc View Source

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

Constructs a FunctionSecondPassGroupingCollector<TMutableValue> instance.

Declaration
public FunctionSecondPassGroupingCollector(IEnumerable<ISearchGroup<TMutableValue>> 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<TMutableValue>> searchGroups

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

The group sort
Lucene.Net.Search.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
Lucene.Net.Queries.Function.ValueSource groupByVS

The Lucene.Net.Queries.Function.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<TMutableValue> RetrieveGroup(int doc)
Parameters
Type Name Description
System.Int32 doc
Returns
Type Description
AbstractSecondPassGroupingCollector.SearchGroupDocs<TMutableValue>
Overrides
Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector<TMutableValue>.RetrieveGroup(System.Int32)
| Improve this Doc View Source

SetNextReader(AtomicReaderContext)

Declaration
public override void SetNextReader(AtomicReaderContext context)
Parameters
Type Name Description
Lucene.Net.Index.AtomicReaderContext context
Overrides
Lucene.Net.Search.Grouping.AbstractSecondPassGroupingCollector<TMutableValue>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)

Implements

Lucene.Net.Search.ICollector