Package net.ssehub.easy.varModel.cst

Class BasicCopyVisitor

java.lang.Object

net.ssehub.easy.varModel.cst.BasicCopyVisitor

All Implemented Interfaces:

IConstraintTreeVisitor

Direct Known Subclasses:

CopyVisitor, SubstitutionVisitor

public class BasicCopyVisitor
extends java.lang.Object
implements IConstraintTreeVisitor

Implements a basic constraint copy visitor. Allows leaving variable nodes as they are as well as mapping variables (although no mapping happens in this class).

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	copyConstants
private boolean	copyExpressions
private boolean	copyVariables
private boolean	doInferDatatype
private ConstraintSyntaxTree	result

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicCopyVisitor()	Creates a copy visitor leaving variable nodes as they are, copying constants, not inferring types on intermediary expressions.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears this visitor for reuse.
protected boolean	getCopyExpressions()	Returns whether (partial) expressions shall always be copied or only if needed.
protected boolean	getCopyVariables()	Returns variables shall always be copied or whether instances shall be reused if possible.
protected EASyLoggerFactory.EASyLogger	getLogger()	Returns the logger.
ConstraintSyntaxTree	getResult()	Returns the copied syntax tree.
protected ConstraintSyntaxTree	inferDatatype(ConstraintSyntaxTree cst)	Performs datatype validation if requested.
protected AbstractVariable	mapVariable(AbstractVariable var)	Maps a variable.
protected DecisionVariableDeclaration	mapVariable(DecisionVariableDeclaration var)	Maps a variable.
protected void	setCopyConstants(boolean copyConstants)	Defines whether ConstraintSytaxTree#inferDatatype shall be called on each partial expression.
protected void	setCopyExpressions(boolean copyExpressions)	Defines whether (partial) expressions shall always be copied or only if needed.
protected void	setCopyVariables(boolean copyVariables)	Defines whether variables shall always be copied or whether instances shall be reused if possible.
protected void	setDoInferDatatype(boolean doInferDatatype)	Defines whether ConstraintSytaxTree#inferDatatype shall be called on each partial expression.
protected void	setResult(ConstraintSyntaxTree cst)	Allows inherited classed to overwrite visiting method and to return a partially translated cst.
void	visitAnnotationVariable(AttributeVariable variable)	Visits a AttributeVariable.
void	visitBlockExpression(BlockExpression block)	Visits the block.
void	visitComment(Comment comment)	Visits a comment.
void	visitCompoundAccess(CompoundAccess access)	Visits a compound access node.
void	visitCompoundInitializer(CompoundInitializer initializer)	Visits a compound initializer.
void	visitConstantValue(ConstantValue value)	Visits a constant value.
void	visitContainerInitializer(ContainerInitializer initializer)	Visits a container initializer.
void	visitContainerOperationCall(ContainerOperationCall call)	Visits a container operation call (e.g.
void	visitDeferInitExpression(DeferInitExpression expression)	Visits a default init expression.
void	visitIfThen(IfThen ifThen)	Visits an if-then-else expression.
void	visitLet(Let let)	Visits a let expression.
void	visitMultiAndExpression(MultiAndExpression expression)	Visits a multi-and expression.
void	visitOclFeatureCall(OCLFeatureCall call)	Visits an OCL feature call.
void	visitParenthesis(Parenthesis parenthesis)	Visits a parenthesis.
void	visitSelf(Self self)	Visits self.
void	visitUnresolvedExpression(UnresolvedExpression expression)	Visits an unresolved expression.
void	visitVariable(Variable variable)	Visits a variable.

Methods inherited from class java.lang.Object

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

Field Detail

result

private ConstraintSyntaxTree result

copyVariables

private boolean copyVariables

doInferDatatype

private boolean doInferDatatype

copyConstants

private boolean copyConstants

copyExpressions

private boolean copyExpressions

Constructor Detail

BasicCopyVisitor

protected BasicCopyVisitor()

Creates a copy visitor leaving variable nodes as they are, copying constants, not inferring types on intermediary expressions.

Method Detail

setCopyVariables

protected void setCopyVariables(boolean copyVariables)

Defines whether variables shall always be copied or whether instances shall be reused if possible.

Parameters:

copyVariables - copy variable node instances if true, reuse them if false

getCopyVariables

protected boolean getCopyVariables()

Returns variables shall always be copied or whether instances shall be reused if possible.

Returns:

copy variable node instances if true, reuse them if false

setDoInferDatatype

protected void setDoInferDatatype(boolean doInferDatatype)

Defines whether ConstraintSytaxTree#inferDatatype shall be called on each partial expression.

Parameters:

doInferDatatype - call/validate the datatypes, false else (then caller is required to infer the datatype before usage of the resulting constraint)

setCopyConstants

protected void setCopyConstants(boolean copyConstants)

Defines whether ConstraintSytaxTree#inferDatatype shall be called on each partial expression.

Parameters:

copyConstants - copy all constant nodes (true), reuse constant nodes (false))

setCopyExpressions

protected void setCopyExpressions(boolean copyExpressions)

Defines whether (partial) expressions shall always be copied or only if needed.

Parameters:

copyExpressions - true for copy always, false else

getCopyExpressions

protected boolean getCopyExpressions()

Returns whether (partial) expressions shall always be copied or only if needed.

Returns:

true for copy always, false else

setResult

protected void setResult(ConstraintSyntaxTree cst)

Allows inherited classed to overwrite visiting method and to return a partially translated cst.

Parameters:

cst - A partially copied cst.

getResult

public ConstraintSyntaxTree getResult()

Returns the copied syntax tree.

Returns:

the copied tree (may be null if no tree was visited).

clear

public void clear()

Clears this visitor for reuse.

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

mapVariable

protected DecisionVariableDeclaration mapVariable(DecisionVariableDeclaration var)

Maps a variable.

Parameters:

var - the variable to be mapped

Returns:

the mapped variable or var

mapVariable

protected AbstractVariable mapVariable(AbstractVariable var)

Maps a variable.

Parameters:

var - the variable to be mapped

Returns:

the mapped variable or var

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

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

visitDeferInitExpression

public void visitDeferInitExpression(DeferInitExpression expression)

Visits a default init expression.

Specified by:

visitDeferInitExpression in interface IConstraintTreeVisitor

Parameters:

expression - the expression

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

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

inferDatatype

protected ConstraintSyntaxTree inferDatatype(ConstraintSyntaxTree cst)

Performs datatype validation if requested.

Parameters:

cst - the constraint expression to perform the validation on

Returns:

cst

Throws:

CSTSemanticException - if validation fails

getLogger

protected EASyLoggerFactory.EASyLogger getLogger()

Returns the logger.

Returns:

the logger