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
|
/*
* Copyright (c) 2005, 2011 IBM Corporation, CEA, 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
* Kenn Hussey (CEA) - 327039
*
* $Id: Pseudostate.java,v 1.12 2007/10/23 15:54:22 jbruck Exp $
*/
package org.eclipse.uml2.uml;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Pseudostate</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A pseudostate is an abstraction that encompasses different types of transient vertices in the state machine graph.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.uml2.uml.Pseudostate#getState <em>State</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Pseudostate#getKind <em>Kind</em>}</li>
* <li>{@link org.eclipse.uml2.uml.Pseudostate#getStateMachine <em>State Machine</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.uml2.uml.UMLPackage#getPseudostate()
* @model
* @generated
*/
public interface Pseudostate
extends Vertex {
/**
* Returns the value of the '<em><b>Kind</b></em>' attribute.
* The default value is <code>"initial"</code>.
* The literals are from the enumeration {@link org.eclipse.uml2.uml.PseudostateKind}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Determines the precise type of the Pseudostate and can be one of: entryPoint, exitPoint, initial, deepHistory, shallowHistory, join, fork, junction, terminate or choice.
* <!-- end-model-doc -->
* @return the value of the '<em>Kind</em>' attribute.
* @see org.eclipse.uml2.uml.PseudostateKind
* @see #setKind(PseudostateKind)
* @see org.eclipse.uml2.uml.UMLPackage#getPseudostate_Kind()
* @model default="initial" required="true" ordered="false"
* @generated
*/
PseudostateKind getKind();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Pseudostate#getKind <em>Kind</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Kind</em>' attribute.
* @see org.eclipse.uml2.uml.PseudostateKind
* @see #getKind()
* @generated
*/
void setKind(PseudostateKind 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#getConnectionPoints <em>Connection Point</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 in which this Pseudostate is defined. This only applies to Pseudostates of the kind entryPoint or exitPoint.
* <!-- end-model-doc -->
* @return the value of the '<em>State Machine</em>' container reference.
* @see #setStateMachine(StateMachine)
* @see org.eclipse.uml2.uml.UMLPackage#getPseudostate_StateMachine()
* @see org.eclipse.uml2.uml.StateMachine#getConnectionPoints
* @model opposite="connectionPoint" transient="false" ordered="false"
* @generated
*/
StateMachine getStateMachine();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Pseudostate#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);
/**
* 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#getConnectionPoints <em>Connection Point</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 this pseudostate and in which it appears.
* <!-- end-model-doc -->
* @return the value of the '<em>State</em>' container reference.
* @see #setState(State)
* @see org.eclipse.uml2.uml.UMLPackage#getPseudostate_State()
* @see org.eclipse.uml2.uml.State#getConnectionPoints
* @model opposite="connectionPoint" transient="false" ordered="false"
* @generated
*/
State getState();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Pseudostate#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);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* An initial vertex can have at most one outgoing transition.
* (self.kind = #initial) implies (self.outgoing->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 -->
* History vertices can have at most one outgoing transition.
* ((self.kind = #deepHistory) or (self.kind = #shallowHistory)) implies
* (self.outgoing->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 validateHistoryVertices(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* In a complete statemachine, a join vertex must have at least two incoming transitions and exactly one outgoing transition.
* (self.kind = #join) implies
* ((self.outgoing->size = 1) and (self.incoming->size >= 2))
*
* @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 validateJoinVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* All transitions incoming a join vertex must originate in different regions of an orthogonal state.
* (self.kind = #join) implies
* self.incoming->forAll (t1, t2 | t1<>t2 implies
* (self.stateMachine.LCA(t1.source, t2.source).container.isOrthogonal))
* @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 validateTransitionsIncoming(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* In a complete statemachine, a fork vertex must have at least two outgoing transitions and exactly one incoming transition.
* (self.kind = #fork) implies
* ((self.incoming->size = 1) and (self.outgoing->size >= 2))
*
* @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 validateForkVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* All transitions outgoing a fork vertex must target states in different regions of an orthogonal state.
* (self.kind = #fork) implies
* self.outgoing->forAll (t1, t2 | t1<>t2 implies
* (self.stateMachine.LCA(t1.target, t2.target).container.isOrthogonal))
* @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 validateTransitionsOutgoing(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* In a complete statemachine, a junction vertex must have at least one incoming and one outgoing transition.
* (self.kind = #junction) implies
* ((self.incoming->size >= 1) and (self.outgoing->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 validateJunctionVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* In a complete statemachine, a choice vertex must have at least one incoming and one outgoing transition.
* (self.kind = #choice) implies
* ((self.incoming->size >= 1) and (self.outgoing->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 validateChoiceVertex(DiagnosticChain diagnostics,
Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The outgoing transition from and initial vertex may have a behavior, but not a trigger or a guard.
* (self.kind = #initial) implies (self.outgoing.guard->isEmpty()
* and self.outgoing.trigger->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 validateOutgoingFromInitial(DiagnosticChain diagnostics,
Map<Object, Object> context);
} // Pseudostate
|
