pl.edu.agh.cast.data.persistence
Interface IPersistenceProvider

All Known Subinterfaces:

IObservablePersistenceProvider

All Known Implementing Classes:

AbstractPersistenceProvider, AbstractPersistenceProviderDecorator, ObservablePersistenceProvider, RuntimePersistenceProvider, SerializationPersistenceProvider, TransparentPersistenceProvider, ZLayerPersistenceProvider

public interface IPersistenceProvider

Interface of data model persistence provider.

Author:

AGH CAST Team

Method Summary

void	destroy() Destroys the instance of IPersistenceProvider.
<T extends IDataSet<? extends IElement>> T	getDataSet(DataSetDescriptor descriptor) Returns the data set described by given descriptor.
<T extends IDataSet<? extends IElement>> T	getDataSet(UUID id) Returns the data set with given ID.
DataSetDescriptor	getDataSetDescriptor(UUID id) Returns the descriptor of data set with given ID.
List<DataSetDescriptor>	getDataSetDescriptors() Returns descriptors of all available data sets.
List<DataSetDescriptor>	getDataSetDescriptors(Type dsType) Returns descriptors of all available data sets of given type (and sub-types).
<T extends IDataSet<? extends IElement>> Map<UUID,T>	getDataSets(Collection<DataSetDescriptor> descriptors) Returns the data sets described by given descriptors.
<T extends IDataSet<? extends IElement>> Map<UUID,T>	getDataSetsById(Collection<UUID> ids) Returns the data sets with given IDs.
List<DomainDataSetDescriptor>	getDomainDataSetDescriptors() Returns descriptors of all available domain data sets.
List<PresentationDataSetDescriptor>	getPresentationDataSetDescriptors() Returns descriptors of all available presentation data sets.
List<VisualDataSetDescriptor>	getVisualDataSetDescriptors() Returns descriptors of all available visual data sets.
void	initialize() Initializes the instance of IPersistenceProvider.
UUID	renameDataSet(UUID id, String newName) Changes the name of the data set with given ID.
UUID	saveDataSet(IDataSet<? extends IElement> dataSet) Saves the given data set.
UUID	saveDataSet(IDataSet<? extends IElement> dataSet, org.eclipse.core.runtime.IProgressMonitor monitor) Saves the given data set.
Map<UUID,UUID>	saveDataSets(Collection<IDataSet<? extends IElement>> dataSets) Saves the given collection of data sets.
Map<UUID,UUID>	saveDataSets(Collection<IDataSet<? extends IElement>> dataSets, org.eclipse.core.runtime.IProgressMonitor monitor) Saves the given collection of data sets.
<T extends IPresentationDataSet<? extends IPresentationElement<? extends IElement>>> T	saveDiagram(T presentationDataSet) Saves the given presentation data set with associated visual data set and returns their new version.
<T extends IPresentationDataSet<? extends IPresentationElement<? extends IElement>>> T	saveDiagram(T presentationDataSet, org.eclipse.core.runtime.IProgressMonitor monitor) Saves the given presentation data set with associated visual data set and returns their new version.
void	setConfig(String filePath) Sets the path to configuration/storage file.

Method Detail

setConfig

void setConfig(String filePath)

Sets the path to configuration/storage file.

Parameters:

filePath - path to configuration/storage file

initialize

void initialize()

Initializes the instance of IPersistenceProvider.

destroy

void destroy()

Destroys the instance of IPersistenceProvider.

getDataSetDescriptors

List<DataSetDescriptor> getDataSetDescriptors()

Returns descriptors of all available data sets.

Returns:

list of descriptors of available data sets

getDataSetDescriptors

List<DataSetDescriptor> getDataSetDescriptors(Type dsType)

Returns descriptors of all available data sets of given type (and sub-types).

Parameters:

dsType - the type (super-type) of the data sets whose descriptors should be returned

Returns:

list of descriptors of data sets of given type

getDomainDataSetDescriptors

List<DomainDataSetDescriptor> getDomainDataSetDescriptors()

Returns descriptors of all available domain data sets.

Returns:

list of descriptors of available domain data sets

getPresentationDataSetDescriptors

List<PresentationDataSetDescriptor> getPresentationDataSetDescriptors()

Returns descriptors of all available presentation data sets.

Returns:

list of descriptors of available presentation data sets

getVisualDataSetDescriptors

List<VisualDataSetDescriptor> getVisualDataSetDescriptors()

Returns descriptors of all available visual data sets.

Returns:

list of descriptors of available visual data sets

getDataSetDescriptor

DataSetDescriptor getDataSetDescriptor(UUID id)

Returns the descriptor of data set with given ID.

Parameters:

id - the ID of the data set

Returns:

the descriptor of data set with given ID

getDataSet

<T extends IDataSet<? extends IElement>> T getDataSet(UUID id)

Returns the data set with given ID.

Type Parameters:

T - the type of data set to be returned

Parameters:

id - the ID of the data set

Returns:

the data set with given ID

getDataSet

<T extends IDataSet<? extends IElement>> T getDataSet(DataSetDescriptor descriptor)

Returns the data set described by given descriptor.

Type Parameters:

T - the type of data set to be returned

Parameters:

descriptor - the descriptor of the data set

Returns:

the data set with described by given descriptor

getDataSetsById

<T extends IDataSet<? extends IElement>> Map<UUID,T> getDataSetsById(Collection<UUID> ids)

Returns the data sets with given IDs.

Type Parameters:

T - the type of data sets to be returned

Parameters:

ids - collection of data set IDs

Returns:

a map of data sets with given IDs, indexed by IDs

getDataSets

<T extends IDataSet<? extends IElement>> Map<UUID,T> getDataSets(Collection<DataSetDescriptor> descriptors)

Returns the data sets described by given descriptors.

Type Parameters:

T - the type of data sets to be returned

Parameters:

descriptors - collection of descriptor of the data sets

Returns:

a map of data sets described by given descriptors, indexed by IDs

saveDataSet

UUID saveDataSet(IDataSet<? extends IElement> dataSet)

Saves the given data set.

Parameters:

dataSet - the data set to save

Returns:

the ID of the data set (as saved)

saveDataSet

UUID saveDataSet(IDataSet<? extends IElement> dataSet,
                 org.eclipse.core.runtime.IProgressMonitor monitor)

Saves the given data set.

Parameters:

dataSet - the data set to save

monitor - operation progress monitor

Returns:

the ID of the data set (as saved)

saveDataSets

Map<UUID,UUID> saveDataSets(Collection<IDataSet<? extends IElement>> dataSets)

Saves the given collection of data sets.

Parameters:

dataSets - collection of data sets to save

Returns:

a map containing new IDs (as saved) of the data sets indexed by their old IDs

saveDataSets

Map<UUID,UUID> saveDataSets(Collection<IDataSet<? extends IElement>> dataSets,
                            org.eclipse.core.runtime.IProgressMonitor monitor)

Saves the given collection of data sets.

Parameters:

dataSets - collection of data sets to save

monitor - operation progress monitor

Returns:

a map containing new IDs (as saved) of the data sets indexed by their old IDs

saveDiagram

<T extends IPresentationDataSet<? extends IPresentationElement<? extends IElement>>> T saveDiagram(T presentationDataSet)

Saves the given presentation data set with associated visual data set and returns their new version.

Type Parameters:

T - the type of presentation data set

Parameters:

presentationDataSet - the presentation data set to save

Returns:

the new version of presentation data set (with associated visual data set) as saved

saveDiagram

<T extends IPresentationDataSet<? extends IPresentationElement<? extends IElement>>> T saveDiagram(T presentationDataSet,
                                                                                                   org.eclipse.core.runtime.IProgressMonitor monitor)

Saves the given presentation data set with associated visual data set and returns their new version.

Type Parameters:

T - the type of presentation data set

Parameters:

presentationDataSet - the presentation data set to save

monitor - operation progress monitor

Returns:

the new version of presentation data set (with associated visual data set) as saved

renameDataSet

UUID renameDataSet(UUID id,
                   String newName)

Changes the name of the data set with given ID.

Parameters:

id - the data set ID

newName - the new name to set

Returns:

the ID of renamed data set