Class FacetsConfig

Records per-dimension configuration. By default a dimension is flat, single valued and does not require count for the dimension; use the setters in this class to change these settings for each dim.

NOTE: this configuration is not saved into the index, but it's vital, and up to the application to ensure, that at search time the provided FacetsConfig matches what was used during indexing. @lucene.experimental

Inheritance
System.Object
FacetsConfig
Assembly: DistributedLucene.Net.Facet.dll
Syntax
public class FacetsConfig : IDisposable, IIdentifiableSurrogate

Constructors

Name Description
FacetsConfig(String)

Default constructor.

Fields

Name Description
DEFAULT_DIM_CONFIG

Default per-dimension configuration.

DEFAULT_INDEX_FIELD_NAME

Which Lucene field holds the drill-downs and ords (as doc values).

Properties

Name Description
DefaultDimConfig

Get the default configuration for new dimensions. Useful when the dimension is not known beforehand and may need different global default settings, like multivalue = true.
DimConfigs

Returns map of field name to FacetsConfig.DimConfig.

Methods

Name Description
Dispose()
GetDimConfig(String)

Get the current configuration for a dimension.
GetSurrogateId()
PathToString(String, String[])

Turns a dim + path into an encoded string.
PathToString(String[])

Turns a dim + path into an encoded string.
PathToString(String[], Int32)

Turns the first length elements of path into an encoded string.

SetHierarchical(String, Boolean)

Pass true if this dimension is hierarchical (has depth > 1 paths).

SetIndexFieldName(String, String)

Specify which index field name should hold the ordinals for this dimension; this is only used by the taxonomy based facet methods.

SetMultiValued(String, Boolean)

Pass true if this dimension may have more than one value per document.

SetRequireDimCount(String, Boolean)

Pass true if at search time you require accurate counts of the dimension, i.e. how many hits have this dimension.

StringToPath(String)

Turns an encoded string (from a previous call to PathToString(String[])) back into the original string[].

Extension Methods