eu.fthevenet.binjr.data.adapters

Class DataAdapter<T,A extends Decoder<T>>

java.lang.Object

eu.fthevenet.binjr.data.adapters.DataAdapter<T,A>

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

CsvFileAdapter, SimpleCachingDataAdapter

public abstract class DataAdapter<T,A extends Decoder<T>>
extends java.lang.Object
implements java.lang.AutoCloseable

Provides the means to access a data source to retrieve raw time series data, as well as the properties required to decode and present the data.

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed

Constructor Summary

Constructors

Constructor and Description
DataAdapter()

Method Summary

Modifier and Type	Method and Description
void	close()
java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>>	fetchDecodedData(java.lang.String path, java.time.Instant begin, java.time.Instant end, java.util.List<TimeSeriesInfo<T>> seriesInfo, boolean bypassCache) Gets decoded data from the source as a map of TimeSeriesProcessor, for the time interval and TimeSeriesInfo specified.
abstract java.io.InputStream	fetchRawData(java.lang.String path, java.time.Instant begin, java.time.Instant end, boolean bypassCache) Gets raw data from the source as an output stream, for the time interval specified.
abstract javafx.scene.control.TreeItem<TimeSeriesBinding<T>>	getBindingTree() Return a hierarchical view of all the individual bindings exposed by the underlying source.
abstract A	getDecoder() Gets the Decoder used to produce TimeSeriesProcessor from the source.
abstract java.lang.String	getEncoding() Gets the encoding used to decode textual data sent by the source.
java.util.UUID	getId() Gets the unique id for the adapter
abstract java.util.Map<java.lang.String,java.lang.String>	getParams() Returns a map of all parameters required to establish a connection to the underlying data source
abstract java.lang.String	getSourceName() Gets the name of the source.
abstract java.time.ZoneId	getTimeZoneId() Gets the id of the time zone used to record dates in the source.
boolean	isClosed()
abstract void	loadParams(java.util.Map<java.lang.String,java.lang.String> params) Sets the parameters required to establish a connection to the underlying data source
void	onStart() An api hook that is executed once, after parameters have been loaded and before any other call to the DataAdapter is made.
abstract boolean	ping() Pings the data source
void	setId(java.util.UUID id) Sets the unique id for the adapter
java.lang.String	toString()
protected <R> R	validateParameter(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String paramName, CheckedFunction<java.lang.String,R,InvalidAdapterParameterException> validator)
protected java.lang.String	validateParameterNullity(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String paramName)

Methods inherited from class java.lang.Object

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

Field Detail

closed

protected volatile boolean closed

Constructor Detail

DataAdapter

public DataAdapter()

Method Detail

getBindingTree

public abstract javafx.scene.control.TreeItem<TimeSeriesBinding<T>> getBindingTree()
                                                                            throws DataAdapterException

Return a hierarchical view of all the individual bindings exposed by the underlying source.

Returns:

a hierarchical view of all the individual bindings exposed by the underlying source.

Throws:

DataAdapterException - if an error occurs while retrieving bindings.

fetchRawData

public abstract java.io.InputStream fetchRawData(java.lang.String path,
                                                 java.time.Instant begin,
                                                 java.time.Instant end,
                                                 boolean bypassCache)
                                          throws DataAdapterException

Gets raw data from the source as an output stream, for the time interval specified.

Parameters:

path - the path of the data in the source

begin - the start of the time interval.

end - the end of the time interval.*

bypassCache - true if adapter cache should be bypassed, false otherwise. This parameter is ignored if adapter does not support caching

Returns:

the output stream in which to return data.

Throws:

DataAdapterException - if an error occurs while retrieving data from the source.

fetchDecodedData

public java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> fetchDecodedData(java.lang.String path,
                                                                                java.time.Instant begin,
                                                                                java.time.Instant end,
                                                                                java.util.List<TimeSeriesInfo<T>> seriesInfo,
                                                                                boolean bypassCache)
                                                                         throws DataAdapterException

Gets decoded data from the source as a map of TimeSeriesProcessor, for the time interval and TimeSeriesInfo specified.

Parameters:

path - the path of the data in the source

begin - the start of the time interval.

end - the end of the time interval.

seriesInfo - the series to get data from.

bypassCache - true if adapter cache should be bypassed, false otherwise. This parameter is ignored if adapter does not support caching

Returns:

the output stream in which to return data.

Throws:

DataAdapterException - if an error occurs while retrieving data from the source.

getEncoding

public abstract java.lang.String getEncoding()

Gets the encoding used to decode textual data sent by the source.

Returns:

the encoding used to decode textual data sent by the source.

getTimeZoneId

public abstract java.time.ZoneId getTimeZoneId()

Gets the id of the time zone used to record dates in the source.

Returns:

the id of the time zone used to record dates in the source.

getDecoder

public abstract A getDecoder()

Gets the Decoder used to produce TimeSeriesProcessor from the source.

Returns:

the Decoder used to produce TimeSeriesProcessor from the source.

getSourceName

public abstract java.lang.String getSourceName()

Gets the name of the source.

Returns:

the name of the source.

getParams

public abstract java.util.Map<java.lang.String,java.lang.String> getParams()

Returns a map of all parameters required to establish a connection to the underlying data source

Returns:

a map of all parameters required to establish a connection to the underlying data source

loadParams

public abstract void loadParams(java.util.Map<java.lang.String,java.lang.String> params)
                         throws DataAdapterException

Sets the parameters required to establish a connection to the underlying data source

Parameters:

params - the parameters required to establish a connection to the underlying data source

Throws:

DataAdapterException

onStart

public void onStart()
             throws DataAdapterException

An api hook that is executed once, after parameters have been loaded and before any other call to the DataAdapter is made.

Used to initialize resources and start-up external components.

The default implementation does nothing.

Throws:

DataAdapterException

ping

public abstract boolean ping()

Pings the data source

Returns:

true if the data source responded to ping request, false otherwise.

getId

public java.util.UUID getId()

Gets the unique id for the adapter

Returns:

the unique id for the adapter

setId

public void setId(java.util.UUID id)

Sets the unique id for the adapter

Parameters:

id - the unique id for the adapter

validateParameterNullity

protected java.lang.String validateParameterNullity(java.util.Map<java.lang.String,java.lang.String> params,
                                                    java.lang.String paramName)
                                             throws InvalidAdapterParameterException

Throws:

InvalidAdapterParameterException

validateParameter

protected <R> R validateParameter(java.util.Map<java.lang.String,java.lang.String> params,
                                  java.lang.String paramName,
                                  CheckedFunction<java.lang.String,R,InvalidAdapterParameterException> validator)
                           throws InvalidAdapterParameterException

Throws:

InvalidAdapterParameterException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isClosed

public boolean isClosed()