AggregateStatisticsByRangeRequest (Kinetica Java API 7.0.19.0 API)

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

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class AggregateStatisticsByRangeRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.aggregateStatisticsByRange(AggregateStatisticsByRangeRequest).
Divides the given set into bins and calculates statistics of the values of a value-column in each bin. The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.
There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AggregateStatisticsByRangeRequest.Options` Map of optional parameters: `ADDITIONAL_COLUMN_NAMES`: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.

Constructor Summary

Constructors
Constructor and Description
`AggregateStatisticsByRangeRequest()` Constructs an AggregateStatisticsByRangeRequest object with default parameters.
`AggregateStatisticsByRangeRequest(String tableName, String selectExpression, String columnName, String valueColumnName, String stats, double start, double end, double interval, Map<String,String> options)` Constructs an AggregateStatisticsByRangeRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete 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()`
`double`	`getEnd()`
`double`	`getInterval()`
`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`	`getSelectExpression()`
`double`	`getStart()`
`String`	`getStats()`
`String`	`getTableName()`
`String`	`getValueColumnName()`
`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.
`AggregateStatisticsByRangeRequest`	`setColumnName(String columnName)`
`AggregateStatisticsByRangeRequest`	`setEnd(double end)`
`AggregateStatisticsByRangeRequest`	`setInterval(double interval)`
`AggregateStatisticsByRangeRequest`	`setOptions(Map<String,String> options)`
`AggregateStatisticsByRangeRequest`	`setSelectExpression(String selectExpression)`
`AggregateStatisticsByRangeRequest`	`setStart(double start)`
`AggregateStatisticsByRangeRequest`	`setStats(String stats)`
`AggregateStatisticsByRangeRequest`	`setTableName(String tableName)`
`AggregateStatisticsByRangeRequest`	`setValueColumnName(String valueColumnName)`
`String`	`toString()`

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

- Constructor Detail
  - AggregateStatisticsByRangeRequest
```
public AggregateStatisticsByRangeRequest()
```
    Constructs an AggregateStatisticsByRangeRequest object with default parameters.
  - AggregateStatisticsByRangeRequest
```
public AggregateStatisticsByRangeRequest(String tableName,
                                         String selectExpression,
                                         String columnName,
                                         String valueColumnName,
                                         String stats,
                                         double start,
                                         double end,
                                         double interval,
                                         Map<String,String> options)
```
    Constructs an AggregateStatisticsByRangeRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the table on which the ranged-statistics operation will be performed.
    
    selectExpression - For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
    
    columnName - Name of the binning-column used to divide the set samples into bins.
    
    valueColumnName - Name of the value-column for which statistics are to be computed.
    
    stats - A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
    
    start - The lower bound of the binning-column.
    
    end - The upper bound of the binning-column.
    
    interval - The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)).
    options - Map of optional parameters:
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
    BIN_VALUES: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
    WEIGHT_COLUMN_NAME: Name of the column used as weighting column for the weighted_average statistic.
    ORDER_COLUMN_NAME: Name of the column used for candlestick charting techniques.
    The default value is an empty Map.
- 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 ranged-statistics operation will be performed.
  - setTableName
```
public AggregateStatisticsByRangeRequest setTableName(String tableName)
```
    Parameters:
    
    tableName - Name of the table on which the ranged-statistics operation will be performed.
    
    Returns:
    
    this to mimic the builder pattern.
  - getSelectExpression
```
public String getSelectExpression()
```
    Returns:
    
    For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
  - setSelectExpression
```
public AggregateStatisticsByRangeRequest setSelectExpression(String selectExpression)
```
    Parameters:
    
    selectExpression - For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
    
    Returns:
    
    this to mimic the builder pattern.
  - getColumnName
```
public String getColumnName()
```
    Returns:
    
    Name of the binning-column used to divide the set samples into bins.
  - setColumnName
```
public AggregateStatisticsByRangeRequest setColumnName(String columnName)
```
    Parameters:
    
    columnName - Name of the binning-column used to divide the set samples into bins.
    
    Returns:
    
    this to mimic the builder pattern.
  - getValueColumnName
```
public String getValueColumnName()
```
    Returns:
    
    Name of the value-column for which statistics are to be computed.
  - setValueColumnName
```
public AggregateStatisticsByRangeRequest setValueColumnName(String valueColumnName)
```
    Parameters:
    
    valueColumnName - Name of the value-column for which statistics are to be computed.
    
    Returns:
    
    this to mimic the builder pattern.
  - getStats
```
public String getStats()
```
    Returns:
    
    A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
  - setStats
```
public AggregateStatisticsByRangeRequest setStats(String stats)
```
    Parameters:
    
    stats - A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
    
    Returns:
    
    this to mimic the builder pattern.
  - getStart
```
public double getStart()
```
    Returns:
    
    The lower bound of the binning-column.
  - setStart
```
public AggregateStatisticsByRangeRequest setStart(double start)
```
    Parameters:
    
    start - The lower bound of the binning-column.
    
    Returns:
    
    this to mimic the builder pattern.
  - getEnd
```
public double getEnd()
```
    Returns:
    
    The upper bound of the binning-column.
  - setEnd
```
public AggregateStatisticsByRangeRequest setEnd(double end)
```
    Parameters:
    
    end - The upper bound of the binning-column.
    
    Returns:
    
    this to mimic the builder pattern.
  - getInterval
```
public double getInterval()
```
    Returns:
    
    The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)).
  - setInterval
```
public AggregateStatisticsByRangeRequest setInterval(double interval)
```
    Parameters:
    
    interval - The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)).
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Returns:
    Map of optional parameters:
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
    BIN_VALUES: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
    WEIGHT_COLUMN_NAME: Name of the column used as weighting column for the weighted_average statistic.
    ORDER_COLUMN_NAME: Name of the column used for candlestick charting techniques.
    The default value is an empty Map.
  - setOptions
```
public AggregateStatisticsByRangeRequest setOptions(Map<String,String> options)
```
    Parameters:
    options - Map of optional parameters:
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
    BIN_VALUES: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
    WEIGHT_COLUMN_NAME: Name of the column used as weighting column for the weighted_average statistic.
    ORDER_COLUMN_NAME: Name of the column used for candlestick charting techniques.
    The default value is an empty Map.
    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 AggregateStatisticsByRangeRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AggregateStatisticsByRangeRequest

AggregateStatisticsByRangeRequest

Method Detail

getClassSchema

getTableName

setTableName

getSelectExpression

setSelectExpression

getColumnName

setColumnName

getValueColumnName

setValueColumnName

getStats

setStats

getStart

setStart

getEnd

setEnd

getInterval

setInterval

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode