Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
EMF Compare/Specifications/Metamodel restructuration
THIS PAGE IS ARCHIVED. IT IS PROBABLY OUTDATED AND WILL NOT BE UPDATED
- 1 Evolution Specification: Title of the evolution
- 1.1 Preamble
- 1.2 Introduction
- 1.3 Detailed Specification
- 1.4 Backward Compatibility and Migration Paths
- 1.5 Tests and Non-regression strategy
- 1.6 Implementation choices and tradeoffs
Evolution Specification: Title of the evolution
Current status is ARCHIVED
This specification aims at setting down on paper and clarifying the requirements and needs for the restructuration of both match and diff metamodels.
_Relevant tickets_ :
The development of EMF Compare has been ongoing for quite some time, and we have reached the limits of what can be expressed with the current definition of our metamodels. First is the "match" metamodel, serving the purpose of expressing the result of EMF Compare's matching phase. It allows us to map the objects from two distinct models two-by-two, and to "mark" the objects with no match (present in one model but not in the other). Second is the "diff" metamodel, which allows us to express the differences themselves. Both of these models must be refactored in order to fix some of the current implementation bugs.
For example, the match model does not allow us to express that an "unmatched" element may contain a "matched" one : if an existing element A (matched) has been moved to a newly added (thus unmatched) element B. As for the diff model, it has become hard to read over time as we tried to maintain existing APIs while adding fundamentaly new concepts (the diff model has not changed much when we introduced three-way matching).
The goal of these restructuration are both :
- to increase the readability and ease the understanding of the metamodel concepts,
- to allow us to express what cannot be done with the current versions.
Backward Compatibility and Migration Paths
We will strive to make the match model reflect the actual hierarchy of the compared model. To this end we need to :
- Make UnmatchElement inherit from MatchElement (so that Match2Element and UnmatchElement share a common superclass)
- Remove the "similarity" attribute from MatchElement
List every API addition, removal and deprecation. For each removal and deprecation, indicate the migration path for existing code.
User Interface Changes
List every user-visible change in the interface. Here "user" includes not only end-users but also developpers.
List every documentation needing an update here, starting by the New and Noteworthy documentation.
Tests and Non-regression strategy
This part of the document should describe the strategy to use to correctly test the evolution and guarantee the non-regression.
Implementation choices and tradeoffs
Any important tradeoff or choice made during the implementation should be referenced here with pros/cons leading to the final decision.