Modeleditor plugin

Mini-Tutorial

Every name in this tutorial have the "old" names, so they may change in the future to be more RIFE specific.

The editor can generate the sources in any existing java project. For the tutorial we import the rife-jumpstart package and delete the containing application files from src-Directory. The only things we leave there are the templates/common/-Directory. I want to use this as the basic templates.

Step 1 - Installing the plugin

The plugin was tested with Eclipse 3.1.1 and 3.1.2. Because of the missing EMF/GEF Versions at the moment you have to use the 3.1.1, install the EMF/JMF and GEF Libs with the Update Manager and update after this to 3.1.2 after this. This should be soon fixed.

After this the plugin zip must be unpacked and the _modeleditor-1.0.0-Directory must be copied in the eclipse plugins directory.

Step 2 - Creating a model in a java project

To create a new model select the Wizard under New->Models->Model Diagram.

At the moment you only have to supply the name and the directory for the model file.

Step 3 - Creating a simple element

After this the model is opened in the editor

The modeleditor consist of two areas. The working area where the elements are displayed and the palette on the right side, where you can select the tools. At the moment there are 5 tools. A selection tool, for selecting a single element, a marque tool, for selection a group, a data connection creation tool, a screen flow connection tool and a element creation tool.

We start by creating a simple element from the number guess game. We select the element creation tool . Click on a position where you want the element to be created.

This opens the dialog to enter the data of the element.

The name of the element has some constraints, because we use this name in the java source, the xml definition and the html templates. So we need to skip the dangerous characters and respect the naming conventions. So the name should start with a character, and can only contain alphanumeric characters.

If the name is not valid or is already used by another element the input field is marked with red background and white font.

The buttons on the right side are only enabled, when they can be used. So if you enter a new input name in the input field unter the inputs list the add button will be enabled. The edit buttons only work if only one list entry is selected and the delete button when at least one entry is selected.

The arrival checkbox at the opper right corner marks this element as the arrival element of the site. There can only be one element, and if you select this every other element that is also selected before will be reseted.

As the element name we use Start. We add an input gameid, an output gameid and an exit started.

After this the editor should show this figure.

Step 4 - Creating a element with a form

The next element we create is the Guess element. This element contains an input gameid, an output gameid and two exits start and success. But this element has also an form.

Switch to the Form Tab and select the Bean Form Definition Checkbox. The input field for the form name and the bean name will be enabled after this. As the form name we enter performGuess and as the bean name we use performGuessBean.

To add a field to the form click on the add button. This opens the dialog:

As the name we use guess and the type is int. We do not supply a default value for this.

The finished element is

Step 5 - Connecting the two elements

To connect a exit with an element, select the Screen Flow Connection-Tool and click on the source element and then on the destination element. This opens the dialog to select an exit.

After this a new connection between this two elements is shown.

To connect an ouput to an input on another element, select the Data Flow Connection-Tool and click again on the source and the destination element. This again opens a dialog where you can select the input and the output name.

After this we have both connection for this elements defined.

Step 6 - Creating the last element and make the project settings

In this Step we create the last element and make some settings for the generator.

The last element we create is the Success element. The resulting element should be .

After this we have to tell the Editor that we want to use this model for the generation. This is called the Master Model, because we want to add a subsite feature in the next versions. So you are able to split your site up.

Save the model file and click on it in the Package Explorer. Then select Model Editor/Mark as Master Model. This will set the file in the project properties. Go to the project settings of this project and click on Site Properties.

The final model should be

Step 7 - Starting the generation process

Ok, we are almost done with this tutorial. Last steps to (hopefully) success

If you have changed your file, save it ! This is a common error, the generator uses the saved file.

Ok, to start the generation you can use the red button in the eclipse toolbar, the menu point or the context menu. If you click on one of the a dialog pops up that warns you. So you do not start this accidently and overwrite all your things that are unprotected.

After this a Progress Dialog is shown and the everything is generated.

Ok, we are done for this first tutorial.