Struct FacetFloatField

Namespace

Examine.Lucene.Search

Assembly

Examine.Lucene.dll

Represents a float facet field

public readonly struct FacetFloatField : IFacetField

Implements

IFacetField

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

FacetFloatField(string, FloatRange[], string, bool)

public FacetFloatField(string field, FloatRange[] floatRanges, string facetField, bool isTaxonomyIndexed = false)

Parameters

field string

floatRanges FloatRange[]

facetField string

isTaxonomyIndexed bool

Properties

FacetField

The field to get the facet field from

public string FacetField { get; }

Property Value

string

Field

The field name

public string Field { get; }

Property Value

string

FloatRanges

The float ranges for the field

public FloatRange[] FloatRanges { get; }

Property Value

FloatRange[]

IsTaxonomyIndexed

Whether this field is indexed in the Taxonomy index

public bool IsTaxonomyIndexed { get; }

Property Value

bool

Methods

ExtractFacets(IFacetExtractionContext)

Extracts the facets from the field

public IEnumerable<KeyValuePair<string, IFacetResult>> ExtractFacets(IFacetExtractionContext facetExtractionContext)

Parameters

facetExtractionContext IFacetExtractionContext

Returns

IEnumerable<KeyValuePair<string, IFacetResult>>

Returns the facets for this field