OpenAmeos tutorial. Contents. Author: Balázs Simon, BME IIT, 2012.

Transcription

1 OpenAmeos tutorial Author: Balázs Simon, BME IIT, Contents 1 Installing OpenAmeos Using OpenAmeos The OpenAmeos project directory Creating an OpenAmeos project Disabling Locking Modeling UML profile Use-case diagram Class diagram Sequence diagram Code generation

2 1 Installing OpenAmeos The UML tool called OpenAmeos will be used on the laboratory: Download version 10.2 for Windows and start the installer: 2

3 Accept the License Agreement: Click next on the following two windows: 3

4 Accept the default Standalone mode and click Next: 4

5 Leave the Repository Server field empty: Select an installation directory. Make sure that no spaces or special characters (e.g. accents) are in the path. E.g. choose: 5

6 Click next: Click Install: 6

7 Finally, exit the installer: 7

8 2 Using OpenAmeos When OpenAmeos is started it displays the following window where one can open a previously created project: We do not have any projects yet, so close this window with the Cancel button! 2.1 The OpenAmeos project directory The project directory is by default the Examples folder under the installation folder of OpenAmeos. This can be changed under the menu item Admin > Preferences : After making changes in this window, OpenAmeos must be restarted. Although OpenAmeos will ask whether it should restart itself, this functionality does not work, so it has to be restarted manually. 8

9 2.2 Creating an OpenAmeos project To create a new project, select the menu item File > New System...! Specify a name for the project (System Name), and select SQLite as Repository Server: After this window you can select which profiles to import. Select UMLStandard and click OK: On Windows Vista and Windows 7-8 the UAC (User Account Control) may appear multiple times (even times). Always allow this operation! 9

10 Finally, the following screen will appear: 10

11 2.3 Disabling Locking OpenAmeos supports collaborative work, however, when we are working alone, this is unnecessary. It is recommended to disable locking in this case. Select the menu item Admin > Ameos Utility and Locking from the drop-down box: Click OK and issue the commands status, disable, status, quit, quit in this order the console window: 11

12 2.4 Modeling A diagram may be created through multiple ways. For example a diagram of type X can be created as: File > New... > X menu item right click on the appropriate diagram type in the main window of OpenAmeos and select the New menu item select the appropriate diagram type in the main window of OpenAmeos, then right click on the list of diagrams and select the New menu item OpenAmeos identifies model elements by their names. This makes it possible to have the same model element on different diagrams. However, this functionality comes at a price: two different classes cannot have the same name even if they are in different packages UML profile If the UMLStandard profile could not be imported or we need to construct our own profile, we can create a UML profile. Then the following window will appear: 12

13 For example, if we would like to construct a simple UML profile so that the <<interface>> stereotype can be used on the class diagram, draw the following profile: Here there is a profile package called UML. Inside this package there is a meta class called UmlClass and a stereotype called interface which extends the meta class. Save this profile diagram and after this, the <<interface>> stereotype is available in the class diagram editor Use-case diagram Create a new use-case diagram. Then the following window appears: To draw a use-case or an actor, click on the appropriate icon and then on the drawing area. After this, you can give a name to the model element. This name can be changed if you click on the element and select the Rename... Systemwide... menu item. 13

14 To make sure that there are no name collisions, select Check Impact Of Systemwide Rename... instead: Now click Check Impact, and then OpenAmeos will check whether there will be no problems renaming this model element. If the renaming will succeed, it will offer to execute the rename operation: This is the safest way to rename our model elements. To draw inheritance, include, extend and communication, click on the appropriate icon on the toolbar, then click on the source model element and then on the target model element. When you are ready, save the diagram. It is recommended to save changes of the diagram frequently. 14

15 2.4.3 Class diagram Create a new class diagram. Then the following window will appear: The icons on the toolbar left behave similarly to the ones on the use-case diagram. Model elements belong to a package if they are positioned inside them physically. It is allowed to nest packages into each other. As it was mentioned earlier, make sure you do not have two different classes with the same name in different packages. The Properties window plays an important role in the class diagram. If it is not visible, it can always be showed by double clicking on any model element. 15

16 Create a class, give it a name and then bring up the Properties window by double clicking the class. Let's examine the various tabs in the Properties window: On the Class tab the general properties of a class can be set. E.g. whether it is abstract. On the Extensibility tab you can assign stereotypes to the model elements. E.g. to assign the <<interface>> stereotype to the class select the stereotype on the left and click on the arrow pointing to the right: Finally, click on the Apply button to apply the changes. From now on the class will behave as an interface. If the UMLStandard profile is not visible on the left, it is possible that we forgot to import it when we created the project, or the import was unsuccessful. In the former case go back to the main window of OpenAmeos, select the Profile diagram type, right click on it and choose the Import Profiles... menu item! In the dialog box select UMLStandard profile and click OK! If the UAC (User Account Control) appears, always allow the operation! In the latter case, i.e. the import was unsuccessful, create your own profile as described in section

17 Attributes and methods can be added to the class on the Members tab: Class Attr and Class Op mean that the attribute or the operation is static. By default neither of them is, however, after opening the drop-down list, this can be changed. The parameters of an operation can be specified according to the UML standard: they have to be separated by commas and for every argument the name must come first followed by a colon and the argument's type. The bottom of this tab is also important: The meaning of the small icons respectively: save table, insert new line above, insert new line below, delete current row, move current row up, move current row down. Using these icons the number and order of the attributes and operations can be changed. The tabs after the icons contain language specific settings. Before editing another model element, make sure to always click on Apply to save the settings of the current model element. The first tab for associations looks like: Here you can specify the role, multiplicity, qualifier, aggregation type and the navigability of the association's ends. 17

18 2.4.4 Sequence diagram Create a new sequence diagram. Then the following window appears: The icons on the left toolbar behave similarly to the ones on the other diagrams. Unfortunately, the sequence diagram is not yet UML 2 conform, there are no loop and alt model elements. OpenAmeos can connect model elements between different diagram types, too. Create for example an Actor element here on the sequence diagram, and leave its name empty. Then right click on the vertical line and select Choose Actor Symbol Name. From the list you can select an actor from a previously drawn use-case diagrams. The same method works with an object. Create an active or a passive object and leave its name empty. Right click on the vertical line and select Choose ActiveObject Symbol Name or Choose PassiveObject Symbol Name and select the type of the object from the list that contains the classes and interfaces from your class diagrams. By double clicking on the message arrows, their properties can also be edited. 18

19 2.5 Code generation OpenAmeos can generate code from the class diagrams. It is also capable of generating more than just a skeleton, and even the code generators are programmable. However, programming code generators are beyond this subject, but anyone interested can look into the templates\uml\tdl\languages subfolder of OpenAmeos. With OpenAmeos 10.2 the following code generators are shipped: For us only the Java code generator is interesting, but you can use the others for other projects. 19

20 Select the Java generator! Then the following parameters can be set for the generator: Under General Parameters the Output to line specifies the output folder of the generator. The Script Parameters group contains the Java-specific settings. The most important ones are: Visibility o DEF_CLASS_VISIB: default visibility for classes o DEF_ATTR_VISIB: default visibility for properties (attributes) o DEF_OP_VISIB: default visibility for operations Associations o DEF_COLL_CLASS: default collection class for association ends with multiplicity o DEF_ROLE_VISIB: default visibility of roles Constructors/Finalizer o CREATE_DEF_CTOR: whether to generate a default constructor o CREATE_FULL_CTOR: whether to generate a constructor for initializing properties o DEF_CTOR_VISIB: default visibility for constructors Operations o CREATE_DEF_RETURN: whether to generate default return variable for methods Additional Constructs o ACCESSOR_METHODS: whether to generate getter-setter methods for properties o CREATE_STANDARD_OPS: whether to generate tostring(), equals() and clone() When you are ready with the settings, right click on the Java generator and select Run Script. After this, the generated source codes are available in the output folder. 20

21 OpenAmeos makes it possible to modify the generated source code and preserve the changes on regeneration. The only requirement for this is that we only place our custom codes between special comments. E.g. a generated method looks like this: public double foo(int a, string b) { double retval = 0.0D; //#ACD# M(UDOP::UID_A3B383AC-98F0-4a70-A2A2-65E672D32137) ---- method body //user defined code to be added here... } //#end ACD# return retval; The retval variable is the default return value. If you do not want this to appear, you can disable it under the Operations / CREATE_DEF_RETURN property for the Java generator. The lines containing #ACD# and #end ACD# must not be deleted. Any program code between these will be preserved on regenerating the source code. Any changes outside these will be lost on regeneration. Change the source on some places and see what happens on regeneration! If you regenerated the code and some of your custom code is lost, you can still restore it for one step back from the.bak files. 21