idare.imagenode.internal.DataManagement

Class DataSetManager

java.lang.Object

idare.imagenode.internal.DataManagement.DataSetManager

public class DataSetManager
extends Object

A class to manage Datasets

Author:

Thomas Pfau

Constructor Summary

Constructors

Constructor and Description
DataSetManager() Default constructor initializing required fields.

Method Summary

Modifier and Type	Method and Description
void	addDataSet(DataSet newDataSet) Add a Dataset to this Manager.
void	addDataSetAboutToBeChangedListener(DataSetAboutToBeChangedListener listener) Add a Listener that needs to be informed, if a dataset state is about to be changed, before the change actually happened
void	addDataSetChangeListener(DataSetChangeListener listener) Add a Listener that needs to be informed, if a dataset state was changed
void	clearDataSets() Clear all Datasets, and inform any listeners that the sets are being removed.
DataSet	createDataSet(boolean TwoCols, String DataSetTypeName, String SetDescription, IDAREWorkbook dsWorkBook) Create a Dataset based on properties and a DataSetFile.
void	deregisterDataSetReader(IDAREDatasetReader reader) DeRegister a IDAREDatasetReader.
void	deRegisterDataSetType(String TypeName, Class<? extends DataSet> dataSetClass) Remove a class from the available Datasetclasses.
void	deregisterPropertiesForDataSet(Class<? extends DataSet> classType, DataSetLayoutProperties properties) Deregister Properties for a DataSet
Collection<String>	getAvailableDataSetTypes() Get the Types of Datasets available to this Manager.
Vector<IDAREDatasetReader>	getAvailableReaders() Get all IDAREDatasetReaders currently registered with IDARE.
DataSet	getDataSetForID(Integer id) Get the dataset with the specified ID from this manager.
Collection<DataSet>	getDataSets()
void	handleEvent(org.cytoscape.session.events.SessionAboutToBeSavedEvent arg0) Handle A SessionAboutToBeSavedEvent, ad add data of the DataManger to this Event.
void	handleEvent(org.cytoscape.session.events.SessionLoadedEvent arg0) Handle A SessionLoadedevent, since order is relevant this object is not directly a listener but gets the command from a listener.
void	registerDataSetReader(IDAREDatasetReader reader) Register a IDAREDatasetReader to be available for file reading.
void	registerDataSetType(String TypeName, Class<? extends DataSet> dataSetClass) Register a DataSetType that can be accessed by the TypeName.
Collection<DataSetLayoutProperties>	registerPropertiesForDataSet(Class<? extends DataSet> classType, Collection<DataSetLayoutProperties> properties) Register a set of properties for a datasetclass.
boolean	registerPropertiesForDataSet(Class<? extends DataSet> classType, DataSetLayoutProperties properties) Add DataSetProperties for a specific dataset
void	removeDataSet(DataSet setToRemove) Remove a DataSet from this Manager
void	removeDataSetAboutToBeChangedListener(DataSetAboutToBeChangedListener listener) Remove a DataSetAboutToBeChangedListener listening to changes in DataSets
void	removeDataSetChangeListener(DataSetChangeListener listener) Remove a Listener that needs to be informed, if a dataset state was changed
void	reset() Reset this DataSetManager clearing all datastructures.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSetManager

public DataSetManager()

Default constructor initializing required fields.

Method Detail

clearDataSets

public void clearDataSets()

Clear all Datasets, and inform any listeners that the sets are being removed.

getAvailableDataSetTypes

public Collection<String> getAvailableDataSetTypes()

Get the Types of Datasets available to this Manager.

Returns:

a Collection of Strings of available DataSet types

registerDataSetType

public void registerDataSetType(String TypeName,
                                Class<? extends DataSet> dataSetClass)
                         throws DuplicateIDException

Register a DataSetType that can be accessed by the TypeName.

Parameters:

TypeName - the TypeName (string description) of the registered DataSetType

dataSetClass - The Class of the DataSet

Throws:

DuplicateIDException - IF an ID for a type of dataset is already present

deRegisterDataSetType

public void deRegisterDataSetType(String TypeName,
                                  Class<? extends DataSet> dataSetClass)

Remove a class from the available Datasetclasses. This is skipped, if the class matching to the typename does not match the class provided.

Parameters:

TypeName - the TypeName (string description) of the deregistered DataSetType

dataSetClass - The Class of the DataSet

registerPropertiesForDataSet

public boolean registerPropertiesForDataSet(Class<? extends DataSet> classType,
                                            DataSetLayoutProperties properties)

Add DataSetProperties for a specific dataset

Parameters:

classType - The class to register the properties for

properties - The properties to make available for the given class

Returns:

whether the properties could be added

registerPropertiesForDataSet

public Collection<DataSetLayoutProperties> registerPropertiesForDataSet(Class<? extends DataSet> classType,
                                                                        Collection<DataSetLayoutProperties> properties)

Register a set of properties for a datasetclass.

Parameters:

classType - the class of the dataset which to register the properties for.

properties - the property options for the dataset that should eb registered.

Returns:

The properties that were not added because they are already present.

deregisterPropertiesForDataSet

public void deregisterPropertiesForDataSet(Class<? extends DataSet> classType,
                                           DataSetLayoutProperties properties)

Deregister Properties for a DataSet

Parameters:

classType - the class of the dataset to deregister items for.

properties - the properties to deregister.

addDataSetAboutToBeChangedListener

public void addDataSetAboutToBeChangedListener(DataSetAboutToBeChangedListener listener)

Add a Listener that needs to be informed, if a dataset state is about to be changed, before the change actually happened

Parameters:

listener - the DataSetAboutToBeChangedListener that listens

removeDataSetAboutToBeChangedListener

public void removeDataSetAboutToBeChangedListener(DataSetAboutToBeChangedListener listener)

Remove a DataSetAboutToBeChangedListener listening to changes in DataSets

Parameters:

listener - the DataSetAboutToBeChangedListener that listens

addDataSetChangeListener

public void addDataSetChangeListener(DataSetChangeListener listener)

Add a Listener that needs to be informed, if a dataset state was changed

Parameters:

listener - the DataSetChangeListener that listens

removeDataSetChangeListener

public void removeDataSetChangeListener(DataSetChangeListener listener)

Remove a Listener that needs to be informed, if a dataset state was changed

Parameters:

listener - the DataSetChangeListener that listens

getDataSets

public Collection<DataSet> getDataSets()

addDataSet

public void addDataSet(DataSet newDataSet)

Add a Dataset to this Manager.

Parameters:

newDataSet - The Dataset to add

removeDataSet

public void removeDataSet(DataSet setToRemove)

Remove a DataSet from this Manager

Parameters:

setToRemove - the Dataset to remove

getDataSetForID

public DataSet getDataSetForID(Integer id)

Get the dataset with the specified ID from this manager.

Parameters:

id - the requested ID

Returns:

the requested DataSet or null if no set has this id.

reset

public void reset()

Reset this DataSetManager clearing all datastructures.

handleEvent

public void handleEvent(org.cytoscape.session.events.SessionLoadedEvent arg0)

Handle A SessionLoadedevent, since order is relevant this object is not directly a listener but gets the command from a listener.

Parameters:

arg0 - the SessionLoadedEvent to obtain data from

getAvailableReaders

public Vector<IDAREDatasetReader> getAvailableReaders()

Get all IDAREDatasetReaders currently registered with IDARE.

Returns:

a Vector of DataSetReaders in the reverse order of their addition to IDARE.

createDataSet

public DataSet createDataSet(boolean TwoCols,
                             String DataSetTypeName,
                             String SetDescription,
                             IDAREWorkbook dsWorkBook)
                      throws ExecutionException,
                             WrongFormat,
                             org.apache.poi.openxml4j.exceptions.InvalidFormatException,
                             DuplicateIDException,
                             IOException,
                             ClassNotFoundException,
                             InstantiationException,
                             IllegalAccessException

Create a Dataset based on properties and a DataSetFile. and add it to the manager.

Parameters:

TwoCols - indicator whether to use twoColumn ID Indicators

DataSetTypeName - Class name of the dataset

SetDescription - Description of the Dataset

dsWorkBook - The IDAREWorkbook to use for this DataSet

Returns:

The Created Dataset with the data from the DataSetFile parsed.

Throws:

WrongFormat - Depending on the Dataset specific properties have to be matched by the file

org.apache.poi.openxml4j.exceptions.InvalidFormatException - Depending on the Dataset specific properties have to be matched by the file

DuplicateIDException - Depending on the Dataset specific properties have to be matched by the file

IOException - if IO on the workbook failed

ExecutionException - if something during the processing went wrong

ClassNotFoundException - if the class for the Dataset is not found

IllegalAccessException - if something wents off with access

InstantiationException - if the Dataset cannot be instantiated

handleEvent

public void handleEvent(org.cytoscape.session.events.SessionAboutToBeSavedEvent arg0)

Handle A SessionAboutToBeSavedEvent, ad add data of the DataManger to this Event. Since order is necessary this class does not itself implement the SessionLoaded/Saved mechanism but relies on a managing class to keep the order of actions.

Parameters:

arg0 - a SessionAboutToBeSavedEvent

registerDataSetReader

public void registerDataSetReader(IDAREDatasetReader reader)

Register a IDAREDatasetReader to be available for file reading. Readers are used in their reverse order of registration. i.e. the later a reader was registered, the higher its precedence of usage. Multiple readers for the same file extensions can be available, and thus the latest registered reader will be tried first.

Parameters:

reader - the reader to add

deregisterDataSetReader

public void deregisterDataSetReader(IDAREDatasetReader reader)

DeRegister a IDAREDatasetReader. It will no longer be available for Datsetreading.

Parameters:

reader - the reader to deregister