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

Interface MatrixStats

  • All Superinterfaces:
    org.elasticsearch.search.aggregations.Aggregation, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.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.common.xcontent.ToXContent

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

    • Field Summary

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

        TYPED_KEYS_DELIMITER

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

        EMPTY_PARAMS

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getCorrelation​(java.lang.String fieldX, java.lang.String fieldY)
      return the correlation coefficient of field x and field y
      double getCovariance​(java.lang.String fieldX, java.lang.String fieldY)
      return the covariance between field x and field y
      long getDocCount()
      return the total document count
      long getFieldCount​(java.lang.String field)
      return total field count (differs from docCount if there are missing values)
      double getKurtosis​(java.lang.String field)
      return the kurtosis of the distribution
      double getMean​(java.lang.String field)
      return the field mean
      double getSkewness​(java.lang.String field)
      return the skewness of the distribution
      double getVariance​(java.lang.String field)
      return the field variance

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

        getMetaData, getName, getType

      • Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

        toXContent

      • Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

        isFragment

    • Method Detail

      • getDocCount

        long getDocCount()
        return the total document count

      • getFieldCount

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

      • getMean

        double getMean​(java.lang.String field)
        return the field mean

      • getVariance

        double getVariance​(java.lang.String field)
        return the field variance

      • getSkewness

        double getSkewness​(java.lang.String field)
        return the skewness of the distribution

      • getKurtosis

        double getKurtosis​(java.lang.String field)
        return the kurtosis of the distribution

      • getCovariance

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

      • getCorrelation

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