eu.fthevenet.binjr.data.adapters

Class DataAdapterFactory

java.lang.Object

eu.fthevenet.binjr.data.adapters.DataAdapterFactory

public class DataAdapterFactory
extends java.lang.Object

Defines methods to discover and create new instances of available DataAdapter classes

Author:

Frederic Thevenet

Method Summary

Modifier and Type	Method and Description
java.util.Collection<DataAdapterInfo>	getActiveAdapters() Gets a collection of DataAdapterInfo for all active (enabled) DataAdapter
java.util.Collection<DataAdapterInfo>	getAllAdapters() Gets a collection of DataAdapterInfo for all registered DataAdapter
DataAdapterDialog	getDialog(java.lang.String key, javafx.scene.Node root) Returns an instance of DataAdapterDialog used to gather source access parameters from the end user.
static DataAdapterFactory	getInstance() Gets the singleton instance of DataAdapterFactory
DataAdapter<?,?>	newAdapter(DataAdapterInfo info) Returns a new instance of a registered DataAdapter as identified by the specified key
DataAdapter<?,?>	newAdapter(java.lang.String key) Returns a new instance of a registered DataAdapter as identified by the specified key

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DataAdapterFactory getInstance()

Gets the singleton instance of DataAdapterFactory

Returns:

the singleton instance of DataAdapterFactory

getActiveAdapters

public java.util.Collection<DataAdapterInfo> getActiveAdapters()

Gets a collection of DataAdapterInfo for all active (enabled) DataAdapter

Returns:

a collection of DataAdapterInfo for all active (enabled) DataAdapter

getAllAdapters

public java.util.Collection<DataAdapterInfo> getAllAdapters()

Gets a collection of DataAdapterInfo for all registered DataAdapter

Returns:

a collection of DataAdapterInfo for all registered DataAdapter

newAdapter

public DataAdapter<?,?> newAdapter(DataAdapterInfo info)
                            throws NoAdapterFoundException,
                                   CannotInitializeDataAdapterException

Returns a new instance of a registered DataAdapter as identified by the specified key

Parameters:

info - a DataAdapterInfo instance used as a key

Returns:

a new instance of DataAdapter

Throws:

NoAdapterFoundException - if no registered DataAdapter could be found for the provided key

CannotInitializeDataAdapterException - if an error occurred while trying to create a new instance.

getDialog

public DataAdapterDialog getDialog(java.lang.String key,
                                   javafx.scene.Node root)
                            throws NoAdapterFoundException,
                                   CannotInitializeDataAdapterException

Returns an instance of DataAdapterDialog used to gather source access parameters from the end user.

Parameters:

key - a string that uniquely identify the type of the DataAdapter

root - the root node to act as the owner of the Dialog

Returns:

an instance of DataAdapterDialog used to gather source access parameters from the end user.

Throws:

NoAdapterFoundException - if no adapter matching the provided key could be found

CannotInitializeDataAdapterException - if an error occurred while trying to create a new instance.

newAdapter

public DataAdapter<?,?> newAdapter(java.lang.String key)
                            throws NoAdapterFoundException,
                                   CannotInitializeDataAdapterException

Returns a new instance of a registered DataAdapter as identified by the specified key

Parameters:

key - a string used as a key

Returns:

a new instance of DataAdapter

Throws:

NoAdapterFoundException - if no registered DataAdapter could be found for the provided key

CannotInitializeDataAdapterException - if an error occurred while trying to create a new instance.