Package net.ssehub.easy.varModel.cstEvaluation

Class VariableValueCopier

java.lang.Object

net.ssehub.easy.varModel.cstEvaluation.VariableValueCopier

public class VariableValueCopier
extends java.lang.Object

Copies specified variable values, i.e., single variables to a single variable or a compatible container or a container to a container. In case of a container as source, the first value will be copied. May create further variables in case of target reference types. Actually, this functionality might be done by a more generic VIL function, but for now a simpler (internal) implementation is sufficient.

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VariableValueCopier.CopySpec	Defines a copy specification.
static class	VariableValueCopier.EnumAttributeFreezeProvider	A default freeze provider for but-expressions based on attributes of type enum.
static interface	VariableValueCopier.IAssignmentListener	Optional listener interface to generically track primary value assignments.
static interface	VariableValueCopier.IFreezeProvider	An interface providing information to create freeze blocks for new variables.
private static class	VariableValueCopier.SourceBasedFreezeProvider	A freeze provider based on known frozen assignment states.

Field Summary

Fields

Modifier and Type	Field	Description
private int	count
private VariableValueCopier.IAssignmentListener	listener
private java.lang.String	namePrefix
private IAssignmentState	newState
private java.util.Map<IDatatype,java.util.Map<java.lang.String,VariableValueCopier.CopySpec>>	specs

Constructor Summary

Constructors

Constructor	Description
VariableValueCopier(java.lang.String namePrefix, IAssignmentState newState, VariableValueCopier.CopySpec... copySpecs)	Creates an instance with given assignment state.
VariableValueCopier(java.lang.String namePrefix, VariableValueCopier.CopySpec... copySpecs)	Creates an instance for copying with state AssignmentState.ASSIGNED.

Method Summary

Modifier and Type	Method	Description
(package private) static IDecisionVariable	copy(IDecisionVariable variable, java.lang.String namePrefix)	Copies the given variable.
private Value	copy(IDecisionVariable source, IDecisionVariable target, VariableValueCopier.IFreezeProvider freezeProvider)	Copies the value of source variable to target variable.
private Value	copySingleVariable(IDecisionVariable source, IDecisionVariable target, VariableValueCopier.IFreezeProvider freezeProvider, boolean adding)	Copies a single variable from source to target and ensures in case of a reference target that a respective variable is created.
static boolean	doCreateNewVars(java.lang.String namePrefix)	Whether new variables shall be created.
private void	doFreeze(VariableValueCopier.IFreezeProvider freezeProvider, Configuration cfg, IDecisionVariable var, IFreezable freezable)	Tries to freeze freezable.
private ContainerVariable	ensureContainerVariable(ContainerVariable target)	Ensures that the given container variable is configured and empty.
static IDecisionVariable	findVariable(IDecisionVariable base, java.lang.String qname)	Finds a variable via its (qualified access) name.
protected EASyLoggerFactory.EASyLogger	getLogger()	Returns the logger of this class.
private void	handleFurther(IDecisionVariable base, java.lang.String[] names, Value value)	Assigns value to the further variables on base given in names at index positions larger than 0.
private static Value	keepFirst(Value actual, Value newValue)	Keeps the first value of actual and newValue.
private void	notifyAssigned(IDecisionVariable target, Value value, boolean added)	Notifies about assigned values.
private void	notifyCreated(IDecisionVariable origin, IDecisionVariable target)	Notifies the listener about a new variable created for a given origin variable.
void	process(Configuration config)	Processes a configuration according to the copy specifications.
private void	process(IDecisionVariable variable, IDecisionVariable base, java.lang.String prefix, java.util.Map<java.lang.String,VariableValueCopier.CopySpec> fieldSpecs, java.util.Set<IDecisionVariable> done)	Processes a decision variable.
void	setAssignmentListener(VariableValueCopier.IAssignmentListener listener)	Defines the assignment listener.

Methods inherited from class java.lang.Object

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

Field Detail

specs

private java.util.Map<IDatatype,java.util.Map<java.lang.String,VariableValueCopier.CopySpec>> specs

namePrefix

private java.lang.String namePrefix

count

private int count

newState

private IAssignmentState newState

listener

private VariableValueCopier.IAssignmentListener listener

Constructor Detail

VariableValueCopier

public VariableValueCopier(java.lang.String namePrefix,
                           VariableValueCopier.CopySpec... copySpecs)

Creates an instance for copying with state AssignmentState.ASSIGNED.

Parameters:

namePrefix - the name prefix for new variables (no new variables will be created if null or empty).

copySpecs - the copy specifications to take into account, individual specs may be null but will be ignored then

VariableValueCopier

public VariableValueCopier(java.lang.String namePrefix,
                           IAssignmentState newState,
                           VariableValueCopier.CopySpec... copySpecs)

Creates an instance with given assignment state.

Parameters:

namePrefix - the name prefix for new variables (no new variables will be created if null or empty).

newState - the state to use (if null, AssignmentState.ASSIGNED is used)

copySpecs - the copy specifications to take into account

Method Detail

setAssignmentListener

public void setAssignmentListener(VariableValueCopier.IAssignmentListener listener)

Defines the assignment listener.

Parameters:

listener - the listener (may be null to disable notifications)

getLogger

protected EASyLoggerFactory.EASyLogger getLogger()

Returns the logger of this class.

Returns:

the logger

process

public void process(Configuration config)
             throws ConfigurationException,
                    ValueDoesNotMatchTypeException,
                    CSTSemanticException

Processes a configuration according to the copy specifications.

Parameters:

config - the configuration to process

Throws:

ConfigurationException - in case that the configuration is not possible

ValueDoesNotMatchTypeException - in case that value types do not match

CSTSemanticException - in case that expressions such as freeze-buts are not correctly constructed

process

private void process(IDecisionVariable variable,
                     IDecisionVariable base,
                     java.lang.String prefix,
                     java.util.Map<java.lang.String,VariableValueCopier.CopySpec> fieldSpecs,
                     java.util.Set<IDecisionVariable> done)
              throws ConfigurationException,
                     ValueDoesNotMatchTypeException,
                     CSTSemanticException

Processes a decision variable.

Parameters:

variable - the variable to process

base - the base variable where processing initially started

prefix - the prefix access name processed so far

fieldSpecs - the field specifications for base

done - already processed variables - avoiding cycles

Throws:

ConfigurationException - in case that the configuration is not possible

ValueDoesNotMatchTypeException - in case that value types do not match

CSTSemanticException - in case that expressions such as freeze-buts are not correctly constructed

handleFurther

private void handleFurther(IDecisionVariable base,
                           java.lang.String[] names,
                           Value value)
                    throws ConfigurationException

Assigns value to the further variables on base given in names at index positions larger than 0.

Parameters:

base - the base variable

names - the further variable names to initialize

value - the value to use for initialization

Throws:

ConfigurationException - in case that the configuration is not possible

findVariable

public static IDecisionVariable findVariable(IDecisionVariable base,
                                             java.lang.String qname)

Finds a variable via its (qualified access) name.

Parameters:

base - the base variable to search on

qname - the variable name to search for

Returns:

the resulting variable or null if there is none

copy

private Value copy(IDecisionVariable source,
                   IDecisionVariable target,
                   VariableValueCopier.IFreezeProvider freezeProvider)
            throws ConfigurationException,
                   ValueDoesNotMatchTypeException,
                   CSTSemanticException

Copies the value of source variable to target variable.

Parameters:

source - the source variable to copy from

target - the target variable to copy to

freezeProvider - optional freeze provider to be applied to new variables (may be null for no freezing)

Returns:

the first value set (may be null)

Throws:

ConfigurationException - in case that the configuration is not possible

ValueDoesNotMatchTypeException - in case that value types do not match

CSTSemanticException - in case that expressions such as freeze-buts are not correctly constructed

keepFirst

private static Value keepFirst(Value actual,
                               Value newValue)

Keeps the first value of actual and newValue.

Parameters:

actual - the actual value

newValue - the new value

Returns:

actual if actual was previously null, newValue else

ensureContainerVariable

private ContainerVariable ensureContainerVariable(ContainerVariable target)
                                           throws ConfigurationException,
                                                  ValueDoesNotMatchTypeException

Ensures that the given container variable is configured and empty.

Parameters:

target - the variable

Returns:

target

Throws:

ConfigurationException - in case that the configuration is not possible

ValueDoesNotMatchTypeException - in case that value types do not match

doCreateNewVars

public static boolean doCreateNewVars(java.lang.String namePrefix)

Whether new variables shall be created.

Parameters:

namePrefix - the name prefix

Returns:

true for new variables, false else

copySingleVariable

private Value copySingleVariable(IDecisionVariable source,
                                 IDecisionVariable target,
                                 VariableValueCopier.IFreezeProvider freezeProvider,
                                 boolean adding)
                          throws ConfigurationException,
                                 ValueDoesNotMatchTypeException,
                                 CSTSemanticException

Copies a single variable from source to target and ensures in case of a reference target that a respective variable is created.

Parameters:

source - the source variable

target - the target variable (may be a nested variable, e.g., of a collection)

freezeProvider - optional freeze provider to be applied to new variables (may be null for no freezing)

adding - whether the value is being added to a collection or just set

Returns:

the actual value set

Throws:

ConfigurationException - in case that the configuration is not possible

ValueDoesNotMatchTypeException - in case that value types do not match

CSTSemanticException - in case that expressions such as freeze-buts are not correctly constructed

doFreeze

private void doFreeze(VariableValueCopier.IFreezeProvider freezeProvider,
                      Configuration cfg,
                      IDecisionVariable var,
                      IFreezable freezable)
               throws ValueDoesNotMatchTypeException,
                      CSTSemanticException

Tries to freeze freezable.

Parameters:

freezeProvider - the freeze provider (may be null, ignored then)

cfg - the configuration to freeze on

var - the variable to freeze

freezable - the freezeable (the declaration of var, used for constructing a temporary freeze block of no direct freeze selector is available

Throws:

ValueDoesNotMatchTypeException - in case that value types do not match

CSTSemanticException - in case that expressions such as freeze-buts are not correctly constructed

notifyAssigned

private void notifyAssigned(IDecisionVariable target,
                            Value value,
                            boolean added)

Notifies about assigned values.

Parameters:

target - the target variable

value - the new value

added - whether value is being added to a collection or set as the single absolute value

notifyCreated

private void notifyCreated(IDecisionVariable origin,
                           IDecisionVariable target)

Notifies the listener about a new variable created for a given origin variable. A notifyAssigned(IDecisionVariable, Value, boolean) shall follow.

Parameters:

origin - the origin variable

target - the new variable

copy

static IDecisionVariable copy(IDecisionVariable variable,
                              java.lang.String namePrefix)
                       throws CSTSemanticException,
                              ValueDoesNotMatchTypeException,
                              ConfigurationException

Copies the given variable.

Parameters:

variable - the variable to copy

namePrefix - the name prefix for new variables.

Returns:

the created (local, temporary) variable including value; further variables may have been created

Throws:

ConfigurationException - in case that the configuration is not possible

ValueDoesNotMatchTypeException - in case that value types do not match

CSTSemanticException - in case that expressions are not correctly constructed