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

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

java.lang.Object

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

Type Parameters:

I - the input data type

CI - the contained input data type in <I>, may be the same as <I> for single-data-point aggregation

O - the output data type

D - the data point type within I and O

T - the timestamp type within I and O

Direct Known Subclasses:

ChannelTimeSeriesAggregator

public class MultiChannelTimeSeriesAggregator<I,CI,O,D,T>
extends Object

Generic multi-data-point time series aggregator for identified channels.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>	Represents the data format independent access to aggregation data for single data points.
static class	MultiChannelTimeSeriesAggregator.ArrayIterator<I>	Iterator for arrays.
static interface	MultiChannelTimeSeriesAggregator.CompletionFunction<T>	Determines whether an aggregation chunk is completed.
static class	MultiChannelTimeSeriesAggregator.LambdaBasedAggregationFunction<I,CI,O,D,T>	Basic aggregation function delegating the operations to (lambda) functions.
static interface	MultiChannelTimeSeriesAggregator.ResultBuilder<O,D,T>	Builds a result from multiple category/data entries.
static class	MultiChannelTimeSeriesAggregator.SingleValueIterator<I>	An iterator over a single value.

Field Summary

Fields

Modifier and Type	Field	Description
private T	aggregationTimestamp
private MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T>	function
private boolean	isAggregating
private Function<I,Iterator<CI>>	iteratorProvider
private int	numberAggregatedSamples
private Map<String,CI>	timePointAggregator
private Map<String,List<D>>	timeSeriesAggregator

Constructor Summary

Constructors

Constructor	Description
MultiChannelTimeSeriesAggregator(boolean isAggregating, MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function)	Creates a new instance for single data points.
MultiChannelTimeSeriesAggregator(boolean isAggregating, MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function, Function<I,Iterator<CI>> iteratorProvider)	Creates a new instance for single data points.
MultiChannelTimeSeriesAggregator(MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function)	Creates a not-yet-aggregating instance.

Method Summary

Modifier and Type	Method	Description
boolean	isAggregating()	Returns whether aggregation is enabled.
O	process(I data)	Called to process the input.
protected O	process(I parent, CI data)	Processes a single data item.
void	startAggregating()	Starts the aggregation.
void	stopAggregating()	Stops the aggregation and clears the data structures.

Methods inherited from class java.lang.Object

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

Field Details

isAggregating

private boolean isAggregating

aggregationTimestamp

private T aggregationTimestamp

numberAggregatedSamples

private int numberAggregatedSamples

timePointAggregator

private Map<String,CI> timePointAggregator

timeSeriesAggregator

private Map<String,List<D>> timeSeriesAggregator

function

private MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function

iteratorProvider

private Function<I,Iterator<CI>> iteratorProvider

Constructor Details

MultiChannelTimeSeriesAggregator

public MultiChannelTimeSeriesAggregator(MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function)

Creates a not-yet-aggregating instance.

Parameters:

function - the aggreation function

Throws:

IllegalArgumentException - if function is not given

MultiChannelTimeSeriesAggregator

public MultiChannelTimeSeriesAggregator(boolean isAggregating,
 MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function,
 Function<I,Iterator<CI>> iteratorProvider)

Creates a new instance for single data points.

Parameters:

isAggregating - whether aggregation shall start immediately

function - the aggregation function

iteratorProvider - function creating an iterator from <I> over <CI>, may be null for none

Throws:

IllegalArgumentException - if function is not given

MultiChannelTimeSeriesAggregator

public MultiChannelTimeSeriesAggregator(boolean isAggregating,
 MultiChannelTimeSeriesAggregator.AggregationFunction<I,CI,O,D,T> function)

Creates a new instance for single data points.

Parameters:

isAggregating - whether aggregation shall start immediately

function - the aggregation function

Throws:

IllegalArgumentException - if function is not given

Method Details

isAggregating

public boolean isAggregating()

Returns whether aggregation is enabled.

Returns:

true for enabled, false else

process

public O process(I data)

Called to process the input.

Parameters:

data - the data to process

Returns:

the aggregated data, may be null for none at this point in time

process

protected O process(I parent,
 CI data)

Processes a single data item.

Parameters:

parent - the parent data item holding data, may be identical to data

data - the data item

Returns:

the aggregated data, may be null for none at this point in time

startAggregating

public void startAggregating()

Starts the aggregation.

stopAggregating

public void stopAggregating()

Stops the aggregation and clears the data structures.