eu.fthevenet.binjr.sources.csv.adapters

Class CsvFileAdapter

java.lang.Object

eu.fthevenet.binjr.data.adapters.DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

eu.fthevenet.binjr.sources.csv.adapters.CsvFileAdapter

All Implemented Interfaces:

java.lang.AutoCloseable

public class CsvFileAdapter
extends DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

A DataAdapter implementation used to Worksheet instances with data from a local CSV formatted file.

Field Summary

Fields inherited from class eu.fthevenet.binjr.data.adapters.DataAdapter

closed

Constructor Summary

Constructors

Constructor and Description
CsvFileAdapter() Initializes a new instance of the CsvFileAdapter class with a set of default values.
CsvFileAdapter(java.lang.String csvPath, java.time.ZoneId zoneId) Initializes a new instance of the CsvFileAdapter class for the provided file and time zone.
CsvFileAdapter(java.lang.String csvPath, java.time.ZoneId zoneId, java.lang.String encoding, java.lang.String dateTimePattern, char delimiter) Initializes a new instance of the CsvFileAdapter class with the provided parameters.

Method Summary

Modifier and Type	Method and Description
void	close()
java.util.Map<TimeSeriesInfo<java.lang.Double>,TimeSeriesProcessor<java.lang.Double>>	fetchDecodedData(java.lang.String path, java.time.Instant begin, java.time.Instant end, java.util.List<TimeSeriesInfo<java.lang.Double>> seriesInfo, boolean bypassCache) Gets decoded data from the source as a map of TimeSeriesProcessor, for the time interval and TimeSeriesInfo specified.
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.
javafx.scene.control.TreeItem<TimeSeriesBinding<java.lang.Double>>	getBindingTree() Return a hierarchical view of all the individual bindings exposed by the underlying source.
protected java.util.SortedMap<java.lang.Long,DataSample<java.lang.Double>>	getDataStore()
CsvDecoder<java.lang.Double>	getDecoder() Gets the Decoder used to produce TimeSeriesProcessor from the source.
java.lang.String	getEncoding() Gets the encoding used to decode textual data sent by the source.
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
java.lang.String	getSourceName() Gets the name of the source.
java.time.ZoneId	getTimeZoneId() Gets the id of the time zone used to record dates in the source.
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
boolean	ping() Pings the data source

Methods inherited from class eu.fthevenet.binjr.data.adapters.DataAdapter

getId, isClosed, onStart, setId, toString, validateParameter, validateParameterNullity

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvFileAdapter

public CsvFileAdapter()
               throws DataAdapterException

Initializes a new instance of the CsvFileAdapter class with a set of default values.

Throws:

DataAdapterException - if the DataAdapter could not be initializes.

CsvFileAdapter

public CsvFileAdapter(java.lang.String csvPath,
                      java.time.ZoneId zoneId)
               throws DataAdapterException

Initializes a new instance of the CsvFileAdapter class for the provided file and time zone.

Parameters:

csvPath - the path to the csv file.

zoneId - the time zone to used.

Throws:

DataAdapterException - if the DataAdapter could not be initializes.

CsvFileAdapter

public CsvFileAdapter(java.lang.String csvPath,
                      java.time.ZoneId zoneId,
                      java.lang.String encoding,
                      java.lang.String dateTimePattern,
                      char delimiter)
               throws DataAdapterException

Initializes a new instance of the CsvFileAdapter class with the provided parameters.

Parameters:

csvPath - the path to the csv file.

zoneId - the time zone to used.

encoding - the encoding for the csv file.

dateTimePattern - a pattern to decode time stamps.

delimiter - the character used by the csv file to separate cells in csv records.

Throws:

DataAdapterException - if the DataAdapter could not be initializes.

Method Detail

getBindingTree

public javafx.scene.control.TreeItem<TimeSeriesBinding<java.lang.Double>> getBindingTree()
                                                                                  throws DataAdapterException

Description copied from class: DataAdapter

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

Specified by:

getBindingTree in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

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

Throws:

DataAdapterException - if an error occurs while retrieving bindings.

fetchDecodedData

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

Description copied from class: DataAdapter

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

Overrides:

fetchDecodedData in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

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.

fetchRawData

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

Description copied from class: DataAdapter

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

Specified by:

fetchRawData in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

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.

getEncoding

public java.lang.String getEncoding()

Description copied from class: DataAdapter

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

Specified by:

getEncoding in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

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

getTimeZoneId

public java.time.ZoneId getTimeZoneId()

Description copied from class: DataAdapter

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

Specified by:

getTimeZoneId in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

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

getDecoder

public CsvDecoder<java.lang.Double> getDecoder()

Description copied from class: DataAdapter

Gets the Decoder used to produce TimeSeriesProcessor from the source.

Specified by:

getDecoder in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

the Decoder used to produce TimeSeriesProcessor from the source.

getSourceName

public java.lang.String getSourceName()

Description copied from class: DataAdapter

Gets the name of the source.

Specified by:

getSourceName in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

the name of the source.

getParams

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

Description copied from class: DataAdapter

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

Specified by:

getParams in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

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

loadParams

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

Description copied from class: DataAdapter

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

Specified by:

loadParams in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Parameters:

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

Throws:

DataAdapterException

ping

public boolean ping()

Description copied from class: DataAdapter

Pings the data source

Specified by:

ping in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

Returns:

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

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class DataAdapter<java.lang.Double,CsvDecoder<java.lang.Double>>

getDataStore

protected java.util.SortedMap<java.lang.Long,DataSample<java.lang.Double>> getDataStore()
                                                                                 throws DataAdapterException

Throws:

DataAdapterException