Package net.ssehub.easy.varModel.model

Class BasicDecisionVariableContainer

java.lang.Object

net.ssehub.easy.varModel.model.ModelElement

net.ssehub.easy.varModel.model.BasicDecisionVariableContainer

All Implemented Interfaces:

IContainableElementsSorter, IDecisionVariableContainer, IModelElement

Direct Known Subclasses:

FullDecisionVariableContainer

public class BasicDecisionVariableContainer
extends ModelElement
implements IDecisionVariableContainer

This class basically realizes a decision variable container (this class does not support realizing constraints). However, this type of class (regarding the interface) may be used from a data type as well as from a containable model element in two different parts of the same inheritance hierarchy. This would duplicate code. As multiple inheritance is not supported in Java, we implement the basic functionality here and support reuse by delegation. So far we refrained from defining (multiple) recursive iterators (over the assignments) due to different style and potential performance issues of the generic code.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private List<DecisionVariableDeclaration>	allDeclarations	This includes all DecisionVariableDeclaration, including nested DecisionVariableDeclarations of attribute assignments.
private List<AttributeAssignment>	assignments
private List<Constraint>	constraints
private List<DecisionVariableDeclaration>	elements
private List<ContainableModelElement>	modelElements
private Set<String>	names

Constructor Summary

Constructors

Constructor	Description
BasicDecisionVariableContainer()	Creates a container instance.

Method Summary

Modifier and Type	Method	Description
void	accept(IModelVisitor visitor)	Accept method for the visitor.
void	add(AttributeAssignment assignment)	Adds a nested assignment.
void	add(Comment comment)	Adds a comment to the list of contained elements.
boolean	add(DecisionVariableDeclaration elem)	Method to add an object to the elements list of the project.
void	add(EvaluationBlock eval)	adds a nested evaluation block.
void	addConstraint(Constraint constraint, boolean internal)	Adds a constraint.
boolean	contains(DecisionVariableDeclaration var)	Returns whether this element contains var.
boolean	containsByName(String name)	Returns whether this project contains an element and its name.
void	forceUpdate()	Forces the IDecisionVariableContainer to update cached lists of nested DecisionVariableDeclarations.
AttributeAssignment	getAssignment(int index)	Returns the assignment specified by index.
int	getAssignmentCount()	Returns the number of assignments.
Constraint	getConstraint(int index)	Returns the specified contained constraint.
int	getConstraintsCount()	Returns the number of contained constraints.
DecisionVariableDeclaration	getDeclaration(int index)	Returns the specified DecisionVariableDeclaration.
int	getDeclarationCount()	Returns the number of all nested DecisionVariableDeclarations including nested DecisionVariableDeclarations of AttributeAssignments.
DecisionVariableDeclaration	getElement(int index)	Returns the element specified by index.
DecisionVariableDeclaration	getElement(String name)	Returns the element specified by name.
int	getElementCount()	Returns the number of elements.
ContainableModelElement	getModelElement(int index)	Returns a contained model element specified by index.
int	getModelElementCount()	Returns the number of contained elements.
Constraint	getRealizing(int index)	Returns the specified realizing constraint.
int	getRealizingCount()	Returns the number of realizing constraints.
boolean	propagateAttribute(Attribute attribute)	Propagates an attribute application from the parent to this element or contained elements.
boolean	removeModelElement(ContainableModelElement element)	Removes the specified model element from this container (if it exists).
void	sortContainedElements(Comparator<ContainableModelElement> comp)	Sorts the contained elements (and creates the related datastructure if needed) according to the specified comparator.
String	toString()

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

findAttribute, getComment, getName, getNameSpace, getParent, getQualifiedName, getUniqueName, isTransparent, setComment, setName

Methods inherited from class java.lang.Object

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

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

getComment, getName, getNameSpace, getParent, getQualifiedName, getUniqueName, isTransparent, setComment

Field Details

elements

private List<DecisionVariableDeclaration> elements

constraints

private List<Constraint> constraints

assignments

private List<AttributeAssignment> assignments

modelElements

private List<ContainableModelElement> modelElements

names

private Set<String> names

allDeclarations

private List<DecisionVariableDeclaration> allDeclarations

This includes all DecisionVariableDeclaration, including nested DecisionVariableDeclarations of attribute assignments. This list will only be generated on demand, i.e. if getDeclarationCount() is called.

Constructor Details

BasicDecisionVariableContainer

public BasicDecisionVariableContainer()

Creates a container instance.

Method Details

sortContainedElements

public void sortContainedElements(Comparator<ContainableModelElement> comp)

Description copied from interface: IContainableElementsSorter

Sorts the contained elements (and creates the related datastructure if needed) according to the specified comparator. Please note the following requirements for applying this method:

• All Elements which were added before this operation must still be member of this project after executing this operation.
• Comments related to an element must occur before the element in the final sequence.

Specified by:

sortContainedElements in interface IContainableElementsSorter

Parameters:

comp - a comparator which fulfills the requirements above

add

public void add(AttributeAssignment assignment)

Description copied from interface: IDecisionVariableContainer

Adds a nested assignment.

Specified by:

add in interface IDecisionVariableContainer

Parameters:

assignment - the assignment which should be added

forceUpdate

public void forceUpdate()

Description copied from interface: IDecisionVariableContainer

Forces the IDecisionVariableContainer to update cached lists of nested DecisionVariableDeclarations. This is only necessary if multiple IDecisionVariableContainer are nested into each other and only during incremental build up if an inner element is updated while already added to the outer element.

Specified by:

forceUpdate in interface IDecisionVariableContainer

add

public void add(EvaluationBlock eval)

adds a nested evaluation block.

Specified by:

add in interface IDecisionVariableContainer

Parameters:

eval - the eval block

getAssignmentCount

public int getAssignmentCount()

Description copied from interface: IDecisionVariableContainer

Returns the number of assignments.

Specified by:

getAssignmentCount in interface IDecisionVariableContainer

Returns:

the number of assignments

getAssignment

public AttributeAssignment getAssignment(int index)

Description copied from interface: IDecisionVariableContainer

Returns the assignment specified by index.

Specified by:

getAssignment in interface IDecisionVariableContainer

Parameters:

index - a 0-based index specifying the element to be returned

Returns:

the assignment

getModelElement

public ContainableModelElement getModelElement(int index)

Description copied from interface: IDecisionVariableContainer

Returns a contained model element specified by index. Please note that this method returns all contained model elements, i.e., decision variables and constraints and is intended to restore the input sequence correctly.

Specified by:

getModelElement in interface IDecisionVariableContainer

Parameters:

index - a 0-based index specifying the operation to be returned

Returns:

the contained element

getModelElementCount

public int getModelElementCount()

Returns the number of contained elements. Please note that this method refers to all contained model elements, i.e., decision variables and constraints and is intended to restore the input sequence correctly.

Specified by:

getModelElementCount in interface IDecisionVariableContainer

Returns:

the number of contained elements

getElement

public DecisionVariableDeclaration getElement(String name)

Description copied from interface: IDecisionVariableContainer

Returns the element specified by name.

Specified by:

getElement in interface IDecisionVariableContainer

Parameters:

name - the name of the element

Returns:

the element, null if none was found

contains

public boolean contains(DecisionVariableDeclaration var)

Description copied from interface: IDecisionVariableContainer

Returns whether this element contains var.

Specified by:

contains in interface IDecisionVariableContainer

Parameters:

var - the variable declaration to search for

Returns:

true if found, false else

containsByName

public boolean containsByName(String name)

Returns whether this project contains an element and its name.

Specified by:

containsByName in interface IDecisionVariableContainer

Parameters:

name - the name to search for

Returns:

true if this project contains the specified element, false else

add

public void add(Comment comment)

Description copied from interface: IDecisionVariableContainer

Adds a comment to the list of contained elements.

Specified by:

add in interface IDecisionVariableContainer

Parameters:

comment - the comment to be added

getElementCount

public int getElementCount()

Description copied from interface: IDecisionVariableContainer

Returns the number of elements.

Specified by:

getElementCount in interface IDecisionVariableContainer

Returns:

the number of elements

getElement

public DecisionVariableDeclaration getElement(int index)

Description copied from interface: IDecisionVariableContainer

Returns the element specified by index.

Specified by:

getElement in interface IDecisionVariableContainer

Parameters:

index - a 0-based index specifying the element to be returned

Returns:

the element

add

public boolean add(DecisionVariableDeclaration elem)

Description copied from interface: IDecisionVariableContainer

Method to add an object to the elements list of the project.

Specified by:

add in interface IDecisionVariableContainer

Parameters:

elem - which should be added

Returns:

true if the addition was successful, false else due to duplicated variable declaration

getConstraintsCount

public int getConstraintsCount()

Description copied from interface: IDecisionVariableContainer

Returns the number of contained constraints.

Specified by:

getConstraintsCount in interface IDecisionVariableContainer

Returns:

the number of constraints

getConstraint

public Constraint getConstraint(int index)

Description copied from interface: IDecisionVariableContainer

Returns the specified contained constraint.

Specified by:

getConstraint in interface IDecisionVariableContainer

Parameters:

index - the index of the constraint to be returned

Returns:

the specified constraint

addConstraint

public void addConstraint(Constraint constraint,
 boolean internal)

Description copied from interface: IDecisionVariableContainer

Adds a constraint.

Specified by:

addConstraint in interface IDecisionVariableContainer

Parameters:

constraint - the constraint to be added

internal - whether the constraint is internally created while building up the model (ignored)

getRealizingCount

public int getRealizingCount()

Description copied from interface: IDecisionVariableContainer

Returns the number of realizing constraints. Please note that these constraints are derived and not originally specified in the input IVML model.

Specified by:

getRealizingCount in interface IDecisionVariableContainer

Returns:

the number of constraints

getRealizing

public Constraint getRealizing(int index)

Description copied from interface: IDecisionVariableContainer

Returns the specified realizing constraint. Please note that these constraints are derived and not originally specified in the input IVML model.

Specified by:

getRealizing in interface IDecisionVariableContainer

Parameters:

index - the index of the constraint to be returned

Returns:

the specified constraint

propagateAttribute

public boolean propagateAttribute(Attribute attribute)

Description copied from interface: IModelElement

Propagates an attribute application from the parent to this element or contained elements. This may imply the creation of clones of the given attribute.

Specified by:

propagateAttribute in interface IModelElement

Overrides:

propagateAttribute in class ModelElement

Parameters:

attribute - the attribute to be propagated

Returns:

true if the operation was successful, false if the element is about being attributed multiple times with the same 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.

getDeclarationCount

public int getDeclarationCount()

Description copied from interface: IDecisionVariableContainer

Returns the number of all nested DecisionVariableDeclarations including nested DecisionVariableDeclarations of AttributeAssignments.

Specified by:

getDeclarationCount in interface IDecisionVariableContainer

Returns:

The number of all nested DecisionVariableDeclarations. This will be greater or equal to 0.

getDeclaration

public DecisionVariableDeclaration getDeclaration(int index)

Description copied from interface: IDecisionVariableContainer

Returns the specified DecisionVariableDeclaration.

Specified by:

getDeclaration in interface IDecisionVariableContainer

Parameters:

index - the index of the DecisionVariableDeclaration to be returned

Returns:

the specified DecisionVariableDeclaration

removeModelElement

public boolean removeModelElement(ContainableModelElement element)

Removes the specified model element from this container (if it exists).

Parameters:

element - The Constraint, DecisionVariableDeclaration, or AttributeAssignment to remove. If null nothing will happen.

Returns:

true if the model element was part of this container and was removed successfully.

toString

public String toString()

Overrides:

toString in class ModelElement