eu.fthevenet.binjr.data.timeseries

Class TimeSeriesProcessor<T>

java.lang.Object

eu.fthevenet.binjr.data.timeseries.TimeSeriesProcessor<T>

Direct Known Subclasses:

DoubleTimeSeriesProcessor

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

The base class for time series processor classes, which holds raw data points and provides access to summary properties.

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>>	data

Constructor Summary

Constructors

Constructor and Description
TimeSeriesProcessor() Initializes a new instance of the TimeSeriesProcessor class with the provided TimeSeriesBinding.

Method Summary

Modifier and Type	Method and Description
void	addSample(javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T> sample) Adds a new sample to the processor's data store
protected abstract T	computeAverageValue()
protected abstract T	computeMaxValue()
protected abstract T	computeMinValue()
T	getAverageValue() Gets the average for all Y coordinates of the TimeSeriesProcessor
java.util.Collection<javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>>	getData() Gets the data of the TimeSeriesProcessor
T	getMaxValue() Gets the maximum value for the Y coordinates of the TimeSeriesProcessor
T	getMinValue() Gets the minimum value for the Y coordinates of the TimeSeriesProcessor
T	getNearestValue(java.time.ZonedDateTime xValue) Get the nearest value for the specified time stamp.
javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>	getSample(int index) Returns the data sample at the given index.
void	setData(java.util.Collection<javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>> newData) Sets the content for the TimeSeriesProcessor's data store
int	size() Returns the number of elements in the processor's data store
java.util.Optional<T>	tryGetNearestValue(java.time.ZonedDateTime xValue) Try to get the nearest value for the specified time stamp.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected java.util.List<javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>> data

Constructor Detail

TimeSeriesProcessor

public TimeSeriesProcessor()

Initializes a new instance of the TimeSeriesProcessor class with the provided TimeSeriesBinding.

Method Detail

getMinValue

public final T getMinValue()

Gets the minimum value for the Y coordinates of the TimeSeriesProcessor

Returns:

the minimum value for the Y coordinates of the TimeSeriesProcessor

getAverageValue

public final T getAverageValue()

Gets the average for all Y coordinates of the TimeSeriesProcessor

Returns:

the average for all Y coordinates of the TimeSeriesProcessor

getMaxValue

public final T getMaxValue()

Gets the maximum value for the Y coordinates of the TimeSeriesProcessor

Returns:

the maximum value for the Y coordinates of the TimeSeriesProcessor

tryGetNearestValue

public java.util.Optional<T> tryGetNearestValue(java.time.ZonedDateTime xValue)

Try to get the nearest value for the specified time stamp.

Remark: If the processor is already being accessed by another thread, returns immediately with Optional.empty

Parameters:

xValue - the time stamp to get the value for.

Returns:

An Optional instance that contains tthe value for the time position nearest to the one requested if process could complete and value is non-null.

getNearestValue

public T getNearestValue(java.time.ZonedDateTime xValue)

Get the nearest value for the specified time stamp.

Remark: If the processor is already being accessed by another thread, waits until lock is released and returns requested value

Parameters:

xValue - the time stamp to get the value for.

Returns:

the value for the time position nearest to the one requested.

getData

public java.util.Collection<javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>> getData()

Gets the data of the TimeSeriesProcessor

Remark: the returned collection is a shallow copy of the the processor's own backing collection, so it can be iterated through without risking a concurrent access error even if content is being added or removed to the processor on a seperate thread. However, the the actual data for individual samples are not guarded against concurrent access in any capacity.

Returns:

the data of the TimeSeriesProcessor

setData

public void setData(java.util.Collection<javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T>> newData)

Sets the content for the TimeSeriesProcessor's data store

Parameters:

newData - the list of XYChart.Data points to use as the TimeSeriesProcessor' data.

getSample

public javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T> getSample(int index)

Returns the data sample at the given index.

Parameters:

index - the index of the sample to retrieve.

Returns:

the data sample at the given index.

size

public int size()

Returns the number of elements in the processor's data store

Returns:

the number of elements in the processor's data store

addSample

public void addSample(javafx.scene.chart.XYChart.Data<java.time.ZonedDateTime,T> sample)

Adds a new sample to the processor's data store

Parameters:

sample - a new sample to add to the processor's data store

computeMinValue

protected abstract T computeMinValue()

computeAverageValue

protected abstract T computeAverageValue()

computeMaxValue

protected abstract T computeMaxValue()