Skip to main content
diff options
Diffstat (limited to 'plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/profile.html')
1 files changed, 0 insertions, 3 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/profile.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/profile.html
deleted file mode 100644
index d20358f0f02..00000000000
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/profile.html
+++ /dev/null
@@ -1,3 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" ""><html xmlns=""><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><h1 id="Introduction">Introduction</h1><p>The purpose of this chapter is to provide the Papyrus users all the documentation needed in order to be able to use UML profiles. It includes the information for modeling and defining a profile using the Papyrus UML profile editor, but also the information for the usage of a profile within a user application model.</p><p>The basic premise of profiles is that all domain-specific concepts are derived as extensions or refinements of existing UML concepts, called UML metaclasses. These extensions are called stereotypes. A stereotype definition must be consistent with the abstract syntax and semantics of standard UML meta-classes it extends. Consequently, a profile-based model can be created and manipulated by any tool that supports standard UML. Moreover, because the concepts underlying a profile are specializations of existing UML concepts, it is more easily learned by anyone with knowledge of UML.</p><p>A stereotype is defined either as an extension of a UML base metaclass or as a specialization of an existing stereotype. The extension relationship of UML is not an association but a kind of association directed from the stereotype to the extended metaclass. Consequently, the metadata conveyed by the associated the attributes of the stereotype are associated to the extended metaclass in a transparent manner for the metaclass itself. This allows profiles owning the stereotypes to be applied and removed dynamically without modifying the underlying models — a fundamental feature of the profile mechanism.</p><p>A stereotype may have attributes and may be associated with other stereotypes or existing UML metaclasses.</p><p>Constraints, such as OCL constraints, can also be defined in a profile. They can apply to stereotypes defined in the profile or those imported by the profile. They can also be used to further constrain elements of the UML metamodel. For instance, one could define an OCL constraint that all instances of Class in a model are active, or that all instances of Class must have at least one Operation (regardless of whether the Class is extended by a stereotype or not). However, not all constraints can be written in OCL. In that case, it is common to denote those latter in natural language. The drawback is that such constraints are no more automatically interpretable and need to be first rewritten in some language the UML tool will understand. In the context of Papyrus, it is then usual to use Java.</p><h1 id="Profile_Creation_and_Modeling">Profile Creation and Modeling</h1><h2 id="Profile_Creation">Profile Creation</h2><p>To create a new Profile, select File &gt; New &gt; Papyrus Project (Or Papyrus model, if you already have an opened project). When asked for a Diagram Language, Select "Profile":</p><p><img title="New Profile" alt="New Profile" border="0" src="images/newProfile.png"/><br/></p><p><img title="New Profile Diagram" alt="New Profile Diagram" border="0" src="images/newProfileDiagram.png"/><br/></p><p><img title="Profile Editor" alt="Profile Editor" border="0" src="images/profileEditor.png"/><br/></p><h2 id="Stereotype_Definition">Stereotype Definition</h2><p>Once a profile has been created, it is now time to populate this latter with UML extensions, i.e. stereotypes, and their related concepts such as properties, extensions, and metaclasses.</p><h3 id="Stereotype_Creation">Stereotype Creation</h3><p>A stereotype is created as any other UML model elements in Papyrus: select the related tool in the palette of the profile diagram editor, and then click in the place you want to create this element on the background of the diagram. If the palette is not open, just click on the small arrow on the upper right corner of the diagram editor. Papyrus will then ask you to provide a name. Once done, hit the return key and that all.</p><p><img title="Stereotype Palette" alt="Stereotype Palette" border="0" src="images/stereotypePalette.png"/><br/></p><p><img title="Stereotype Name" alt="Stereotype Name" border="0" src="images/stereotypeName.png"/><br/></p><h3 id="Metaclass_Import">Metaclass Import</h3><p>Once you have created a stereotype, you need to import the UML2 metaclasses you want to extend. First, you have to select the tool “Import Metaclass” within the palette of the profile diagram editor. Then, let’s click on the profile diagram where you want to drop the imported metaclass. A Papyrus dialog box is then opened in order to ask you to specify which metaclasses you want to import. Select the metaclasses in the left list and either drag and drop these latter in the right list or press the button with arrow directed from left to right and located between both aforementioned lists. Then, let’s press the button “ok” and it is done. The imported metaclasses are then shown in the diagram as illustrated.</p><p><img title="Import Metaclass" alt="Import Metaclass" border="0" src="images/importMetaclassDialog.png"/><br/></p><p><img title="Imported Metaclass" alt="Imported Metaclass" border="0" src="images/importedMetaclass.png"/><br/></p><p>Note: When you import UML2 metaclasses, Papyrus is creating ImportElement model element referent to the metaclasses of the UML2 metamodel itself. Those so-called specific model elements, the ImportElement, are indeed a kind of proxy to the model elements contained in another model, in the UML2 metamodel. If a metaclass has already be imported, you do not need to import it again to use it in another context. You can select the imported meta-class from the model browser and drag and drop this latter on the diagram you want to use it.</p><h3 id="Extension_Creation">Extension Creation</h3><p>Once the stereotype is created and the meta-class is imported, you may then model the extension relation from the stereotype to the meta-class as shown in the following figure. The extension relationship is modeled using the extension tool in the profile diagram palette, <img title="Extension" alt="Extension" border="0" src="images/Extension.gif"/>. Within the diagram shown in next figure, both stereotypes «Requirement» and «Refinement» extend respectively both meta-classes Class and Dependency:</p><p><img title="Metaclass Extension" alt="Metaclass Extension" border="0" src="images/metaclassExtension.png"/><br/></p><h3 id="Subprofile_Creation">Subprofile Creation</h3><p>Some profile may be complex due as for example to their scope that may be large. In order to cope with this complexity, it is then possible to decompose a profile into a hierarchy of subprofiles. A subprofile behaves such as a sub-package; it is a container of stereotypes.</p><p>To create a sub profile, select the profile tool in the profile diagram palette (<img title="Profile" alt="Profile" border="0" src="images/Profile.gif"/>) and then click on the profile diagram where you want to create your new profile.</p><p>In the example denoted below, we have created two sub-profiles of the SimplifiedReqML profile in order to gather in one hand the extensions that apply to node elements of the models and in the other hand the extension defined in the DSML for modeling relationships between those nodes:</p><p><img title="Sub Profiles" alt="Sub Profiles" border="0" src="images/subProfiles.png"/><br/></p><h3 id="Stereotype_Generalization">Stereotype Generalization</h3><p>When designing a profile, it is possible to reuse existing stereotypes defined in other existing profiles. Stereotypes can indeed be generalized enabling to create child stereotypes that inherit features of one or more generalized stereotype define either locally in the profile or externally other profiles.</p><p>To create a stereotype generalization using the profile diagram editor, let’s draw a generalization relationship using the tool <img title="Generalization" alt="Generalization" border="0" src="images/Generalization.gif"/> from the palette. As any relationship within Papyrus, you need to click first on the source and then on the target of the relationship you want to model.</p><p>In our example, there exists in the UML predefined profile a stereotype extending the dependency relationship in order to introduce the concept of refinement: «Refine». Consequently, we will redesign our sub-profile SRMLRelationship in order our stereotype «Refinement» to be a specialization of this UML stereotype instead of directly extending the UML dependency meta-class.</p><p>As previously mentioned, you may extend a stereotype defined in your profile or a stereotype defined in another external profile. In the latter case, the first thing to do is to import the profile where the stereotype has been defined, as denoted in the following example:</p><p><img title="Import Profile" alt="Import Profile" border="0" src="images/importProfile.png"/><br/></p><p><img title="Select Profile" alt="Select Profile" border="0" src="images/selectProfile.png"/><br/></p><p>Once the profile has been imported, you can select the stereotype you want to generalize from the imported profile (In the Model Explorer) and drop this latter in the diagram of profile description: </p><p><img title="Drop Stereotype" alt="Drop Stereotype" border="0" src="images/dropStereotype.png"/><br/></p><p>Now, let’s draw the generalization relationship from your stereotype (e.g., «Refinement» in the figure below) to the generalized stereotype (e.g., «Refine» in the figure below). </p><p><img title="Generalize Stereotype" alt="Generalize Stereotype" border="0" src="images/generalizeStereotype.png"/><br/></p><p>At this point, your diagram should look like something like the one shown here:</p><p><img title="Result Profile" alt="Result Profile" border="0" src="images/resultProfile.png"/><br/></p><h2 id="Stereotype_display_options">Stereotype display options</h2><p>When a stereotype application is shown in a diagram, the by-default way to show it within diagrams is using a string where the name of the stereotype is shown within a pair of French guillemets above or before the name of the model element. However, it is also possible to modify the graphical appearance of the annotated model element using icons. If the graphical representation of the model element is something like a box (including ellipse of the use cases), the icons can be displayed inside and on top of the figures, or it may replace this latter. In that latter case, the property of the element cannot be shown and the name of the model element appears within a label displayed near the icon. If the model element is graphically denoted by a line, the icon is shown in front of the name of the link.</p><p>In order to specify the icons you want to attach to a stereotype, select the stereotype and the tab UML of the property view. In the right-upper corner of the widget named “icons”, press the button <img title="Add" alt="Add" border="0" src="images/Add.gif"/> to add a new icon as shown in step 1. Once done, the dialog box shown at step 2 is open. Within this latter, let’s fill in a name and select an image file using the button <img title="Add" alt="Add" border="0" src="images/Add.gif"/> defining the content of the icon. Next, you have to define the kind value: icon or shape. Using this property, you can choose to associate the selected image either as an icon or as a shape.</p><p><img title="Step 1: Icons for Stereotypes" alt="Step 1: Icons for Stereotypes" border="0" src="images/iconsForStereotype.png"/><br/></p><p><img title="Step 2: Select Icon" alt="Step 2: Select Icon" border="0" src="images/selectIcon.png"/><br/></p><p>It is possible to associate only one shape to a stereotype, but you can associate different icons to a same stereotype. In that latter case, there is a description property that is used to select which one to display. By default, if no expression is defined, the first one is the list is chosen for displaying. The expression has to be on a property of the stereotype which type is an enumeration type.
-In our example, we can set different icons to the stereotype «Requirement» depending on the value of its importance property. This latter is indeed typed by the ImportanceLevel enumeration which values may be High, Medium of Low (figure shown below). For this example, we will then associate the three following images <img title="High" alt="High" border="0" src="images/high.png"/>, <img title="Medium" alt="Medium" border="0" src="images/medium.png"/>, and <img title="Low" alt="Low" border="0" src="images/low.png"/>, to the stereotype «Requirement» and their related expression will be respectively importance=High (e.g. figure shown below), importance=Medium and importance=Low.</p><p><img title="Many Stereotype Icons" alt="Many Stereotype Icons" border="0" src="images/manyStereotypeIcons.png"/><br/></p><p><img title="Icon Kind" alt="Icon Kind" border="0" src="images/iconKind.png"/><br/></p><p><img title="Icon Expressions" alt="Icon Expressions" border="0" src="images/iconExpressions.png"/><br/></p><p><img title="High Req. Icon" alt="High Req. Icon" border="0" src="images/highReqIcon.png"/><br/></p><h1 id="Profile_Definition_and_Export">Profile Definition and Export</h1><p>Once a profile has been modeled, we need to define it before being able to apply it on user models. The definition of a profile consists in:</p><p><i>“When defining a dynamic profile representation, the contents of a profile are converted to an equivalent Ecore format that is stored as an annotation on the profile. Then, when a profile and its stereotypes are applied to a model and its elements, dynamic EMF (see the EMF book for details) is used to store property values for the stereotypes. For the most part, you can ignore this complexity, as long as you remember to define your profile before using it.”</i></p><p>(This definition has been extracted from <a href="/wiki/" title=""></a>)</p><p><i>PS: The implementation of profile support in the UML2 component of MDT supports defining both dynamic and static profile representations. In this the document, we will focus on dynamic profiles.</i></p><p>To define a profile within Papyrus, you just need to save it doing as for example following actions: either through the menu bar action File &gt; Save or using the key shortcut “CTRL S”.
-Let’s notice, that it is not mandatory to define a profile each time you save it. If you do not want to define your profile when saving it, just answer no to the related question asked by Papyrus when saving profile modifications. However, if you want to apply the modifications you have done on a given profile, this you have to define it again in order the modifications may be taken into account at the user model level.</p><p><img title="Profile Definition" alt="Profile Definition" border="0" src="images/profileDefinition1.png"/><br/></p><p><img title="Profile Definition" alt="Profile Definition" border="0" src="images/profileDefinition2.png"/><br/></p><p>Note: If the profile contains errors (Such as an untyped Property or unnamed Stereotype), you won't be able to define it. However, it can still be saved. In such a case, a Diagnostic dialog displays all the validation errors preventing the profile from being defined.</p><p><img title="Profile Definition Errors" alt="Profile Definition Errors" border="0" src="images/profileDefinitionErrors.png"/><br/></p><h1 id="Profile_Application_and_Usage">Profile Application and Usage</h1><p>Once a profile has been designed and defined as previously explained, it now times to use it. The first step to process is to apply the profile on your model or a part of the model. This is the purpose of the next section to explain this first step. Then, we will explain how to use the applied profile and mainly how to use its extensions, i.e. its stereotypes.</p><h2 id="Applying_a_Profile">Applying a Profile</h2><p>To apply a profile, first you need to open your model.</p><p>The first step consists in selecting the part of the model you want to apply the profile on. Profiles can be applied either on Models or Packages. Then to apply the profile on this part, let’s select the profile tab in the property view, and press the <img title="Apply Profile" alt="Apply Profile" border="0" src="images/Add.gif"/> button.</p><p><img title="Select Package" alt="Select Package" border="0" src="images/applyProfile.png"/><br/></p><p><img title="Profile Tab" alt="Profile Tab" border="0" src="images/applyProfile2.png"/><br/></p><p><img title="Apply Profile" alt="Apply Profile" border="0" src="images/applyProfile3.png"/><br/></p><p>Then, Papyrus will ask you firstly to choose the profile to apply from your workspace, and secondly to choose which part of the selected profile you want to apply. It is indeed possible that your profile may be composed of sub-profiles as explained in the previous chapter. It is then possible to apply partially a profile by applying one or more of its sub-profiles.</p><p><img title="Select Profile" alt="Select Profile" border="0" src="images/selectProfileModel.png"/><br/></p><p><img title="Select Profiles" alt="Select Profiles" border="0" src="images/selectProfiles.png"/><br/></p><p>Your model should now look like this:</p><p><img title="Applied Profiles" alt="Applied Profiles" border="0" src="images/appliedProfiles.png"/><br/></p><h2 id="Using_the_Stereotypes_of_a_Profile">Using the Stereotypes of a Profile</h2><p>Once the profile is applied on you model, its extensions, i.e. stereotypes, are available in the modeling tool and can be used in your model to annotate it.</p><h3 id="Applying_a_Stereotype">Applying a Stereotype</h3><p>To annotate a model element, you first need to select it either through the model explorer or in one open diagram. Then, select the tab named “profile” in the properties view, and add your stereotype using the <img title="Apply Profile" alt="Apply Profile" border="0" src="images/Add.gif"/> button of the widget named “Applied stereotypes”</p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype2.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype3.png"/><br/></p><p>A dialog box enables you to select the stereotype(s) you want to apply (left part of the dialog box) and using the <img title="Add" alt="Add" border="0" src="images/arrow_right.gif"/> button located in the middle of the dialog box enables to define which stereotypes have to be applied. The list located on the right of the dialog box denotes the list of applied stereotype. If you want to unapply stereotypes, you can select those latter from the right list and use the <img title="Remove" alt="Remove" border="0" src="images/arrow_left.gif"/> button to unapply them.</p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype4.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype5.png"/><br/></p><p>At this point, your Papyrus should look like this:</p><p><img title="Applied Stereotype" alt="Applied Stereotype" border="0" src="images/appliedStereotype.png"/><br/></p><h3 id="Assigning_values_to_properties_of_stereotypes">Assigning values to properties of stereotypes</h3><p>As already mentioned, Stereotypes may have properties. Consequently, when applying a stereotype to a model element, it may be necessary to set the values of those properties. For that, you will go to the profile tab of the properties view and then you can unfold the stereotype application as shown in following figure:</p><p><img title="Stereotype Properties" alt="Stereotype Properties" border="0" src="images/stereotypeProperties.png"/><br/></p><p>Once you have selected the property to edit, its value (if already set, as for example if there is a default value defined in the profile for the property) appear in the right part of the property view. If the property has not yet been valued, you can add a value by using the <img title="Add" alt="Add" border="0" src="images/add.gif"/> button located on the top right of the widget named “Properties values”. If there is a value, double-click on the value to edit this latter.</p><p><img title="Edit Property" alt="Edit Property" border="0" src="images/stereotypePropertyEdition.png"/><br/></p><p>Ps: If you want to delete a value set to property, let’s use the <img title="Delete" alt="Delete" border="0" src="images/Delete.gif"/> button located on the top right of the widget named “Properties values”.</p><h3 id="Display_options_of_a_stereotype_application">Display options of a stereotype application</h3><p>Stereotype applications may be graphically rendered under different forms, either textually, or using specific icons. Details to specify those icons associated to a stereotype are given in previous chapters (See <a href="#Stereotype_display_options">Stereotype display options</a>).</p><p>Let’s remind that in UML, you can apply several stereotypes on a same model element. In Papyrus, it is then possible to select the ones you want to show for each diagram. For showing or hiding a stereotype application, you have to select the tab “appearance” in the properties view. As shown in the next figure, there is one widget named “Applied stereotypes” that denotes the list of stereotypes applied on the current selected model element. On the example illustrated within this figure, you can see on the upper corner of the icon placed in front of the stereotype name “Requirement” an overlay denoting that this stereotype application is shown.</p><p><img title="Stereotype Display" alt="Stereotype Display" border="0" src="images/stereotypeDisplayOptions.png"/><br/></p><p><i>Warning: Let’s notice that the appearance tab of the property view is only visible if you select a model element from one of the open diagram. In other case, if you select the model element from the model explorer, the concept of graphical does not make sense because the information specified within this view are only related to graphical information.</i></p><p><i>Consequently, the values set to the appearance properties of model element are valid only in the context of the diagram where the element is selected. It is then possible to show a stereotype on a diagram and hide it in another diagram depending on the concerns of the view realized by the diagram.</i></p><p>To hide or show stereotype applications, you have to select them from the list of applied stereotypes available within the appearance tab and then either press the <img title="Display qualified name" alt="Display qualified name" border="0" src="images/ConsoleViewQN.gif"/> button or <img title="Display" alt="Display" border="0" src="images/change_display.gif"/>.</p><p>The former is to be used if you want to display the stereotype application with its qualified name, and the latter is to be used if you want to show it without qualified name. Using one of both depends if you may have ambiguities or not on the origin of the stereotype when as for example applying several profiles defining similar stereotypes. As for example, both profiles, MARTE and SysML, define a stereotype named «FlowPort».</p><p>In addition, there are three other widgets dedicated to configure the stereotype display options:</p><ul><li>“Stereotype display” is an enumeration which values may be Text, Icon, Text and Icon or Shape. In UML, as explained previously, a stereotype may be denoted either as a string between a pair of French guillemets (e.g., «Requirement»), or as an icon embedded in the figure or as a shape with a label. In case of the shape option, it substitutes the normal graphical figure used to represent the element and its label denotes the name of the element.</li></ul><ul><li>“Text alignment” is an enumeration which values may be Horizontal or Vertical. When several applied stereotypes are shown, it is rendered as a list of string separated by a comma and enclosed between a pair of French guillemets. By default, this string is shown horizontally. But some times for aesthetic reasons, it may be useful to show it vertically, that is to say showing one stereotype per line.</li></ul><ul><li>“Display place” is an enumeration which values may be Compartment, Comment or With brace. This appearance property is used to set where to show the properties values of the applied stereotypes. In UML, those values can be shown either within a pair of braces located just near (above or on top) the name label of the model element (“With brace” option), or into a dedicated compartment, or in a text note associated with the annotated model element.</li></ul><p><i>PS: if you display several stereotype applications, and if you select the options to display them with icon or with icon and text, this is the icon of the first stereotype application in the list which is chosen to be displayed.</i></p></body></html> \ No newline at end of file

Back to the top