org.elasticsearch.search.facet.statistical

Class InternalStatisticalFacet

java.lang.Object

org.elasticsearch.search.facet.InternalFacet

org.elasticsearch.search.facet.statistical.InternalStatisticalFacet

All Implemented Interfaces:

Streamable, ToXContent, Facet, StatisticalFacet

public class InternalStatisticalFacet
extends InternalFacet
implements StatisticalFacet

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.facet.InternalFacet

InternalFacet.ReduceContext, InternalFacet.Stream, InternalFacet.Streams

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.search.facet.statistical.StatisticalFacet

TYPE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalStatisticalFacet(String name, double min, double max, double total, double sumOfSquares, long count)

Method Summary

Modifier and Type	Method and Description
long	getCount() The number of values counted.
double	getMax() The maximum value.
double	getMean() The mean (average) of the values.
double	getMin() The minimum value.
double	getStdDeviation() Standard deviation of the values.
double	getSumOfSquares() The sum of squares of the values.
double	getTotal() The total (sum) of values.
String	getType() The type of the facet.
double	getVariance() Variance of the values.
void	readFrom(StreamInput in)
static StatisticalFacet	readStatisticalFacet(StreamInput in)
Facet	reduce(InternalFacet.ReduceContext context)
static void	registerStreams()
BytesReference	streamType()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.search.facet.InternalFacet

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.search.facet.Facet

getName

Constructor Detail

InternalStatisticalFacet

public InternalStatisticalFacet(String name,
                                double min,
                                double max,
                                double total,
                                double sumOfSquares,
                                long count)

Method Detail

registerStreams

public static void registerStreams()

streamType

public BytesReference streamType()

Specified by:

streamType in class InternalFacet

getType

public String getType()

Description copied from interface: Facet

The type of the facet.

Specified by:

getType in interface Facet

getCount

public long getCount()

Description copied from interface: StatisticalFacet

The number of values counted.

Specified by:

getCount in interface StatisticalFacet

getTotal

public double getTotal()

Description copied from interface: StatisticalFacet

The total (sum) of values.

Specified by:

getTotal in interface StatisticalFacet

getSumOfSquares

public double getSumOfSquares()

Description copied from interface: StatisticalFacet

The sum of squares of the values.

Specified by:

getSumOfSquares in interface StatisticalFacet

getMean

public double getMean()

Description copied from interface: StatisticalFacet

The mean (average) of the values.

Specified by:

getMean in interface StatisticalFacet

getMin

public double getMin()

Description copied from interface: StatisticalFacet

The minimum value.

Specified by:

getMin in interface StatisticalFacet

getMax

public double getMax()

Description copied from interface: StatisticalFacet

The maximum value.

Specified by:

getMax in interface StatisticalFacet

getVariance

public double getVariance()

Description copied from interface: StatisticalFacet

Variance of the values.

Specified by:

getVariance in interface StatisticalFacet

getStdDeviation

public double getStdDeviation()

Description copied from interface: StatisticalFacet

Standard deviation of the values.

Specified by:

getStdDeviation in interface StatisticalFacet

reduce

public Facet reduce(InternalFacet.ReduceContext context)

Specified by:

reduce in class InternalFacet

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readStatisticalFacet

public static StatisticalFacet readStatisticalFacet(StreamInput in)
                                             throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class InternalFacet

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class InternalFacet

Throws:

IOException