org.apache.lucene.facet

Class FacetResult

java.lang.Object

org.apache.lucene.facet.FacetResult

public final class FacetResult
extends java.lang.Object

Counts or aggregates for a single dimension.

Field Summary

Fields

Modifier and Type	Field and Description
int	childCount How many child labels were encountered.
java.lang.String	dim Dimension that was requested.
LabelAndValue[]	labelValues Child counts.
java.lang.String[]	path Path whose children were requested.
java.lang.Number	value Total value for this path (sum of all child counts, or sum of all child values), even those not included in the topN.

Constructor Summary

Constructors

Constructor and Description
FacetResult(java.lang.String dim, java.lang.String[] path, java.lang.Number value, LabelAndValue[] labelValues, int childCount) Sole constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object _other)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

dim

public final java.lang.String dim

Dimension that was requested.

path

public final java.lang.String[] path

Path whose children were requested.

value

public final java.lang.Number value

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

childCount

public final int childCount

How many child labels were encountered.

labelValues

public final LabelAndValue[] labelValues

Child counts.

Constructor Detail

FacetResult

public FacetResult(java.lang.String dim,
                   java.lang.String[] path,
                   java.lang.Number value,
                   LabelAndValue[] labelValues,
                   int childCount)

Sole constructor.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object _other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object