eu.fthevenet.binjr.data.timeseries.transform

Class TimeSeriesTransform<T>

java.lang.Object

eu.fthevenet.binjr.data.timeseries.transform.TimeSeriesTransform<T>

Direct Known Subclasses:

DecimationTransform, LargestTriangleThreeBucketsTransform

public abstract class TimeSeriesTransform<T>
extends java.lang.Object

The base class for time series transformation functions.

Author:

Frederic Thevenet

Constructor Summary

Constructors

Constructor and Description
TimeSeriesTransform(java.lang.String name) Base constructor for TimeSeriesTransform instances.

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>>	apply(java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> series) The actual transform implementation
java.lang.String	getName() Gets the name of the transform function
java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>>	transform(java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> series, boolean enabled) Applies the transform function to the provided series

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesTransform

public TimeSeriesTransform(java.lang.String name)

Base constructor for TimeSeriesTransform instances.

Parameters:

name - the name of the transform function

Method Detail

apply

protected abstract java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> apply(java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> series)

The actual transform implementation

Parameters:

series - the time series to apply the transform to.

Returns:

A map of the transformed series.

transform

public java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> transform(java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> series,
                                                                         boolean enabled)

Applies the transform function to the provided series

Parameters:

series - the time series to apply the transform to.

enabled - true if the transform should be applied, false otherwise.

Returns:

A map of the transformed series.

getName

public java.lang.String getName()

Gets the name of the transform function

Returns:

the name of the transform function