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

object

AbstractAllGroupsCollector<MutableValue>

FunctionAllGroupsCollector<TMutableValue>

Implements

IAbstractAllGroupsCollector<MutableValue>

ICollector

Inherited Members

AbstractAllGroupsCollector<MutableValue>.GroupCount

AbstractAllGroupsCollector<MutableValue>.SetScorer(Scorer)

AbstractAllGroupsCollector<MutableValue>.AcceptsDocsOutOfOrder

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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

FunctionAllGroupsCollector(ValueSource, IDictionary)

Constructs a FunctionAllGroupsCollector<TMutableValue> instance.

Declaration

public FunctionAllGroupsCollector(ValueSource groupBy, IDictionary vsContext)

Parameters

Type	Name	Description
ValueSource	groupBy	The Lucene.Net.Queries.Function.ValueSource to group by
IDictionary	vsContext	The Lucene.Net.Queries.Function.ValueSource context

Properties

Groups

Returns the group values

This is an unordered collections of group values. For each group that matched the query there is a Lucene.Net.Util.BytesRef representing a group value.

Declaration

public override IEnumerable<MutableValue> Groups { get; }

Property Value

Type	Description
IEnumerable<MutableValue>	the group values

Overrides

AbstractAllGroupsCollector<MutableValue>.Groups

Methods

Collect(int)

Called once for every document matching a query, with the unbased document number.

Note: The collection of the current segment can be terminated by throwing a Lucene.Net.Search.CollectionTerminatedException. In this case, the last docs of the current Lucene.Net.Index.AtomicReaderContext will be skipped and Lucene.Net.Search.IndexSearcher will swallow the exception and continue collection with the next leaf.

Note: this is called in an inner search loop. For good search performance, implementations of this method should not call Doc(int) or Document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Declaration

public override void Collect(int doc)

Parameters

Type	Name	Description
int	doc

Overrides

AbstractAllGroupsCollector<MutableValue>.Collect(int)

SetNextReader(AtomicReaderContext)

Called before collecting from each Lucene.Net.Index.AtomicReaderContext. All doc ids in Collect(int) will correspond to Lucene.Net.Index.IndexReaderContext.Reader.

Add Lucene.Net.Index.AtomicReaderContext.DocBase to the current Lucene.Net.Index.IndexReaderContext.Reader's internal document id to re-base ids in Collect(int).

Declaration

public override void SetNextReader(AtomicReaderContext context)

Parameters

Type	Name	Description
AtomicReaderContext	context	next atomic reader context

Overrides

AbstractAllGroupsCollector<MutableValue>.SetNextReader(AtomicReaderContext)

Implements

IAbstractAllGroupsCollector<TGroupValue>

Lucene.Net.Search.ICollector