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

Class ParsedMatrixStats

java.lang.Object
org.elasticsearch.search.aggregations.ParsedAggregation
org.elasticsearch.search.aggregations.matrix.stats.ParsedMatrixStats
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, org.elasticsearch.search.aggregations.Aggregation, MatrixStats
public class ParsedMatrixStats
extends org.elasticsearch.search.aggregations.ParsedAggregation
implements MatrixStats

  • 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 class org.elasticsearch.search.aggregations.ParsedAggregation

    metadata

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

    TYPED_KEYS_DELIMITER

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    ParsedMatrixStats()  

  • Method Summary

    Modifier and Type Method Description
    protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    static ParsedMatrixStats fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String name)  
    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
    java.lang.String getType()  
    double getVariance​(java.lang.String field)
    return the field variance

    Methods inherited from class org.elasticsearch.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.elasticsearch.search.aggregations.Aggregation

    getMetadata, getName

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

    toXContent

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

    isFragment

  • Constructor Details

    • ParsedMatrixStats

      public ParsedMatrixStats()

  • Method Details

    • getType

      public java.lang.String getType()
      Specified by:
      getType in interface org.elasticsearch.search.aggregations.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​(java.lang.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​(java.lang.String field)
      Description copied from interface: MatrixStats
      return the field mean
      Specified by:
      getMean in interface MatrixStats

    • getVariance

      public double getVariance​(java.lang.String field)
      Description copied from interface: MatrixStats
      return the field variance
      Specified by:
      getVariance in interface MatrixStats

    • getSkewness

      public double getSkewness​(java.lang.String field)
      Description copied from interface: MatrixStats
      return the skewness of the distribution
      Specified by:
      getSkewness in interface MatrixStats

    • getKurtosis

      public double getKurtosis​(java.lang.String field)
      Description copied from interface: MatrixStats
      return the kurtosis of the distribution
      Specified by:
      getKurtosis in interface MatrixStats

    • getCovariance

      public double getCovariance​(java.lang.String fieldX, java.lang.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​(java.lang.String fieldX, java.lang.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.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      doXContentBody in class org.elasticsearch.search.aggregations.ParsedAggregation
      Throws:
      java.io.IOException

    • fromXContent

      public static ParsedMatrixStats fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String name) throws java.io.IOException
      Throws:
      java.io.IOException