Class TermDistinctValuesCollector
A term based implementation of AbstractDistinctValuesCollector{TermDistinctValuesCollector.GroupCount} that relies on Lucene.Net.Index.SortedDocValues to count the distinct values per group.
Note
This API is experimental and might change in incompatible ways in the next release.
Inheritance
Inherited Members
Namespace: Lucene.Net.Search.Grouping.Terms
Assembly: Lucene.Net.Grouping.dll
Syntax
public class TermDistinctValuesCollector : AbstractDistinctValuesCollector<TermDistinctValuesCollector.GroupCount>, IAbstractDistinctValuesCollector<TermDistinctValuesCollector.GroupCount>, ICollectorConstructors
TermDistinctValuesCollector(string, string, IEnumerable<ISearchGroup<BytesRef>>)
Constructs TermDistinctValuesCollector instance.
Declaration
public TermDistinctValuesCollector(string groupField, string countField, IEnumerable<ISearchGroup<BytesRef>> groups)Parameters
| Type | Name | Description |
|---|---|---|
| string | groupField | The field to group by |
| string | countField | The field to count distinct values for |
| IEnumerable<ISearchGroup<BytesRef>> | groups | The top N groups, collected during the first phase search |
Properties
Groups
Returns all unique values for each top N group.
Declaration
public override IEnumerable<TermDistinctValuesCollector.GroupCount> Groups { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<TermDistinctValuesCollector.GroupCount> | all unique values for each top N group |
Overrides
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
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 |