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
|
/*****************************************************************************
* Copyright (c) 2009 CEA LIST.
*
* 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:
* Remi Schnekenburger (CEA LIST) remi.schnekenburger@cea.fr - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.diagram.common.editpolicies;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.transaction.Transaction;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.emf.workspace.AbstractEMFOperation;
import org.eclipse.gef.EditPart;
import org.eclipse.gef.EditPartViewer;
import org.eclipse.gef.Request;
import org.eclipse.gef.commands.Command;
import org.eclipse.gef.editpolicies.AbstractEditPolicy;
import org.eclipse.gmf.runtime.common.core.command.CommandResult;
import org.eclipse.gmf.runtime.common.core.util.Log;
import org.eclipse.gmf.runtime.common.core.util.StringStatics;
import org.eclipse.gmf.runtime.common.core.util.Trace;
import org.eclipse.gmf.runtime.diagram.ui.commands.ICommandProxy;
import org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart;
import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIDebugOptions;
import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIPlugin;
import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIStatusCodes;
import org.eclipse.gmf.runtime.diagram.ui.parts.DiagramGraphicalViewer;
import org.eclipse.gmf.runtime.diagram.ui.util.EditPartUtil;
import org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand;
import org.eclipse.gmf.runtime.emf.commands.core.command.CompositeTransactionalCommand;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.papyrus.core.utils.PapyrusTrace;
import org.eclipse.papyrus.commands.wrappers.EMFtoGMFCommandWrapper;
import org.eclipse.papyrus.diagram.common.commands.DefferedAppliedStereotypeToDisplayCommand;
import org.eclipse.papyrus.diagram.common.editparts.IUMLEditPart;
import org.eclipse.papyrus.diagram.common.helper.NamedElementHelper;
import org.eclipse.papyrus.diagram.common.service.ApplyStereotypeRequest;
import org.eclipse.papyrus.umlutils.NamedElementUtil;
import org.eclipse.papyrus.umlutils.ui.helper.AppliedStereotypeHelper;
import org.eclipse.uml2.uml.Element;
import org.eclipse.uml2.uml.NamedElement;
import org.eclipse.uml2.uml.Stereotype;
/**
* Apply Stereotype edit policy.
* <P>
* Edit policy in charge of applying stereotypes on uml elements
* </P>
*/
public class ApplyStereotypeEditPolicy extends AbstractEditPolicy {
/**
* Creates a new ApplyStereotypeEditPolicy.
*/
public ApplyStereotypeEditPolicy() {
super();
}
/**
* {@inheritDoc}
*/
@Override
public Command getCommand(Request request) {
if(understandsRequest(request)) {
executeCommand(getApplyStereotypeCommand((ApplyStereotypeRequest)request));
return null;
} else
return super.getCommand(request);
}
/**
* {@inheritDoc}
*/
@Override
public boolean understandsRequest(Request req) {
if(ApplyStereotypeRequest.APPLY_STEREOTYPE_REQUEST.equals(req.getType())) {
return true;
}
return super.understandsRequest(req);
}
//
// /**
// * {@inheritDoc}
// */
// @Override
// public Command getCommand(Request request) {
// // command should be a composed command: apply stereotype, display stereotype and eventually
// // change the name of the semantic element
// if (ApplyStereotypeRequest.APPLY_STEREOTYPE_REQUEST.equals(request.getType()))
// return getApplyStereotypeCommand((ApplyStereotypeRequest) request);
//
// return super.getCommand(request);
// }
/**
* Executes the supplied command inside an <code>unchecked action</code>
*
* @param cmd
* command that can be executed (i.e., cmd.canExecute() == true)
*/
protected void executeCommand(final Command cmd) {
Map<String, Boolean> options = null;
EditPart ep = getHost();
boolean isActivating = true;
// use the viewer to determine if we are still initializing the diagram
// do not use the DiagramEditPart.isActivating since ConnectionEditPart's
// parent will not be a diagram edit part
EditPartViewer viewer = ep.getViewer();
if(viewer instanceof DiagramGraphicalViewer) {
isActivating = ((DiagramGraphicalViewer)viewer).isInitializing();
}
if(isActivating || !EditPartUtil.isWriteTransactionInProgress((IGraphicalEditPart)getHost(), false, false))
options = Collections.singletonMap(Transaction.OPTION_UNPROTECTED, Boolean.TRUE);
AbstractEMFOperation operation = new AbstractEMFOperation(((IGraphicalEditPart)getHost()).getEditingDomain(), StringStatics.BLANK, options) {
protected IStatus doExecute(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {
cmd.execute();
return Status.OK_STATUS;
}
};
try {
operation.execute(new NullProgressMonitor(), null);
} catch (ExecutionException e) {
Trace.catching(DiagramUIPlugin.getInstance(), DiagramUIDebugOptions.EXCEPTIONS_CATCHING, getClass(), "executeCommand", e); //$NON-NLS-1$
Log.warning(DiagramUIPlugin.getInstance(), DiagramUIStatusCodes.IGNORED_EXCEPTION_WARNING, "executeCommand", e); //$NON-NLS-1$
}
}
/**
* {@inheritDoc}
*/
@Override
public EditPart getTargetEditPart(Request request) {
if(understandsRequest(request)) {
return getHost();
}
return super.getTargetEditPart(request);
}
/**
* Returns the <code>Command</code> contribution for the given <code>ApplyStereotypeRequest</code>
*
* @param request
* the request linked to this edit policy
* @return the command that applies the stereotype or <code>null</code>
*/
protected Command getApplyStereotypeCommand(ApplyStereotypeRequest request) {
final ApplyStereotypeRequest _request = request;
TransactionalEditingDomain editingDomain = ((IGraphicalEditPart)getHost()).getEditingDomain();
CompositeTransactionalCommand cc = new CompositeTransactionalCommand(editingDomain, "Apply Stereotype");
final List<EObject> result = new ArrayList<EObject>();
final Element element = (Element)(((View)getHost().getModel()).getElement());
// 1. apply stereotypes
cc.compose(new AbstractTransactionalCommand(editingDomain, "Apply Stereotype", null) {
@Override
protected CommandResult doExecuteWithResult(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {
// retrieves the edit part on which stereotype request is made
if(getHost() instanceof IUMLEditPart || ((getHost().getModel() instanceof View) && (((View)getHost().getModel()).getElement()) instanceof Element)) {
if(element == null) {
return null;
}
// retrieves the list of stereotypes to be applied
List<String> stereotypeQNames = _request.getStereotypesToApply();
for(String stereotypeQName : stereotypeQNames) {
// retrieve the stereotype to apply
Stereotype stereotype = element.getApplicableStereotype(stereotypeQName);
if(stereotype == null) {
// stereotype has no been found. should ask for profile application ?
PapyrusTrace.log(IStatus.WARNING, "impossible to retrieve the stereotype " + stereotypeQName);
} else {
result.add(element.applyStereotype(stereotype));
}
}
}
return CommandResult.newOKCommandResult(result);
}
});
// check if the name of base element must be changed (don't bother what is the value of the
// element, only the key is needed
Object newName = request.getExtendedData().get(ApplyStereotypeRequest.NEW_EDIT_PART_NAME);
if(newName != null) {
cc.compose(new AbstractTransactionalCommand(editingDomain, "Edit Base Element Name", null) {
@Override
protected CommandResult doExecuteWithResult(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {
// retrieves the edit part on which stereotype request is made
if(getHost() instanceof IUMLEditPart || ((getHost().getModel() instanceof View) && (((View)getHost().getModel()).getElement()) instanceof Element)) {
if(!(element instanceof NamedElement)) {
return null;
}
// retrieves the list of stereotypes to be applied (qualified names)
List<String> stereotypeQNames = _request.getStereotypesToApply();
String stereotypeName = NamedElementUtil.getNameFromQualifiedName(stereotypeQNames.get(0));
// find a new name for the element
String name = NamedElementHelper.EINSTANCE.getNewUMLElementName(element.getOwner(), stereotypeName);
((NamedElement)element).setName(name);
}
return CommandResult.newOKCommandResult(result);
}
});
}
// 2. display stereotypes
String presentationKind = AppliedStereotypeHelper.getAppliedStereotypePresentationKind(element);
// should display real applied stereotypes and not the list of stereotypes to apply...
cc.compose(new EMFtoGMFCommandWrapper(new DefferedAppliedStereotypeToDisplayCommand(editingDomain, getHost(), "", presentationKind)));
return new ICommandProxy(cc.reduce());
}
/**
* Returns the list of stereotypes to display
*
* @param request
* the request that triggers this policy
* @return the list of stereotypes to display
*/
public String getStereotypeList(ApplyStereotypeRequest request) {
// transforms the list of stereotypes in the request into a string corresponding to the
// string input of the display stereotype command.
StringBuffer buffer = new StringBuffer();
Iterator<String> it = request.getStereotypesToApply().iterator();
while(it.hasNext()) {
String stereotypeQN = it.next();
buffer.append(stereotypeQN);
if(it.hasNext()) {
buffer.append(", ");
}
}
return buffer.toString();
}
}
|
