eu.fthevenet.binjr.data.adapters

Class BaseDataAdapterInfo

java.lang.Object

eu.fthevenet.binjr.data.adapters.BaseDataAdapterInfo

All Implemented Interfaces:

DataAdapterInfo

Direct Known Subclasses:

CsvFileDataAdapterInfo, JrdsDataAdapterInfo

public class BaseDataAdapterInfo
extends java.lang.Object
implements 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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDataAdapterInfo(java.lang.String name, java.lang.String description, java.lang.String copyright, java.lang.String license, java.lang.String siteUrl, java.lang.Class<? extends DataAdapter> adapterClass, java.lang.Class<? extends DataAdapterDialog> dialogClass)
protected	BaseDataAdapterInfo(java.lang.String name, java.lang.String description, Version version, java.lang.String copyright, java.lang.String license, java.lang.String siteUrl, java.lang.Class<? extends DataAdapter> adapterClass, java.lang.Class<? extends DataAdapterDialog> dialogClass) Initializes a new instance of the DataAdapterInfo class.

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() Gets the value of the property enabled.
void	setEnabled(boolean enabled) Sets the value of the property enabled.

Methods inherited from class java.lang.Object

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

Property Detail

enabled

public javafx.beans.property.BooleanProperty enabledProperty

Specified by:

enabledProperty in interface DataAdapterInfo

Returns:

The enabled property.

See Also:

isEnabled(), setEnabled(boolean)

Constructor Detail

BaseDataAdapterInfo

protected BaseDataAdapterInfo(java.lang.String name,
                              java.lang.String description,
                              java.lang.String copyright,
                              java.lang.String license,
                              java.lang.String siteUrl,
                              java.lang.Class<? extends DataAdapter> adapterClass,
                              java.lang.Class<? extends DataAdapterDialog> dialogClass)

BaseDataAdapterInfo

protected BaseDataAdapterInfo(java.lang.String name,
                              java.lang.String description,
                              Version version,
                              java.lang.String copyright,
                              java.lang.String license,
                              java.lang.String siteUrl,
                              java.lang.Class<? extends DataAdapter> adapterClass,
                              java.lang.Class<? extends DataAdapterDialog> dialogClass)

Initializes a new instance of the DataAdapterInfo class.

Parameters:

name - the name of the data adapter.

description - the description associated to the data adapter.

version -

copyright -

license -

siteUrl -

adapterClass - the class that implements the data adapter.

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

Method Detail

getName

public java.lang.String getName()

Returns the name of the data adapter.

Specified by:

getName in interface DataAdapterInfo

Returns:

the name of the data adapter.

getDescription

public java.lang.String getDescription()

Returns the description associated to the data adapter.

Specified by:

getDescription in interface DataAdapterInfo

Returns:

the description associated to the data adapter.

getAdapterClass

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

Returns the class that implements the data adapter.

Specified by:

getAdapterClass in interface DataAdapterInfo

Returns:

the class that implements the data adapter.

getKey

public java.lang.String getKey()

Returns a key to uniquely identify the adapter.

Specified by:

getKey in interface DataAdapterInfo

Returns:

a key to uniquely identify the adapter.

getAdapterDialog

public 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.

Specified by:

getAdapterDialog in interface DataAdapterInfo

Returns:

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

enabledProperty

public javafx.beans.property.BooleanProperty enabledProperty()

Description copied from interface: DataAdapterInfo

The enabled property.

Specified by:

enabledProperty in interface DataAdapterInfo

Returns:

The enabled property.

See Also:

isEnabled(), setEnabled(boolean)

isEnabled

public boolean isEnabled()

Gets the value of the property enabled.

Specified by:

isEnabled in interface DataAdapterInfo

Returns:

true if the adapter is enabled, false otherwise.

setEnabled

public void setEnabled(boolean enabled)

Sets the value of the property enabled.

Specified by:

setEnabled in interface DataAdapterInfo

Parameters:

enabled - true to enable the adapter, false otherwise.

getVersion

public Version getVersion()

Description copied from interface: DataAdapterInfo

Returns the version of the adapter.

Specified by:

getVersion in interface DataAdapterInfo

Returns:

the version of the adapter.

getCopyright

public java.lang.String getCopyright()

Description copied from interface: DataAdapterInfo

Returns the copyright notice associated with the adapter.

Specified by:

getCopyright in interface DataAdapterInfo

Returns:

the copyright notice associated with the adapter.

getLicense

public java.lang.String getLicense()

Description copied from interface: DataAdapterInfo

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

Specified by:

getLicense in interface DataAdapterInfo

Returns:

the name of license under which the adapter is distributed.

getJarLocation

public java.lang.String getJarLocation()

Description copied from interface: DataAdapterInfo

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

Specified by:

getJarLocation in interface DataAdapterInfo

Returns:

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

getSiteUrl

public java.lang.String getSiteUrl()

Description copied from interface: DataAdapterInfo

Returns the url of the website associated with the adapter.

Specified by:

getSiteUrl in interface DataAdapterInfo

Returns:

the url of the website associated with the adapter.