Class AbstractGroupFacetCollector

Base class for computing grouped facets.

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

Inheritance

System.Object

AbstractGroupFacetCollector

TermGroupFacetCollector

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

Assembly: Lucene.Net.Grouping.dll

Syntax

public abstract class AbstractGroupFacetCollector : ICollector

Constructors

| Improve this Doc View Source

AbstractGroupFacetCollector(String, String, BytesRef)

Declaration

protected AbstractGroupFacetCollector(string groupField, string facetField, BytesRef facetPrefix)

Parameters

Type	Name	Description
System.String	groupField
System.String	facetField
Lucene.Net.Util.BytesRef	facetPrefix

Fields

| Improve this Doc View Source

m_endFacetOrd

Declaration

protected int m_endFacetOrd

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

m_facetField

Declaration

protected readonly string m_facetField

Field Value

Type	Description
System.String

| Improve this Doc View Source

m_facetPrefix

Declaration

protected readonly BytesRef m_facetPrefix

Field Value

Type	Description
Lucene.Net.Util.BytesRef

| Improve this Doc View Source

m_groupField

Declaration

protected readonly string m_groupField

Field Value

Type	Description
System.String

| Improve this Doc View Source

m_segmentFacetCounts

Declaration

protected int[] m_segmentFacetCounts

Field Value

Type	Description
System.Int32[]

| Improve this Doc View Source

m_segmentResults

Declaration

protected readonly IList<AbstractGroupFacetCollector.AbstractSegmentResult> m_segmentResults

Field Value

Type	Description
System.Collections.Generic.IList<AbstractGroupFacetCollector.AbstractSegmentResult>

| Improve this Doc View Source

m_segmentTotalCount

Declaration

protected int m_segmentTotalCount

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

m_startFacetOrd

Declaration

protected int m_startFacetOrd

Field Value

Type	Description
System.Int32

Properties

| Improve this Doc View Source

AcceptsDocsOutOfOrder

Declaration

public virtual bool AcceptsDocsOutOfOrder { get; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

Collect(Int32)

Declaration

public abstract void Collect(int doc)

Parameters

Type	Name	Description
System.Int32	doc

| Improve this Doc View Source

CreateSegmentResult()

Declaration

protected abstract AbstractGroupFacetCollector.AbstractSegmentResult CreateSegmentResult()

Returns

Type	Description
AbstractGroupFacetCollector.AbstractSegmentResult

| Improve this Doc View Source

MergeSegmentResults(Int32, Int32, Boolean)

Returns grouped facet results that were computed over zero or more segments. Grouped facet counts are merged from zero or more segment results.

Declaration

public virtual AbstractGroupFacetCollector.GroupedFacetResult MergeSegmentResults(int size, int minCount, bool orderByCount)

Parameters

Type	Name	Description
System.Int32	size	The total number of facets to include. This is typically offset + limit
System.Int32	minCount	The minimum count a facet entry should have to be included in the grouped facet result
System.Boolean	orderByCount	Whether to sort the facet entries by facet entry count. If `false` then the facets are sorted lexicographically in ascending order.

Returns

Type	Description
AbstractGroupFacetCollector.GroupedFacetResult	grouped facet results

Exceptions

Type	Condition
System.IO.IOException	If I/O related errors occur during merging segment grouped facet counts.

| Improve this Doc View Source

SetNextReader(AtomicReaderContext)

Declaration

public abstract void SetNextReader(AtomicReaderContext context)

Parameters

Type	Name	Description
Lucene.Net.Index.AtomicReaderContext	context

| Improve this Doc View Source

SetScorer(Scorer)

Declaration

public virtual void SetScorer(Scorer scorer)

Parameters

Type	Name	Description
Lucene.Net.Search.Scorer	scorer

Implements

Lucene.Net.Search.ICollector