java.lang.Object

org.elasticsearch.client.analytics.ParsedStringStats

All Implemented Interfaces:: ToXContent, ToXContentFragment, Aggregation

public class ParsedStringStats
extends ParsedAggregation

Results from the string_stats aggregation.

Method Summary

Modifier and Type	Method	Description
`protected XContentBuilder`	`doXContentBody(XContentBuilder builder, ToXContent.Params params)`
`double`	`getAvgLength()`	The average length computed over all terms.
`long`	`getCount()`	The number of non-empty fields counted.
`java.util.Map<java.lang.String,java.lang.Double>`	`getDistribution()`	The probability distribution for all characters.
`double`	`getEntropy()`	The Shannon Entropy value computed over all terms collected by the aggregation.
`int`	`getMaxLength()`	The length of the longest term.
`int`	`getMinLength()`	The length of the shortest term.
`java.lang.String`	`getType()`

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

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

isFragment

Field Details
- PARSER
  
  public static final ConstructingObjectParser<ParsedStringStats,java.lang.String> PARSER
Method Details
- getCount
  
  public long getCount()
  
  The number of non-empty fields counted.
- getMinLength
  
  public int getMinLength()
  
  The length of the shortest term.
- getMaxLength
  
  public int getMaxLength()
  
  The length of the longest term.
- getAvgLength
  
  public double getAvgLength()
  
  The average length computed over all terms.
- getEntropy
  
  public double getEntropy()
  
  The Shannon Entropy value computed over all terms collected by the aggregation. Shannon entropy quantifies the amount of information contained in the field. It is a very useful metric for measuring a wide range of properties of a data set, such as diversity, similarity, randomness etc.
- getDistribution
  
  public java.util.Map<java.lang.String,java.lang.Double> getDistribution()
  
  The probability distribution for all characters. null unless explicitly requested with StringStatsAggregationBuilder.showDistribution(boolean).
- getType
  
  public java.lang.String getType()
- doXContentBody
  
  protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
  
  Specified by:
  
  doXContentBody in class ParsedAggregation
  
  Throws:
  
  java.io.IOException

Class ParsedStringStats