Package net.ssehub.easy.varModel.cstEvaluation

Class CollectionElementVariable

java.lang.Object

net.ssehub.easy.varModel.model.ModelElement

net.ssehub.easy.varModel.model.ContainableModelElement

net.ssehub.easy.varModel.model.AbstractVariable

net.ssehub.easy.varModel.cstEvaluation.CollectionElementVariable

All Implemented Interfaces:

ICollectionElementVariable, IDatatypeVisitable, IDerivedDatatypeListener, IAttributeAccess, IModelElement

class CollectionElementVariable
extends AbstractVariable
implements ICollectionElementVariable

A temporary variable representing a value of a container. By design decision, container do not have contained decision variables. Anyway, references to container variables can be defined and are resolved via this temporary variable. For resolving this variable for a specific configuration, this class is equipped with a resolution path for deferred variable resolution.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractVariable	base
private int	index
private IResolutionPathElement	path

Constructor Summary

Constructors

Constructor	Description
CollectionElementVariable(AbstractVariable base, IDatatype type, IResolutionPathElement path, int index)	Creates a collection element variable.

Method Summary

Modifier and Type	Method	Description
void	accept(IModelVisitor visitor)	Accept method for the visitor.
Attribute	getAttribute(int index)	Returns a specific attribute.
Attribute	getAttribute(String name)	Returns a specific (declared) attribute.
int	getAttributesCount()	Returns the number of (declared) attributes.
AbstractVariable	getBaseVariable()	The base variable representing the collection.
int	getIndex()	The index of the element in the collection, i.e., the nested element.
boolean	isAttribute()	Returns whether this variable is an attribute.
boolean	isConstant()	Returns whether this variable is a constant.
boolean	isTemporaryVariable()	Returns whether this decision variable declaration is used as a temporary variable (in constraints, i.e.
IDecisionVariable	resolve(IConfiguration config)	Resolves the element variable to a decision variable.

Methods inherited from class net.ssehub.easy.varModel.model.AbstractVariable

constraintsChanged, equals, getDefaultValue, getType, hashCode, isSame, setValue, setValue, setValue

Methods inherited from class net.ssehub.easy.varModel.model.ContainableModelElement

accept, getNameSpace, getParent, getProject, getQualifiedName, getTopLevelParent, isTopLevel, setParent

Methods inherited from class net.ssehub.easy.varModel.model.ModelElement

findAttribute, getComment, getName, getUniqueName, isTransparent, propagateAttribute, setComment, setName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.ssehub.easy.varModel.model.IAttributeAccess

getParent

Field Details

base

private AbstractVariable base

index

private int index

path

private IResolutionPathElement path

Constructor Details

CollectionElementVariable

CollectionElementVariable(AbstractVariable base,
 IDatatype type,
 IResolutionPathElement path,
 int index)

Creates a collection element variable.

Parameters:

base - the base the collection variable

type - the contained type

path - the path to resolve base in a configuration

index - the index within base

Method Details

getAttributesCount

public int getAttributesCount()

Description copied from interface: IAttributeAccess

Returns the number of (declared) attributes.

Specified by:

getAttributesCount in interface IAttributeAccess

Returns:

the number of attributes

getAttribute

public Attribute getAttribute(String name)

Description copied from interface: IAttributeAccess

Returns a specific (declared) attribute.

Specified by:

getAttribute in interface IAttributeAccess

Parameters:

name - the name of the attribute

Returns:

the attribute (or null if not found)

getAttribute

public Attribute getAttribute(int index)

Description copied from interface: IAttributeAccess

Returns a specific attribute.

Specified by:

getAttribute in interface IAttributeAccess

Parameters:

index - the index of the attribute

Returns:

the attribute

accept

public void accept(IModelVisitor visitor)

Description copied from interface: IModelElement

Accept method for the visitor.

Specified by:

accept in interface IModelElement

Parameters:

visitor - The visitor, which should process this model element.

getIndex

public int getIndex()

Description copied from interface: ICollectionElementVariable

The index of the element in the collection, i.e., the nested element.

Specified by:

getIndex in interface ICollectionElementVariable

Returns:

the index

getBaseVariable

public AbstractVariable getBaseVariable()

Description copied from interface: ICollectionElementVariable

The base variable representing the collection.

Specified by:

getBaseVariable in interface ICollectionElementVariable

Returns:

the collection base variable

isTemporaryVariable

public boolean isTemporaryVariable()

Description copied from class: AbstractVariable

Returns whether this decision variable declaration is used as a temporary variable (in constraints, i.e. the parent is a constraint).

Specified by:

isTemporaryVariable in class AbstractVariable

Returns:

true if it is a temporary variable, false if it is a defined variable in the model

isAttribute

public boolean isAttribute()

Description copied from class: AbstractVariable

Returns whether this variable is an attribute.

Specified by:

isAttribute in class AbstractVariable

Returns:

true if it is an attribute, false else

resolve

public IDecisionVariable resolve(IConfiguration config)

Description copied from interface: ICollectionElementVariable

Resolves the element variable to a decision variable.

Specified by:

resolve in interface ICollectionElementVariable

Parameters:

config - the configuration to resolve on

Returns:

the resolved decision variable (may be null if not resolvable)

isConstant

public boolean isConstant()

Description copied from class: AbstractVariable

Returns whether this variable is a constant.

Specified by:

isConstant in class AbstractVariable

Returns:

true for constant, false else