This article describes how to get started with the UML2 plug-ins for Eclipse. In particular, it gives an overview of how to create models (and their contents) both programmatically and by using the sample UML editor.

This article describes how to get started with the UML2 plug-ins for Eclipse. In particular, it gives an overview of how to create models (and their contents) both programmatically and by using the sample UML editor.

−

'''Kenn Hussey and James Bruck''' <br> Last Updated: October 12, 2011

+

'''Kenn Hussey and James Bruck''' <br> Last Updated: January 21, 2014

= Prerequisites =

= Prerequisites =

−

To start using UML2 (and to follow along with the example in this article), you must have [http://www.eclipse.org/eclipse/ Eclipse], [http://www.eclipse.org/modeling/emf/?project=emf EMF], and [http://www.eclipse.org/modeling/mdt/?project=uml2 UML2] installed. You can either download the [http://www.eclipse.org/downloads/packages/eclipse-modeling-tools/indigosr1 Modeling Tools Package] or follow these steps:

+

To start using UML2 (and to follow along with the example in this article), you must have [http://www.eclipse.org/eclipse/ Eclipse], [http://www.eclipse.org/modeling/emf/?project=emf EMF], and [http://www.eclipse.org/modeling/mdt/?project=uml2 UML2] installed. You can either download the [http://www.eclipse.org/downloads/packages/eclipse-modeling-tools/lunam4 Modeling Tools Package] or follow these steps:

#Download and run Eclipse.

#Download and run Eclipse.

#Select the '''Help &gt; Install New Software…''' menu item.

#Select the '''Help &gt; Install New Software…''' menu item.

−

#Select a software site to work with, e.g., '''Indigo - http://download.eclipse.org/releases/indigo'''.

+

#Select a software site to work with, e.g., '''Luna - http://download.eclipse.org/releases/luna'''.

#Expand the '''Modeling''' tree item.

#Expand the '''Modeling''' tree item.

#Select '''UML2 Extender SDK''' and press the '''Next &gt;''' button.

#Select '''UML2 Extender SDK''' and press the '''Next &gt;''' button.

Line 28:

Line 28:

This article will walk you through the basics of creating models using UML2. Using a simple model (the ExtendedPO2 model, shamelessly “borrowed” from the EMF “bible” [1]) as an example, we’ll look at what’s involved in creating some of the more common elements that make up a model. For each type of element, we’ll first explain the creation process using the sample UML editor and then explore how to accomplish the same thing using Java code. The ExtendedPO2 model is shown below.

This article will walk you through the basics of creating models using UML2. Using a simple model (the ExtendedPO2 model, shamelessly “borrowed” from the EMF “bible” [1]) as an example, we’ll look at what’s involved in creating some of the more common elements that make up a model. For each type of element, we’ll first explain the creation process using the sample UML editor and then explore how to accomplish the same thing using Java code. The ExtendedPO2 model is shown below.

−

[[Image:GSWU2 Introduction.gif]]

+

[[Image:GSWU2 Introduction.png]]

= Getting Started =

= Getting Started =

+

+

[[Image:GSWU2 tip.gif]] Readers who don't want to follow every step of this tutorial may install a working solution from the '''New &rarr; Example...''' wizard, selecting the '''UML2 Example Projects &rarr; Getting Started with UML2''' sample. This will be available when [https://bugs.eclipse.org/bugs/show_bug.cgi?id=382342 Enhancement 382342] is resolved and released in a UML2 build. This includes the finished model, complete source code, and a launch configuration that runs the stand-alone Java application which creates the model in the root folder of the example project.

+

+

[[Image:GSWU2 ExampleWizard.png]]

Before getting started, you’ll need to create a simple project in your workspace. This project will serve as the container for the model that we’ll create using the UML editor. To create a simple project for this article, follow these steps:

Before getting started, you’ll need to create a simple project in your workspace. This project will serve as the container for the model that we’ll create using the UML editor. To create a simple project for this article, follow these steps:

Line 38:

Line 42:

#Select the '''File &gt; New &gt; Project...''' menu item.

#Select the '''File &gt; New &gt; Project...''' menu item.

#Select the '''Project''' wizard from the '''General''' category and press the '''Next &gt;''' button.

#Select the '''Project''' wizard from the '''General''' category and press the '''Next &gt;''' button.

−

#Enter a project name (i.e. “Getting Started with UML2”) and press the '''Finish''' button.

+

#Enter a project name (e.g. “Getting Started with UML2”) and press the '''Finish''' button.

At this point your workspace should look something like this:

At this point your workspace should look something like this:

Line 45:

Line 49:

OK, that should be enough to get us going with the UML editor. Now, to follow along with the programmatic approach to creating models, we’ll assume that you’ve created a class (named, say, “GettingStartedWithUML2”) in which you can write some code to construct our sample model. The code snippets we’ll show assume you’ve defined the following utility methods to give the user information on the program’s status:

OK, that should be enough to get us going with the UML editor. Now, to follow along with the programmatic approach to creating models, we’ll assume that you’ve created a class (named, say, “GettingStartedWithUML2”) in which you can write some code to construct our sample model. The code snippets we’ll show assume you’ve defined the following utility methods to give the user information on the program’s status:

−

<pre> public static boolean DEBUG = true;

+

<pre> public static boolean DEBUG = true;

−

+

−

protected static void out(String output) {

+

−

if (DEBUG) {

+

protected static void out(String format, Object... args) {

−

System.out.println(output);

+

if (DEBUG) {

−

}

+

System.out.printf(format, args);

−

}

+

if (!format.endsWith("%n")) {

+

System.out.println();

+

}

+

}

+

}

−

protected static void err(String error) {

+

protected static void err(String format, Object... args) {

−

System.err.println(error);

+

System.err.printf(format, args);

−

}

+

if (!format.endsWith("%n")) {

+

System.err.println();

+

}

+

}

</pre>

</pre>

A static debug flag can be used to enable or disable verbose information printed to the system’s output stream. Errors will always be printed to the system’s error stream.

A static debug flag can be used to enable or disable verbose information printed to the system’s output stream. Errors will always be printed to the system’s error stream.

−

All righty then! In each of the following subsections, we’ll look at how to create a different kind of UML element, starting with models.

+

All right, then! In each of the following subsections, we’ll look at how to create a different kind of UML element, starting with models.

= Creating Models =

= Creating Models =

Line 66:

Line 75:

At the root of a typical UML model is a model element. It contains a (hierarchical) set of elements that together describe the physical system being modeled. To create a model using the UML editor, follow these steps:

At the root of a typical UML model is a model element. It contains a (hierarchical) set of elements that together describe the physical system being modeled. To create a model using the UML editor, follow these steps:

−

#Select a project (i.e., '''Getting Started with UML2''') in the Project Explorer view and select the '''File &gt; New &gt; Other...''' menu item.

+

#Select a project (e.g., '''Getting Started with UML2''') in the Project Explorer view and select the '''File &gt; New &gt; Other...''' menu item.

#Enter a file name (i.e., “ExtendedPO2.uml”) and press the '''Next &gt;''' button.

+

#Enter a file name (e.g., “ExtendedPO2.uml”) and press the '''Next &gt;''' button.

#Select '''Model''' for the model object and press the '''Finish''' button.

#Select '''Model''' for the model object and press the '''Finish''' button.

#Select the '''Window &gt; Show View &gt; Properties''' menu item.

#Select the '''Window &gt; Show View &gt; Properties''' menu item.

#Select the '''&lt;Model&gt;''' element in the UML editor.

#Select the '''&lt;Model&gt;''' element in the UML editor.

−

#Enter a value (i.e., “epo2”) for the '''Name''' property in the '''Properties''' view.

+

#Enter a value (e.g., “epo2”) for the '''Name''' property in the '''Properties''' view.

At this point your workspace should look something like this:

At this point your workspace should look something like this:

Line 78:

Line 87:

[[Image:GSWU2 CreatingModels.png]]

[[Image:GSWU2 CreatingModels.png]]

−

<br>Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a model with a specified name.

+

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a model with a specified name.

−

<pre> protected static Model createModel(String name) {

+

<pre> protected static Model createModel(String name) {

−

Model model = UMLFactory.eINSTANCE.createModel();

+

Model model = UMLFactory.eINSTANCE.createModel();

−

model.setName(name);

+

model.setName(name);

−

+

−

out("Model '" + model.getQualifiedName() + "' created.");

+

out("Model '%s' created.", model.getQualifiedName());

−

+

−

return model;

+

return model;

−

}

+

}

</pre>

</pre>

First, we ask the UML factory singleton to create a model, and we set its name. Then, we output information to let the user know that the model has been successfully created. Finally, we return the model. You’ll notice most, if not all, of the code snippets in this article will follow this pattern – create the element (and set some properties on it), inform the user, and return it.

First, we ask the UML factory singleton to create a model, and we set its name. Then, we output information to let the user know that the model has been successfully created. Finally, we return the model. You’ll notice most, if not all, of the code snippets in this article will follow this pattern – create the element (and set some properties on it), inform the user, and return it.

Line 93:

Line 102:

OK, let’s see this method in action. For example, we could create a model named ‘epo2’ as follows:

OK, let’s see this method in action. For example, we could create a model named ‘epo2’ as follows:

−

<pre> Model epo2Model = createModel("epo2");

+

<pre> Model epo2Model = createModel("epo2");

−

</pre>

+

</pre>

+

= Creating Packages =

= Creating Packages =

A package is a namespace for its members (''packageable elements''), and may contain other packages. A package can import either individual members of other packages, or all of the members of other packages. To create a package using the UML editor, follow these steps:

A package is a namespace for its members (''packageable elements''), and may contain other packages. A package can import either individual members of other packages, or all of the members of other packages. To create a package using the UML editor, follow these steps:

−

#Select a package (e.g.,&nbsp;'''&lt;Package&gt;''' foo) in the UML editor.

+

#Select a package (e.g.,&nbsp;'''&lt;Package&gt; epo2''') in the UML editor.

#Enter a value (e.g., “bar”) for the '''Name''' property in the '''Properties''' view.

#Enter a value (e.g., “bar”) for the '''Name''' property in the '''Properties''' view.

−

We don’t actually need to create a package because our sample model doesn’t contain any… except of course for the root package (i.e., the model). That’s right – a model is a type of package.

+

We don’t actually need to create a package because our sample model doesn’t contain any &emdash; except of course for the root package (i.e., the model). That’s right: a model is a type of package.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a package with a specified name in a specified nesting package.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a package with a specified name in a specified nesting package.

Here, instead of asking the factory to create the package for us, we’re making use of one of the factory methods in the UML2 API. In UML2, a factory method exists for every feature that can contain other elements (i.e., every containment feature). In addition, more convenient factory methods exist for commonly created types (like packages). In this case, the package has a feature ('''packagedElement''') that can contain packageable elements, so we could obtain the Ecore class of the type of (packageable) element we want to create (i.e., '''Package''') from the UML Ecore package singleton, and pass it to the '''createPackagedElement(String, EClass)''' factory method. Instead, we use the more convenient '''createNestedPackage(String)''' factory method which implicitly creates a package and accepts the desired package name as an argument. Behind the scenes, the package will create a nested package, set its name, and add the package to its list of packaged elements.

Here, instead of asking the factory to create the package for us, we’re making use of one of the factory methods in the UML2 API. In UML2, a factory method exists for every feature that can contain other elements (i.e., every containment feature). In addition, more convenient factory methods exist for commonly created types (like packages). In this case, the package has a feature ('''packagedElement''') that can contain packageable elements, so we could obtain the Ecore class of the type of (packageable) element we want to create (i.e., '''Package''') from the UML Ecore package singleton, and pass it to the '''createPackagedElement(String, EClass)''' factory method. Instead, we use the more convenient '''createNestedPackage(String)''' factory method which implicitly creates a package and accepts the desired package name as an argument. Behind the scenes, the package will create a nested package, set its name, and add the package to its list of packaged elements.

OK, let’s see this method in action. For example, we could create a package named ‘bar’ in nesting package ‘foo’ as follows:

OK, let’s see this method in action. For example, we could create a package named ‘bar’ in nesting package ‘foo’ as follows:

A primitive type defines a predefined data type, without any relevant substructure. Primitive types used in UML™ itself include '''Boolean''', '''Integer''', '''Real''', '''String''', and '''UnlimitedNatural'''. To create a primitive type using the UML editor, follow these steps:

A primitive type defines a predefined data type, without any relevant substructure. Primitive types used in UML™ itself include '''Boolean''', '''Integer''', '''Real''', '''String''', and '''UnlimitedNatural'''. To create a primitive type using the UML editor, follow these steps:

−

#Select a package (i.e.,&nbsp;'''&lt;Model&gt; epo2''') in the UML editor.

+

#Select a package (e.g.,&nbsp;'''&lt;Model&gt; epo2''') in the UML editor.

#Enter a value (i.e., “int”) for the '''Name''' property in the '''Properties''' view.

+

#Enter a value (e.g., “int”) for the '''Name''' property in the '''Properties''' view.

[[Image:GSWU2 tryit.gif]] Create the remaining primitive types from the ExtendedPO2 model using the UML editor.

[[Image:GSWU2 tryit.gif]] Create the remaining primitive types from the ExtendedPO2 model using the UML editor.

Line 134:

Line 145:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a primitive type with a specified name in a specified package.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a primitive type with a specified name in a specified package.

#Enter a value (i.e., “Pending”) for the '''Name''' property in the '''Properties''' view.

+

#Enter a value (e.g., “Pending”) for the '''Name''' property in the '''Properties''' view.

[[Image:GSWU2 tryit.gif]] Create the remaining enumeration literals from the ExtendedPO2 model using the UML editor.

[[Image:GSWU2 tryit.gif]] Create the remaining enumeration literals from the ExtendedPO2 model using the UML editor.

Line 190:

Line 202:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an enumeration literal with a specified name in a specified enumeration.<br>

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an enumeration literal with a specified name in a specified enumeration.<br>

A class is a kind of classifier whose features are attributes (some of which may represent the navigable ends of associations) and operations. To create a class using the UML editor, follow these steps:

A class is a kind of classifier whose features are attributes (some of which may represent the navigable ends of associations) and operations. To create a class using the UML editor, follow these steps:

#Enter a value (i.e., “Supplier”) for the '''Name''' property in the '''Properties''' view.

+

#Enter a value (e.g., “Supplier”) for the '''Name''' property in the '''Properties''' view.

[[Image:GSWU2 tryit.gif]] Create the remaining classes from the ExtendedPO2 model using the UML editor.

[[Image:GSWU2 tryit.gif]] Create the remaining classes from the ExtendedPO2 model using the UML editor.

Line 220:

Line 232:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a(n) (abstract) class with a specified name in a specified package.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a(n) (abstract) class with a specified name in a specified package.

Here we call the '''createOwnedClass(String, boolean)''' convenience factory method to ask the package to create a class with the specified name as one of its packaged elements, and set the '''isAbstract''' attribute of the class based on the specified '''boolean''' argument.

Here we call the '''createOwnedClass(String, boolean)''' convenience factory method to ask the package to create a class with the specified name as one of its packaged elements, and set the '''isAbstract''' attribute of the class based on the specified '''boolean''' argument.

Line 233:

Line 245:

OK, let’s see this method in action. For example, we could create a non-abstract class named ‘Supplier’ in model ‘epo2’ as follows:

OK, let’s see this method in action. For example, we could create a non-abstract class named ‘Supplier’ in model ‘epo2’ as follows:

A generalization is a taxonomic relationship between a specific classifier and a more general classifier whereby each instance of the specific classifier is also an indirect instance of, and inherits the features of, the general classifier. To create a generalization using the UML editor, follow these steps:

A generalization is a taxonomic relationship between a specific classifier and a more general classifier whereby each instance of the specific classifier is also an indirect instance of, and inherits the features of, the general classifier. To create a generalization using the UML editor, follow these steps:

−

#Select a classifier (i.e., '''&lt;Class&gt; USAddress''') in the UML editor.

+

#Select a classifier (e.g., '''&lt;Class&gt; USAddress''') in the UML editor.

#Select a value (i.e., '''epo2::Address''') for the '''General''' property in the '''Properties''' view.

+

#Select a value (e.g., '''epo2::Address''') for the '''General''' property in the '''Properties''' view.

[[Image:GSWU2 tryit.gif]] Create the remaining generalizations from the ExtendedPO2 model using the UML editor.

[[Image:GSWU2 tryit.gif]] Create the remaining generalizations from the ExtendedPO2 model using the UML editor.

Line 252:

Line 264:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a generalization between specified specific and general classifiers.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a generalization between specified specific and general classifiers.

#Enter a value (i.e., "name”) for the '''Name''' property in the '''Properties''' view.

+

#Enter a value (e.g., "name”) for the '''Name''' property in the '''Properties''' view.

−

#Select a value (i.e., '''epo2::String''') for the '''Type''' property in the '''Properties''' view.

+

#Select a value (e.g., '''epo2::String''') for the '''Type''' property in the '''Properties''' view.

−

#Enter a value (i.e., 0) for the '''Lower''' property in the '''Properties''' view.

+

#Enter a value (e.g., 0) for the '''Lower''' property in the '''Properties''' view.

[[Image:GSWU2 tip.gif]] Lower and upper values for multiplicity elements (like properties) are represented as value specifications (first-class objects) in UML™ 2.x. The default value for lower and upper bounds is 1, unless a child value specification exists, in which case its value is used. Specifying a value for the lower or upper property will create a child value specification if none exists, or update its value if one does. Note that, to be treated as a bound, the lower value must be an integer and the upper value must be an unlimited natural.

[[Image:GSWU2 tip.gif]] Lower and upper values for multiplicity elements (like properties) are represented as value specifications (first-class objects) in UML™ 2.x. The default value for lower and upper bounds is 1, unless a child value specification exists, in which case its value is used. Specifying a value for the lower or upper property will create a child value specification if none exists, or update its value if one does. Note that, to be treated as a bound, the lower value must be an integer and the upper value must be an unlimited natural.

Line 290:

Line 302:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an attribute with a specified upper bound, lower bound, type, and name in a specified class.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an attribute with a specified upper bound, lower bound, type, and name in a specified class.

Here we call a '''createOwnedAttribute(String, Type, int, int)''' convenience factory method to ask the class to create a property as one of its owned attributes, set the type of the attribute to the specified type, and set the lower and upper bounds of the attribute (the factory method indirectly creates a literal integer and literal unlimited natural, respectively, and sets their values to the specified integer values).

Here we call a '''createOwnedAttribute(String, Type, int, int)''' convenience factory method to ask the class to create a property as one of its owned attributes, set the type of the attribute to the specified type, and set the lower and upper bounds of the attribute (the factory method indirectly creates a literal integer and literal unlimited natural, respectively, and sets their values to the specified integer values).

Line 321:

Line 321:

OK, let’s see this method in action. For example, we could create an attribute with multiplicity 0..1 of type ‘String’ named ‘name’ in class ‘Supplier’ as follows:

OK, let’s see this method in action. For example, we could create an attribute with multiplicity 0..1 of type ‘String’ named ‘name’ in class ‘Supplier’ as follows:

#Select a value (i.e., '''Composite''') for the '''Aggregation''' property in the '''Properties''' view.

+

#Select a value (e.g., '''Composite''') for the '''Aggregation''' property in the '''Properties''' view.

−

#Select a value (i.e., '''epo2::A_orders_supplier''') for the '''Association''' property in the '''Properties''' view.

+

#Select a value (e.g., '''epo2::A_orders_supplier''') for the '''Association''' property in the '''Properties''' view.

−

#Enter a value (i.e., "orders") for the '''Name''' property in the '''Properties''' view.

+

#Enter a value (e.g., "orders") for the '''Name''' property in the '''Properties''' view.

−

#Select a value (i.e., '''epo2::PurchaseOrder''') for the '''Type''' property in the '''Properties''' view.

+

#Select a value (e.g., '''epo2::PurchaseOrder''') for the '''Type''' property in the '''Properties''' view.

−

#Enter a value (i.e., 0) for the '''Lower''' property in the '''Properties''' view.

+

#Enter a value (e.g., 0) for the '''Lower''' property in the '''Properties''' view.

−

#Enter a value (i.e., *) for the '''Upper''' property in the '''Properties''' view.

+

#Enter a value (e.g., *) for the '''Upper''' property in the '''Properties''' view.

[[Image:GSWU2 tryit.gif]] Create the remaining associations from the ExtendedPO2 model using the UML editor.

[[Image:GSWU2 tryit.gif]] Create the remaining associations from the ExtendedPO2 model using the UML editor.

Line 354:

Line 354:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an association between two specified types, with ends that have the specified upper bounds, lower bounds, role names, aggregation kinds, and navigabilities.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an association between two specified types, with ends that have the specified upper bounds, lower bounds, role names, aggregation kinds, and navigabilities.

Here we call a convenience factory method on the first end type that creates an association (and its ends) between it and another type as one of its siblings (i.e. as a child of its package namespace) and with the specified upper bounds, lower bounds, role names, aggregation kinds, and navigabilities. The owners of the association ends (properties) are based on the specified navigabilities – navigable ends are owned by the end type if allowed, otherwise they are owned by the association; non-navigable ends are owned by the association.

Here we call a convenience factory method on the first end type that creates an association (and its ends) between it and another type as one of its siblings (i.e. as a child of its package namespace) and with the specified upper bounds, lower bounds, role names, aggregation kinds, and navigabilities. The owners of the association ends (properties) are based on the specified navigabilities – navigable ends are owned by the end type if allowed, otherwise they are owned by the association; non-navigable ends are owned by the association.

Line 419:

Line 394:

OK, let’s see this method in action. For example, we could create a unidirectional composition (composite association) between classes ‘Supplier’ and ‘PurchaseOrder’ in model ‘epo2’ as follows:

OK, let’s see this method in action. For example, we could create a unidirectional composition (composite association) between classes ‘Supplier’ and ‘PurchaseOrder’ in model ‘epo2’ as follows:

It’s that simple. Programmatically, we have a bit more work to do because so far, we’ve been creating our model in a vacuum, i.e. without a containing resource. The code snippet below shows a method that saves a specified package to a resource with a specified URI.

It’s that simple. Programmatically, we have a bit more work to do because so far, we’ve been creating our model in a vacuum, i.e. without a containing resource. The code snippet below shows a method that saves a specified package to a resource with a specified URI.

// Create a resource-set to contain the resource(s) that we are saving

−

resource.getContents().add(package_);

+

ResourceSet resourceSet = new ResourceSetImpl();

−

+

−

try {

+

// Initialize registrations of resource factories, library models,

−

resource.save(null);

+

// profiles, Ecore metadata, and other dependencies required for

−

out("Done.");

+

// serializing and working with UML resources. This is only necessary in

−

} catch (IOException ioe) {

+

// applications that are not hosted in the Eclipse platform run-time, in

−

err(ioe.getMessage());

+

// which case these registrations are discovered automatically from

−

}

+

// Eclipse extension points.

−

}

+

UMLResourcesUtil.init(resourceSet);

+

+

// Create the output resource and add our model package to it.

+

Resource resource = resourceSet.createResource(uri);

+

resource.getContents().add(package_);

+

+

// And save

+

try {

+

resource.save(null); // no save options needed

+

out("Done.");

+

} catch (IOException ioe) {

+

err(ioe.getMessage());

+

}

+

}

</pre>

</pre>

Here we create a resource set and a resource with the specified URI, add the package to the resource’s contents , and ask the resource to save itself using the default options. If an exception occurs, we notify the user via our handy utility method.

Here we create a resource set and a resource with the specified URI, add the package to the resource’s contents , and ask the resource to save itself using the default options. If an exception occurs, we notify the user via our handy utility method.

+

+

[[Image:GSWU2 tip.gif]] The above example uses the '''UMLResourcesUtil.init(...)''' API introduced in UML2 4.0.0 for Juno. As commented in the code snippet, this is not required in code running in the Eclipse Platform run-time, as in that case these registrations are discovered automatically from extension points.

OK, let’s see this method in action. For example, we could save the ‘epo2’ model to a resource with URI ‘ExtendedPO2.uml’ (relative to a URI passed in as an argument) as follows:

OK, let’s see this method in action. For example, we could save the ‘epo2’ model to a resource with URI ‘ExtendedPO2.uml’ (relative to a URI passed in as an argument) as follows:

[[Image:GSWU2 tip.gif]] The '''UMLResource.FILE_EXTENSION''' constant represents the file extension for UML resources ('''.uml'''). Note that the '''UMLResource''' interface contains a number of constants that you will find useful when working with UML resources.

+

[[Image:GSWU2 tip.gif]] The '''UMLResource.FILE_EXTENSION''' constant represents the file extension for UML resources ('''.uml'''). Note that the '''UMLResource''' interface contains a number of constants that you will find useful when working with UML resources.

= Conclusion =

= Conclusion =

Line 453:

Line 443:

Congratulations! If you’ve made it this far, you’ve successfully created a simple model programmatically and/or using the UML editor. There’s a whole lot more that could be said, but the purpose of this article was just to get you started. Stay tuned for more articles on how to develop tools with UML2.

Congratulations! If you’ve made it this far, you’ve successfully created a simple model programmatically and/or using the UML editor. There’s a whole lot more that could be said, but the purpose of this article was just to get you started. Stay tuned for more articles on how to develop tools with UML2.

−

For more information on UML2, visit the [http://www.eclipse.org/modeling/mdt/?project=uml2 home page] or join a discussion in the [http://www.eclipse.org/forums/eclipse.modeling.mdt.uml2 forum].

+

For more information on UML2, visit the [http://www.eclipse.org/modeling/mdt/?project=uml2 home page] or join a discussion in the [http://www.eclipse.org/forums/eclipse.modeling.mdt.uml2 forum].

+

+

The [http://www.eclipse.org/modeling/mdt/papyrus Papyrus Project] provides graphical support for UML, SysML and MARTE models. See the [[Papyrus_User_Guide | Papyrus User Guide]] for further information.

Summary

This article describes how to get started with the UML2 plug-ins for Eclipse. In particular, it gives an overview of how to create models (and their contents) both programmatically and by using the sample UML editor.

Kenn Hussey and James Bruck Last Updated: January 21, 2014

Prerequisites

To start using UML2 (and to follow along with the example in this article), you must have Eclipse, EMF, and UML2 installed. You can either download the Modeling Tools Package or follow these steps:

Accept the terms of the license agreement and press the Finish button.

Restart Eclipse when prompted to do so.

At this stage, UML2 and all dependencies should be installed.

Introduction

This article will walk you through the basics of creating models using UML2. Using a simple model (the ExtendedPO2 model, shamelessly “borrowed” from the EMF “bible” [1]) as an example, we’ll look at what’s involved in creating some of the more common elements that make up a model. For each type of element, we’ll first explain the creation process using the sample UML editor and then explore how to accomplish the same thing using Java code. The ExtendedPO2 model is shown below.

Getting Started

Readers who don't want to follow every step of this tutorial may install a working solution from the New → Example... wizard, selecting the UML2 Example Projects → Getting Started with UML2 sample. This will be available when Enhancement 382342 is resolved and released in a UML2 build. This includes the finished model, complete source code, and a launch configuration that runs the stand-alone Java application which creates the model in the root folder of the example project.

Before getting started, you’ll need to create a simple project in your workspace. This project will serve as the container for the model that we’ll create using the UML editor. To create a simple project for this article, follow these steps:

Select the Window > Open Perspective > Other… menu item.

Select the Resource perspective and press the OK button.

Select the File > New > Project... menu item.

Select the Project wizard from the General category and press the Next > button.

Enter a project name (e.g. “Getting Started with UML2”) and press the Finish button.

At this point your workspace should look something like this:

OK, that should be enough to get us going with the UML editor. Now, to follow along with the programmatic approach to creating models, we’ll assume that you’ve created a class (named, say, “GettingStartedWithUML2”) in which you can write some code to construct our sample model. The code snippets we’ll show assume you’ve defined the following utility methods to give the user information on the program’s status:

A static debug flag can be used to enable or disable verbose information printed to the system’s output stream. Errors will always be printed to the system’s error stream.

All right, then! In each of the following subsections, we’ll look at how to create a different kind of UML element, starting with models.

Creating Models

At the root of a typical UML model is a model element. It contains a (hierarchical) set of elements that together describe the physical system being modeled. To create a model using the UML editor, follow these steps:

Select a project (e.g., Getting Started with UML2) in the Project Explorer view and select the File > New > Other... menu item.

Select the UML Model wizard from the Example EMF Model Creation Wizards category and press the Next > button.

Enter a file name (e.g., “ExtendedPO2.uml”) and press the Next > button.

Select Model for the model object and press the Finish button.

Select the Window > Show View > Properties menu item.

Select the <Model> element in the UML editor.

Enter a value (e.g., “epo2”) for the Name property in the Properties view.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a model with a specified name.

First, we ask the UML factory singleton to create a model, and we set its name. Then, we output information to let the user know that the model has been successfully created. Finally, we return the model. You’ll notice most, if not all, of the code snippets in this article will follow this pattern – create the element (and set some properties on it), inform the user, and return it.

All named elements (a model is a type of named element) have a “simple” name and a qualified name. The qualified name is the “simple” name prefixed with the “simple” names of all of the named element’s containing namespaces. Note that the qualified name of a named element is only defined if all of its containing namespaces have non-empty “simple” names.

OK, let’s see this method in action. For example, we could create a model named ‘epo2’ as follows:

Model epo2Model = createModel("epo2");

Creating Packages

A package is a namespace for its members (packageable elements), and may contain other packages. A package can import either individual members of other packages, or all of the members of other packages. To create a package using the UML editor, follow these steps:

Enter a value (e.g., “bar”) for the Name property in the Properties view.

We don’t actually need to create a package because our sample model doesn’t contain any &emdash; except of course for the root package (i.e., the model). That’s right: a model is a type of package.

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a package with a specified name in a specified nesting package.

Here, instead of asking the factory to create the package for us, we’re making use of one of the factory methods in the UML2 API. In UML2, a factory method exists for every feature that can contain other elements (i.e., every containment feature). In addition, more convenient factory methods exist for commonly created types (like packages). In this case, the package has a feature (packagedElement) that can contain packageable elements, so we could obtain the Ecore class of the type of (packageable) element we want to create (i.e., Package) from the UML Ecore package singleton, and pass it to the createPackagedElement(String, EClass) factory method. Instead, we use the more convenient createNestedPackage(String) factory method which implicitly creates a package and accepts the desired package name as an argument. Behind the scenes, the package will create a nested package, set its name, and add the package to its list of packaged elements.

OK, let’s see this method in action. For example, we could create a package named ‘bar’ in nesting package ‘foo’ as follows:

Creating Primitive Types

A primitive type defines a predefined data type, without any relevant substructure. Primitive types used in UML™ itself include Boolean, Integer, Real, String, and UnlimitedNatural. To create a primitive type using the UML editor, follow these steps:

Enter a value (e.g., “int”) for the Name property in the Properties view.

Create the remaining primitive types from the ExtendedPO2 model using the UML editor.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a primitive type with a specified name in a specified package.

Enter a value (e.g., “Pending”) for the Name property in the Properties view.

Create the remaining enumeration literals from the ExtendedPO2 model using the UML editor.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an enumeration literal with a specified name in a specified enumeration.

Here we call a createOwnedLiteral(String) convenience factory method to ask the enumeration to create an enumeration literal with the specified name as one of its owned literals.

OK, let’s see this method in action. For example, we could create an enumeration literal named ‘Pending’ in enumeration ‘OrderStatus’ as follows:

createEnumerationLiteral(orderStatusEnumeration, "Pending");

Write code to programmatically create the remaining enumeration literals from the ExtendedPO2 model.

Creating Classes

A class is a kind of classifier whose features are attributes (some of which may represent the navigable ends of associations) and operations. To create a class using the UML editor, follow these steps:

Enter a value (e.g., “Supplier”) for the Name property in the Properties view.

Create the remaining classes from the ExtendedPO2 model using the UML editor.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a(n) (abstract) class with a specified name in a specified package.

Here we call the createOwnedClass(String, boolean) convenience factory method to ask the package to create a class with the specified name as one of its packaged elements, and set the isAbstract attribute of the class based on the specified boolean argument.

You may have noticed that we have been fully qualifying references to the Package and Class interfaces. This is recommended so that these types are not confused with java.lang.Class and java.lang.Package, which are imported implicitly in Java.

OK, let’s see this method in action. For example, we could create a non-abstract class named ‘Supplier’ in model ‘epo2’ as follows:

Write code to programmatically create the remaining classes from the ExtendedPO2 model.

Creating Generalizations

A generalization is a taxonomic relationship between a specific classifier and a more general classifier whereby each instance of the specific classifier is also an indirect instance of, and inherits the features of, the general classifier. To create a generalization using the UML editor, follow these steps:

Select a classifier (e.g., <Class> USAddress) in the UML editor.

Select the New Child > Generalization > Generalization option from the context menu.

Select a value (e.g., epo2::Address) for the General property in the Properties view.

Create the remaining generalizations from the ExtendedPO2 model using the UML editor.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns a generalization between specified specific and general classifiers.

Enter a value (e.g., "name”) for the Name property in the Properties view.

Select a value (e.g., epo2::String) for the Type property in the Properties view.

Enter a value (e.g., 0) for the Lower property in the Properties view.

Lower and upper values for multiplicity elements (like properties) are represented as value specifications (first-class objects) in UML™ 2.x. The default value for lower and upper bounds is 1, unless a child value specification exists, in which case its value is used. Specifying a value for the lower or upper property will create a child value specification if none exists, or update its value if one does. Note that, to be treated as a bound, the lower value must be an integer and the upper value must be an unlimited natural.

Create the remaining attributes from the ExtendedPO2 model using the UML editor.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an attribute with a specified upper bound, lower bound, type, and name in a specified class.

Here we call a createOwnedAttribute(String, Type, int, int) convenience factory method to ask the class to create a property as one of its owned attributes, set the type of the attribute to the specified type, and set the lower and upper bounds of the attribute (the factory method indirectly creates a literal integer and literal unlimited natural, respectively, and sets their values to the specified integer values).

The LiteralUnlimitedNatural.UNLIMITED constant represents the unlimited value for upper bounds (-1), as it does in EMF; when setting this value in the Properties view, an asterisk (‘*’) can alternatively be specified.

OK, let’s see this method in action. For example, we could create an attribute with multiplicity 0..1 of type ‘String’ named ‘name’ in class ‘Supplier’ as follows:

createAttribute(supplierClass, "name", stringPrimitiveType, 0, 1);

Write code to programmatically create the remaining attributes from the ExtendedPO2 model.

Creating Associations

An association specifies a semantic relationship that can occur between two or more typed instances; its ends are represented by properties, each of which is connected to the type of the end. When a property is owned by an association it represents a non-navigable end of the association, in which case the type of the property is the type of the association end.

The notion of association end navigability was separated from that of ownership in the UML™ 2.0 specification, so a property that is owned by an association isn’t necessarily non-navigable as of UML2 2.0.

Select a value (e.g., Composite) for the Aggregation property in the Properties view.

Select a value (e.g., epo2::A_orders_supplier) for the Association property in the Properties view.

Enter a value (e.g., "orders") for the Name property in the Properties view.

Select a value (e.g., epo2::PurchaseOrder) for the Type property in the Properties view.

Enter a value (e.g., 0) for the Lower property in the Properties view.

Enter a value (e.g., *) for the Upper property in the Properties view.

Create the remaining associations from the ExtendedPO2 model using the UML editor.

At this point your workspace should look something like this:

Let’s look at how to perform the same task using Java code. The code snippet below shows a method that programmatically creates and returns an association between two specified types, with ends that have the specified upper bounds, lower bounds, role names, aggregation kinds, and navigabilities.

Here we call a convenience factory method on the first end type that creates an association (and its ends) between it and another type as one of its siblings (i.e. as a child of its package namespace) and with the specified upper bounds, lower bounds, role names, aggregation kinds, and navigabilities. The owners of the association ends (properties) are based on the specified navigabilities – navigable ends are owned by the end type if allowed, otherwise they are owned by the association; non-navigable ends are owned by the association.

The NamedElement.SEPARATOR constant represents the standard separator (::) used in qualified names.

OK, let’s see this method in action. For example, we could create a unidirectional composition (composite association) between classes ‘Supplier’ and ‘PurchaseOrder’ in model ‘epo2’ as follows:

Write code to programmatically create the remaining associations from the ExtendedPO2 model.

Saving Models

Now that we’ve spent all this time creating a model, we’d better save our work. When we created our model using the UML model wizard, a UML resource was created for us, so now all that needs to be done is to serialize the contents of our model as XMI to our file on disk (i.e., ExtendedPO2.uml). To save a model using the UML editor, follow these steps:

Select the File > Save menu item.

It’s that simple. Programmatically, we have a bit more work to do because so far, we’ve been creating our model in a vacuum, i.e. without a containing resource. The code snippet below shows a method that saves a specified package to a resource with a specified URI.

Here we create a resource set and a resource with the specified URI, add the package to the resource’s contents , and ask the resource to save itself using the default options. If an exception occurs, we notify the user via our handy utility method.

The above example uses the UMLResourcesUtil.init(...) API introduced in UML2 4.0.0 for Juno. As commented in the code snippet, this is not required in code running in the Eclipse Platform run-time, as in that case these registrations are discovered automatically from extension points.

OK, let’s see this method in action. For example, we could save the ‘epo2’ model to a resource with URI ‘ExtendedPO2.uml’ (relative to a URI passed in as an argument) as follows:

The UMLResource.FILE_EXTENSION constant represents the file extension for UML resources (.uml). Note that the UMLResource interface contains a number of constants that you will find useful when working with UML resources.

Conclusion

Congratulations! If you’ve made it this far, you’ve successfully created a simple model programmatically and/or using the UML editor. There’s a whole lot more that could be said, but the purpose of this article was just to get you started. Stay tuned for more articles on how to develop tools with UML2.

For more information on UML2, visit the home page or join a discussion in the forum.