com.cinchapi.concourse

Class Calculator

Object

Calculator

public class Calculator
extends Object

The interface for Concourse's aggregation and calculation abilities.

Method Summary

Modifier and Type	Method and Description
Number	average(String key) Return the average of all the values stored across key.
Number	average(String key, Collection<Long> records) This method assumes that all the values are numeric.
Number	average(String key, Collection<Long> records, Timestamp timestamp) This method assumes that all the values are numeric.
Number	average(String key, Criteria criteria) Return the average of all the values for key in each of the records that match the Criteria.
Number	average(String key, Criteria criteria, Timestamp timestamp) Return the average of all the values for key in each of the records that match the Criteria.
Number	average(String key, long record) Return the average of all the values stored for key in record.
Number	average(String key, long record, Timestamp timestamp) This method assumes that all the values are numeric.
Number	average(String key, String ccl) Return the average of all the values for key in each of the records that match the criteria.
Number	average(String key, String ccl, Timestamp timestamp) Return the average of all the values at timestamp for key in each of the records that match the criteria.
Number	average(String key, Timestamp timestamp) Return the average of all the values stored across key at timestamp.
long	count(String key) Return the count of all the values stored across key.
long	count(String key, Collection<Long> records) This method assumes that all the values are numeric.
long	count(String key, Collection<Long> records, Timestamp timestamp) This method assumes that all the values are numeric.
long	count(String key, Criteria criteria) Return the count of all the values for key in each of the records that match the Criteria.
long	count(String key, Criteria criteria, Timestamp timestamp) Return the count of all the values for key in each of the records that match the Criteria.
long	count(String key, long record) Return the count of all the values stored for key in record.
long	count(String key, long record, Timestamp timestamp) This method assumes that all the values are numeric.
long	count(String key, String ccl) Return the count of all the values for key in each of the records that match the criteria.
long	count(String key, String ccl, Timestamp timestamp) Return the count of all the values at timestamp for key in each of the records that match the criteria.
long	count(String key, Timestamp timestamp) Return the count of all the values stored across key at timestamp.
Number	max(String key) Return the max of all the values stored across key.
Number	max(String key, Collection<Long> records) This method assumes that all the values are numeric.
Number	max(String key, Collection<Long> records, Timestamp timestamp) This method assumes that all the values are numeric.
Number	max(String key, Criteria criteria) Return the max of all the values for key in each of the records that match the Criteria.
Number	max(String key, Criteria criteria, Timestamp timestamp) Return the max of all the values for key in each of the records that match the Criteria.
Number	max(String key, long record) Return the max of all the values stored for key in record.
Number	max(String key, long record, Timestamp timestamp) This method assumes that all the values are numeric.
Number	max(String key, String ccl) Return the max of all the values for key in each of the records that match the criteria.
Number	max(String key, String ccl, Timestamp timestamp) Return the max of all the values at timestamp for key in each of the records that match the criteria.
Number	max(String key, Timestamp timestamp) Return the max of all the values stored across key at timestamp.
Number	min(String key) Return the min of all the values stored across key.
Number	min(String key, Collection<Long> records) This method assumes that all the values are numeric.
Number	min(String key, Collection<Long> records, Timestamp timestamp) This method assumes that all the values are numeric.
Number	min(String key, Criteria criteria) Return the min of all the values for key in each of the records that match the Criteria.
Number	min(String key, Criteria criteria, Timestamp timestamp) Return the min of all the values for key in each of the records that match the Criteria.
Number	min(String key, long record) Return the min of all the values stored for key in record.
Number	min(String key, long record, Timestamp timestamp) This method assumes that all the values are numeric.
Number	min(String key, String ccl) Return the min of all the values for key in each of the records that match the criteria.
Number	min(String key, String ccl, Timestamp timestamp) Return the min of all the values at timestamp for key in each of the records that match the criteria.
Number	min(String key, Timestamp timestamp) Return the min of all the values stored across key at timestamp.
Number	sum(String key) Return the sum of all the values stored across key.
Number	sum(String key, Collection<Long> records) This method assumes that all the values are numeric.
Number	sum(String key, Collection<Long> records, Timestamp timestamp) This method assumes that all the values are numeric.
Number	sum(String key, Criteria criteria) Return the sum of all the values for key in each of the records that match the Criteria.
Number	sum(String key, Criteria criteria, Timestamp timestamp) Return the sum of all the values for key in each of the records that match the Criteria.
Number	sum(String key, long record) Return the sum of all the values stored for key in record.
Number	sum(String key, long record, Timestamp timestamp) This method assumes that all the values are numeric.
Number	sum(String key, String ccl) Return the sum of all the values for key in each of the records that match the criteria.
Number	sum(String key, String ccl, Timestamp timestamp) Return the sum of all the values at timestamp for key in each of the records that match the criteria.
Number	sum(String key, Timestamp timestamp) Return the sum of all the values stored across key at timestamp.

Methods inherited from class Object

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

Method Detail

average

public Number average(String key)

Return the average of all the values stored across key.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

Returns:

the average of the values

average

public Number average(String key,
                      Collection<Long> records)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

Returns:

the average of the values

average

public Number average(String key,
                      Collection<Long> records,
                      Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

timestamp -

Returns:

the average of the values

average

public Number average(String key,
                      Criteria criteria)

Return the average of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

{@link - Criteria}

Returns:

the average of the values

average

public Number average(String key,
                      Criteria criteria,
                      Timestamp timestamp)

Return the average of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

{@link - Criteria}

timestamp - the Timestamp at which the values are selected

Returns:

the average of the values

average

public Number average(String key,
                      long record)

Return the average of all the values stored for key in record.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

record - the record id

Returns:

the average of the values

average

public Number average(String key,
                      long record,
                      Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

record -

timestamp -

Returns:

the average of the values

average

public Number average(String key,
                      String ccl)

Return the average of all the values for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

ccl -

Returns:

the average of the values

average

public Number average(String key,
                      String ccl,
                      Timestamp timestamp)

Return the average of all the values at timestamp for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

criteria - a criteria written using the Concourse Criteria Language (CCL)

timestamp - the Timestamp at which the values are selected

Returns:

the average of the values

average

public Number average(String key,
                      Timestamp timestamp)

Return the average of all the values stored across key at timestamp.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

timestamp - the Timestamp at which the values are selected

Returns:

the average of the values

count

public long count(String key)

Return the count of all the values stored across key.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

Returns:

the count of the values

count

public long count(String key,
                  Collection<Long> records)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

Returns:

the count of the values

count

public long count(String key,
                  Collection<Long> records,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

timestamp -

Returns:

the count of the values

count

public long count(String key,
                  Criteria criteria)

Return the count of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

{@link - Criteria}

Returns:

the count of the values

count

public long count(String key,
                  Criteria criteria,
                  Timestamp timestamp)

Return the count of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

{@link - Criteria}

timestamp - the Timestamp at which the values are selected

Returns:

the count of the values

count

public long count(String key,
                  long record)

Return the count of all the values stored for key in record.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

record - the record id

Returns:

the count of the values

count

public long count(String key,
                  long record,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

record -

timestamp -

Returns:

the count of the values

count

public long count(String key,
                  String ccl)

Return the count of all the values for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

ccl -

Returns:

the count of the values

count

public long count(String key,
                  String ccl,
                  Timestamp timestamp)

Return the count of all the values at timestamp for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

criteria - a criteria written using the Concourse Criteria Language (CCL)

timestamp - the Timestamp at which the values are selected

Returns:

the average of the values

count

public long count(String key,
                  Timestamp timestamp)

Return the count of all the values stored across key at timestamp.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

timestamp - the Timestamp at which the values are selected

Returns:

the count of the values

max

public Number max(String key)

Return the max of all the values stored across key.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

Returns:

the max of the values

max

public Number max(String key,
                  Collection<Long> records)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

Returns:

the max of the values

max

public Number max(String key,
                  Collection<Long> records,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

timestamp -

Returns:

the max of the values

max

public Number max(String key,
                  Criteria criteria)

Return the max of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

{@link - Criteria}

Returns:

the max of the values

max

public Number max(String key,
                  Criteria criteria,
                  Timestamp timestamp)

Return the max of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

{@link - Criteria}

timestamp - the Timestamp at which the values are selected

Returns:

the max of the values

max

public Number max(String key,
                  long record)

Return the max of all the values stored for key in record.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

record - the record id

Returns:

the max of the values

max

public Number max(String key,
                  long record,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

record -

timestamp -

Returns:

the max of the values

max

public Number max(String key,
                  String ccl)

Return the max of all the values for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

ccl -

Returns:

the max of the values

max

public Number max(String key,
                  String ccl,
                  Timestamp timestamp)

Return the max of all the values at timestamp for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

criteria - a criteria written using the Concourse Criteria Language (CCL)

timestamp - the Timestamp at which the values are selected

Returns:

the average of the values

max

public Number max(String key,
                  Timestamp timestamp)

Return the max of all the values stored across key at timestamp.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

timestamp - the Timestamp at which the values are selected

Returns:

the max of the values

min

public Number min(String key)

Return the min of all the values stored across key.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

Returns:

the min of the values

min

public Number min(String key,
                  Collection<Long> records)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

Returns:

the min of the values

min

public Number min(String key,
                  Collection<Long> records,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

timestamp -

Returns:

the min of the values

min

public Number min(String key,
                  Criteria criteria)

Return the min of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

{@link - Criteria}

Returns:

the min of the values

min

public Number min(String key,
                  Criteria criteria,
                  Timestamp timestamp)

Return the min of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

{@link - Criteria}

timestamp - the Timestamp at which the values are selected

Returns:

the min of the values

min

public Number min(String key,
                  long record)

Return the min of all the values stored for key in record.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

record - the record id

Returns:

the min of the values

min

public Number min(String key,
                  long record,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

record -

timestamp -

Returns:

the min of the values

min

public Number min(String key,
                  String ccl)

Return the min of all the values for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

ccl -

Returns:

the min of the values

min

public Number min(String key,
                  String ccl,
                  Timestamp timestamp)

Return the min of all the values at timestamp for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

criteria - a criteria written using the Concourse Criteria Language (CCL)

timestamp - the Timestamp at which the values are selected

Returns:

the average of the values

min

public Number min(String key,
                  Timestamp timestamp)

Return the min of all the values stored across key at timestamp.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

timestamp - the Timestamp at which the values are selected

Returns:

the min of the values

sum

public Number sum(String key)

Return the sum of all the values stored across key.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

Returns:

the sum of the values

sum

public Number sum(String key,
                  Collection<Long> records)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

Returns:

the sum of the values

sum

public Number sum(String key,
                  Collection<Long> records,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

records -

timestamp -

Returns:

the sum of the values

sum

public Number sum(String key,
                  Criteria criteria)

Return the sum of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

{@link - Criteria}

Returns:

the sum of the values

sum

public Number sum(String key,
                  Criteria criteria,
                  Timestamp timestamp)

Return the sum of all the values for key in each of the records that match the Criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

{@link - Criteria}

timestamp - the Timestamp at which the values are selected

Returns:

the sum of the values

sum

public Number sum(String key,
                  long record)

Return the sum of all the values stored for key in record.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

record - the record id

Returns:

the sum of the values

sum

public Number sum(String key,
                  long record,
                  Timestamp timestamp)

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key -

record -

timestamp -

Returns:

the sum of the values

sum

public Number sum(String key,
                  String ccl)

Return the sum of all the values for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

ccl -

Returns:

the sum of the values

sum

public Number sum(String key,
                  String ccl,
                  Timestamp timestamp)

Return the sum of all the values at timestamp for key in each of the records that match the criteria.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - the field name

criteria - a criteria written using the Concourse Criteria Language (CCL)

timestamp - the Timestamp at which the values are selected

Returns:

the sum of the values

sum

public Number sum(String key,
                  Timestamp timestamp)

Return the sum of all the values stored across key at timestamp.

This method assumes that all the values are numeric. An exception will be thrown if any non-numeric values are encountered.

Parameters:

key - a field name

timestamp - the Timestamp at which the values are selected

Returns:

the sum of the values