Class SingleTaxonomyFacets

Base class for all taxonomy-based facets that aggregate to a per-ords float[].

NOTE: This was FloatTaxonomyFacets in Lucene

Inheritance

object

Facets

TaxonomyFacets

SingleTaxonomyFacets

TaxonomyFacetSumSingleAssociations

TaxonomyFacetSumValueSource

Inherited Members

TaxonomyFacets.m_indexFieldName

TaxonomyFacets.m_taxoReader

TaxonomyFacets.m_config

TaxonomyFacets.m_children

TaxonomyFacets.m_siblings

TaxonomyFacets.VerifyDim(string)

TaxonomyFacets.GetAllDims(int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Facet.Taxonomy

Assembly: Lucene.Net.Facet.dll

Syntax

public abstract class SingleTaxonomyFacets : TaxonomyFacets

Constructors

SingleTaxonomyFacets(string, TaxonomyReader, FacetsConfig)

Sole constructor.

Declaration

protected SingleTaxonomyFacets(string indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)

Parameters

Type	Name	Description
string	indexFieldName
TaxonomyReader	taxoReader
FacetsConfig	config

Fields

m_values

Per-ordinal value.

Declaration

protected readonly float[] m_values

Field Value

Type	Description
float[]

Methods

GetSpecificValue(string, params string[])

Return the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.

Declaration

public override float GetSpecificValue(string dim, params string[] path)

Parameters

Type	Name	Description
string	dim
string[]	path

Returns

Type	Description
float

Overrides

Facets.GetSpecificValue(string, params string[])

GetTopChildren(int, string, params string[])

Returns the topN child labels under the specified path. Returns null if the specified path doesn't exist or if this dimension was never seen.

Declaration

public override FacetResult? GetTopChildren(int topN, string dim, params string[] path)

Parameters

Type	Name	Description
int	topN
string	dim
string[]	path

Returns

Type	Description
FacetResult

Overrides

Facets.GetTopChildren(int, string, params string[])

Rollup()

Rolls up any single-valued hierarchical dimensions.

Declaration

protected virtual void Rollup()