Package net.ssehub.easy.integration.common.impl

Class DecisionVariable

java.lang.Object

net.ssehub.easy.integration.common.impl.DecisionVariable

All Implemented Interfaces:

IDecisionVariable, IModelElement

public class DecisionVariable
extends java.lang.Object
implements IDecisionVariable

Implements a decision variable (delegate).

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	ATTRIBUTE_NAME_BINDING_TIME
private EnumLiteral	bindingTime
private IDecisionVariable	value
private DecisionVariableDeclaration	variable

Constructor Summary

Constructors

Constructor	Description
DecisionVariable(java.lang.String name, IDatatype type, java.lang.String defaultValue, Project parent)	Creates a new decision variable.
DecisionVariable(DecisionVariableDeclaration variable, IDecisionVariable value)	Creates a decision variable.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBindingTime()	Returns the binding time of the variable.
(package private) Attribute	getBindingTimeAttribute()	Returns the binding time attribute if there is any.
java.lang.String	getDefaultValue()	Returns the default value of the variable as specified as part of the variable declaration in the underlying IVML model.
DecisionVariableDeclaration	getInstance()	Returns the corresponding IVML model instance.
java.lang.String	getName()	Returns the name of the variable.
java.lang.String	getType()	Returns the type of the variable.
java.lang.String	getValue()	Returns the configured value for this variable.
boolean	hasFrozenValue()	Returns whether the this variable has been configured and is frozen.
boolean	hasValue()	Returns whether there this variable has been configured with a value.
void	setBindingTime(Enum bindingTimes, EnumLiteral bindingTime)	Changes the binding time.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_NAME_BINDING_TIME

private static final java.lang.String ATTRIBUTE_NAME_BINDING_TIME

See Also:

Constant Field Values

variable

private DecisionVariableDeclaration variable

value

private IDecisionVariable value

bindingTime

private EnumLiteral bindingTime

Constructor Detail

DecisionVariable

DecisionVariable(DecisionVariableDeclaration variable,
                 IDecisionVariable value)

Creates a decision variable.

Parameters:

variable - the IVML variable

value - the related decision variable

DecisionVariable

public DecisionVariable(java.lang.String name,
                        IDatatype type,
                        java.lang.String defaultValue,
                        Project parent)
                 throws ModelException

Creates a new decision variable.

Parameters:

name - the name of the variable

type - the type of the variable

defaultValue - the default value (may be null)

parent - the parent of the variable, i.e. the project

Throws:

ModelException - in case that the given value does not match to type

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IDecisionVariable

Returns the name of the variable.

Specified by:

getName in interface IDecisionVariable

Returns:

the name of the variable

getType

public java.lang.String getType()

Description copied from interface: IDecisionVariable

Returns the type of the variable.

Specified by:

getType in interface IDecisionVariable

Returns:

the type of the variable, possibly adjusted by the model after adding this variable if the model supports fault-tolerance

getBindingTime

public java.lang.String getBindingTime()

Description copied from interface: IDecisionVariable

Returns the binding time of the variable.

Specified by:

getBindingTime in interface IDecisionVariable

Returns:

the binding time, may be null if none is defined

getDefaultValue

public java.lang.String getDefaultValue()

Description copied from interface: IDecisionVariable

Returns the default value of the variable as specified as part of the variable declaration in the underlying IVML model. For obtaining the actual value in a configuration, please refer to IDecisionVariable.getValue().

Specified by:

getDefaultValue in interface IDecisionVariable

Returns:

the default value, may be null if none is defined, possibly adjusted by the model after adding this variable if the model supports fault-tolerance

getValue

public java.lang.String getValue()

Description copied from interface: IDecisionVariable

Returns the configured value for this variable. Please consider IDecisionVariable.hasValue() and IDecisionVariable.hasFrozenValue() in order to judge the return value correctly.

Specified by:

getValue in interface IDecisionVariable

Returns:

the configured value for this variable, may be null if the actual value is null or if the variable has not been configured (see IDecisionVariable.hasValue())

hasValue

public boolean hasValue()

Description copied from interface: IDecisionVariable

Returns whether there this variable has been configured with a value.

Specified by:

hasValue in interface IDecisionVariable

Returns:

true if variable has been configured, false else

hasFrozenValue

public boolean hasFrozenValue()

Description copied from interface: IDecisionVariable

Returns whether the this variable has been configured and is frozen.

Specified by:

hasFrozenValue in interface IDecisionVariable

Returns:

true if the configured value is frozen, false else

setBindingTime

public void setBindingTime(Enum bindingTimes,
                           EnumLiteral bindingTime)
                    throws ModelException

Changes the binding time.

Parameters:

bindingTimes - the binding times enum

bindingTime - the new binding time

Throws:

ModelException - in case that the value cannot be set

getBindingTimeAttribute

Attribute getBindingTimeAttribute()

Returns the binding time attribute if there is any.

Returns:

the binding times attribute

getInstance

public DecisionVariableDeclaration getInstance()

Returns the corresponding IVML model instance.

Returns:

the corresponding model instance