Class FieldStats

    • Constructor Summary

      Constructors 
      Constructor Description
      FieldStats()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FieldStats clone()  
      boolean equals​(Object obj)  
      Long getCount()
      The number of documents that contain a value in the specified field in the result set.
      String getMax()
      The maximum value found in the specified field in the result set.
      String getMean()
      The average of the values found in the specified field in the result set.
      String getMin()
      The minimum value found in the specified field in the result set.
      Long getMissing()
      The number of documents that do not contain a value in the specified field in the result set.
      Double getStddev()
      The standard deviation of the values in the specified field in the result set.
      Double getSum()
      The sum of the field values across the documents in the result set.
      Double getSumOfSquares()
      The sum of all field values in the result set squared.
      int hashCode()  
      void setCount​(Long count)
      The number of documents that contain a value in the specified field in the result set.
      void setMax​(String max)
      The maximum value found in the specified field in the result set.
      void setMean​(String mean)
      The average of the values found in the specified field in the result set.
      void setMin​(String min)
      The minimum value found in the specified field in the result set.
      void setMissing​(Long missing)
      The number of documents that do not contain a value in the specified field in the result set.
      void setStddev​(Double stddev)
      The standard deviation of the values in the specified field in the result set.
      void setSum​(Double sum)
      The sum of the field values across the documents in the result set.
      void setSumOfSquares​(Double sumOfSquares)
      The sum of all field values in the result set squared.
      String toString()
      Returns a string representation of this object; useful for testing and debugging.
      FieldStats withCount​(Long count)
      The number of documents that contain a value in the specified field in the result set.
      FieldStats withMax​(String max)
      The maximum value found in the specified field in the result set.
      FieldStats withMean​(String mean)
      The average of the values found in the specified field in the result set.
      FieldStats withMin​(String min)
      The minimum value found in the specified field in the result set.
      FieldStats withMissing​(Long missing)
      The number of documents that do not contain a value in the specified field in the result set.
      FieldStats withStddev​(Double stddev)
      The standard deviation of the values in the specified field in the result set.
      FieldStats withSum​(Double sum)
      The sum of the field values across the documents in the result set.
      FieldStats withSumOfSquares​(Double sumOfSquares)
      The sum of all field values in the result set squared.
    • Constructor Detail

      • FieldStats

        public FieldStats()
    • Method Detail

      • setMin

        public void setMin​(String min)

        The minimum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Parameters:
        min - The minimum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

      • getMin

        public String getMin()

        The minimum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Returns:
        The minimum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

      • withMin

        public FieldStats withMin​(String min)

        The minimum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Parameters:
        min - The minimum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setMax

        public void setMax​(String max)

        The maximum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Parameters:
        max - The maximum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

      • getMax

        public String getMax()

        The maximum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Returns:
        The maximum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

      • withMax

        public FieldStats withMax​(String max)

        The maximum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Parameters:
        max - The maximum value found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCount

        public void setCount​(Long count)

        The number of documents that contain a value in the specified field in the result set.

        Parameters:
        count - The number of documents that contain a value in the specified field in the result set.
      • getCount

        public Long getCount()

        The number of documents that contain a value in the specified field in the result set.

        Returns:
        The number of documents that contain a value in the specified field in the result set.
      • withCount

        public FieldStats withCount​(Long count)

        The number of documents that contain a value in the specified field in the result set.

        Parameters:
        count - The number of documents that contain a value in the specified field in the result set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setMissing

        public void setMissing​(Long missing)

        The number of documents that do not contain a value in the specified field in the result set.

        Parameters:
        missing - The number of documents that do not contain a value in the specified field in the result set.
      • getMissing

        public Long getMissing()

        The number of documents that do not contain a value in the specified field in the result set.

        Returns:
        The number of documents that do not contain a value in the specified field in the result set.
      • withMissing

        public FieldStats withMissing​(Long missing)

        The number of documents that do not contain a value in the specified field in the result set.

        Parameters:
        missing - The number of documents that do not contain a value in the specified field in the result set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSum

        public void setSum​(Double sum)

        The sum of the field values across the documents in the result set. null for date fields.

        Parameters:
        sum - The sum of the field values across the documents in the result set. null for date fields.
      • getSum

        public Double getSum()

        The sum of the field values across the documents in the result set. null for date fields.

        Returns:
        The sum of the field values across the documents in the result set. null for date fields.
      • withSum

        public FieldStats withSum​(Double sum)

        The sum of the field values across the documents in the result set. null for date fields.

        Parameters:
        sum - The sum of the field values across the documents in the result set. null for date fields.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSumOfSquares

        public void setSumOfSquares​(Double sumOfSquares)

        The sum of all field values in the result set squared.

        Parameters:
        sumOfSquares - The sum of all field values in the result set squared.
      • getSumOfSquares

        public Double getSumOfSquares()

        The sum of all field values in the result set squared.

        Returns:
        The sum of all field values in the result set squared.
      • withSumOfSquares

        public FieldStats withSumOfSquares​(Double sumOfSquares)

        The sum of all field values in the result set squared.

        Parameters:
        sumOfSquares - The sum of all field values in the result set squared.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setMean

        public void setMean​(String mean)

        The average of the values found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Parameters:
        mean - The average of the values found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

      • getMean

        public String getMean()

        The average of the values found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Returns:
        The average of the values found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

      • withMean

        public FieldStats withMean​(String mean)

        The average of the values found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Parameters:
        mean - The average of the values found in the specified field in the result set.

        If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStddev

        public void setStddev​(Double stddev)

        The standard deviation of the values in the specified field in the result set.

        Parameters:
        stddev - The standard deviation of the values in the specified field in the result set.
      • getStddev

        public Double getStddev()

        The standard deviation of the values in the specified field in the result set.

        Returns:
        The standard deviation of the values in the specified field in the result set.
      • withStddev

        public FieldStats withStddev​(Double stddev)

        The standard deviation of the values in the specified field in the result set.

        Parameters:
        stddev - The standard deviation of the values in the specified field in the result set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object