1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
/*
* Copyright (c) 2005, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM - initial API and implementation
*
* $Id: Region.java,v 1.16 2007/10/23 15:54:21 jbruck Exp $
*/
package org.eclipse.uml2.uml;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Region</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A region is an orthogonal part of either a composite state or a state machine. It contains states and transitions.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.uml2.uml.Region#getSubvertices <em>Subvertex</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Region#getTransitions <em>Transition</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Region#getState <em>State</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Region#getExtendedRegion <em>Extended Region</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Region#getStateMachine <em>State Machine</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.uml2.uml.UMLPackage#getRegion()
* @model
* @generated
*/
public interface Region
extends Namespace, RedefinableElement {
/**
* Returns the value of the '<em><b>Subvertex</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Vertex}.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Vertex#getContainer <em>Container</em>}'.
* <p>
* This feature subsets the following features:
* <ul>
* <li>'{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() <em>Owned Member</em>}'</li>
* </ul>
* </p>
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The set of vertices that are owned by this region.
* <!-- end-model-doc -->
* @return the value of the '<em>Subvertex</em>' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getRegion_Subvertex()
* @see org.eclipse.uml2.uml.Vertex#getContainer
* @model opposite="container" containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList<Vertex> getSubvertices();
/**
* Creates a new {@link org.eclipse.uml2.uml.Vertex}, with the specified '<em><b>Name</b></em>', and appends it to the '<em><b>Subvertex</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Vertex}, or <code>null</code>.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Vertex} to create.
* @return The new {@link org.eclipse.uml2.uml.Vertex}.
* @see #getSubvertices()
* @generated
*/
Vertex createSubvertex(String name, EClass eClass);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Vertex} with the specified '<em><b>Name</b></em>' from the '<em><b>Subvertex</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Vertex} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.uml.Vertex} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getSubvertices()
* @generated
*/
Vertex getSubvertex(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Vertex} with the specified '<em><b>Name</b></em>' from the '<em><b>Subvertex</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Vertex} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Vertex} to retrieve, or <code>null</code>.
* @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Vertex} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Vertex} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getSubvertices()
* @generated
*/
Vertex getSubvertex(String name, boolean ignoreCase, EClass eClass,
boolean createOnDemand);
/**
* Returns the value of the '<em><b>Transition</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Transition}.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Transition#getContainer <em>Container</em>}'.
* <p>
* This feature subsets the following features:
* <ul>
* <li>'{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() <em>Owned Member</em>}'</li>
* </ul>
* </p>
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The set of transitions owned by the region. Note that internal transitions are owned by a region, but applies to the source state.
* <!-- end-model-doc -->
* @return the value of the '<em>Transition</em>' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getRegion_Transition()
* @see org.eclipse.uml2.uml.Transition#getContainer
* @model opposite="container" containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList<Transition> getTransitions();
/**
* Creates a new {@link org.eclipse.uml2.uml.Transition}, with the specified '<em><b>Name</b></em>', and appends it to the '<em><b>Transition</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Transition}, or <code>null</code>.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Transition} to create.
* @return The new {@link org.eclipse.uml2.uml.Transition}.
* @see #getTransitions()
* @generated
*/
Transition createTransition(String name, EClass eClass);
/**
* Creates a new {@link org.eclipse.uml2.uml.Transition}, with the specified '<em><b>Name</b></em>', and appends it to the '<em><b>Transition</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.Transition}, or <code>null</code>.
* @return The new {@link org.eclipse.uml2.uml.Transition}.
* @see #getTransitions()
* @generated
*/
Transition createTransition(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>' from the '<em><b>Transition</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getTransitions()
* @generated
*/
Transition getTransition(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>' from the '<em><b>Transition</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Transition} to retrieve, or <code>null</code>.
* @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Transition} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Transition} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getTransitions()
* @generated
*/
Transition getTransition(String name, boolean ignoreCase, EClass eClass,
boolean createOnDemand);
/**
* Returns the value of the '<em><b>State</b></em>' container reference.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.State#getRegions <em>Region</em>}'.
* <p>
* This feature subsets the following features:
* <ul>
* <li>'{@link org.eclipse.uml2.uml.NamedElement#getNamespace() <em>Namespace</em>}'</li>
* </ul>
* </p>
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The State that owns the Region. If a Region is owned by a State, then it cannot also be owned by a StateMachine.
* <!-- end-model-doc -->
* @return the value of the '<em>State</em>' container reference.
* @see #setState(State)
* @see org.eclipse.uml2.uml.UMLPackage#getRegion_State()
* @see org.eclipse.uml2.uml.State#getRegions
* @model opposite="region" transient="false" ordered="false"
* @generated
*/
State getState();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Region#getState <em>State</em>}' container reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>State</em>' container reference.
* @see #getState()
* @generated
*/
void setState(State value);
/**
* Returns the value of the '<em><b>Extended Region</b></em>' reference.
* <p>
* This feature subsets the following features:
* <ul>
* <li>'{@link org.eclipse.uml2.uml.RedefinableElement#getRedefinedElements() <em>Redefined Element</em>}'</li>
* </ul>
* </p>
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The region of which this region is an extension.
* <!-- end-model-doc -->
* @return the value of the '<em>Extended Region</em>' reference.
* @see #setExtendedRegion(Region)
* @see org.eclipse.uml2.uml.UMLPackage#getRegion_ExtendedRegion()
* @model ordered="false"
* @generated
*/
Region getExtendedRegion();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Region#getExtendedRegion <em>Extended Region</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Extended Region</em>' reference.
* @see #getExtendedRegion()
* @generated
*/
void setExtendedRegion(Region value);
/**
* Returns the value of the '<em><b>State Machine</b></em>' container reference.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.StateMachine#getRegions <em>Region</em>}'.
* <p>
* This feature subsets the following features:
* <ul>
* <li>'{@link org.eclipse.uml2.uml.NamedElement#getNamespace() <em>Namespace</em>}'</li>
* </ul>
* </p>
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The StateMachine that owns the Region. If a Region is owned by a StateMachine, then it cannot also be owned by a State.
* <!-- end-model-doc -->
* @return the value of the '<em>State Machine</em>' container reference.
* @see #setStateMachine(StateMachine)
* @see org.eclipse.uml2.uml.UMLPackage#getRegion_StateMachine()
* @see org.eclipse.uml2.uml.StateMachine#getRegions
* @model opposite="region" transient="false" ordered="false"
* @generated
*/
StateMachine getStateMachine();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Region#getStateMachine <em>State Machine</em>}' container reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>State Machine</em>' container reference.
* @see #getStateMachine()
* @generated
*/
void setStateMachine(StateMachine value);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A region can have at most one initial vertex
* self.subvertex->select (v | v.oclIsKindOf(Pseudostate))->
* select(p : Pseudostate | p.kind = #initial)->size() <= 1
*
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @model
* @generated
*/
boolean validateInitialVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A region can have at most one deep history vertex
* self.subvertex->select (v | v.oclIsKindOf(Pseudostate))->
* select(p : Pseudostate | p.kind = #deepHistory)->size() <= 1
*
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @model
* @generated
*/
boolean validateDeepHistoryVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A region can have at most one shallow history vertex
* self.subvertex->select(v | v.oclIsKindOf(Pseudostate))->
* select(p : Pseudostate | p.kind = #shallowHistory)->size() <= 1
*
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @model
* @generated
*/
boolean validateShallowHistoryVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If a Region is owned by a StateMachine, then it cannot also be owned by a State and vice versa.
* (stateMachine->notEmpty() implies state->isEmpty()) and (state->notEmpty() implies stateMachine->isEmpty())
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @model
* @generated
*/
boolean validateOwned(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The redefinition context of a region is the nearest containing statemachine
* result = let sm = containingStateMachine() in
* if sm.context->isEmpty() or sm.general->notEmpty() then
* sm
* else
* sm.context
* endif
* <!-- end-model-doc -->
* @model required="true" ordered="false"
* @generated
*/
Classifier redefinitionContext();
/**
* <p>
* This operation redefines the following operations:
* <ul>
* <li>'{@link org.eclipse.uml2.uml.RedefinableElement#isRedefinitionContextValid(org.eclipse.uml2.uml.RedefinableElement) <em>Is Redefinition Context Valid</em>}' </li>
* </ul>
* </p>
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The query isRedefinitionContextValid() specifies whether the redefinition contexts of a region are properly related to the redefinition contexts of the specified region to allow this element to redefine the other. The containing statemachine/state of a redefining region must redefine the containing statemachine/state of the redefined region.
* result = true
* <!-- end-model-doc -->
* @model dataType="org.eclipse.uml2.uml.Boolean" required="true" ordered="false" redefinedRequired="true" redefinedOrdered="false"
* @generated
*/
boolean isRedefinitionContextValid(Region redefined);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The operation containingStateMachine() returns the sate machine in which this Region is defined
* result = if stateMachine->isEmpty()
* then
* state.containingStateMachine()
* else
* stateMachine
* endif
* <!-- end-model-doc -->
* @model required="true" ordered="false"
* @generated
*/
StateMachine containingStateMachine();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The operation belongsToPSM () checks if the region belongs to a protocol state machine
* result = if not stateMachine->isEmpty() then
* oclIsTypeOf(ProtocolStateMachine)
* else if not state->isEmpty() then
* state.container.belongsToPSM ()
* else false
* <!-- end-model-doc -->
* @model dataType="org.eclipse.uml2.uml.Boolean" required="true" ordered="false"
* @generated
*/
boolean belongsToPSM();
} // Region
|
