eu.fthevenet.binjr.data.adapters

Interface DataAdapterInfo

All Known Implementing Classes:

BaseDataAdapterInfo, CsvFileDataAdapterInfo, JrdsDataAdapterInfo

public interface DataAdapterInfo

An immutable representation of a DataAdapter's metadata

Author:

Frederic Thevenet

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	enabled The enabled property.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	enabledProperty() The enabled property.
java.lang.Class<? extends DataAdapter>	getAdapterClass() Returns the class that implements the data adapter.
java.lang.Class<? extends DataAdapterDialog>	getAdapterDialog() Returns the class that implements the dialog box used to gather the adapter's parameters from the end user.
java.lang.String	getCopyright() Returns the copyright notice associated with the adapter.
java.lang.String	getDescription() Returns the description associated to the data adapter.
java.lang.String	getJarLocation() Returns the location of the JAR in which the adapter is packaged.
java.lang.String	getKey() Returns a key to uniquely identify the adapter.
java.lang.String	getLicense() Returns the name of license under which the adapter is distributed.
java.lang.String	getName() Returns the name of the data adapter.
java.lang.String	getSiteUrl() Returns the url of the website associated with the adapter.
Version	getVersion() Returns the version of the adapter.
boolean	isEnabled() Returns true if the adapter is enabled, false otherwise.
void	setEnabled(boolean enabled) Set to true to enable the adapter, false otherwise.

Property Detail

enabled

javafx.beans.property.BooleanProperty enabledProperty

The enabled property.

See Also:

isEnabled(), setEnabled(boolean)

Method Detail

getName

java.lang.String getName()

Returns the name of the data adapter.

Returns:

the name of the data adapter.

getDescription

java.lang.String getDescription()

Returns the description associated to the data adapter.

Returns:

the description associated to the data adapter.

getVersion

Version getVersion()

Returns the version of the adapter.

Returns:

the version of the adapter.

getSiteUrl

java.lang.String getSiteUrl()

Returns the url of the website associated with the adapter.

Returns:

the url of the website associated with the adapter.

getLicense

java.lang.String getLicense()

Returns the name of license under which the adapter is distributed.

Returns:

the name of license under which the adapter is distributed.

getCopyright

java.lang.String getCopyright()

Returns the copyright notice associated with the adapter.

Returns:

the copyright notice associated with the adapter.

getJarLocation

java.lang.String getJarLocation()

Returns the location of the JAR in which the adapter is packaged.

Returns:

the location of the JAR in which the adapter is packaged.

getAdapterClass

java.lang.Class<? extends DataAdapter> getAdapterClass()

Returns the class that implements the data adapter.

Returns:

the class that implements the data adapter.

getKey

java.lang.String getKey()

Returns a key to uniquely identify the adapter.

Returns:

a key to uniquely identify the adapter.

getAdapterDialog

java.lang.Class<? extends DataAdapterDialog> getAdapterDialog()

Returns the class that implements the dialog box used to gather the adapter's parameters from the end user.

Returns:

the class that implements the dialog box used to gather the adapter's parameters from the end user.

enabledProperty

javafx.beans.property.BooleanProperty enabledProperty()

The enabled property.

See Also:

isEnabled(), setEnabled(boolean)

isEnabled

boolean isEnabled()

Returns true if the adapter is enabled, false otherwise.

Returns:

true if the adapter is enabled, false otherwise.

setEnabled

void setEnabled(boolean enabled)

Set to true to enable the adapter, false otherwise.

Parameters:

enabled - true to enable the adapter, false otherwise.