Package net.ssehub.easy.varModel.cstEvaluation

Class VariableValueCopier.EnumAttributeFreezeProvider

java.lang.Object

net.ssehub.easy.varModel.cstEvaluation.VariableValueCopier.EnumAttributeFreezeProvider

All Implemented Interfaces:

VariableValueCopier.IFreezeProvider

Enclosing class:

VariableValueCopier

public static class VariableValueCopier.EnumAttributeFreezeProvider
extends Object
implements VariableValueCopier.IFreezeProvider

A default freeze provider for but-expressions based on attributes of type enum.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private Attribute	annotation
private EnumLiteral	literal
private String	name
private String	operation

Constructor Summary

Constructors

Constructor	Description
EnumAttributeFreezeProvider(String name, Attribute annotation, String operation, EnumLiteral literal)	Creates a but-freeze provider for expressions of the form name | name.annotation operation literal
EnumAttributeFreezeProvider(String name, Attribute annotation, EnumLiteral literal)	Creates a but-freeze provider for expressions of the form name | name.annotation == literal

Method Summary

Modifier and Type	Method	Description
ConstraintSyntaxTree	createButExpression(DecisionVariableDeclaration freezeIter)	Creates the freeze-but expression.
private Attribute	findAttribute(Project prj, String name, Set<Project> done)	Finds a declaration for the attribute name in prj or it's imports.
String	getFreezeVariableName()	The name of the freeze variable.
IFreezeSelector	getSelector()	Returns a freeze selector to use.

Methods inherited from class java.lang.Object

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

Field Details

name

private String name

operation

private String operation

annotation

private Attribute annotation

literal

private EnumLiteral literal

Constructor Details

EnumAttributeFreezeProvider

public EnumAttributeFreezeProvider(String name,
 Attribute annotation,
 EnumLiteral literal)

Creates a but-freeze provider for expressions of the form name | name.annotation == literal

Parameters:

name - the name of the freeze variable

annotation - the annotation on name (providing annotation name and type)

literal - the literal to test for

EnumAttributeFreezeProvider

public EnumAttributeFreezeProvider(String name,
 Attribute annotation,
 String operation,
 EnumLiteral literal)

Creates a but-freeze provider for expressions of the form name | name.annotation operation literal

Parameters:

name - the name of the freeze variable

annotation - the annotation on name (providing annotation name and type)

operation - the operation to be applied

literal - the literal to test for

Method Details

getFreezeVariableName

public String getFreezeVariableName()

Description copied from interface: VariableValueCopier.IFreezeProvider

The name of the freeze variable.

Specified by:

getFreezeVariableName in interface VariableValueCopier.IFreezeProvider

Returns:

the name

findAttribute

private Attribute findAttribute(Project prj,
 String name,
 Set<Project> done)

Finds a declaration for the attribute name in prj or it's imports.

Parameters:

prj - the project to search for

name - the name of the attribute

done - the already processed projects (cycle detection)

Returns:

the found attribute (may be null)

createButExpression

public ConstraintSyntaxTree createButExpression(DecisionVariableDeclaration freezeIter)
                                         throws CSTSemanticException,
ValueDoesNotMatchTypeException

Description copied from interface: VariableValueCopier.IFreezeProvider

Creates the freeze-but expression.

Specified by:

createButExpression in interface VariableValueCopier.IFreezeProvider

Parameters:

freezeIter - the freeze iterator variable (of type FreezeVariableType)

Returns:

the but-expression

Throws:

CSTSemanticException - in case that the but-expression was not constructed correctly

ValueDoesNotMatchTypeException - in case that creating values fails

getSelector

public IFreezeSelector getSelector()

Description copied from interface: VariableValueCopier.IFreezeProvider

Returns a freeze selector to use.

Specified by:

getSelector in interface VariableValueCopier.IFreezeProvider

Returns:

the selector or null for none, i.e., create an internal freeze-block based on the information in this provider