Kermeta tutorial

How to install Kermeta

Didier Vojtisek, François Tanguy, Marie Gouyette

Build date: 3-November-2010

$Date: 2010-05-28 16:02:27 +0200 (Fri, 28 May 2010) $

Abstract

This tutorial is part of a serie of tutorials that explain step by step one of the aspect of Kermeta. This one shows how to install Kermeta workbench.


Table of Contents

Preface
1. Prerequisites
2. The first Eclipse start
3. Kermeta Installation
4. Diagnosing a Kermeta installation
4.1. Plugin Registry diagnostic
4.2. Read the Error log
5. Conclusion

Preface

Kermeta is a Domain Specific Language dedicated to metamodel engineering. It fills the gap let by MOF which defines only the structure of meta-models, by adding a way to specify static semantic (similar to OCL) and dynamic semantic (using operational semantic in the operation of the metamodel). Kermeta uses the object-oriented paradigm like Java or Eiffel This document presents various aspects of the language, including the textual syntax, the metamodel (which can be viewed as the abstract syntax) and some more advanced features typically included in its framework.

[Important]Important

Kermeta is an evolving software and despite that we put a lot of attention to this document, it may contain errors (more likely in the code samples). If you find any error or have some information that improves this document, please send it to us using the bug tracker in the forge: http://gforge.inria.fr/tracker/?group_id=32 or using the user mailing list (kermeta-users@lists.gforge.inria.fr) Last check: v1.2.0

[Tip]Tip

The most update version of this document is available online : http://www.kermeta.org/documents .

Chapter 1. Prerequisites

  • Your operating system must use the 1.5 or above version of Java. If not, please visit the Java web page (http://java.sun.com/) and install the latest version of Java.

  • Eclipse must be installed. We currently use Eclipse 3.5.0 (Galileo). You can get Eclipse from http://www.eclipse.org/downloads/.

    In this tutorial, you should download the Eclipse Modeling Tool version of Eclipse which is a good base for development with Kermeta. This tutorial will cover every necessary step to get Kermeta working with Eclipse.

    Some additional installation instructions are available here : http://www.eclipse.org/documentation/ .

Chapter 2. The first Eclipse start

When you start Eclipse for the first time, you will be asked for a workspace location. This is the directory used by Eclipse to store the projects you will create in the future. The image below is the dialog box you should see. By default, Eclipse proposes to create a workspace directory named "workspace" in your home directory.

Select a workspace location

Figure 2.1. Select a workspace location


[Tip]Tip

If (like me) you have many versions of eclipse with various configurations, you may consider create your workspace directly in the eclipse folder. You'll be able to easily move or remove a complete eclipse without the risk of corrupting eclipse .metadata with various configurations.

On every launch, you will be prompted for the workspace location. For now, we just click "OK" to open the main window of Eclipse using the workspace you've created. You should see a window like the one below.

Eclipse Welcome window

Figure 2.2. Eclipse Welcome window


You can close the "Welcome" tab. Now your window looks like this one :

Main Eclipse window

Figure 2.3. Main Eclipse window


Now, let's proceed to the Kermeta installation.

Chapter 3. Kermeta Installation

Kermeta installation use the installer built in Eclipse.

In the main menu of Eclipse, select Help >> Install New Software . A dialog box appears.

Dialog box to install new software

Figure 3.1.  Dialog box to install new software


Now, you need to tell Eclipse where to look for Kermeta features. So you click on Add Site... and fill it like in the following picture.

Add site dialog window

Figure 3.2.  Add site dialog window


Cick on OK. Then select the Kermeta update site in the scroll menu and select everything from Kermeta site like shown below.

Select Kermeta feature

Figure 3.3.  Select Kermeta feature


Then click on Next .

The next dialog shows the install Details. Click on Next.

Installation details

Figure 3.4. Installation details


You must accept the term of the licenses agreement and click on finish.

Licence agreement window

Figure 3.5. Licence agreement window


Finally, after the installation, you must reboot Eclipse to take changes in account. Do it by clicking on "Yes".

Reboot Eclipse Dialog Window

Figure 3.6. Reboot Eclipse Dialog Window


Once rebooted, you can check your version of Kermeta in the main menu of Eclipse > Help >> About Eclipse SDK. You should see Kermeta logo. Clicking on it must display its version and build date

About Eclipse Window

Figure 3.7. About Eclipse Window


Chapter 4. Diagnosing a Kermeta installation

If you suspect your installation to be incorrect (for example, because you started from another version of Eclipse, or because you have already some plugins installed in your eclipse), this chapter list some way to help you diagnose your Kermeta installation.

4.1. Plugin Registry diagnostic

Since Eclipse 3.4, the Plugin Registry view allows to diagnose the installed plugins.

In the main menu of Eclipse > Windows >> Show view >> Other... then select the Plug-in Registry view in the Plug-in Development folder.

Select Plug-in Registry View

Figure 4.1. Select Plug-in Registry View


Then you must enable the advanced options. (small triangle on the top rigth corner of the view)

Plug-in Registry view

Figure 4.2. Plug-in Registry view


Now, you can right click on the plugins and diagnose them. In this tutorial we diagnose the plugin fr.irisa.triskell.kermeta.graphicaleditor. Typically, if it requires another plugin that cannot be run, it will tell you. If this other plugin is in the list, diagnose it until you find the origin of your problem...

Diagnose plugin

Figure 4.3. Diagnose plugin


4.2. Read the Error log

If the Plugin registry didn't show you the error, you may additionnaly have a look in the Error Log view. In the main menu of Eclipse > Windows >> Show view >> Other... then select the Error Log view in the General folder.

Chapter 5.  Conclusion

Now, you have installed Kermeta into Eclipse. It 's time to use it! For more information, please refer to Kermeta tutorials or Kermeta Manual