We propose the EMF Store as a project in the Eclipse Modeling Framework Technology Project (EMFT). This proposal is in the Project Proposal Phase (as defined in the Eclipse Development Process document). The goal of this proposal is to find more interested parties and to get feedback of the community. Please send all feedback to the EMFT forum.
BackgroundMany EMF-based Applications need to share data among multiple clients. A model repository can help an application to share instances of an EMF model. Additionally a model repository will keep track of the version history of the model. File-based repositories such as SVN or CVS are not well suited for this task since they work on a different level of abstraction, namely on files with textual content. With a file-based repository frequent merging is required since every simultaneous change on file is considered a conflict and must be merged in the local client. A model repository manages models on the appropriate level of abstract models. Therefore it can supply support tailored to models for change tracking, diffing, conflict detection, merging and versioning.
ScopeIn a model repository framework every client can manipulate the model instances and send its changes to a central repository, where the currently valid version of all model instances is maintained. Similar to SVN or CVS, clients keep a local copy of the model instances they need to work on and can therefore work disconnected (=> Offline Mode) from the repository. If the clients send their changes to the repository, conflicts may occur, which need to be detected and resolved by a user (=> Model Merging). The framework supplies user interfaces for commit, update and merge, which can be replaced if necessary. Since changing the Ecore model requires migration of existing instances of the model, the repository also supports the generation of migrators from the changes performed in the Ecore (=> Model Migration). To help developers in the development of applications based on a model repository, the framework supplies views to browse the repository, to view the history of model instances, to manage access control and to view and manipulate model instances on the client (=> Tooling). The goal of EMFStore is to allow for a very easy integration into existing applications with minimum effort.
DescriptionWe will describe important aspects of the EMFStore in more detail in the following:
Model RepositoryThe EMFStore is a model repository that allows to store EMF model instances and which keeps a version history of these instances. EMFStore follows the checkout/update/commit interaction paradigm known from SVN or CVS. The framework allows to checkout a copy of a model instance from the repository. Then it tracks change on the model instances on the clients and provides an API to send the changes to the repository. Also the API allows updating the model instances according to changes of other clients via the repository.
Automatic PersistencyThe framework persists the model instances on the client transparently. In other words if a change is performed on a model instances, this change is immediately persistent. There is no need to manually save a model instance to a resource. The same applies for data on the server.
Transparency on Model APIApplications can use the regular EMF model API for changing to the model and the regular EMF observer patterns to listen for changes to the model. The framework is transparent for code operating at this level of abstraction.
Offline ModeEMFStore clients work disconnected and do not need a connection to the repository other than to update or commit changes.
Interactive Model MergingEMFStore supports Interactive Model Merging to resolve conflicts if two clients changes the same data in a model instance. It supplies interactive merge user interfaces to support users in model merging. Conflict detection and merging are extensible by extension points.
Model MigrationIf the Ecore model of an application is changed, a migrator can be generated from these changes to migrate existing model instances to conform to the new model. This migration is based on the technology of the Edapt Eclipse project (formerly COPE) and is already integrated in the EMFStore. Clients and Server will automatically migrate existing instances.
ToolingTo ease the development of applications that store data in the EMFStore, the framework ships with comprehensive tooling. The EMFStore Browser view allows browsing an EMFStore server and its model instances. Also access control to model instances can be configured in this view. The History Browser helps to visualize the version history of a model instance and to restore old versions. The Navigator shows all model instances, which have been checked out on a client. The Model Element Editor can be used to view a single model element in a reflective editor.
The EMFStore (http://emfstore.org) is developed as part of the UNICASE project (http://unicase.org). While it was originally targeted only at the UNICASE Client application, it is now used by a number of different applications and it is available as a standalone framework. The goal of this proposal is to make the EMFStore technology available to the Eclipse community as an EMFT project and to build an active open source community around the EMFStore.
Code contributionsEMFStore is already implemented and its entire code will be contributed to the Eclipse project. The code is currently hosted on Google code at emfstore.org
Relationship with other Eclipse Projects
- EMFStore builts on top of EMF
- EMFStore builts on top of Edapt for model migration
- EMFStore will use EMFCompare to create diffs
- EMFStore can built on EclipseLink for persistency
- EMFStore has a different focus than CDO:
- Continuous Offline Operation (like SVN)
- Interactive Model Merging
- Automated Model Evolution Support
- Tooling and Views: Commit/Update/Merge, Repo-Browser, History-Browser
- Slim but fully vertical integration
- Maximilian Koegel, Technische Universitaet Muenchen - proposed project co-lead
- Jonas Helming, Technische Universitaet Muenchen - proposed project co-lead
- Otto von Wesendonk, Individual
- Florian Pirchner, redView
- Ed Merks
- Sven Efftinge
- Bauhaus Luftfahrt Germany, Gernot Stenz, http://www.bauhaus-luftfahrt.net
- Beople, Harald Stangl, http://beople.de
- EADS Germany, Matthias Buderath, http://www.eads.com
- EclipseSource, Jochen Krause, http://eclipsesource.com
- Edapt Eclipse Project, Markus Herrmansdoerfer, http://cope.in.tum.de
- Mangrove SOA Modeling Framework, Juan Cadavid, http://www.eclipse.org/proposals/mangrove/
- Instantiations, Steve Messick, http://www.instantiations.com
- Max Plank Institute for Physics, Prof. Bethke, http://www.mpp.mpg.de
- red-open, Ekkehard Gentz, Florian Pirchner, http://red.open.org
- redView, Florian Pirchner, Ekkehard Gentz, http://redview.org
- Steffen Stundzig, Itemis, http://www.itemis.com/
- Serano Colameo, itemis Schweiz, http://www.itemis-schweiz.ch
- Seissol Project, Technische Universitaet Muenchen, Department for Geophysics, Prof. Bunge, Dr. Martin Kaeser, http://www.geophysik.uni-muenchen.de/~kaeser/SeisSol/
- Technische Universitaet Muenchen, Chair for Applied Software Engineering, Prof. Bernd Bruegge Ph.D., http://www1.in.tum.de
- University Bonn-Rhein-Siegen, Software Engineering, Prof. Dr. Simone Bürsner, http://www.hochschule-bonn-rhein-sieg.de
- University Heidelberg, Chair for Software Engineering, Prof. Dr. Barbara Paech, Germany, http://se.ifi.uni-heidelberg.de
The following individuals are proposed as initial committers to the project:
The following Architecture Council members will mentor this project:
The following individuals, organisations, companies and projects have expressed interest in this project:
Changes to this Document