AggregateStatisticsRequest (Kinetica Java API 6.0.1 API)

java.lang.Object
- com.gpudb.protocol.AggregateStatisticsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class AggregateStatisticsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.aggregateStatistics(AggregateStatisticsRequest).
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.
Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation--individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AggregateStatisticsRequest.Options` Optional parameters.
`static class`	`AggregateStatisticsRequest.Stats` Comma separated list of the statistics to calculate, e.g.

Constructor Summary

Constructors
Constructor and Description
`AggregateStatisticsRequest()` Constructs an AggregateStatisticsRequest object with default parameters.
`AggregateStatisticsRequest(String tableName, String columnName, String stats, Map<String,String> options)` Constructs an AggregateStatisticsRequest object with the specified parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getColumnName()`
`Map<String,String>`	`getOptions()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getStats()`
`String`	`getTableName()`
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`AggregateStatisticsRequest`	`setColumnName(String columnName)`
`AggregateStatisticsRequest`	`setOptions(Map<String,String> options)`
`AggregateStatisticsRequest`	`setStats(String stats)`
`AggregateStatisticsRequest`	`setTableName(String tableName)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AggregateStatisticsRequest
```
public AggregateStatisticsRequest()
```
    Constructs an AggregateStatisticsRequest object with default parameters.
  - AggregateStatisticsRequest
```
public AggregateStatisticsRequest(String tableName,
                          String columnName,
                          String stats,
                          Map<String,String> options)
```
    Constructs an AggregateStatisticsRequest object with the specified parameters.
    Parameters:
    tableName - Name of the table on which the statistics operation will be performed.
    columnName - Name of the primary column for which the statistics are to be calculated.
    stats - Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
    
    COUNT: Number of objects (independent of the given column(s)).
    MEAN: Arithmetic mean (average), equivalent to sum/count.
    STDV: Sample standard deviation (denominator is count-1).
    VARIANCE: Unbiased sample variance (denominator is count-1).
    SKEW: Skewness (third standardized moment).
    KURTOSIS: Kurtosis (fourth standardized moment).
    SUM: Sum of all values in the column(s).
    MIN: Minimum value of the column(s).
    MAX: Maximum value of the column(s).
    WEIGHTED_AVERAGE: Weighted arithmetic mean (using the option weight_column_name as the weighting column).
    CARDINALITY: Number of unique values in the column(s).
    ESTIMATED_CARDINALITY: Estimate (via hyperloglog technique) of the number of unique values in the column(s).
    PERCENTILE: Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median).
    PERCENTILE_RANK: Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile_rank() will return approximately 50.0).
    options - Optional parameters.
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and columnName must be of the same type. Must not include the column specified in columnName and no column can be listed twice.
    WEIGHT_COLUMN_NAME: Name of column used as weighting attribute for the weighted average statistic.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    the schema for the class.
  - getTableName
```
public String getTableName()
```
    Returns:
    Name of the table on which the statistics operation will be performed.
  - setTableName
```
public AggregateStatisticsRequest setTableName(String tableName)
```
    Parameters:
    tableName - Name of the table on which the statistics operation will be performed.
    
    Returns:
    this to mimic the builder pattern.
  - getColumnName
```
public String getColumnName()
```
    Returns:
    Name of the primary column for which the statistics are to be calculated.
  - setColumnName
```
public AggregateStatisticsRequest setColumnName(String columnName)
```
    Parameters:
    columnName - Name of the primary column for which the statistics are to be calculated.
    
    Returns:
    this to mimic the builder pattern.
  - getStats
```
public String getStats()
```
    Returns:
    Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
    
    COUNT: Number of objects (independent of the given column(s)).
    MEAN: Arithmetic mean (average), equivalent to sum/count.
    STDV: Sample standard deviation (denominator is count-1).
    VARIANCE: Unbiased sample variance (denominator is count-1).
    SKEW: Skewness (third standardized moment).
    KURTOSIS: Kurtosis (fourth standardized moment).
    SUM: Sum of all values in the column(s).
    MIN: Minimum value of the column(s).
    MAX: Maximum value of the column(s).
    WEIGHTED_AVERAGE: Weighted arithmetic mean (using the option weight_column_name as the weighting column).
    CARDINALITY: Number of unique values in the column(s).
    ESTIMATED_CARDINALITY: Estimate (via hyperloglog technique) of the number of unique values in the column(s).
    PERCENTILE: Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median).
    PERCENTILE_RANK: Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile_rank() will return approximately 50.0).
  - setStats
```
public AggregateStatisticsRequest setStats(String stats)
```
    Parameters:
    stats - Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
    
    COUNT: Number of objects (independent of the given column(s)).
    MEAN: Arithmetic mean (average), equivalent to sum/count.
    STDV: Sample standard deviation (denominator is count-1).
    VARIANCE: Unbiased sample variance (denominator is count-1).
    SKEW: Skewness (third standardized moment).
    KURTOSIS: Kurtosis (fourth standardized moment).
    SUM: Sum of all values in the column(s).
    MIN: Minimum value of the column(s).
    MAX: Maximum value of the column(s).
    WEIGHTED_AVERAGE: Weighted arithmetic mean (using the option weight_column_name as the weighting column).
    CARDINALITY: Number of unique values in the column(s).
    ESTIMATED_CARDINALITY: Estimate (via hyperloglog technique) of the number of unique values in the column(s).
    PERCENTILE: Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median).
    PERCENTILE_RANK: Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile_rank() will return approximately 50.0).
    Returns:
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    Optional parameters.
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and columnName must be of the same type. Must not include the column specified in columnName and no column can be listed twice.
    WEIGHT_COLUMN_NAME: Name of column used as weighting attribute for the weighted average statistic.
  - setOptions
```
public AggregateStatisticsRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Optional parameters.
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and columnName must be of the same type. Must not include the column specified in columnName and no column can be listed twice.
    WEIGHT_COLUMN_NAME: Name of column used as weighting attribute for the weighted average statistic.
    Returns:
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    the schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    index - the position of the field to get
    
    Returns:
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
       Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    index - the position of the field to set
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AggregateStatisticsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AggregateStatisticsRequest

AggregateStatisticsRequest

Method Detail

getClassSchema

getTableName

setTableName

getColumnName

setColumnName

getStats

setStats

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode