Package net.ssehub.easy.producer.core.persistence.standard

Class Persistencer

java.lang.Object

net.ssehub.easy.producer.core.persistence.standard.Persistencer

All Implemented Interfaces:

IPersistencer, PersistenceConstants

public class Persistencer
extends java.lang.Object
implements IPersistencer, PersistenceConstants

This class represents an interlayer between persistency-layer and model. It provides functions for loading a model from the storage or saving it to storage. Therefore it performs a conversion between the persistency model and the application model. Uses UrlResolver.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private static net.ssehub.easy.basics.logger.EASyLoggerFactory.EASyLogger	LOGGER
private net.ssehub.easy.basics.progress.ProgressObserver	observer
private java.io.File	projectFolder
private DataStorage	storage

Fields inherited from interface net.ssehub.easy.producer.core.persistence.standard.PersistenceConstants

CONFIG_FILE, EASY_FILES_DEFAULT, INSTANTIATOR_ENGINE, INSTANTIATOR_FILE, INSTANTIATOR_INHERITED, INSTANTIATOR_PATH_REGEX, INSTANTIATOR_PATHS, INSTANTIATOR_UUID, PLP_LOCATION, PLP_VERSION, PRESUCCESSOR_LOCATION, PRESUCCESSOR_MEMEBERNAME, PRESUCCESSOR_UUID, PRESUCCESSOR_VERSION, PTN_PROJECTNAME, PTN_UUID, REASONER_ATTRIBUTE, REASONER_TIMEOUT, REASONER_VALUE_SEPARATOR, REASONER_VALUES, SETTINGS_DEBUG

Constructor Summary

Constructors

Constructor	Description
Persistencer(PathEnvironment pathEnv, java.io.File projectFolder, java.lang.String storageFile, net.ssehub.easy.basics.progress.ProgressObserver observer)	Sole constructor for this class for saving/reading persistence information out of a xml file.

Method Summary

Modifier and Type	Method	Description
IProjectCreationResult	createProject(java.lang.String projectName, java.io.File parentFolder, java.lang.String projectID, boolean lazy)	Creates an empty EASy project without any eclipse specific stuff.
PathEnvironment	getPathEnvironment()	Returns the path environment for making absolute paths relative and vice versa.
java.lang.String	getProjectID()	Returns the ID of a given EASy project.
PersistentProject	load()	Loads a PersistentProject, which is an EASy project representation, from a storage (file system).
private void	loadDefaultModels()	Loads the default models if existent.
PLPInfo	loadPLP()	Loads a PLPInfo from a storage (file system).
void	save(PLPInfo plp)	Saves given EASy to storage.
private void	save(PersistentProject project)	Saves given EASy to storage.
void	update()	Updates the models in the given project.
private void	writeDebugData(PLPInfo plp)	Writes debug data to file system, if and only if PLPInfo.getSaveDebugInformation() was set to true.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final net.ssehub.easy.basics.logger.EASyLoggerFactory.EASyLogger LOGGER

storage

private DataStorage storage

observer

private net.ssehub.easy.basics.progress.ProgressObserver observer

projectFolder

private java.io.File projectFolder

Constructor Detail

Persistencer

public Persistencer(PathEnvironment pathEnv,
                    java.io.File projectFolder,
                    java.lang.String storageFile,
                    net.ssehub.easy.basics.progress.ProgressObserver observer)

Sole constructor for this class for saving/reading persistence information out of a xml file.

Parameters:

pathEnv - a path environment for making files and paths relative

projectFolder - The location of the product line project.

storageFile - The absolute path of the file, which should be read/be written. for loading (nested) ivml models.

observer - a progress observer, may be ProgressObserver.NO_OBSERVER

Method Detail

loadDefaultModels

private void loadDefaultModels()

Loads the default models if existent.

load

public PersistentProject load()
                       throws PersistenceException

Description copied from interface: IPersistencer

Loads a PersistentProject, which is an EASy project representation, from a storage (file system).

Specified by:

load in interface IPersistencer

Returns:

The PersistentProject of the project which should be loaded.

Throws:

PersistenceException - In case of an incorrect data format of the configuration file, this exception will be thrown.

loadPLP

public PLPInfo loadPLP()
                throws PersistenceException

Loads a PLPInfo from a storage (file system).

Returns:

The PLPInfo which should be loaded.

Throws:

PersistenceException - In case of an incorrect data format of the configuration file, this exception will be thrown.

createProject

public IProjectCreationResult createProject(java.lang.String projectName,
                                            java.io.File parentFolder,
                                            java.lang.String projectID,
                                            boolean lazy)
                                     throws PersistenceException

Description copied from interface: IPersistencer

Creates an empty EASy project without any eclipse specific stuff.

Specified by:

createProject in interface IPersistencer

Parameters:

projectName - The name of the project, which should be created.

parentFolder - The parentFolder, where the project should be created.

projectID - The unique ID of the project which should be created.

lazy - if true, create only required parts, else assume that project does not exist before

Returns:

IProjectCreationResult Information of newly created items.

Throws:

PersistenceException - Will be thrown if the System cannot create folders and files in the parentFolder.

save

public void save(PLPInfo plp)
          throws PersistenceException

Saves given EASy to storage.

Specified by:

save in interface IPersistencer

Parameters:

plp - the information, which should be saved.

Throws:

PersistenceException - If the file cannot be written to the file system.

writeDebugData

private void writeDebugData(PLPInfo plp)
                     throws PersistenceException

Writes debug data to file system, if and only if PLPInfo.getSaveDebugInformation() was set to true. Part of the save(PLPInfo) method.

Parameters:

plp - the information, which should be saved.

Throws:

PersistenceException - If the file cannot be written to the file system.

save

private void save(PersistentProject project)
           throws PersistenceException

Saves given EASy to storage.

Parameters:

project - the information, which should be saved.

Throws:

PersistenceException - If the file cannot be written to the file system.

getProjectID

public java.lang.String getProjectID()

Returns the ID of a given EASy project.

Specified by:

getProjectID in interface IPersistencer

Returns:

the id or null if the specified project has no configuration file.

update

public void update()
            throws PersistenceException

Description copied from interface: IPersistencer

Updates the models in the given project.

Specified by:

update in interface IPersistencer

Throws:

PersistenceException - if errors during the update occur

getPathEnvironment

public PathEnvironment getPathEnvironment()

Description copied from interface: IPersistencer

Returns the path environment for making absolute paths relative and vice versa.

Specified by:

getPathEnvironment in interface IPersistencer

Returns:

the path environment