Class AbstractDistinctValuesCollector<GC>

A second pass grouping collector that keeps track of distinct values for a specified field for the top N group.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk

Inheritance

System.Object

AbstractDistinctValuesCollector<GC>

FunctionDistinctValuesCollector

TermDistinctValuesCollector

Implements

IAbstractDistinctValuesCollector<GC>

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

Assembly: Lucene.Net.Grouping.dll

Syntax

public abstract class AbstractDistinctValuesCollector<GC> : IAbstractDistinctValuesCollector<GC>, ICollector where GC : AbstractDistinctValuesCollector.IGroupCount<object>

Type Parameters

Name	Description
GC

Properties

AcceptsDocsOutOfOrder

Declaration

public virtual bool AcceptsDocsOutOfOrder { get; }

Property Value

Type	Description
System.Boolean

Groups

Returns all unique values for each top N group.

Declaration

public abstract IEnumerable<GC> Groups { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<GC>	all unique values for each top N group

Methods

Collect(Int32)

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 CollectionTerminatedException. In this case, the last docs of the current AtomicReaderContext will be skipped and 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(Int32) or Document(Int32) on every hit. Doing so can slow searches by an order of magnitude or more.

Declaration

public abstract void Collect(int doc)

Parameters

Type	Name	Description
System.Int32	doc

SetNextReader(AtomicReaderContext)

Called before collecting from each AtomicReaderContext. All doc ids in Collect(Int32) will correspond to Reader.

Add DocBase to the current Reader's internal document id to re-base ids in Collect(Int32).

Declaration

public abstract void SetNextReader(AtomicReaderContext context)

Parameters

Type	Name	Description
AtomicReaderContext	context	next atomic reader context

SetScorer(Scorer)

Declaration

public virtual void SetScorer(Scorer scorer)

Parameters

Type	Name	Description
Scorer	scorer

Implements

IAbstractDistinctValuesCollector<GC>

ICollector