Class FacetFullTextField

Namespace

Examine.Lucene.Search

Assembly

Examine.Lucene.dll

Represents a full text facet field

public class FacetFullTextField : IFacetField

Inheritance

object

FacetFullTextField

Implements

IFacetField

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FacetFullTextField(string, string[], string, int, string[]?, bool)

public FacetFullTextField(string field, string[] values, string facetField, int maxCount = 10, string[]? path = null, bool isTaxonomyIndexed = false)

Parameters

field string

values string[]

facetField string

maxCount int

path 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

IsTaxonomyIndexed

Whether this field is indexed in the Taxonomy index

public bool IsTaxonomyIndexed { get; }

Property Value

bool

MaxCount

Maximum number of terms to return

public int MaxCount { get; }

Property Value

int

Path

Path hierachy

public string[]? Path { get; }

Property Value

string[]

Values

Filter values

public string[] Values { get; }

Property Value

string[]

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