Class TaxonomyFacets

Base class for all taxonomy-based facets impls.

Inheritance

object

Facets

TaxonomyFacets

Int32TaxonomyFacets

SingleTaxonomyFacets

Inherited Members

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

Facets.GetSpecificValue(string, params string[])

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 TaxonomyFacets : Facets

Constructors

TaxonomyFacets(string, TaxonomyReader, FacetsConfig)

Sole constructor.

Declaration

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

Parameters

Type	Name	Description
string	indexFieldName
TaxonomyReader	taxoReader
FacetsConfig	config

Fields

m_children

Maps parent ordinal to its child, or -1 if the parent is childless.

Declaration

protected readonly int[] m_children

Field Value

Type	Description
int[]

m_config

FacetsConfig provided to the constructor.

Declaration

protected readonly FacetsConfig m_config

Field Value

Type	Description
FacetsConfig

m_indexFieldName

Index field name provided to the constructor.

Declaration

protected readonly string m_indexFieldName

Field Value

Type	Description
string

m_siblings

Maps an ordinal to its sibling, or -1 if there is no sibling.

Declaration

protected readonly int[] m_siblings

Field Value

Type	Description
int[]

m_taxoReader

TaxonomyReader provided to the constructor.

Declaration

protected readonly TaxonomyReader m_taxoReader

Field Value

Type	Description
TaxonomyReader

Methods

GetAllDims(int)

Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.

Declaration

public override IList<FacetResult> GetAllDims(int topN)

Parameters

Type	Name	Description
int	topN

Returns

Type	Description
IList<FacetResult>

Overrides

Facets.GetAllDims(int)

VerifyDim(string)

Throws ArgumentException if the dimension is not recognized. Otherwise, returns the FacetsConfig.DimConfig for this dimension.

Declaration

protected virtual FacetsConfig.DimConfig VerifyDim(string dim)

Parameters

Type	Name	Description
string	dim

Returns

Type	Description
FacetsConfig.DimConfig