Class FacetResult

Counts or aggregates for a single dimension.

Inheritance

object

FacetResult

Implements

IFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Facet

Assembly: Lucene.Net.Facet.dll

Syntax

public sealed class FacetResult : IFormattable

Constructors

FacetResult(string, string[], int, LabelAndValue[], int)

Constructor for intvalue. Makes the ToString() method print the value as an int with no decimal.

Declaration

public FacetResult(string dim, string[] path, int value, LabelAndValue[] labelValues, int childCount)

Parameters

Type	Name	Description
string	dim
string[]	path
int	value
LabelAndValue[]	labelValues
int	childCount

FacetResult(string, string[], float, LabelAndValue[], int)

Constructor for floatvalue. Makes the ToString() method print the value as a float with at least 1 number after the decimal.

Declaration

public FacetResult(string dim, string[] path, float value, LabelAndValue[] labelValues, int childCount)

Parameters

Type	Name	Description
string	dim
string[]	path
float	value
LabelAndValue[]	labelValues
int	childCount

Properties

ChildCount

How many child labels were encountered.

Declaration

public int ChildCount { get; }

Property Value

Type	Description
int

Dim

Dimension that was requested.

Declaration

public string Dim { get; }

Property Value

Type	Description
string

LabelValues

Child counts.

Declaration

public LabelAndValue[] LabelValues { get; }

Property Value

Type	Description
LabelAndValue[]

Path

Path whose children were requested.

Declaration

public string[] Path { get; }

Property Value

Type	Description
string[]

TypeOfValue

The original data type of Value that was passed through the constructor.

Declaration

public Type TypeOfValue { get; }

Property Value

Type	Description
Type

Value

Total value for this path (sum of all child counts, or sum of all child values), even those not included in the topN.

Declaration

public float Value { get; }

Property Value

Type	Description
float

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object? other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

ToString()

Converts the value of this instance to its equivalent string representation.

Declaration

public override string ToString()

Returns

Type	Description
string	A string representation of the values of FacetResult.

Overrides

object.ToString()

ToString(IFormatProvider?)

Converts the value of this instance to its equivalent string representation using the specified culture-specific format information.

Declaration

public string ToString(IFormatProvider? provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An object that supplies culture-specific formatting information.

Returns

Type	Description
string	A string representation of the values of FacetResult as specified by provider.

Implements

IFormattable