Class FunctionAllGroupsCollector<TMutableValue>

A collector that collects all groups that match the query. Only the group value is collected, and the order is undefined. This collector does not determine the most relevant document of a group.

Implementation detail: Uses Lucene.Net.Queries.Function.ValueSource and Lucene.Net.Queries.Function.FunctionValues to retrieve the field values to group by.

Note

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

Inheritance
System.Object
AbstractAllGroupsCollector<Lucene.Net.Util.Mutable.MutableValue>
FunctionAllGroupsCollector<TMutableValue>
Implements
IAbstractAllGroupsCollector<Lucene.Net.Util.Mutable.MutableValue>
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 FunctionAllGroupsCollector<TMutableValue> : AbstractAllGroupsCollector<MutableValue>, IAbstractAllGroupsCollector<MutableValue>, ICollector where TMutableValue : MutableValue
Type Parameters
Name Description
TMutableValue

Constructors

| Improve this Doc View Source

FunctionAllGroupsCollector(ValueSource, IDictionary)

Constructs a FunctionAllGroupsCollector<TMutableValue> instance.

Declaration
public FunctionAllGroupsCollector(ValueSource groupBy, IDictionary vsContext)
Parameters
Type Name Description
Lucene.Net.Queries.Function.ValueSource groupBy

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

The Lucene.Net.Queries.Function.ValueSource context

Properties

| Improve this Doc View Source

Groups

Declaration
public override IEnumerable<MutableValue> Groups { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Lucene.Net.Util.Mutable.MutableValue>
Overrides
Lucene.Net.Search.Grouping.AbstractAllGroupsCollector<Lucene.Net.Util.Mutable.MutableValue>.Groups

Methods

| Improve this Doc View Source

Collect(Int32)

Declaration
public override void Collect(int doc)
Parameters
Type Name Description
System.Int32 doc
Overrides
Lucene.Net.Search.Grouping.AbstractAllGroupsCollector<Lucene.Net.Util.Mutable.MutableValue>.Collect(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.AbstractAllGroupsCollector<Lucene.Net.Util.Mutable.MutableValue>.SetNextReader(Lucene.Net.Index.AtomicReaderContext)

Implements

Lucene.Net.Search.ICollector