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
|
/*****************************************************************************
* Copyright (c) 2011, 2015 LIFL, CEA, Christian W. Damus, 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:
* LIFL - Initial API and implementation
* Christian W. Damus (CEA) - bug 431618
* Christian W. Damus - bug 467016
*
*****************************************************************************/
package org.eclipse.papyrus.uml.tools.model;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.eclipse.emf.ecore.EAnnotation;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.papyrus.infra.core.resource.ModelSet;
import org.eclipse.papyrus.infra.core.resource.ModelUtils;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.core.services.ServicesRegistry;
import org.eclipse.papyrus.infra.core.utils.ServiceUtils;
import org.eclipse.papyrus.infra.core.utils.ServiceUtilsForActionHandlers;
import org.eclipse.papyrus.uml.tools.Activator;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
/**
* Set of utility methods linked to Trace for ControlMode
*
* @author cedric dumoulin
*
*/
public class UmlUtils {
private static final String ANNOTATION_SUBSETS = "subsets"; //$NON-NLS-1$
/**
* Gets the UmlModel for the currently selected editor. <br>
* Warning: This method is designed to be call from ui.handlers. It is not
* designed to be call from Editors. This method can return null if called
* during the MultiEditor initialization.
*
* @see ServiceUtilsForActionHandlers.getInstance().getModelSet()
*
*
* @return The {@link UmlModel} of the current editor, or null if not found.
*/
public static UmlModel getUmlModel() {
try {
return (UmlModel) ServiceUtilsForActionHandlers.getInstance().getModelSet().getModel(UmlModel.MODEL_ID);
} catch (ServiceException e) {
return null;
}
}
/**
* Gets the UmlModel for the currently selected editor. <br>
* Warning: this method can return null if called during the MultiEditor
* initialization.
*
*
* @return The {@link UmlModel} of the current editor, or null if not found.
* @throws ServiceException
* If an error occurs while getting or starting the service.
*/
public static UmlModel getUmlModelChecked() throws ServiceException {
return (UmlModel) ServiceUtilsForActionHandlers.getInstance().getModelSet().getModel(UmlModel.MODEL_ID);
}
/**
* Gets the UmlModel from the {@link ModelSet}. <br>
*
* @param modelSet
* The modelManager containing the requested model.
*
* @return The {@link SashModel} registered in modelManager, or null if not
* found.
*/
public static UmlModel getUmlModel(ModelSet modelSet) {
return (UmlModel) modelSet.getModel(UmlModel.MODEL_ID);
}
/**
* Gets the UmlModel from the {@link ServiceRegistry}.
*
* @return ServicesRegistry The service registry under which the ModelSet is
* registered.
*/
public static UmlModel getUmlModel(ServicesRegistry servicesRegistry) {
try {
return getUmlModelChecked(servicesRegistry);
} catch (ServiceException e) {
return null;
}
}
/**
* Gets the UmlModel from the {@link ServiceRegistry}.
*
* @return ServicesRegistry The service registry under which the ModelSet is
* registered.
* @throws ServiceException
* If the service can't be returned.
*/
public static UmlModel getUmlModelChecked(ServicesRegistry servicesRegistry) throws ServiceException {
return (UmlModel) ModelUtils.getModelSetChecked(servicesRegistry).getModel(UmlModel.MODEL_ID);
}
/**
* Return the UML Resource associated to the Services Registry. May be null.
*
* @param modelSet
* @return
*/
public static Resource getUmlResource(ServicesRegistry registry) {
try {
ModelSet modelSet = ServiceUtils.getInstance().getModelSet(registry);
return getUmlResource(modelSet);
} catch (ServiceException ex) {
Activator.log.error(ex);
return null;
}
}
/**
* Return the UML Resource associated to the ModelSet. May be null.
*
* @param modelSet
* @return
*/
public static Resource getUmlResource(ModelSet modelSet) {
UmlModel umlModel = getUmlModel(modelSet);
if (umlModel != null) {
return umlModel.getResource();
}
return null;
}
public static Collection<EReference> getAllChangeableSupersets(EReference subset) {
Collection<EReference> result = null;
// null has no supersets
EAnnotation supersets = (subset == null) ? null : subset.getEAnnotation(ANNOTATION_SUBSETS);
if (supersets != null) {
result = collectChangeableSupersets(supersets.getReferences(), new HashSet<EReference>());
}
return (result == null) ? Collections.<EReference> emptyList() : result;
}
private static Collection<EReference> collectChangeableSupersets(Collection<EObject> supersets, Set<EReference> result) {
for (EObject next : supersets) {
if (next instanceof EReference) {
EReference superset = (EReference) next;
if (superset.isChangeable() && result.add(superset)) {
EAnnotation recursive = (superset == null) ? null : superset.getEAnnotation(ANNOTATION_SUBSETS);
if (recursive != null) {
collectChangeableSupersets(recursive.getReferences(), result);
}
}
}
}
return result;
}
public static boolean isSubset(EReference subset) {
boolean result = false;
// null is not a subset of anything
EAnnotation supersets = (subset == null) ? null : subset.getEAnnotation(ANNOTATION_SUBSETS);
if (supersets != null) {
result = !supersets.getReferences().isEmpty();
}
return result;
}
public static boolean isSubsetOf(EReference subset, EReference superset) {
boolean result = false;
// null is not a subset of anything
EAnnotation supersets = (subset == null) ? null : subset.getEAnnotation(ANNOTATION_SUBSETS);
if (supersets != null) {
result = supersets.getReferences().contains(superset);
if (!result) {
// Look for transitive subset, which is at least plausible
// considering that we do have some superset
for (Iterator<EObject> iter = supersets.getReferences().iterator(); !result && iter.hasNext();) {
EObject next = iter.next();
if (next instanceof EReference) {
result = isSubsetOf((EReference) next, superset);
}
}
}
}
return result;
}
/**
* Obtains all supersets, including transitive supersets-of-supersets, of the specified {@code subset}.
*
* @param subset
* a subset reference
* @return its supersets, or an empty iterable if it is not actually a subset of anything
*/
public static Iterable<EReference> getSupersets(EReference subset) {
List<EReference> result;
EAnnotation supersets = (subset == null) ? null : subset.getEAnnotation(ANNOTATION_SUBSETS);
if (supersets == null) {
result = Collections.emptyList();
} else {
result = Lists.newArrayListWithCapacity(supersets.getReferences().size());
for (EObject next : supersets.getReferences()) {
if (next instanceof EReference) {
EReference superset = (EReference) next;
result.add(superset);
if (isSubset(superset)) {
// Look for transitive supersets
Iterables.addAll(result, getSupersets(superset));
}
}
}
}
return result;
}
}
|
