Package net.ssehub.easy.varModel.validation

Class IvmlValidationVisitor

java.lang.Object

net.ssehub.easy.varModel.model.AbstractVisitor

net.ssehub.easy.varModel.validation.IvmlValidationVisitor

All Implemented Interfaces:

IConstraintTreeVisitor, ICustomDatatypeVisitor, IModelVisitor, IValueVisitor

public class IvmlValidationVisitor
extends AbstractVisitor
implements IValueVisitor, IConstraintTreeVisitor

Checks a model for IVML compliance. This visitor is currently not complete!

Author:

Holger Eichelberger, El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<IDatatype>	customTypes
private java.util.Stack<java.lang.String>	location
private java.util.List<ValidationMessage>	messages

Constructor Summary

Constructors

Constructor	Description
IvmlValidationVisitor()

Method Summary

Modifier and Type	Method	Description
private void	addElementIsNullError(java.lang.String elementName, int pos, java.lang.Object cause)	Adds an error because the given element is null.
private void	addError(java.lang.String text, java.lang.Object cause, int code)	Adds an error and appends the current location if possible.
private void	checkComment(java.lang.String text, boolean allowNull, java.lang.Object cause)	Checks a comment.
private void	checkDeclaration(AbstractVariable decl)	Check whether the IDatatype of an AbstractVariable is part of the Project.
private boolean	checkExpression(ConstraintSyntaxTree expression, java.lang.String info, java.lang.Object cause)	Checks for a valid (sub-)expression.
private void	checkIdentifier(java.lang.String identifier, java.lang.String info, java.lang.Object cause, boolean allowWildcard)	Checks for a valid identifier and stores an error message if required.
private void	checkNameIdentifier(java.lang.String identifier, java.lang.Object cause)	Checks for a valid (name) identifier and stores an error message if required.
private void	checkParent(IModelElement parent, java.lang.Object cause, IModelElement expectedParent)	Checks for a valid parent (reference).
private void	checkParent(IModelElement element, IModelElement expectedParent)	Checks for a valid parent (reference).
private void	checkType(IDatatype type, java.lang.Object cause)	Checks for a valid datatype.
int	getErrorCount()	Returns the number of detected errors.
ValidationMessage	getMessage(int index)	Returns the specified message.
int	getMessageCount()	Returns the number of detected messages.
void	visitAnnotationVariable(AttributeVariable variable)	Visits a AttributeVariable.
void	visitAttribute(Attribute attribute)	Method for visiting an attribute.
void	visitAttributeAssignment(AttributeAssignment assignment)	Visits an attribute assignment.
void	visitBlockExpression(BlockExpression block)	Visits the block.
void	visitBooleanValue(BooleanValue value)	This method is used for visiting BooleanValue.
void	visitComment(Comment comment)	Visits a comment.
void	visitComment(Comment comment)	Method for visiting a comment.
void	visitCompound(Compound compound)	Method for visiting a compound.
void	visitCompoundAccess(CompoundAccess access)	Visits a compound access node.
void	visitCompoundAccessStatement(CompoundAccessStatement access)	Visits a compound access statement (may occur in freeze blocks.
void	visitCompoundInitializer(CompoundInitializer initializer)	Visits a compound initializer.
void	visitCompoundValue(CompoundValue value)	This method is used for visiting CompoundValue.
void	visitConstantValue(ConstantValue value)	Visits a constant value.
void	visitConstraint(Constraint constraint)	Method for visiting a constraint.
void	visitConstraintValue(ConstraintValue value)	This method is used for visiting ConstraintValue.
void	visitContainerInitializer(ContainerInitializer initializer)	Visits a container initializer.
void	visitContainerOperationCall(ContainerOperationCall call)	Visits a container operation call (e.g.
void	visitContainerValue(ContainerValue value)	This method is used for visiting ContainerValue.
void	visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)	This method is used for visiting a decision variable declaration.
void	visitDeferInitExpression(DeferInitExpression expression)	Visits a default init expression.
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	visitEnumValue(EnumValue value)	This method is used for visiting EnumValue.
void	visitFreezeBlock(FreezeBlock freeze)	Method for visiting a freeze block.
void	visitIfThen(IfThen ifThen)	Visits an if-then-else expression.
void	visitIntValue(IntValue value)	This method is used for visiting IntValue.
void	visitLet(Let let)	Visits a let expression.
void	visitMetaTypeValue(MetaTypeValue value)	This method is used for visiting meta type value.
void	visitMultiAndExpression(MultiAndExpression expression)	Visits a multi-and expression.
void	visitNullValue(NullValue value)	This method is used for visiting a null value.
void	visitOclFeatureCall(OCLFeatureCall call)	Visits an OCL feature call.
void	visitOperationDefinition(OperationDefinition opdef)	Method for visiting an operation definition.
void	visitOrderedEnum(OrderedEnum eenum)	Method for visiting an ordered enum.
void	visitParenthesis(Parenthesis parenthesis)	Visits a parenthesis.
void	visitPartialEvaluationBlock(PartialEvaluationBlock block)	Method for visiting a partial evaluation block.
void	visitProject(Project project)	Method for visiting a project.
void	visitProjectImport(ProjectImport pImport)	This method is used for visiting a ProjectImport.
void	visitProjectInterface(ProjectInterface iface)	Method for visiting a project interface.
void	visitRealValue(RealValue value)	This method is used for visiting RealValue.
void	visitReference(Reference reference)	Method for visiting a reference.
void	visitReferenceValue(ReferenceValue referenceValue)	This method is used for visiting referenceValue.
void	visitSelf(Self self)	Visits self.
void	visitSequence(Sequence sequence)	Method for visiting a sequence.
void	visitSet(Set set)	Method for visiting a set.
void	visitStringValue(StringValue value)	This method is used for visiting StringValue.
void	visitUnresolvedExpression(UnresolvedExpression expression)	Visits an unresolved expression.
void	visitVariable(Variable variable)	Visits a variable.
void	visitVersionValue(VersionValue value)	This method is used for visiting a version value.

Methods inherited from class java.lang.Object

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

Field Detail

messages

private java.util.List<ValidationMessage> messages

location

private java.util.Stack<java.lang.String> location

customTypes

private java.util.Set<IDatatype> customTypes

Constructor Detail

IvmlValidationVisitor

public IvmlValidationVisitor()

Method Detail

getErrorCount

public int getErrorCount()

Returns the number of detected errors.

Returns:

the number of detected errors

getMessageCount

public int getMessageCount()

Returns the number of detected messages.

Returns:

the number of detected messages

getMessage

public ValidationMessage getMessage(int index)

Returns the specified message.

Parameters:

index - the index of the message to return

Returns:

the message

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index >=getMessageCount()}

checkDeclaration

private void checkDeclaration(AbstractVariable decl)

Check whether the IDatatype of an AbstractVariable is part of the Project.

Parameters:

decl - The declaration to check, must be part of the project.

checkNameIdentifier

private void checkNameIdentifier(java.lang.String identifier,
                                 java.lang.Object cause)

Checks for a valid (name) identifier and stores an error message if required.

Parameters:

identifier - the identifier to check for

cause - the cause for the error (may be null)

checkIdentifier

private void checkIdentifier(java.lang.String identifier,
                             java.lang.String info,
                             java.lang.Object cause,
                             boolean allowWildcard)

Checks for a valid identifier and stores an error message if required.

Parameters:

identifier - the identifier to check for

info - optional information denoting the specific part with invalid identifier

cause - the cause for the error (may be null)

allowWildcard - allows for wildcard characters

checkType

private void checkType(IDatatype type,
                       java.lang.Object cause)

Checks for a valid datatype.

Parameters:

type - the type to be checked

cause - the cause for the error (may be null)

checkParent

private void checkParent(IModelElement element,
                         IModelElement expectedParent)

Checks for a valid parent (reference).

Parameters:

element - the element to check the parent reference for

expectedParent - the expected parent reference

checkParent

private void checkParent(IModelElement parent,
                         java.lang.Object cause,
                         IModelElement expectedParent)

Checks for a valid parent (reference).

Parameters:

parent - the parent reference for

cause - the cause for the error (the holder of the parent reference)

expectedParent - the expected parent reference

checkComment

private void checkComment(java.lang.String text,
                          boolean allowNull,
                          java.lang.Object cause)

Checks a comment.

Parameters:

text - the comment text

allowNull - if true then text==null is not considered as an error, if false an error is registered in case of text==null

cause - the cause for the error (may be null)

checkExpression

private boolean checkExpression(ConstraintSyntaxTree expression,
                                java.lang.String info,
                                java.lang.Object cause)

Checks for a valid (sub-)expression.

Parameters:

expression - the expression to check

info - optional information denoting the specific expression

cause - the cause for the error (may be null)

Returns:

true if the expression is valid, false else

addError

private void addError(java.lang.String text,
                      java.lang.Object cause,
                      int code)

Adds an error and appends the current location if possible.

Parameters:

text - the textual description of the error

cause - the cause for the error (may be null)

code - specifies the kind of the error (ValidationMessage)

addElementIsNullError

private void addElementIsNullError(java.lang.String elementName,
                                   int pos,
                                   java.lang.Object cause)

Adds an error because the given element is null.

Parameters:

elementName - the logical name of the element

pos - the position within the element collection

cause - the cause for the error (may be null)

visitProject

public void visitProject(Project project)

Description copied from interface: IModelVisitor

Method for visiting a project.

Specified by:

visitProject in interface IModelVisitor

Overrides:

visitProject in class AbstractVisitor

Parameters:

project - The project which should be visited.

visitEnum

public void visitEnum(Enum eenum)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an enum.

Specified by:

visitEnum in interface ICustomDatatypeVisitor

Overrides:

visitEnum in class AbstractVisitor

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.

Specified by:

visitOrderedEnum in interface ICustomDatatypeVisitor

Overrides:

visitOrderedEnum in class AbstractVisitor

Parameters:

eenum - The enum which should be visited.

visitCompound

public void visitCompound(Compound compound)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a compound.

Specified by:

visitCompound in interface ICustomDatatypeVisitor

Overrides:

visitCompound in class AbstractVisitor

Parameters:

compound - The compound which should be visited.

visitProjectImport

public void visitProjectImport(ProjectImport pImport)

Description copied from interface: IModelVisitor

This method is used for visiting a ProjectImport.

Specified by:

visitProjectImport in interface IModelVisitor

Parameters:

pImport - One ProjectImport which should be visited.

visitDecisionVariableDeclaration

public void visitDecisionVariableDeclaration(DecisionVariableDeclaration decl)

Description copied from interface: IModelVisitor

This method is used for visiting a decision variable declaration.

Specified by:

visitDecisionVariableDeclaration in interface IModelVisitor

Parameters:

decl - One declaration which should be visited.

visitAttribute

public void visitAttribute(Attribute attribute)

Description copied from interface: IModelVisitor

Method for visiting an attribute.

Specified by:

visitAttribute in interface IModelVisitor

Parameters:

attribute - The attribute which should be visited.

visitConstraint

public void visitConstraint(Constraint constraint)

Description copied from interface: IModelVisitor

Method for visiting a constraint.

Specified by:

visitConstraint in interface IModelVisitor

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.

Specified by:

visitFreezeBlock in interface IModelVisitor

Parameters:

freeze - The freeze block which should be visited.

visitOperationDefinition

public void visitOperationDefinition(OperationDefinition opdef)

Description copied from interface: IModelVisitor

Method for visiting an operation definition.

Specified by:

visitOperationDefinition in interface IModelVisitor

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.

Specified by:

visitPartialEvaluationBlock in interface IModelVisitor

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.

Specified by:

visitProjectInterface in interface IModelVisitor

Parameters:

iface - The interface which should be visited.

visitComment

public void visitComment(Comment comment)

Description copied from interface: IModelVisitor

Method for visiting a comment.

Specified by:

visitComment in interface IModelVisitor

Parameters:

comment - the comment to visit

visitAttributeAssignment

public void visitAttributeAssignment(AttributeAssignment assignment)

Description copied from interface: IModelVisitor

Visits an attribute assignment.

Specified by:

visitAttributeAssignment in interface IModelVisitor

Parameters:

assignment - the assignment to visit

visitDerivedDatatype

public void visitDerivedDatatype(DerivedDatatype datatype)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a derived datatype.

Specified by:

visitDerivedDatatype in interface ICustomDatatypeVisitor

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.

Specified by:

visitEnumLiteral in interface ICustomDatatypeVisitor

Parameters:

literal - The literal which should be visited.

visitReference

public void visitReference(Reference reference)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a reference.

Specified by:

visitReference in interface ICustomDatatypeVisitor

Parameters:

reference - The reference which should be visited.

visitSequence

public void visitSequence(Sequence sequence)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a sequence.

Specified by:

visitSequence in interface ICustomDatatypeVisitor

Parameters:

sequence - The sequence which should be visited.

visitSet

public void visitSet(Set set)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting a set.

Specified by:

visitSet in interface ICustomDatatypeVisitor

Parameters:

set - The set which should be visited.

visitConstantValue

public void visitConstantValue(ConstantValue value)

Description copied from interface: IConstraintTreeVisitor

Visits a constant value.

Specified by:

visitConstantValue in interface IConstraintTreeVisitor

Parameters:

value - the value which should be visited

visitVariable

public void visitVariable(Variable variable)

Description copied from interface: IConstraintTreeVisitor

Visits a variable.

Specified by:

visitVariable in interface IConstraintTreeVisitor

Parameters:

variable - the variable which should be visited

visitParenthesis

public void visitParenthesis(Parenthesis parenthesis)

Description copied from interface: IConstraintTreeVisitor

Visits a parenthesis.

Specified by:

visitParenthesis in interface IConstraintTreeVisitor

Parameters:

parenthesis - the parenthesis which should be visited

visitComment

public void visitComment(Comment comment)

Description copied from interface: IConstraintTreeVisitor

Visits a comment.

Specified by:

visitComment in interface IConstraintTreeVisitor

Parameters:

comment - the comment node which should be visited

visitOclFeatureCall

public void visitOclFeatureCall(OCLFeatureCall call)

Description copied from interface: IConstraintTreeVisitor

Visits an OCL feature call.

Specified by:

visitOclFeatureCall in interface IConstraintTreeVisitor

Parameters:

call - the feature call which should be visited

visitDeferInitExpression

public void visitDeferInitExpression(DeferInitExpression expression)

Description copied from interface: IConstraintTreeVisitor

Visits a default init expression.

Specified by:

visitDeferInitExpression in interface IConstraintTreeVisitor

Parameters:

expression - the expression

visitMultiAndExpression

public void visitMultiAndExpression(MultiAndExpression expression)

Description copied from interface: IConstraintTreeVisitor

Visits a multi-and expression.

Specified by:

visitMultiAndExpression in interface IConstraintTreeVisitor

Parameters:

expression - the expression to be visited

visitLet

public void visitLet(Let let)

Description copied from interface: IConstraintTreeVisitor

Visits a let expression.

Specified by:

visitLet in interface IConstraintTreeVisitor

Parameters:

let - the let expression which should be visited

visitIfThen

public void visitIfThen(IfThen ifThen)

Description copied from interface: IConstraintTreeVisitor

Visits an if-then-else expression.

Specified by:

visitIfThen in interface IConstraintTreeVisitor

Parameters:

ifThen - the if-then-else expression which should be visited

visitContainerOperationCall

public void visitContainerOperationCall(ContainerOperationCall call)

Description copied from interface: IConstraintTreeVisitor

Visits a container operation call (e.g. quantors, iterators).

Specified by:

visitContainerOperationCall in interface IConstraintTreeVisitor

Parameters:

call - the container operation call

visitCompoundAccess

public void visitCompoundAccess(CompoundAccess access)

Description copied from interface: IConstraintTreeVisitor

Visits a compound access node.

Specified by:

visitCompoundAccess in interface IConstraintTreeVisitor

Parameters:

access - the compound access node

visitUnresolvedExpression

public void visitUnresolvedExpression(UnresolvedExpression expression)

Description copied from interface: IConstraintTreeVisitor

Visits an unresolved expression. Please note that an unresolved expression may represent a leaf as well as an inner tree node. Typically, visitors shall continue visiting transparently at UnresolvedExpression.getActualExpression().

Specified by:

visitUnresolvedExpression in interface IConstraintTreeVisitor

Parameters:

expression - the expression

visitCompoundInitializer

public void visitCompoundInitializer(CompoundInitializer initializer)

Description copied from interface: IConstraintTreeVisitor

Visits a compound initializer.

Specified by:

visitCompoundInitializer in interface IConstraintTreeVisitor

Parameters:

initializer - the compound initializer node

visitContainerInitializer

public void visitContainerInitializer(ContainerInitializer initializer)

Description copied from interface: IConstraintTreeVisitor

Visits a container initializer.

Specified by:

visitContainerInitializer in interface IConstraintTreeVisitor

Parameters:

initializer - the container initializer node

visitConstraintValue

public void visitConstraintValue(ConstraintValue value)

Description copied from interface: IValueVisitor

This method is used for visiting ConstraintValue.

Specified by:

visitConstraintValue in interface IValueVisitor

Parameters:

value - One ConstraintValue which should be visited.

visitEnumValue

public void visitEnumValue(EnumValue value)

Description copied from interface: IValueVisitor

This method is used for visiting EnumValue.

Specified by:

visitEnumValue in interface IValueVisitor

Parameters:

value - One EnumValue which should be visited.

visitStringValue

public void visitStringValue(StringValue value)

Description copied from interface: IValueVisitor

This method is used for visiting StringValue.

Specified by:

visitStringValue in interface IValueVisitor

Parameters:

value - One StringValue which should be visited.

visitCompoundValue

public void visitCompoundValue(CompoundValue value)

Description copied from interface: IValueVisitor

This method is used for visiting CompoundValue.

Specified by:

visitCompoundValue in interface IValueVisitor

Parameters:

value - One CompoundValue which should be visited.

visitContainerValue

public void visitContainerValue(ContainerValue value)

Description copied from interface: IValueVisitor

This method is used for visiting ContainerValue.

Specified by:

visitContainerValue in interface IValueVisitor

Parameters:

value - One CompoundValue which should be visited.

visitIntValue

public void visitIntValue(IntValue value)

Description copied from interface: IValueVisitor

This method is used for visiting IntValue.

Specified by:

visitIntValue in interface IValueVisitor

Parameters:

value - One IntValue which should be visited.

visitRealValue

public void visitRealValue(RealValue value)

Description copied from interface: IValueVisitor

This method is used for visiting RealValue.

Specified by:

visitRealValue in interface IValueVisitor

Parameters:

value - One RealValue which should be visited.

visitBooleanValue

public void visitBooleanValue(BooleanValue value)

Description copied from interface: IValueVisitor

This method is used for visiting BooleanValue.

Specified by:

visitBooleanValue in interface IValueVisitor

Parameters:

value - One BooleanValue which should be visited.

visitReferenceValue

public void visitReferenceValue(ReferenceValue referenceValue)

Description copied from interface: IValueVisitor

This method is used for visiting referenceValue.

Specified by:

visitReferenceValue in interface IValueVisitor

Parameters:

referenceValue - One referenceValue which should be visited.

visitMetaTypeValue

public void visitMetaTypeValue(MetaTypeValue value)

Description copied from interface: IValueVisitor

This method is used for visiting meta type value.

Specified by:

visitMetaTypeValue in interface IValueVisitor

Parameters:

value - a value which should be visited.

visitNullValue

public void visitNullValue(NullValue value)

Description copied from interface: IValueVisitor

This method is used for visiting a null value.

Specified by:

visitNullValue in interface IValueVisitor

Parameters:

value - a value which should be visited (actually NullValue.INSTANCE).

visitCompoundAccessStatement

public void visitCompoundAccessStatement(CompoundAccessStatement access)

Description copied from interface: IModelVisitor

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

Specified by:

visitCompoundAccessStatement in interface IModelVisitor

Parameters:

access - the access statement

visitVersionValue

public void visitVersionValue(VersionValue value)

Description copied from interface: IValueVisitor

This method is used for visiting a version value.

Specified by:

visitVersionValue in interface IValueVisitor

Parameters:

value - a value which should be visited.

visitSelf

public void visitSelf(Self self)

Description copied from interface: IConstraintTreeVisitor

Visits self.

Specified by:

visitSelf in interface IConstraintTreeVisitor

Parameters:

self - the self object to visit

visitAnnotationVariable

public void visitAnnotationVariable(AttributeVariable variable)

Description copied from interface: IConstraintTreeVisitor

Visits a AttributeVariable.

Specified by:

visitAnnotationVariable in interface IConstraintTreeVisitor

Parameters:

variable - the attribute variable which should be visited

visitBlockExpression

public void visitBlockExpression(BlockExpression block)

Description copied from interface: IConstraintTreeVisitor

Visits the block.

Specified by:

visitBlockExpression in interface IConstraintTreeVisitor

Parameters:

block - the block to be visited