Package net.ssehub.easy.varModel.confModel

Class ConfigurationSaver

java.lang.Object

net.ssehub.easy.varModel.confModel.ConfigurationSaver

public class ConfigurationSaver
extends java.lang.Object

This method is part of the configuration and responsible for saving the values of the configuration inside the Configuration.toProject(boolean) method. The visibility of this class has been relaxed in order to serve as basis for refinements.

Author:

El-Sharkawy, Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private Project	destProject	The destination project where the information of the configuration should be stored to.
private static EASyLoggerFactory.EASyLogger	LOGGER
private boolean	onlyUserInput	Specifies whether only user Input should be stored: true: Assignments in state AssignmentState.ASSIGNED and AssignmentState.FROZEN will be saved. false: Assignments in state AssignmentState.ASSIGNED, AssignmentState.FROZEN, and AssignmentState.DERIVED will be saved (i.e.
private Configuration	srcConfiguration	this configuration, which should be saved.

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	ConfigurationSaver(Configuration srcConfiguration, boolean ownProject)	Default constructor for this class.
protected	ConfigurationSaver(Configuration srcConfiguration, boolean ownProject, boolean onlyUserInput)	Constructor for this class for saving the configuration.

Method Summary

Modifier and Type	Method	Description
protected void	addAttributes(Project destProject, Configuration srcConfiguration)	Adds attributes to destProject.
protected void	addImports(Project destProject, Configuration srcConfiguration)	Adds the imports to destProject.
protected void	addLocalVariables(Project destProject, Configuration srcConfiguration)	Adds local variables to destProject.
protected void	addVersion(Project destProject, Configuration srcConfiguration)	Adds the current version to destProject.
private boolean	checkState(IAssignmentState state)	Checks whether the sate (of a variable) should be saved.
protected ConstraintSyntaxTree	createAssignmentConstraint(Project dstProject, AbstractVariable decl, IDecisionVariable var, Value value)	Creates an assignment constraint.
protected FreezeBlock	createFreezeBlock(IFreezable[] freezables, Project parent)	Creates a freeze block, allowing customization (factory method).
protected Project	createProject(Configuration srcConfiguration)	Creates the project to store the configuration into.
protected ConstraintSyntaxTree	deriveOperand(AbstractVariable decl, IDecisionVariable var)	Derives the operand expression for turning a configuration into a project.
protected Configuration	getConfiguration()	Returns the Configuration, which will currently saved by this saver.
Project	getSavedConfiguration()	Returns the project where the values and frozen states are saved to.
protected boolean	isSavingEnabled(Project destProject, IDecisionVariable var)	Returns whether saving this variable (for the destination project destProject) is enabled.
private int	processAssignment(Project confProject, java.lang.StringBuilder errors, AbstractVariable decl, IDecisionVariable var, Value value)	Processes an assignment.
private void	removedLocalConfigChanges()	Part of the Configuration.toProject(boolean) method.
protected void	saveFreezeStates(Project confProject)	Part of the Configuration.toProject(boolean) method.
protected Value	toSaveableValue(IDecisionVariable var, Value value)	This method escapes special characters for saving them into a file.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final EASyLoggerFactory.EASyLogger LOGGER

srcConfiguration

private Configuration srcConfiguration

this configuration, which should be saved.

destProject

private Project destProject

The destination project where the information of the configuration should be stored to.

onlyUserInput

private boolean onlyUserInput

Specifies whether only user Input should be stored:

• true: Assignments in state AssignmentState.ASSIGNED and AssignmentState.FROZEN will be saved.
• false: Assignments in state AssignmentState.ASSIGNED, AssignmentState.FROZEN, and AssignmentState.DERIVED will be saved (i.e. also computed values).

Constructor Detail

ConfigurationSaver

ConfigurationSaver(Configuration srcConfiguration,
                   boolean ownProject)
            throws ConfigurationException

Default constructor for this class. This Constructor will save only user input.

Parameters:

srcConfiguration - The configuration which should be saved.

ownProject - return an own project (true) or add the configuration to Configuration.getProject() (false)

Throws:

ConfigurationException - in case of any configuration errors

See Also:

ConfigurationSaver(Configuration, boolean, boolean)

ConfigurationSaver

protected ConfigurationSaver(Configuration srcConfiguration,
                             boolean ownProject,
                             boolean onlyUserInput)
                      throws ConfigurationException

Constructor for this class for saving the configuration. With this constructor it is possible to decide whether only user input should be saved or all configured values.

Parameters:

srcConfiguration - The configuration which should be saved.

ownProject - return an own project (true) or add the configuration to Configuration.getProject() (false)

onlyUserInput - Specifies whether only user Input should be stored:

• true: Assignments in state AssignmentState.ASSIGNED and AssignmentState.FROZEN will be saved.
• false: Assignments in state AssignmentState.ASSIGNED, AssignmentState.FROZEN, and AssignmentState.DERIVED will be saved (i.e. also computed values).

Throws:

ConfigurationException - in case of any configuration errors

See Also:

createProject(Configuration), addVersion(Project, Configuration), addImports(Project, Configuration), #addVariables(Project, Configuration)

Method Detail

getSavedConfiguration

public Project getSavedConfiguration()

Returns the project where the values and frozen states are saved to.

Returns:

Configuration.getProject() if the constructor was called with ownProject = false, otherwise a new project which imports Configuration.getProject().

getConfiguration

protected Configuration getConfiguration()

Returns the Configuration, which will currently saved by this saver.

Returns:

The configuration to be saved.

createProject

protected Project createProject(Configuration srcConfiguration)

Creates the project to store the configuration into.

Parameters:

srcConfiguration - the configuration to be stored

Returns:

the project to store the configuration into

addVersion

protected void addVersion(Project destProject,
                          Configuration srcConfiguration)

Adds the current version to destProject.

Parameters:

destProject - the destination project being set up

srcConfiguration - the source configuration

addImports

protected void addImports(Project destProject,
                          Configuration srcConfiguration)

Adds the imports to destProject.

Parameters:

destProject - the destination project being set up

srcConfiguration - the source configuration

addLocalVariables

protected void addLocalVariables(Project destProject,
                                 Configuration srcConfiguration)

Adds local variables to destProject.

Parameters:

destProject - the destination project being set up

srcConfiguration - the source configuration

addAttributes

protected void addAttributes(Project destProject,
                             Configuration srcConfiguration)

Adds attributes to destProject.

Parameters:

destProject - the destination project being set up

srcConfiguration - the source configuration

createAssignmentConstraint

protected ConstraintSyntaxTree createAssignmentConstraint(Project dstProject,
                                                          AbstractVariable decl,
                                                          IDecisionVariable var,
                                                          Value value)

Creates an assignment constraint.

Parameters:

dstProject - the destination project

decl - the variable declaration

var - the configuration variable itself

value - the value assigned to decl

Returns:

the created constraint

isSavingEnabled

protected boolean isSavingEnabled(Project destProject,
                                  IDecisionVariable var)

Returns whether saving this variable (for the destination project destProject) is enabled.

Parameters:

destProject - the project being saved

var - the variable to be checked

Returns:

true if saving for var is enabled, false else

removedLocalConfigChanges

private void removedLocalConfigChanges()

Part of the Configuration.toProject(boolean) method. Removes all local configuration settings of the current project, before current configuration can be merged into the project.

processAssignment

private int processAssignment(Project confProject,
                              java.lang.StringBuilder errors,
                              AbstractVariable decl,
                              IDecisionVariable var,
                              Value value)

Processes an assignment.

Parameters:

confProject - the project to be modified as a side effect

errors - the errors collected so far

decl - the variable declaration

var - the configuration variable itself

value - the value assigned to decl

Returns:

the new value of code

deriveOperand

protected ConstraintSyntaxTree deriveOperand(AbstractVariable decl,
                                             IDecisionVariable var)

Derives the operand expression for turning a configuration into a project.

Parameters:

decl - the variable declaration to start at

var - the related decision variable

Returns:

the constraint syntax tree representing the operand for an assignment

toSaveableValue

protected Value toSaveableValue(IDecisionVariable var,
                                Value value)

This method escapes special characters for saving them into a file. Should only be called inside the processAssignment(Project, StringBuilder, AbstractVariable, IDecisionVariable, Value) method.

Parameters:

var - The variable which belongs to the corresponding value (as t holds the states, which are needed for filtering irrelevant values).

value - The value which should be saved.

Returns:

the value where all problematic characters are escaped.

checkState

private boolean checkState(IAssignmentState state)

Checks whether the sate (of a variable) should be saved.

Parameters:

state - The sate of the current variable to be saved.

Returns:

true if the sate should be saved, false otherwise.

saveFreezeStates

protected void saveFreezeStates(Project confProject)

Part of the Configuration.toProject(boolean) method. This method saves the frozen state of frozen variables.

Parameters:

confProject - The project where the states should be saved to.

See Also:

Configuration.toProject(boolean)

createFreezeBlock

protected FreezeBlock createFreezeBlock(IFreezable[] freezables,
                                        Project parent)

Creates a freeze block, allowing customization (factory method).

Parameters:

freezables - the freezables

parent - the parent of the freeze block

Returns:

the freeze block