Package com.qfs.agg

Interface IAggregationFunction

All Superinterfaces:

IGenericAggregationFunction, IPluginValue, Serializable

All Known Subinterfaces:

IHistoryAggregationFunction

All Known Implementing Classes:

AAggregationFunction, AGenericAggregationFunction, AGenericBaseAggregationFunction, AGenericVectorAggregationFunction, AVectorAggregationFunction, AvgFunction, ComparableMaxFunction, CopyFunction, CountFunction, DistinctCountFunction, DistinctCountSupportingRemovalsFunction, GrossSumFunction, LongFunction, MaxFunction, MaxHistoryFunction, MedianFunction, MinFunction, MinHistoryFunction, MultiplyFunction, PercentileFunction, ShortFunction, SingleValueFunction, SquareSumFunction, SumFunction, TimestampFunction

public interface IAggregationFunction
extends IGenericAggregationFunction

Aggregation function based on a single field.

Author:

ActiveViam

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVG_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	COMPARABLE_MAX_PLUGIN_KEY	Plugin value key for ComparableMaxFunction.
static final String	COPY_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	COUNT_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	DISTINCT_COUNT_HISTORY_PLUGIN_KEY	Plugin value key for function.
static final String	DISTINCT_COUNT_PLUGIN_KEY	Plugin value key for function.
static final String	GROSS_SUM_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	LONG_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	MAX_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	MAX_HISTORY_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	MEDIAN_FUNCTION_PLUGIN_KEY	Plugin value key for the MedianFunction.
static final String	MIN_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	MIN_HISTORY_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	MULTIPLY_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	POPULATION_STD_PLUGIN_KEY	Plugin value key for population standard deviation function.
static final String	POPULATION_VAR_PLUGIN_KEY	Plugin value key for population variance function.
static final String	SAMPLE_STD_PLUGIN_KEY	Plugin value key for the sample standard deviation function.
static final String	SAMPLE_VAR_PLUGIN_KEY	Plugin value key for sample variance function.
static final String	SHORT_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	SINGLE_VALUE_PLUGIN_KEY	Plugin value key for function.
static final String	SQUARE_SUM_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	SUM_FUNCTION_PLUGIN_KEY	Plugin value key for function.
static final String	TIMESTAMP_FUNCTION_PLUGIN_KEY	Plugin value key for function.

Fields inherited from interface com.qfs.agg.IGenericAggregationFunction

SUM_PRODUCT_FUNCTION_PLUGIN_KEY

Method Summary

Modifier and Type	Method	Description
IAggregation	createAggregation(List<String> sourceIdentifiers, int[] sourceTypes)	Creates an IGenericAggregation that can bind a list of data structures to a single destination data structure.
static int	retrieveType(String pluginKey, int sourceType)	Retrieves the aggregated data-type of a function from its plugin key.

Methods inherited from interface com.qfs.agg.IGenericAggregationFunction

getAggregatedType, withRemovalSupport

Methods inherited from interface com.quartetfs.fwk.types.IPluginValue

description, getPlugin, key, setPlugin

Field Details

AVG_FUNCTION_PLUGIN_KEY

static final String AVG_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

MEDIAN_FUNCTION_PLUGIN_KEY

static final String MEDIAN_FUNCTION_PLUGIN_KEY

Plugin value key for the MedianFunction.

See Also:

• Constant Field Values

MIN_FUNCTION_PLUGIN_KEY

static final String MIN_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

MIN_HISTORY_FUNCTION_PLUGIN_KEY

static final String MIN_HISTORY_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

MAX_FUNCTION_PLUGIN_KEY

static final String MAX_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

MAX_HISTORY_FUNCTION_PLUGIN_KEY

static final String MAX_HISTORY_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

SUM_FUNCTION_PLUGIN_KEY

static final String SUM_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

COUNT_FUNCTION_PLUGIN_KEY

static final String COUNT_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

SHORT_FUNCTION_PLUGIN_KEY

static final String SHORT_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

TIMESTAMP_FUNCTION_PLUGIN_KEY

static final String TIMESTAMP_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

GROSS_SUM_FUNCTION_PLUGIN_KEY

static final String GROSS_SUM_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

COPY_FUNCTION_PLUGIN_KEY

static final String COPY_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

MULTIPLY_FUNCTION_PLUGIN_KEY

static final String MULTIPLY_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

LONG_FUNCTION_PLUGIN_KEY

static final String LONG_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

SQUARE_SUM_FUNCTION_PLUGIN_KEY

static final String SQUARE_SUM_FUNCTION_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

DISTINCT_COUNT_PLUGIN_KEY

static final String DISTINCT_COUNT_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

DISTINCT_COUNT_HISTORY_PLUGIN_KEY

static final String DISTINCT_COUNT_HISTORY_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

SINGLE_VALUE_PLUGIN_KEY

static final String SINGLE_VALUE_PLUGIN_KEY

Plugin value key for function.

See Also:

• Constant Field Values

POPULATION_VAR_PLUGIN_KEY

static final String POPULATION_VAR_PLUGIN_KEY

Plugin value key for population variance function.

See Also:

• Constant Field Values

POPULATION_STD_PLUGIN_KEY

static final String POPULATION_STD_PLUGIN_KEY

Plugin value key for population standard deviation function.

See Also:

• Constant Field Values

SAMPLE_VAR_PLUGIN_KEY

static final String SAMPLE_VAR_PLUGIN_KEY

Plugin value key for sample variance function.

See Also:

• Constant Field Values

SAMPLE_STD_PLUGIN_KEY

static final String SAMPLE_STD_PLUGIN_KEY

Plugin value key for the sample standard deviation function.

See Also:

• Constant Field Values

COMPARABLE_MAX_PLUGIN_KEY

static final String COMPARABLE_MAX_PLUGIN_KEY

Plugin value key for ComparableMaxFunction.

See Also:

• Constant Field Values

Method Details

createAggregation

IAggregation createAggregation(List<String> sourceIdentifiers,
 int[] sourceTypes)

Description copied from interface: IGenericAggregationFunction

Creates an IGenericAggregation that can bind a list of data structures to a single destination data structure.

The created aggregation is specialized for the given source identifiers, which can then be used to retrieve the correct source data structures to bind with a destination.

The two given collections must have the same size.

Specified by:

createAggregation in interface IGenericAggregationFunction

Parameters:

sourceIdentifiers - A way to identify the source data structures

sourceTypes - The data types of the elements to be aggregated

Returns:

the newly created aggregation, tailored for the given identifiers and types

retrieveType

static int retrieveType(String pluginKey,
 int sourceType)

Retrieves the aggregated data-type of a function from its plugin key.

Parameters:

pluginKey - the aggregation function's plugin key

sourceType - the data types of the elements to be aggregated

Returns:

the type of the elements aggregated by the given aggregation function