Package de.iip_ecosphere.platform.kiServices.functions.aggregation

Class MultiChannelTimeSeriesAggregator.LambdaBasedAggregationFunction<I,CI,O,D,T>

java.lang.Object

de.iip_ecosphere.platform.kiServices.functions.aggregation.MultiChannelTimeSeriesAggregator.LambdaBasedAggregationFunction<I,CI,O,D,T>

Type Parameters:

I - the input data type

O - the output data type

D - the data point type within I and O

T - the timestamp type within I and O

All Implemented Interfaces:

MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>, MultiChannelTimeSeriesAggregator.CompletionFunction<T>

Enclosing class:

MultiChannelTimeSeriesAggregator<I,CI,O,D,T>

public static class MultiChannelTimeSeriesAggregator.LambdaBasedAggregationFunction<I,CI,O,D,T>
extends Object
implements MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>

Basic aggregation function delegating the operations to (lambda) functions.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private Function<CI,String>	categoryProvider
private MultiChannelTimeSeriesAggregator.CompletionFunction<T>	completionFunction
private Function<CI,D>	dataProvider
private Function<Integer,MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T>>	resultBuilderProvider
private Function<I,T>	timestampProvider

Constructor Summary

Constructors

Constructor	Description
LambdaBasedAggregationFunction(Function<I,T> timestampProvider, Function<CI,String> categoryProvider, Function<CI,D> dataProvider, MultiChannelTimeSeriesAggregator.CompletionFunction<T> completionFunction, Function<Integer,MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T>> resultBuilderProvider)	Creates a lambda based aggregation function.

Method Summary

Modifier and Type	Method	Description
boolean	chunkCompleted(int numberAggregatedSamples, T timestamp)	Returns whether an aggregation chunk has been completed and a result instance shall be created.
MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T>	createResult(int categoriesCount)	Creates a result builder for composing a potentially multi-category result.
String	getCategory(CI input)	Returns the aggregation category from input.
D	getData(CI input)	Returns a data point from input.
T	getTimestamp(I input)	Returns the aggregation timestamp from input.

Methods inherited from class java.lang.Object

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

Field Details

timestampProvider

private Function<I,T> timestampProvider

categoryProvider

private Function<CI,String> categoryProvider

dataProvider

private Function<CI,D> dataProvider

completionFunction

private MultiChannelTimeSeriesAggregator.CompletionFunction<T> completionFunction

resultBuilderProvider

private Function<Integer,MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T>> resultBuilderProvider

Constructor Details

LambdaBasedAggregationFunction

public LambdaBasedAggregationFunction(Function<I,T> timestampProvider,
 Function<CI,String> categoryProvider,
 Function<CI,D> dataProvider,
 MultiChannelTimeSeriesAggregator.CompletionFunction<T> completionFunction,
 Function<Integer,MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T>> resultBuilderProvider)

Creates a lambda based aggregation function. All parameters must not be null.

Parameters:

timestampProvider - the timestamp provider implementing getTimestamp(Object)

categoryProvider - the timestamp provider implementing getCategory(Object)

dataProvider - the data provider implementing getData(Object)

completionFunction - the completion function provider implementing chunkCompleted(int, Object)

resultBuilderProvider - the result builder function provider implementing createResult(int)

Method Details

getTimestamp

public T getTimestamp(I input)

Description copied from interface: MultiChannelTimeSeriesAggregator.AggregationFunction

Returns the aggregation timestamp from input.

Specified by:

getTimestamp in interface MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>

Parameters:

input - the input data

Returns:

the timestamp from input

getCategory

public String getCategory(CI input)

Description copied from interface: MultiChannelTimeSeriesAggregator.AggregationFunction

Returns the aggregation category from input.

Specified by:

getCategory in interface MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>

Parameters:

input - the input data

Returns:

the category from input

getData

public D getData(CI input)

Description copied from interface: MultiChannelTimeSeriesAggregator.AggregationFunction

Returns a data point from input.

Specified by:

getData in interface MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>

Parameters:

input - the input data

Returns:

the data point from input

chunkCompleted

public boolean chunkCompleted(int numberAggregatedSamples,
 T timestamp)

Description copied from interface: MultiChannelTimeSeriesAggregator.CompletionFunction

Returns whether an aggregation chunk has been completed and a result instance shall be created.

Specified by:

chunkCompleted in interface MultiChannelTimeSeriesAggregator.CompletionFunction<I>

Parameters:

numberAggregatedSamples - the number of samples aggregated so far

timestamp - the timestamp the aggregation started

Returns:

true for completed, false else

createResult

public MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T> createResult(int categoriesCount)

Description copied from interface: MultiChannelTimeSeriesAggregator.AggregationFunction

Creates a result builder for composing a potentially multi-category result.

Specified by:

createResult in interface MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>

Parameters:

categoriesCount - the actual number of categories

Returns:

the result builder instance