Class FacetResult

Counts or aggregates for a single dimension.

Inheritance

System.Object

FacetResult

Namespace: Lucene.Net.Facet

Assembly: Lucene.Net.Facet.dll

Syntax

public sealed class FacetResult : object

Constructors

| Improve this Doc View Source

FacetResult(String, String[], Int32, LabelAndValue[], Int32)

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

Declaration

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

Parameters

Type	Name	Description
System.String	dim
System.String[]	path
System.Int32	value
LabelAndValue[]	labelValues
System.Int32	childCount

| Improve this Doc View Source

FacetResult(String, String[], Single, LabelAndValue[], Int32)

Constructor for value. Makes the ToString() method print the value as a 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
System.String	dim
System.String[]	path
System.Single	value
LabelAndValue[]	labelValues
System.Int32	childCount

Properties

| Improve this Doc View Source

ChildCount

How many child labels were encountered.

Declaration

public int ChildCount { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Dim

Dimension that was requested.

Declaration

public string Dim { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LabelValues

Child counts.

Declaration

public LabelAndValue[] LabelValues { get; }

Property Value

Type	Description
LabelAndValue[]

| Improve this Doc View Source

Path

Path whose children were requested.

Declaration

public string[] Path { get; }

Property Value

Type	Description
System.String[]

| Improve this Doc View Source

TypeOfValue

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

Declaration

public Type TypeOfValue { get; }

Property Value

Type	Description
Type

| Improve this Doc View Source

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
System.Single

Methods

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String