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
|
/*******************************************************************************
* Copyright (c) 2003, 2005 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 Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.wst.common.internal.emfworkbench.edit;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.TreeSet;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.jem.util.RegistryReader;
import org.eclipse.jem.util.logger.proxy.Logger;
import org.eclipse.wst.common.internal.emfworkbench.EMFWorkbenchContext;
import org.eclipse.wst.common.internal.emfworkbench.EMFWorkbenchEditResourceHandler;
import org.eclipse.wst.common.internal.emfworkbench.integration.EMFWorkbenchEditPlugin;
import org.eclipse.wst.common.internal.emfworkbench.integration.EditModel;
import org.eclipse.wst.common.internal.emfworkbench.integration.IEditModelFactory;
import org.eclipse.wst.common.project.facet.core.IFacetedProject;
import org.eclipse.wst.common.project.facet.core.IProjectFacet;
import org.eclipse.wst.common.project.facet.core.ProjectFacetsManager;
/**
* @author mdelder
*/
public class EditModelRegistry extends RegistryReader {
private final static EditModelRegistry INSTANCE = new EditModelRegistry();
private final Map factoryConfigurations = new HashMap();
private static boolean initialized = false;
public static final String EDIT_MODEL_ELEMENT = "editModel"; //$NON-NLS-1$
public static final String EDIT_MODEL_ID_ATTR = "editModelID"; //$NON-NLS-1$
public static final String FACTORY_CLASS_ATTR = "factoryClass"; //$NON-NLS-1$
public static final String PARENT_MODEL_ATTR = "parentModelID"; //$NON-NLS-1$
public static final String LOAD_UNKNOWN_RESOURCES_ATTR = "loadUnknownResourcesAsReadOnly"; //$NON-NLS-1$
protected EditModelRegistry() {
super(EMFWorkbenchEditPlugin.ID, EMFWorkbenchEditPlugin.EDIT_MODEL_FACTORIES_EXTENSION_POINT);
}
public static EditModelRegistry getInstance() {
if(isInitialized())
return INSTANCE;
synchronized(INSTANCE) {
if(!isInitialized()) {
INSTANCE.readRegistry();
initialized = true;
}
}
return INSTANCE;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.wst.common.frameworks.internal.RegistryReader#readElement(org.eclipse.core.runtime.IConfigurationElement)
*/
public boolean readElement(IConfigurationElement element) {
/*
* The EditModel Extension Point defines Configuration elements named "editModel" with
* attributes "editModelID" and "factoryClass"
*/
boolean result = false;
if (element.getName().equals(EDIT_MODEL_ELEMENT)) {
String editModelID = element.getAttribute(EDIT_MODEL_ID_ATTR);
if (editModelID != null) {
this.factoryConfigurations.put(editModelID, new EditModelInfo(editModelID, element));
result = true;
}
}
return result;
}
public String getCacheID(String editModelID, Map params) {
IEditModelFactory factory = getEditModelFactoryByKey(editModelID);
return factory.getCacheID(editModelID, params);
}
public EditModel createEditModelForRead(String editModelID, EMFWorkbenchContext context, Map params) {
return getEditModelFactoryByKey(editModelID).createEditModelForRead(editModelID, context, params);
}
public EditModel createEditModelForWrite(String editModelID, EMFWorkbenchContext context, Map params) {
return getEditModelFactoryByKey(editModelID).createEditModelForWrite(editModelID, context, params);
}
public Collection getEditModelResources(String editModelID) {
Collection resources = new TreeSet();
EditModelInfo nextEditModelInfo = (EditModelInfo) factoryConfigurations.get(editModelID);
String parentModelID = null;
Map visitedEditModels = new HashMap();
/* collect the resources from the parents */
while (nextEditModelInfo != null && (parentModelID = nextEditModelInfo.getParentModelID()) != null) {
if (visitedEditModels.containsKey(parentModelID))
throw new IllegalStateException(EMFWorkbenchEditResourceHandler.getString(EMFWorkbenchEditResourceHandler.EditModelRegistry_ERROR_0, new Object[]{editModelID})); //$NON-NLS-1$
visitedEditModels.put(parentModelID, null);
resources.addAll(getAllEditModelResources(parentModelID));
nextEditModelInfo = (EditModelInfo) factoryConfigurations.get(parentModelID);
}
/* Get the resources for the actual edit model id */
resources.addAll(getAllEditModelResources(editModelID));
return resources;
}
public IEditModelFactory findEditModelFactoryByKey(Object editModelID) {
IEditModelFactory factory = null;
EditModelInfo editMdlInfo = (EditModelInfo) factoryConfigurations.get(editModelID);
if (editMdlInfo != null)
factory = editMdlInfo.getEditModelFactory();
return factory;
}
public IEditModelFactory findEditModelFactoryByProject(IProject project) {
IFacetedProject facetedProject = null;
try {
facetedProject = ProjectFacetsManager.create(project);
} catch (Exception e) {
return null;
}
if (facetedProject == null) return null;
Iterator keys = factoryConfigurations.keySet().iterator();
while (keys.hasNext()) {
Object key = keys.next();
if (key instanceof String) {
try {
IProjectFacet projectFacet = ProjectFacetsManager.getProjectFacet((String)key);
if (projectFacet != null && facetedProject.hasProjectFacet(projectFacet))
return findEditModelFactoryByKey(key);
} catch (Exception e) {
continue;
}
}
}
return null;
}
protected Collection getAllEditModelResources(String editModelID) {
Collection resources = new ArrayList();
resources.addAll(getLocalEditModelResources(editModelID));
resources.addAll(getExtendedEditModelResources(editModelID));
return resources;
}
protected Collection getLocalEditModelResources(String editModelID) {
EditModelInfo editMdlInfo = (EditModelInfo) factoryConfigurations.get(editModelID);
return (editMdlInfo != null) ? editMdlInfo.getEditModelResources() : Collections.EMPTY_LIST;
}
protected Collection getExtendedEditModelResources(String editModelID) {
return EditModelExtensionRegistry.getInstance().getEditModelResources(editModelID);
}
/**
* @param editModelKey
* the editModelID of a given EditModelFactory defined in the Extension Point
* @throws IllegalArgumentException
* if a IEditModelFactory cannot be found for the given ID.
* @return the EditModelFactory associated with a given EditModelID
*/
protected IEditModelFactory getEditModelFactoryByKey(Object editModelID) {
IEditModelFactory factory = null;
EditModelInfo editMdlInfo = (EditModelInfo) factoryConfigurations.get(editModelID);
if (editMdlInfo != null)
factory = editMdlInfo.getEditModelFactory();
else
throw new IllegalArgumentException(EMFWorkbenchEditResourceHandler.getString(EMFWorkbenchEditResourceHandler.EditModelRegistry_ERROR_2, new Object[]{editModelID})); //$NON-NLS-1$
return factory;
}
public class EditModelInfo {
private String editModelID = null;
private IConfigurationElement configurationElement = null;
private IEditModelFactory factory = null;
private List editModelResources = null;
private String parentModelID = null;
private String tostringCache = null;
public EditModelInfo(String editModelID, IConfigurationElement configurationElement) {
this.configurationElement = configurationElement;
this.editModelID = editModelID;
this.parentModelID = this.configurationElement.getAttribute(PARENT_MODEL_ATTR);
}
public List getEditModelResources() {
/* this method is guarded */
initializeResources();
return editModelResources;
}
public IEditModelFactory getEditModelFactory() {
if (this.factory == null) {
if (this.configurationElement != null) {
try {
this.factory = (IEditModelFactory) this.configurationElement.createExecutableExtension(FACTORY_CLASS_ATTR);
String loadUnknownResourceAsReadOnly = this.configurationElement.getAttribute(LOAD_UNKNOWN_RESOURCES_ATTR);
Boolean value = loadUnknownResourceAsReadOnly != null ? Boolean.valueOf(loadUnknownResourceAsReadOnly) : Boolean.FALSE;
this.factory.setLoadKnownResourcesAsReadOnly(value.booleanValue());
discardConfigurationElementIfNecessary();
} catch (CoreException e) {
Logger.getLogger(EMFWorkbenchEditPlugin.ID).logError(e);
}
} else {
Logger.getLogger().logError(EMFWorkbenchEditResourceHandler.EditModelRegistry_ERROR_1); //$NON-NLS-1$
}
}
return this.factory;
}
private void initializeResources() {
if (editModelResources == null) {
if (configurationElement != null) {
editModelResources = new ArrayList();
IConfigurationElement[] resources = configurationElement.getChildren(EditModelResource.EDIT_MODEL_RESOURCE_ELEMENT);
for (int j = 0; j < resources.length; j++)
editModelResources.add(new EditModelResource(resources[j]));
discardConfigurationElementIfNecessary();
} else {
editModelResources = Collections.EMPTY_LIST;
}
}
}
private void discardConfigurationElementIfNecessary() {
if (this.editModelResources != null && this.factory != null)
this.configurationElement = null;
}
public String toString() {
if (tostringCache == null)
tostringCache = "EditModelID: {" + this.editModelID + "}, Parent Model ID {" + this.parentModelID + "}, Configuration Element: [" + this.configurationElement + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$//$NON-NLS-4$
return tostringCache;
}
/**
* @return Returns the parentModelID.
*/
public String getParentModelID() {
return parentModelID;
}
}
/**
* @return Returns the initialized.
*/
protected static boolean isInitialized() {
return initialized;
}
public String[] getRegisteredEditModelIDs() {
return (String[]) factoryConfigurations.keySet().toArray(new String[factoryConfigurations.keySet().size()]);
}
}
|
