eu.fthevenet.binjr.sources.jrds.adapters

Class JrdsDataAdapter

java.lang.Object

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

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

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

eu.fthevenet.binjr.sources.jrds.adapters.JrdsDataAdapter

All Implemented Interfaces:

java.lang.AutoCloseable

public class JrdsDataAdapter
extends HttpDataAdapterBase<java.lang.Double,CsvDecoder<java.lang.Double>>

This class provides an implementation of DataAdapter for JRDS.

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ENCODING_PARAM_NAME
static java.lang.String	JRDS_FILTER
static java.lang.String	JRDS_TREE
protected static java.lang.String	TREE_VIEW_TAB_PARAM_NAME
protected static java.lang.String	ZONE_ID_PARAM_NAME

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

BASE_ADDRESS_PARAM_NAME

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

DEFAULT_CACHE_SIZE

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

closed

Constructor Summary

Constructors

Constructor and Description
JrdsDataAdapter() Default constructor
JrdsDataAdapter(java.net.URL baseURL, java.time.ZoneId zoneId, java.lang.String encoding, JrdsTreeViewTab treeViewTab, java.lang.String filter) Initializes a new instance of the JrdsDataAdapter class.

Method Summary

Modifier and Type	Method and Description
void	close()
protected java.net.URI	craftFetchUri(java.lang.String path, java.time.Instant begin, java.time.Instant end)
java.util.Collection<java.lang.String>	discoverFilters()
static JrdsDataAdapter	fromUrl(java.lang.String address, java.time.ZoneId zoneId, JrdsTreeViewTab treeViewTab, java.lang.String filter) Builds a new instance of the JrdsDataAdapter class from the provided parameters.
javafx.scene.control.TreeItem<TimeSeriesBinding<java.lang.Double>>	getBindingTree() Return a hierarchical view of all the individual bindings exposed by the underlying source.
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.HttpDataAdapterBase

craftRequestUri, craftRequestUri, createSslCustomContext, doHttpGet, getBaseAddress, httpClientFactory, onCacheMiss, setBaseAddress

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

fetchRawData

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

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

Methods inherited from class java.lang.Object

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

Field Detail

JRDS_FILTER

public static final java.lang.String JRDS_FILTER

See Also:

Constant Field Values

JRDS_TREE

public static final java.lang.String JRDS_TREE

See Also:

Constant Field Values

ENCODING_PARAM_NAME

protected static final java.lang.String ENCODING_PARAM_NAME

See Also:

Constant Field Values

ZONE_ID_PARAM_NAME

protected static final java.lang.String ZONE_ID_PARAM_NAME

See Also:

Constant Field Values

TREE_VIEW_TAB_PARAM_NAME

protected static final java.lang.String TREE_VIEW_TAB_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

JrdsDataAdapter

public JrdsDataAdapter()
                throws DataAdapterException

Default constructor

Throws:

DataAdapterException

JrdsDataAdapter

public JrdsDataAdapter(java.net.URL baseURL,
                       java.time.ZoneId zoneId,
                       java.lang.String encoding,
                       JrdsTreeViewTab treeViewTab,
                       java.lang.String filter)
                throws DataAdapterException

Initializes a new instance of the JrdsDataAdapter class.

Parameters:

zoneId - the id of the time zone used to record dates.

encoding - the encoding used by the download servlet.

treeViewTab - the filter to apply to the tree view

Throws:

DataAdapterException

Method Detail

fromUrl

public static JrdsDataAdapter fromUrl(java.lang.String address,
                                      java.time.ZoneId zoneId,
                                      JrdsTreeViewTab treeViewTab,
                                      java.lang.String filter)
                               throws DataAdapterException

Builds a new instance of the JrdsDataAdapter class from the provided parameters.

Parameters:

address - the URL to the JRDS webapp.

zoneId - the id of the time zone used to record dates.

Returns:

a new instance of the JrdsDataAdapter class.

Throws:

DataAdapterException

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.

craftFetchUri

protected java.net.URI craftFetchUri(java.lang.String path,
                                     java.time.Instant begin,
                                     java.time.Instant end)
                              throws DataAdapterException

Specified by:

craftFetchUri in class HttpDataAdapterBase<java.lang.Double,CsvDecoder<java.lang.Double>>

Throws:

DataAdapterException

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

Overrides:

getParams in class HttpDataAdapterBase<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

Overrides:

loadParams in class HttpDataAdapterBase<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.

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.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

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

discoverFilters

public java.util.Collection<java.lang.String> discoverFilters()
                                                       throws DataAdapterException,
                                                              java.net.URISyntaxException

Throws:

DataAdapterException

java.net.URISyntaxException