Class FunctionFirstPassGroupingCollector<TMutableValue>

Concrete implementation of AbstractFirstPassGroupingCollector<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
AbstractFirstPassGroupingCollector<TMutableValue>
FunctionFirstPassGroupingCollector<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 FunctionFirstPassGroupingCollector<TMutableValue> : AbstractFirstPassGroupingCollector<TMutableValue>, IAbstractFirstPassGroupingCollector<TMutableValue>, ICollector where TMutableValue : MutableValue
Type Parameters
Name Description
TMutableValue

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
Lucene.Net.Queries.Function.ValueSource groupByVS

The Lucene.Net.Queries.Function.ValueSource instance to group by
System.Collections.IDictionary vsContext

The Lucene.Net.Queries.Function.ValueSource context
Lucene.Net.Search.Sort groupSort

The Lucene.Net.Search.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.
Exceptions
Type Condition
System.IO.IOException

When I/O related errors occur

Methods

| Improve this Doc View Source

CopyDocGroupValue(TMutableValue, TMutableValue)

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

GetDocGroupValue(Int32)

Declaration
protected override TMutableValue GetDocGroupValue(int doc)
Parameters
Type Name Description
System.Int32 doc
Returns
Type Description
TMutableValue
Overrides
Lucene.Net.Search.Grouping.AbstractFirstPassGroupingCollector<TMutableValue>.GetDocGroupValue(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.AbstractFirstPassGroupingCollector<TMutableValue>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)

Implements

Lucene.Net.Search.ICollector