Package com.activeviam.agg

Interface IUserDefinedAggregateFunction

All Superinterfaces:

IGenericAggregationFunction, IMultiSourceAggregationFunction, IPluginValue, Serializable

All Known Implementing Classes:

AUserDefinedAggregateFunction, AUserDefinedAggregateFunctionWithRemoval, AVarianceAggregateFunction, PopulationStdAggregateFunction, PopulationVarianceAggregateFunction, SampleStdAggregateFunction, SampleVarianceAggregateFunction, SerializableUserDefinedAggregateFunction, SerializableUserDefinedAggregateFunctionWithRemoval, SerializableUserDefinedVectorAggregateFunction, SerializableUserDefinedVectorAggregateFunctionWithRemoval

public interface IUserDefinedAggregateFunction
extends IMultiSourceAggregationFunction

Interface for aggregate functions whose aggregation handle multiple fields as source.

Author:

ActiveViam

Field Summary

Fields inherited from interface com.qfs.agg.IGenericAggregationFunction

SUM_PRODUCT_FUNCTION_PLUGIN_KEY

Method Summary

Modifier and Type	Method	Description
IUserDefinedAggregation	createAggregation(List<String> sourceIdentifiers, int[] sourceTypes)	Creates an IGenericAggregation that can bind a list of data structures to a single destination data structure.
int	getAggregatedDataType()	Returns the output type of the aggregates of this user-defined aggregate function.
static IUserDefinedAggregateFunction	getFunction(String pluginKey)	Returns the IUserDefinedAggregateFunction associated with this plugin using the input key.
static int	retrieveType(String pluginKey)	Retrieves the aggregated data-type of an IUserDefinedAggregateFunction 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

Method Detail

getAggregatedDataType

int getAggregatedDataType()

Returns the output type of the aggregates of this user-defined aggregate function.

Returns:

the output type

createAggregation

IUserDefinedAggregation 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

Specified by:

createAggregation in interface IMultiSourceAggregationFunction

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)

Retrieves the aggregated data-type of an IUserDefinedAggregateFunction from its plugin key.

getFunction

static IUserDefinedAggregateFunction getFunction(String pluginKey)

Returns the IUserDefinedAggregateFunction associated with this plugin using the input key.

This method uses the current registry obtained through Registry.getRegistry().

Parameters:

pluginKey - The target function's plugin key

Returns:

The target function