Package net.ssehub.easy.varModel.model.filter

Class ModelElementTypeFinder

java.lang.Object

net.ssehub.easy.varModel.model.AbstractProjectVisitor

net.ssehub.easy.varModel.model.filter.ModelElementTypeFinder

All Implemented Interfaces:

ICustomDatatypeVisitor, IModelVisitor

public class ModelElementTypeFinder
extends AbstractProjectVisitor

This class provides a visitor for providing a ModelElementTypeFinder.ModelElementDescription of a model element in a specific Project. The search for the desired model element only requires the name of that element and the Project the element is located in.

Author:

kroeher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModelElementTypeFinder.ClassType	Type descriptions.
class	ModelElementTypeFinder.ModelElementDescription	This inner class is used as return type of the outer ModelElementTypeFinder that stores the relevant information (name, type, and class) of the model element found in a Project.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	COMPOUND_TYPE
private static final String	DECISION_VARIABLE_TYPE	Constant strings that are used to map ModelElementTypeFinder.ClassTypes to a textual representation.
private ModelElementTypeFinder.ModelElementDescription	elementTypeDescription	Stores the description of the the model element found in a given Project.
private static final String	ENUM_TYPE
private static final String	MAPPING_TYPE
private String	searchElementName	Stores the name of the model element for which the ModelElementTypeFinder.ModelElementDescription should be found.
private Project	targetProject	Stores the Project in which the model element is located.

Constructor Summary

Constructors

Constructor	Description
ModelElementTypeFinder(Project originProject, FilterType filterType)	Constructs a new ModelElementTypeFinder.

Method Summary

Modifier and Type	Method	Description
private ModelElementTypeFinder.ClassType	getClassTypeFromFreezable(IFreezable freezable)	Returns the ModelElementTypeFinder.ClassType the given IFreezable is an instance of.
ModelElementTypeFinder.ModelElementDescription	getDatatypeByElementName(String elementName)	Returns a ModelElementTypeFinder.ModelElementDescription of the model element specified by the given element name.
static String	toString(ModelElementTypeFinder.ClassType type)	Returns the textual representation of a ModelElementTypeFinder.ClassType.
void	visitAttribute(Attribute attribute)	Method for visiting an attribute.
void	visitAttributeAssignment(AttributeAssignment assignment)	Visits an attribute assignment.
void	visitComment(Comment comment)	Method for visiting a comment.
void	visitCompound(Compound compound)	Method for visiting a compound.
void	visitCompoundAccessStatement(CompoundAccessStatement access)	Visits a compound access statement (may occur in freeze blocks.
void	visitConstraint(Constraint constraint)	Method for visiting a constraint.
void	visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)	This method is used for visiting a decision variable declaration.
void	visitDerivedDatatype(DerivedDatatype datatype)	Method for visiting a derived datatype.
void	visitEnum(Enum eenum)	Method for visiting an enum.
void	visitEnumLiteral(EnumLiteral literal)	Method for visiting an enum literal.
void	visitFreezeBlock(FreezeBlock freeze)	Method for visiting a freeze block.
void	visitOperationDefinition(OperationDefinition opdef)	Method for visiting an operation definition.
void	visitOrderedEnum(OrderedEnum eenum)	Method for visiting an ordered enum.
void	visitPartialEvaluationBlock(PartialEvaluationBlock block)	Method for visiting a partial evaluation block.
void	visitProjectInterface(ProjectInterface iface)	Method for visiting a project interface.
void	visitReference(Reference reference)	Method for visiting a reference.
void	visitSequence(Sequence sequence)	Method for visiting a sequence.
void	visitSet(Set set)	Method for visiting a set.

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

clear, getFilterType, getStartingProject, visitProject, visitProjectImport

Methods inherited from class java.lang.Object

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

Field Details

DECISION_VARIABLE_TYPE

private static final String DECISION_VARIABLE_TYPE

Constant strings that are used to map ModelElementTypeFinder.ClassTypes to a textual representation.

See Also:

• Constant Field Values

ENUM_TYPE

private static final String ENUM_TYPE

See Also:

• Constant Field Values

COMPOUND_TYPE

private static final String COMPOUND_TYPE

See Also:

• Constant Field Values

MAPPING_TYPE

private static final String MAPPING_TYPE

See Also:

• Constant Field Values

elementTypeDescription

private ModelElementTypeFinder.ModelElementDescription elementTypeDescription

Stores the description of the the model element found in a given Project.

targetProject

private Project targetProject

Stores the Project in which the model element is located.

searchElementName

private String searchElementName

Stores the name of the model element for which the ModelElementTypeFinder.ModelElementDescription should be found.

Constructor Details

ModelElementTypeFinder

public ModelElementTypeFinder(Project originProject,
 FilterType filterType)

Constructs a new ModelElementTypeFinder.

Parameters:

originProject - the Project in which the model element is located

filterType - specifies whether project imports shall be considered or not using a FilterType

Method Details

getDatatypeByElementName

public ModelElementTypeFinder.ModelElementDescription getDatatypeByElementName(String elementName)

Returns a ModelElementTypeFinder.ModelElementDescription of the model element specified by the given element name.

Parameters:

elementName - the name of the model element as a String for which the description should be created

Returns:

the ModelElementTypeFinder.ModelElementDescription. May return null if the given model element name is empty, the Project does not exist, or the element could not be found.

visitDecisionVariableDeclaration

public void visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)

Description copied from interface: IModelVisitor

This method is used for visiting a decision variable declaration.

Parameters:

decl - One declaration which should be visited.

visitAttribute

public void visitAttribute(Attribute attribute)

Description copied from interface: IModelVisitor

Method for visiting an attribute.

Parameters:

attribute - The attribute which should be visited.

visitConstraint

public void visitConstraint(Constraint constraint)

Description copied from interface: IModelVisitor

Method for visiting a constraint.

Parameters:

constraint - The constraint which should be visited.

visitFreezeBlock

public void visitFreezeBlock(FreezeBlock freeze)

Description copied from interface: IModelVisitor

Method for visiting a freeze block.

Parameters:

freeze - The freeze block which should be visited.

getClassTypeFromFreezable

private ModelElementTypeFinder.ClassType getClassTypeFromFreezable(IFreezable freezable)

Returns the ModelElementTypeFinder.ClassType the given IFreezable is an instance of.

Parameters:

freezable - the IFreezable for which the actual ModelElementTypeFinder.ClassType should be determined

Returns:

the ModelElementTypeFinder.ClassType the given IFreezable is an instance of or null if there is no ModelElementTypeFinder.ClassType for the actual type of the IFreezable defined.

visitOperationDefinition

public void visitOperationDefinition(OperationDefinition opdef)

Description copied from interface: IModelVisitor

Method for visiting an operation definition.

Parameters:

opdef - The operation definition which should be visited.

visitPartialEvaluationBlock

public void visitPartialEvaluationBlock(PartialEvaluationBlock block)

Description copied from interface: IModelVisitor

Method for visiting a partial evaluation block.

Parameters:

block - The partial evaluation block which should be visited.

visitProjectInterface

public void visitProjectInterface(ProjectInterface iface)

Description copied from interface: IModelVisitor

Method for visiting a project interface.

Parameters:

iface - The interface which should be visited.

visitComment

public void visitComment(Comment comment)

Description copied from interface: IModelVisitor

Method for visiting a comment.

Parameters:

comment - the comment to visit

visitAttributeAssignment

public void visitAttributeAssignment(AttributeAssignment assignment)

Description copied from interface: IModelVisitor

Visits an attribute assignment.

Parameters:

assignment - the assignment to visit

visitCompoundAccessStatement

public void visitCompoundAccessStatement(CompoundAccessStatement access)

Description copied from interface: IModelVisitor

Visits a compound access statement (may occur in freeze blocks.

Parameters:

access - the access statement

visitEnum

public void visitEnum(Enum eenum)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an enum.

Parameters:

eenum - The enum which should be visited.

visitOrderedEnum

public void visitOrderedEnum(OrderedEnum eenum)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an ordered enum.

Parameters:

eenum - The enum which should be visited.

visitCompound

public void visitCompound(Compound compound)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a compound.

Parameters:

compound - The compound which should be visited.

visitDerivedDatatype

public void visitDerivedDatatype(DerivedDatatype datatype)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a derived datatype.

Parameters:

datatype - The datatype which should be visited.

visitEnumLiteral

public void visitEnumLiteral(EnumLiteral literal)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an enum literal.

Parameters:

literal - The literal which should be visited.

visitReference

public void visitReference(Reference reference)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a reference.

Parameters:

reference - The reference which should be visited.

visitSequence

public void visitSequence(Sequence sequence)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a sequence.

Parameters:

sequence - The sequence which should be visited.

visitSet

public void visitSet(Set set)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a set.

Parameters:

set - The set which should be visited.

toString

public static String toString(ModelElementTypeFinder.ClassType type)

Returns the textual representation of a ModelElementTypeFinder.ClassType.

Parameters:

type - the ModelElementTypeFinder.ClassType to be turned into a String

Returns:

the textual representation of the given ModelElementTypeFinder.ClassType. May return an empty String if the given ModelElementTypeFinder.ClassType cannot be resolved.