Class TaxonomyFacets

Base class for all taxonomy-based facets impls.

Inheritance
System.Object
Facets
TaxonomyFacets
Int32TaxonomyFacets
SingleTaxonomyFacets
Inherited Members
Namespace: Lucene.Net.Facet.Taxonomy
Assembly: Lucene.Net.Facet.dll
Syntax
public abstract class TaxonomyFacets : Facets

Constructors

| Improve this Doc View Source

TaxonomyFacets(String, TaxonomyReader, FacetsConfig)

Sole constructor.

Declaration
protected TaxonomyFacets(string indexFieldName, TaxonomyReader taxoReader, FacetsConfig config)
Parameters
Type Name Description
System.String indexFieldName
TaxonomyReader taxoReader
FacetsConfig config

Fields

| Improve this Doc View Source

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
System.Int32[]
| Improve this Doc View Source

m_config

FacetsConfig provided to the constructor.

Declaration
protected readonly FacetsConfig m_config
Field Value
Type Description
FacetsConfig
| Improve this Doc View Source

m_indexFieldName

Index field name provided to the constructor.

Declaration
protected readonly string m_indexFieldName
Field Value
Type Description
System.String
| Improve this Doc View Source

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
System.Int32[]
| Improve this Doc View Source

m_taxoReader

TaxonomyReader provided to the constructor.

Declaration
protected readonly TaxonomyReader m_taxoReader
Field Value
Type Description
TaxonomyReader

Methods

| Improve this Doc View Source

GetAllDims(Int32)

Declaration
public override IList<FacetResult> GetAllDims(int topN)
Parameters
Type Name Description
System.Int32 topN
Returns
Type Description
IList<FacetResult>
Overrides
| Improve this Doc View Source

VerifyDim(String)

Throws 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
System.String dim
Returns
Type Description
FacetsConfig.DimConfig