Package org.elasticsearch.search.aggregations.matrix.stats

Interface MatrixStats

All Superinterfaces:
org.elasticsearch.search.aggregations.Aggregation, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
All Known Implementing Classes:
InternalMatrixStats, ParsedMatrixStats
public interface MatrixStats extends org.elasticsearch.search.aggregations.Aggregation
Interface for MatrixStats Metric Aggregation

  • Nested Class Summary

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

    org.elasticsearch.search.aggregations.Aggregation.CommonFields

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

  • Field Summary

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

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    double
    getVariance(String field)
    return the field variance

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

    getMetadata, getName, getType

    Methods inherited from interface org.elasticsearch.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

    isFragment

  • Method Details

    • getDocCount

      long getDocCount()
      return the total document count

    • getFieldCount

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

    • getMean

      double getMean(String field)
      return the field mean

    • getVariance

      double getVariance(String field)
      return the field variance

    • getSkewness

      double getSkewness(String field)
      return the skewness of the distribution

    • getKurtosis

      double getKurtosis(String field)
      return the kurtosis of the distribution

    • getCovariance

      double getCovariance(String fieldX, String fieldY)
      return the covariance between field x and field y

    • getCorrelation

      double getCorrelation(String fieldX, String fieldY)
      return the correlation coefficient of field x and field y