Package net.ssehub.easy.varModel.model.rewrite

Class ProjectRewriteVisitor

java.lang.Object

net.ssehub.easy.varModel.model.rewrite.ProjectRewriteVisitor

All Implemented Interfaces:

ICustomDatatypeVisitor, IModelVisitor

public class ProjectRewriteVisitor
extends java.lang.Object
implements IModelVisitor

Visitor for modifying a (copied) project. This can be used to filter a project for specific demands, e.g., a Project without constraints containing frozen variables.
This visitor modifies the given project. For this reason, it is recommended to use the ProjectCopyVisitor before to create a copy first.

Usage

1. Create visitor for the desired Project and specify whether imported projects shall also be rewritten (cf. FilterType)
2. Add desired IModelElementFilter and ProjectImport filters
3. Call Project.accept(net.ssehub.easy.varModel.model.IModelVisitor)
4. project will be affected through this visitation and should not be saved.

For instance:

 Project project = ...
 Configuration config = new Configuration(project); // Needed for some filter
 ProjectRewriteVisitor rewriter = new ProjectRewriteVisitor(project, FilterType.ALL);
 rewriter.addModelCopyModifier(new ModelElementFilter(Comment.class));
 rewriter.addModelCopyModifier(new FrozenConstraintsFilter(config));
 rewriter.addModelCopyModifier(new FrozenTypeDefResolver(config));
 rewriter.addModelCopyModifier(new FrozenConstraintVarFilter(config));
 rewriter.addModelCopyModifier(new FrozenCompoundConstraintsOmitter(config));
 project.accept(rewriter);
 

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private RewriteContext	context
private Project	currentProject
private java.util.Set<Project>	done
private FilterType	filterType	Specifies whether project imports shall be considered or not.
private java.util.List<IProjectImportFilter>	importModifiers
private java.util.Map<java.lang.Class<? extends ModelElement>,java.util.List<IModelElementFilter<?>>>	modifiers
private Project	originProject	The project where the visiting has been started.
private java.util.List<IProjectModifier>	projectModifiers

Constructor Summary

Constructors

Constructor	Description
ProjectRewriteVisitor(Project originProject, FilterType filterType)	Default constructor for this class.

Method Summary

Modifier and Type	Method	Description
private void	addCopiedElement(ContainableModelElement copy)	Adds a modified and filtered element to the currentProject, part of the filter(ContainableModelElement) method.
void	addImportModifier(IProjectImportFilter modifier)	Adds a new modifier for filtering ProjectImports.
void	addModelCopyModifier(IModelElementFilter<? extends ModelElement> modifier)	Adds a new IModelElementFilter to this ProjectRewriteVisitor.
void	addProjectModifier(IProjectModifier modifier)	Adds a new modifier to modify complete Projects at the end of their visitation.
private void	copyConstraint(Constraint constraint)	Copies the given Constraint.
private ContainableModelElement	filter(ContainableModelElement original)	Method for filtering (and modifying) the original ContainableModelElement using the IModelElementFilter.
void	reset(Project originProject, FilterType filterType)	Resets the ProjectRewriteVisitor to use it for a new visitation.
private void	revisit(Project project)	Starts a new visitation to clean up inconsistent data.
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	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	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 java.lang.Object

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

Field Detail

originProject

private Project originProject

The project where the visiting has been started.

filterType

private FilterType filterType

Specifies whether project imports shall be considered or not.

modifiers

private java.util.Map<java.lang.Class<? extends ModelElement>,java.util.List<IModelElementFilter<?>>> modifiers

importModifiers

private java.util.List<IProjectImportFilter> importModifiers

projectModifiers

private java.util.List<IProjectModifier> projectModifiers

currentProject

private Project currentProject

done

private java.util.Set<Project> done

context

private RewriteContext context

Constructor Detail

ProjectRewriteVisitor

public ProjectRewriteVisitor(Project originProject,
                             FilterType filterType)

Default constructor for this class.

Parameters:

originProject - The project where the visiting shall start

filterType - Specifies whether project imports shall be considered or not.

Method Detail

reset

public void reset(Project originProject,
                  FilterType filterType)

Resets the ProjectRewriteVisitor to use it for a new visitation. This will keep the internal knowledge and, thus, enable the removal of removed elements in other projects.

Parameters:

originProject - The project where the visiting shall start

filterType - Specifies whether project imports shall be considered or not.

addModelCopyModifier

public void addModelCopyModifier(IModelElementFilter<? extends ModelElement> modifier)

Adds a new IModelElementFilter to this ProjectRewriteVisitor. If none was specified for a given ContainableModelElement type, these kind of elements will be copied. If a IModelElementFilter was specified the modifier will be applied to each element of the same type. Multiple IModelElementFilter may be specified for the same ContainableModelElement type.

Parameters:

modifier - A IModelCopyModifier for a given ContainableModelElement class, must not be null.

addImportModifier

public void addImportModifier(IProjectImportFilter modifier)

Adds a new modifier for filtering ProjectImports.

Parameters:

modifier - A modifier for filtering ProjectImports.

addProjectModifier

public void addProjectModifier(IProjectModifier modifier)

Adds a new modifier to modify complete Projects at the end of their visitation.

Parameters:

modifier - A modifier to change projects.

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.

copyConstraint

private void copyConstraint(Constraint constraint)

Copies the given Constraint.

Parameters:

constraint - A constraints, which syntax is not null

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

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

visitEnum

public void visitEnum(Enum eenum)

Description copied from interface: ICustomDatatypeVisitor

Method for visiting an enum.

Specified by:

visitEnum in interface ICustomDatatypeVisitor

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

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

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.

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.

filter

private ContainableModelElement filter(ContainableModelElement original)

Method for filtering (and modifying) the original ContainableModelElement using the IModelElementFilter. If none is specified for the given element type, the element will be returned without any modification. The returned element must be added to the currentProject through the addCopiedElement(ContainableModelElement) method. This methods are splitted into two methods, to enable further processing between the filtering and the add method, i.e., adapting to the currentProject.

Parameters:

original - A ContainableModelElement of the currentProject to be filtered (and modified).

Returns:

The modified instance (maybe the same instance) or null if it was completely filtered.

See Also:

addCopiedElement(ContainableModelElement)

addCopiedElement

private void addCopiedElement(ContainableModelElement copy)

Adds a modified and filtered element to the currentProject, part of the filter(ContainableModelElement) method.

Parameters:

copy - The copied instance, maybe null if filtered completely.

visitProject

public void visitProject(Project project)

Method for visiting a project.
Attention: This method will modify the visited project as a side effect. If the original project should not be modified, it is necessary to create a copy first via the ProjectCopyVisitor.

Specified by:

visitProject in interface IModelVisitor

Parameters:

project - The project which should be visited.

revisit

private void revisit(Project project)

Starts a new visitation to clean up inconsistent data.

Parameters:

project - The original project which was used to start the whole visitation process.

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.