Class ParsedMatrixStats

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.matrix.stats.ParsedMatrixStats

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, MatrixStats

public class ParsedMatrixStats
extends ParsedAggregation
implements MatrixStats

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields inherited from class org.opensearch.search.aggregations.ParsedAggregation

metadata

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedMatrixStats()

Method Summary

Modifier and Type	Method	Description
protected org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static ParsedMatrixStats	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String name)
double	getCorrelation(String fieldX, String fieldY)	return the correlation coefficient of field x and field y
double	getCovariance(String fieldX, String fieldY)	return the covariance between field x and field y
long	getDocCount()	return the total document count
long	getFieldCount(String field)	return total field count (differs from docCount if there are missing values)
double	getKurtosis(String field)	return the kurtosis of the distribution
double	getMean(String field)	return the field mean
double	getSkewness(String field)	return the skewness of the distribution
String	getType()
double	getVariance(String field)	return the field variance

Methods inherited from class org.opensearch.search.aggregations.ParsedAggregation

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

ParsedMatrixStats

public ParsedMatrixStats()

Method Details

getType

public String getType()

Specified by:

getType in interface Aggregation

getDocCount

public long getDocCount()

Description copied from interface: MatrixStats

return the total document count

Specified by:

getDocCount in interface MatrixStats

getFieldCount

public long getFieldCount(String field)

Description copied from interface: MatrixStats

return total field count (differs from docCount if there are missing values)

Specified by:

getFieldCount in interface MatrixStats

getMean

public double getMean(String field)

Description copied from interface: MatrixStats

return the field mean

Specified by:

getMean in interface MatrixStats

getVariance

public double getVariance(String field)

Description copied from interface: MatrixStats

return the field variance

Specified by:

getVariance in interface MatrixStats

getSkewness

public double getSkewness(String field)

Description copied from interface: MatrixStats

return the skewness of the distribution

Specified by:

getSkewness in interface MatrixStats

getKurtosis

public double getKurtosis(String field)

Description copied from interface: MatrixStats

return the kurtosis of the distribution

Specified by:

getKurtosis in interface MatrixStats

getCovariance

public double getCovariance(String fieldX,
 String fieldY)

Description copied from interface: MatrixStats

return the covariance between field x and field y

Specified by:

getCovariance in interface MatrixStats

getCorrelation

public double getCorrelation(String fieldX,
 String fieldY)

Description copied from interface: MatrixStats

return the correlation coefficient of field x and field y

Specified by:

getCorrelation in interface MatrixStats

doXContentBody

protected org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                               throws IOException

Specified by:

doXContentBody in class ParsedAggregation

Throws:

IOException

fromXContent

public static ParsedMatrixStats fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String name)
                                      throws IOException

Throws:

IOException