Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus/UserGuide/Papyrus Constraints"
(→Create and edit constraints) |
|||
| Line 1: | Line 1: | ||
= Create and edit constraints = | = Create and edit constraints = | ||
| − | + | Papyrus supports the creation of UML constraints. Creating constraints comprises three steps: | |
| − | + | 1. Specify the context | |
| − | + | 2. Specify the language | |
| − | + | 3. Specify the context text based on the constraint behaviour | |
| − | + | ||
== Define a constraint and its context == | == Define a constraint and its context == | ||
| + | To define a constraint, and associated context, in a diagram do the following: | ||
| − | + | 1. Within any Papyrus diagram select the constraint tool from the palette | |
| − | + | 2. Click at the position where you want to create the constraint on the diagram canvas | |
| − | + | 3. Automatically a ContextLink relationship will be created from the new constraint. This relationship should be connected to the element to be constrainted on the diagram, by clicking on the target element in the diagram (in two-click mode). If you are in one-click-mode (connection tool preference), click on the constraint and keep it pressed until the context object is selected. This ContextLink relationship defines the context for which the constraint will be evaluated. | |
<center> | <center> | ||
| Line 18: | Line 18: | ||
</center> | </center> | ||
| − | + | To create a constraint, and associated context, via the Model Explorer do the following: | |
| + | |||
| + | 1. Within the Model Explorer right click a model element | ||
| + | 2. Select New Child -> "Create a new Constraint" from the context menu. The context is automatically set to the parent of the constraint. This context can be changed via the Properties View if required. | ||
<center> | <center> | ||
[[Image:PapyrusConstraint-CreateViaME.png]]<br> | [[Image:PapyrusConstraint-CreateViaME.png]]<br> | ||
| − | Create a constraint via the | + | Create a constraint via the Model Explorer |
</center> | </center> | ||
<center> | <center> | ||
[[Image:PapyrusConstraint-ContextViaPropertyView.png]]<br> | [[Image:PapyrusConstraint-ContextViaPropertyView.png]]<br> | ||
| − | Set the context via the | + | Set the context via the Properties View |
</center> | </center> | ||
| − | == Define constraint specification == | + | == Define a constraint specification == |
| − | Each constraint has a specification containing a condition. Whereas it may be an arbitrary value specification, such as a StringExpression or LiteralInteger, it is in most cases useful to define an | + | Each constraint has a specification containing a condition. Whereas it may be an arbitrary value specification, such as a StringExpression or LiteralInteger, it is in most cases useful to define an OpaqueExpression consisting of a language and body pair. The constraint body may be written in at least OCL, JAVA, or natural language. In order to make constraints evaluable by Papyrus the constraint must be written in either OCL or JAVA. To define a constraint's specification, first select a constraint on either a diagram or in the Model Explorer, then do the following: |
| − | * On the diagram open the default editor for constraints | + | * On the diagram open the default editor for constraints by selecting the constraint and then click on the middle of the already selected constraint. Youcan also select the constraint and then press F2. The editor assumes the language is OCL but this can be changed later via the Properties View. The constraint text is defined directly in the editor. The default editor can be controlled via the preferences. |
* On the diagram select a specific editor via the context menu, as shown in the following screenshot. | * On the diagram select a specific editor via the context menu, as shown in the following screenshot. | ||
| Line 43: | Line 46: | ||
</center> | </center> | ||
| − | Use the | + | Use the Properties View to create a new or open an existing specification, as shown in the following figure. Here, we assume that the specification is an opaque expression. |
| − | + | ||
<center> | <center> | ||
[[Image:PapyrusConstraint-SpecViaPropertyView.png]]<br> | [[Image:PapyrusConstraint-SpecViaPropertyView.png]]<br> | ||
| − | Open the specification via the | + | Open the specification via the Properties View |
</center> | </center> | ||
| − | You can add the language, as | + | You can add the language, as follows:<br> |
<center> | <center> | ||
[[Image:PapyrusConstraint-OpaqueExpressionAddLang.png]]<br> | [[Image:PapyrusConstraint-OpaqueExpressionAddLang.png]]<br> | ||
| − | + | Specifying a constraint language. | |
</center> | </center> | ||
<center> | <center> | ||
[[Image:PapyrusConstraint-OpaqueExpressionEdit.png]]<br> | [[Image:PapyrusConstraint-OpaqueExpressionEdit.png]]<br> | ||
| − | Write the body of the | + | Write the body of the OpaqueExpression |
</center> | </center> | ||
| − | |||
| − | |||
| − | |||
Revision as of 09:15, 20 May 2014
Create and edit constraints
Papyrus supports the creation of UML constraints. Creating constraints comprises three steps: 1. Specify the context 2. Specify the language 3. Specify the context text based on the constraint behaviour
Define a constraint and its context
To define a constraint, and associated context, in a diagram do the following:
1. Within any Papyrus diagram select the constraint tool from the palette 2. Click at the position where you want to create the constraint on the diagram canvas 3. Automatically a ContextLink relationship will be created from the new constraint. This relationship should be connected to the element to be constrainted on the diagram, by clicking on the target element in the diagram (in two-click mode). If you are in one-click-mode (connection tool preference), click on the constraint and keep it pressed until the context object is selected. This ContextLink relationship defines the context for which the constraint will be evaluated.
The constraint and context-link tools in the palette
To create a constraint, and associated context, via the Model Explorer do the following:
1. Within the Model Explorer right click a model element 2. Select New Child -> "Create a new Constraint" from the context menu. The context is automatically set to the parent of the constraint. This context can be changed via the Properties View if required.
Create a constraint via the Model Explorer
Set the context via the Properties View
Define a constraint specification
Each constraint has a specification containing a condition. Whereas it may be an arbitrary value specification, such as a StringExpression or LiteralInteger, it is in most cases useful to define an OpaqueExpression consisting of a language and body pair. The constraint body may be written in at least OCL, JAVA, or natural language. In order to make constraints evaluable by Papyrus the constraint must be written in either OCL or JAVA. To define a constraint's specification, first select a constraint on either a diagram or in the Model Explorer, then do the following:
- On the diagram open the default editor for constraints by selecting the constraint and then click on the middle of the already selected constraint. Youcan also select the constraint and then press F2. The editor assumes the language is OCL but this can be changed later via the Properties View. The constraint text is defined directly in the editor. The default editor can be controlled via the preferences.
- On the diagram select a specific editor via the context menu, as shown in the following screenshot.
Explicitly choose the editor for the constraint
Use the Properties View to create a new or open an existing specification, as shown in the following figure. Here, we assume that the specification is an opaque expression.
Open the specification via the Properties View
You can add the language, as follows:
Specifying a constraint language.
Write the body of the OpaqueExpression