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
|
/*****************************************************************************
* Copyright (c) 2015 CEA LIST 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:
* CEA LIST - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.infra.nattable.common.api;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.gmf.runtime.common.core.command.ICommand;
import org.eclipse.gmf.runtime.emf.type.core.requests.DestroyElementRequest;
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.emf.gmf.command.GMFtoEMFCommandWrapper;
import org.eclipse.papyrus.infra.emf.utils.EMFHelper;
import org.eclipse.papyrus.infra.emf.utils.ServiceUtilsForResource;
import org.eclipse.papyrus.infra.nattable.common.Activator;
import org.eclipse.papyrus.infra.nattable.model.nattable.Table;
import org.eclipse.papyrus.infra.services.edit.service.ElementEditServiceUtils;
import org.eclipse.papyrus.infra.services.edit.service.IElementEditService;
/**
* @author VL222926
*
*/
public class TableEditorDeleteHelper {
/**
* the table to delete
*/
private Table table;
/* these fields are determined calculating calling canDeleteTableEditor */
/**
* the command provider (calculated calling {@link #canDeleteTableEditor()})
*/
private IElementEditService commandProvider;
/**
* the command to delete the table (calculated calling {@link #canDeleteTableEditor()})
*/
private Command deleteCommand;
/**
* the editing domain used to execute the command
*/
private TransactionalEditingDomain editingDomain;
/**
*
* Constructor.
*
* @param table
* the table to delete
*/
public TableEditorDeleteHelper(final Table table) {
this.table = table;
}
/**
*
* @return
* a IStatus indicating if the table can be destroyed
* The returned IStatus provides a message for each error and a code. The possible code are described in {@link ITableEditorStatusCode}
*/
@SuppressWarnings("unchecked")
public IStatus canDeleteTableEditor() {
final String pluginID = getPluginID();
// 0. check given parameters
if (this.table == null) {
return new Status(IStatus.OK, pluginID, ITableEditorStatusCode.OK_STATUS_CODE, "There is no table to delete", null); //$NON-NLS-1$
}
// 1. check read only
if (EMFHelper.isReadOnly(this.table)) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.TABLE_IS_READ_ONLY, "The table to delete is read-only", null); //$NON-NLS-1$
}
// 2. get the command provider
this.commandProvider = ElementEditServiceUtils.getCommandProvider(this.table);
if (this.commandProvider == null) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.COMMAND_PROVIDER_NOT_FOUND, "There is no command provider to delete the table", null); //$NON-NLS-1$
}
// 3. build the delete request
DestroyElementRequest request = new DestroyElementRequest(this.table, false);
// 4. check the editing domain
ServicesRegistry servicesRegistry;
try {
servicesRegistry = ServiceUtilsForResource.getInstance().getServiceRegistry(table.getContext().eResource());
} catch (ServiceException e) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.SERVICES_REGISTRY_NOT_FOUND, e.getMessage(), e);
}
if (servicesRegistry == null) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.SERVICES_REGISTRY_NOT_FOUND, "Service Registry not found", null); //$NON-NLS-1$
}
try {
this.editingDomain = ServiceUtils.getInstance().getTransactionalEditingDomain(servicesRegistry);
} catch (ServiceException e) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.EDITING_DOMAIN_NOT_FOUND, e.getMessage(), e);
}
if (editingDomain == null) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.EDITING_DOMAIN_NOT_FOUND, "The editing domain has not been found", null); //$NON-NLS-1$
}
// 5. create and check the deletion command
// Map<?, ?> parameters = new HashMap<Object, Object>();
// request.getParameters().putAll(parameters);
ICommand cmd = this.commandProvider.getEditCommand(request);
if (cmd == null) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.COMMAND_NULL, "The deletion command cannot be created", null); //$NON-NLS-1$
}
if (!cmd.canExecute()) {
return new Status(IStatus.ERROR, pluginID, ITableEditorStatusCode.COMMAND_NOT_EXECUTABLE, "The deletion command is not executable", null); //$NON-NLS-1$
}
this.deleteCommand = new GMFtoEMFCommandWrapper(cmd);
return Status.OK_STATUS;
}
/**
*
* @return
* the delete table editor command or <code>null</code> if the delete command can not be built
*/
public Command getDeleteTableEditorCommand() {
if (canDeleteTableEditor().isOK()) {
return this.deleteCommand;
}
return null;
}
/**
* delete the wanted table
*/
public void deleteTableEditor() {
Command cmd = getDeleteTableEditorCommand();
if (cmd != null) {
this.editingDomain.getCommandStack().execute(cmd);
}
}
/**
*
* @param table
* the table to destroy
*/
public void setTable(final Table table) {
this.table = table;
}
/**
*
* @return
* the activator id of the plugin
*/
protected String getPluginID() {
return Activator.PLUGIN_ID;
}
}
|
