Jump to Menu

UML Getting Started - UML Modeling in Eclipse

Eclipse is truly one of the best integrated development environment (IDE). To many software developers, Eclipse was the first IDE they ever used for serious software development. Eclipse is easy to use, and it comes with a lot of useful features to make implementation faster and more accurate, ultimately improving efficiency and software stability.

Compatible edition(s): Enterprise, Professional, Standard

  • March 03, 2016
  • Views: 143,108
  • PDF

Visual Paradigm is an agile development platform that provides software developers with the wide variety of toolset they need for designing great software products. It supports a collection of widely-used modeling notations, such as UML, ERD and BPMN and more. Software developers can either run Visual Paradigm in standalone manner, or to run it in embedded extension within the IDE. With this Eclipse UML tool, developers can perform visual modeling and other agile development activities within a unified Eclipse IDE platform.

In this tutorial, you will walk through the steps required to integrate Visual Paradigm with Eclipse. The second part of the tutorial will demonstrate the automatic generation of Java code from UML class diagram.

Preparation

In order to follow this tutorial, you must have Visual Paradigm installed, which can be downloaded from Visual Paradigm download page. Besides, you also need the Eclipse platform, which can downloaded at the Eclipse official site.

Installing Visual Paradigm in Eclipse

  1. In Visual Paradigm, select Window > Integration > IDE Integration... from the application toolbar.
    To instasll IDE Integration
  2. In the Visual Paradigm IDE Integration window, check Eclipse Integration.
    Select Eclipse integration
  3. Click Next.
  4. Enter the path of Eclipse and click Next.
    Specify Eclipse path
    This begins files copying. If you see the error messages "java.io.IOException: Cannot make dirs for file...", please restart Visual Paradigm with the Run as Administrator option. When finished files copying, close Visual Paradigm and move on to the next section to see how to create a Java project in Eclipse along with UML model.

Creating a Java Project

  1. Start Eclipse.
  2. Select File > New > Java Project from the main menu to open the New Java Project window.
  3. In the New Java Project window, enter My Project in the Project name field.
    New Java project
  4. Click Finish.

Creating a UML Model for the Java Project

Now, you have an empty Java project. Let's create a UML model for it. To create a UML model:

  1. Right-click on the project node in Package Explorer and select Open Visual Paradigm from the popup menu.
    Opening Visual Paradigm from Eclipse
  2. If you see the VM Requirement dialog box, please keep the option Configure "eclipse.ini" and restart eclipse selected and click OK to restart Eclipse, and then re-perform the previous step to open Visual Paradigm.
    Configure eclipse.ini
  3. Click OK when you are prompted to select a path to store the .vpp file.
    Confirm project path

UML Modeling in Eclipse

Let's draw a simple class diagram. We will generate Java code from it in the next section.

  1. In Diagram Navigator, right-click on Class Diagram node and select New Class Diagram from the popup menu.
    New class diagram
  2. A new diagram is created. Double click on the package header field at the top left corner of the diagram, with a labeled <default package> in it.
    To enter package header
  3. Enter myapp and press Enter. From now on classes to be drawn in this diagram will be placed in a (new) package named myapp. In practice you can also enter a nested package structure like com.vp.myapp.
    Entering package header
  4. Create a class. Select Class from the diagram toolbar. Drag it out and put it onto the diagram. Enter User as name and press Enter to confirm.
    Create class
  5. A user has two attributes: name and phone number. Let's add them. Right-click on the User class and select Add > Attribute from the popup menu.
    Adding attribute to class
  6. Enter name : String to create the name attribute in String type. Then press Enter to confirm.
  7. Similarly, enter phoneNum : int to create the phoneNum attribute in int type. Then press Enter to confirm it and press Esc to cancel the next attribute.
    Class created
  8. We want Visual Paradigm to generate getter and setter for the attributes during code generation. Right-click on the name attribute and select Create Getter and Setter from the popup menu.
    Create getter and setter
  9. Repeat the previous step on the attribute phoneNum. Up to now, your class diagram should look like this:
    Getters and setters created

Generate Java Code from UML Class

Let's produce Java source code from the UML class. There are several ways to achieve this. Here let's try the one that generate code for the entire UML model. Click on the Update Code button at the top of Diagram Navigator.


Update code

In the Package Explorer, expand the project node and the src folder node. The package myapp and User class are there. Open User.java. You can see the User class filled with attributes and its getter and setter.


Java code generated

Perform Coding

In this section, you are going to build an executable application with the User class.

  1. Create a Main class. In the Package Explorer, right-click on the package myapp and select New > Class from the popup menu.
  2. In the New Java Class window, enter Main as class name and click Finish.
    New Java class
  3. Create a static main method in the Main class that create and instantiate two User objects. Set the name and phone number through the setter.
    Code modified
  4. It would be nice to add into the User class a method to print out its name and phone number. Add a public method printInfo() in the User class.
    Method added
  5. Call printInfo() from the Main class to display the information of created users.
    New methoed called

Running the Application

Let's run the application. Keep the Main class opened. Select Run > Run As > Java Application from the main menu. You should see the Console view appear with users' information printed in it.


Console output

Updating the UML Model from Java Code

You have made some changes in source code, such as the creation of Main class and printInfo() in User class. In order to keep the design consistent with your source code, you need to update the UML model from code. Let's do it now.

  1. In the Eclipse toolbar, click on the Update UML Model button.
    Update UML model
  2. Open the class diagram. The printInfo() method is presented in the User class.
    UML class updated
  3. For the Main class, you can find it under the Model Explorer. Drag it out and put it below the User class.
    Class visualized


Turn every software project into a successful one.

We use cookies to offer you a better experience. By visiting our website, you agree to the use of cookies as described in our Cookie Policy.

OK