Difference between revisions of "EMF Compare/User Guide"

From Eclipsepedia

Jump to: navigation, search
(User Interface)
Line 1: Line 1:
 
{{EMF_Compare}}
 
{{EMF_Compare}}
  
== Getting Started  ==
+
= Getting Started  =
  
=== Installing EMF Compare  ===
+
== Installing EMF Compare  ==
  
 
'''Marketplace Client'''  
 
'''Marketplace Client'''  
Line 99: Line 99:
 
An empty cell indicates that the compatibility hasn't been tested for a particular combination.
 
An empty cell indicates that the compatibility hasn't been tested for a particular combination.
  
== Usage ==
+
= Usage =
  
 
Once installed, you can compare your files (locally or from any Version Control System) as usual using the '''compare with''' menu.
 
Once installed, you can compare your files (locally or from any Version Control System) as usual using the '''compare with''' menu.
Line 105: Line 105:
 
[[Image:EMFC Compare With.png|center]]
 
[[Image:EMFC Compare With.png|center]]
  
=== User Interface  ===
+
= User Interface  =
  
 
The main points of interest are highlighted in the following picture :
 
The main points of interest are highlighted in the following picture :
Line 121: Line 121:
 
# Allows you to navigate through the detected differences.
 
# Allows you to navigate through the detected differences.
  
== Features ==
+
= Features =
  
=== Handling Conflicts  ===
+
== Handling Conflicts  ==
  
=== Grouping Differences  ===
+
== Grouping Differences  ==
  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/Groups/groups.htm [Demo : Grouping Differences]]  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/Groups/groups.htm [Demo : Grouping Differences]]  
Line 131: Line 131:
 
TBD  
 
TBD  
  
=== Filtering Differences  ===
+
== Filtering Differences  ==
  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/Filters/filters.htm [Demo : Filtering Differences]]  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/Filters/filters.htm [Demo : Filtering Differences]]  
Line 137: Line 137:
 
TBD  
 
TBD  
  
=== Text Attribute Comparison  ===
+
== Text Attribute Comparison  ==
  
[http://www.eclipse.org/emf/compare/doc/features/videos/Text%20compare/textCompare.htm [Demo&nbsp;: Comparing Textual Attribute]]<br>
+
[http://www.eclipse.org/emf/compare/doc/features/videos/Text%20compare/textCompare.htm [Demo&nbsp;: Comparing Textual Attribute]]
 
+
<br>
+
  
 
[[Image:Compare text fieldaction.png]]  
 
[[Image:Compare text fieldaction.png]]  
  
<br>
+
[[Image:Compare text field.png]]
  
<br>
+
== Graphical Comparison  ==
 
+
[[Image:Compare text field.png]]<br>
+
 
+
<br>
+
 
+
=== Graphical Comparison  ===
+
  
 
Since the 1.2 release EMF compare provides the ability to compare models with graphical modelers.  
 
Since the 1.2 release EMF compare provides the ability to compare models with graphical modelers.  
  
Have a look on the following demos&nbsp;:  
+
Have a look on the following demos :
  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/EcoreTools-v2/EMFCompareEcoreTools.html [Demo&nbsp;: Comparing Ecore files with diagrams]]  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/EcoreTools-v2/EMFCompareEcoreTools.html [Demo&nbsp;: Comparing Ecore files with diagrams]]  
Line 163: Line 155:
 
[[http://www.eclipse.org/emf/compare/doc/features/videos/Papyrus/EMFComparePapyrus.html Demo&nbsp;: Comparing UML files with diagrams]]  
 
[[http://www.eclipse.org/emf/compare/doc/features/videos/Papyrus/EMFComparePapyrus.html Demo&nbsp;: Comparing UML files with diagrams]]  
  
[[Image:Diag comp diff.png]]  
+
[[Image:Diag comp diff.png]]
  
<br>
+
== Logical Model  ==
 
+
=== Logical Model  ===
+
  
 
The Eclipse Platform logical model API allows to hook in all the workspace and team operations to adapt the user request. It enables, for instance, to add in a commit request new files which are required to keep model consistency.  
 
The Eclipse Platform logical model API allows to hook in all the workspace and team operations to adapt the user request. It enables, for instance, to add in a commit request new files which are required to keep model consistency.  
  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/LogicalModels/LogicalModels.html [Demo &nbsp;: keeping model consistency on Workspace operation]]  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/LogicalModels/LogicalModels.html [Demo &nbsp;: keeping model consistency on Workspace operation]]  
 
<br>
 
  
 
[[Image:EGit logical Selection.png]]  
 
[[Image:EGit logical Selection.png]]  
  
=== UML Specialization  ===
+
== UML Specialization  ==
  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/UML%20comparison/compareUml.htm [Demo&nbsp;: Specific support to encapsulate profiles and stereotypes diffs]]  
 
[http://www.eclipse.org/emf/compare/doc/features/videos/UML%20comparison/compareUml.htm [Demo&nbsp;: Specific support to encapsulate profiles and stereotypes diffs]]  
  
=== SysML Specialization ===
+
== SysML Specialization ==
  
=== Exporting Differences  ===
+
== Exporting Differences  ==
  
== Other Materials  ==
+
= Other Materials  =
  
 
*[http://www.eclipse.org/emf/compare/doc/features/videos/index.html Videos of 2011 new features]  
 
*[http://www.eclipse.org/emf/compare/doc/features/videos/index.html Videos of 2011 new features]  
*[[EMF Compare/CompareUMLPapyrusAPI|Specification and Documentation about the comparison of UML diagrams]]<br>
+
*[[EMF Compare/CompareUMLPapyrusAPI|Specification and Documentation about the comparison of UML diagrams]]
  
 
[[Category:EMF Compare]]
 
[[Category:EMF Compare]]

Revision as of 08:15, 18 October 2012


EMF Compare
Website
Download
Community
Mailing List
Forums
Bugzilla
Open
Create New
Contribute
Browse Source


Contents

Getting Started

Installing EMF Compare

Marketplace Client

Using the bundled Eclipse marketplace client you can install EMF Compare in one click. Just type "emf compare", click on search, and then on install.


Marketplace.png

Update Site

EMF has been part of the Eclipse release train since Galileo, you can install it using the following update sites, depending on your platform. Note that the following are not meant to be visited in your internet browser; they must be pasted in the Help > Install New Software dialog of your Eclipse, as p2 repositories.

 http://download.eclipse.org/releases/galileo
 http://download.eclipse.org/releases/helios
 http://download.eclipse.org/releases/indigo
 http://download.eclipse.org/releases/juno

Please note that the EMF Compare development team does its best to maintain downward compatibility towards Galileo (Eclipse 3.5). Following is the compatibility chart :

EMF Compare Eclipse 3.2 - EMF 2.2 Eclipse 3.3 - EMF 2.3 Eclipse 3.4 - EMF 2.4 Eclipse 3.5 - EMF 2.5 Eclipse 3.6 - EMF 2.6 Eclipse 3.7 - EMF 2.7 Eclipse 3.8 - EMF 2.8
0.7 OK
0.8 KO OK OK
1.0 KO OK OK OK OK
1.1 KO KO OK OK OK OK OK
1.2 KO KO OK OK OK OK OK
1.3 KO KO KO OK OK OK OK
2.0 KO KO KO OK OK OK OK

An empty cell indicates that the compatibility hasn't been tested for a particular combination.

Usage

Once installed, you can compare your files (locally or from any Version Control System) as usual using the compare with menu.

EMFC Compare With.png

User Interface

The main points of interest are highlighted in the following picture :

EMF Compare's basic user interface
  1. Overview of the differences detected between the given two (or three) models.
  2. First version of the compared models.
  3. Second version of the compared models.
  4. This button will only be visible in the case of three-way comparisons (for example, comparing with a remote repository). It will make a third version of the compared model (the common ancestor of the two others) visible in the interface.
  5. This button will allow you to group differences together in the structural view. For example, grouping all "Additions" or "Deletions" together.
  6. This button will allow you to filter some differences out of the view according to a set predicate. For example, filtering out all "Additions" or "Moves".
  7. Allows you to merge all non conflicting differences (left to right, or right to left) at once.
  8. Allows you to merge the single, currently selected difference in a given direction (left to right, or right to left).
  9. Allows you to navigate through the detected differences.

Features

Handling Conflicts

Grouping Differences

[Demo : Grouping Differences]

TBD

Filtering Differences

[Demo : Filtering Differences]

TBD

Text Attribute Comparison

[Demo : Comparing Textual Attribute]

Compare text fieldaction.png

Compare text field.png

Graphical Comparison

Since the 1.2 release EMF compare provides the ability to compare models with graphical modelers.

Have a look on the following demos :

[Demo : Comparing Ecore files with diagrams]

[Demo : Comparing UML files with diagrams]

Diag comp diff.png

Logical Model

The Eclipse Platform logical model API allows to hook in all the workspace and team operations to adapt the user request. It enables, for instance, to add in a commit request new files which are required to keep model consistency.

[Demo  : keeping model consistency on Workspace operation]

EGit logical Selection.png

UML Specialization

[Demo : Specific support to encapsulate profiles and stereotypes diffs]

SysML Specialization

Exporting Differences

Other Materials