/
EMFEditObservables.java
324 lines (308 loc) · 11.4 KB
/
EMFEditObservables.java
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
/**
* <copyright>
*
* Copyright (c) 2007 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 - Initial API and implementation
*
* </copyright>
*
* $Id: EMFEditObservables.java,v 1.3 2008/04/22 13:35:52 emerks Exp $
*/
package org.eclipse.emf.databinding.edit;
import org.eclipse.core.databinding.observable.IObservable;
import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.map.IObservableMap;
import org.eclipse.core.databinding.observable.masterdetail.IObservableFactory;
import org.eclipse.core.databinding.observable.masterdetail.MasterDetailObservables;
import org.eclipse.core.databinding.observable.set.IObservableSet;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.emf.common.util.EMap;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.edit.domain.EditingDomain;
/**
* PROVISIONAL This API is subject to arbitrary change, including renaming or
* removal.
*/
public class EMFEditObservables {
/**
* Returns an observable value for the given feature of the object.
*
* @param domain
* the editing domain used for applying changes.
* @param eObject
* the object to observe.
* @param eStructuralFeature
* the feature of the object to observe.
* @return an observable value for the given feature of the object.
*/
@SuppressWarnings("deprecation")
public static IObservableValue observeValue(EditingDomain domain,
EObject eObject, EStructuralFeature eStructuralFeature) {
return new EditingDomainEObjectObservableValue(domain, eObject,
eStructuralFeature);
}
/**
* Returns an observable value for the given feature of the object.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param eObject
* the object to observe.
* @param eStructuralFeature
* the feature of the object to observe.
* @return an observable value for the given feature of the object.
*/
@SuppressWarnings("deprecation")
public static IObservableValue observeValue(Realm realm,
EditingDomain domain, EObject eObject,
EStructuralFeature eStructuralFeature) {
return new EditingDomainEObjectObservableValue(realm, domain, eObject,
eStructuralFeature);
}
/**
* Returns an observable value for the given feature of the object.
*
* @param eObject
* the object to observe.
* @param domain
* the editing domain used for applying changes.
* @param eStructuralFeature
* the map feature whose key is observed
* @param key
* the key value
* @param eMapValueFeature
* the value feature name
* @return an observable value for the given feature of the object.
*/
public static IObservableValue observeMapValue(EditingDomain domain, EObject eObject,
EStructuralFeature eStructuralFeature, Object key,
EStructuralFeature eMapValueFeature) {
EMap<?, ?> map = (EMap<?, ?>) eObject.eGet(eStructuralFeature);
return observeValue(domain, (EObject) map.get(map.indexOfKey(key)),
eMapValueFeature);
}
/**
* Returns an observable value for the given feature of the object.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param eObject
* the object to observe.
* @param eStructuralFeature
* the map feature whose key is observed
* @param key
* the key value
* @param eMapValueFeature
* the value feature name
* @return an observable value for the given feature of the object.
*/
public static IObservableValue observeMapValue(Realm realm,
EditingDomain domain, EObject eObject, EStructuralFeature eStructuralFeature, Object key,
EStructuralFeature eMapValueFeature) {
EMap<?, ?> map = (EMap<?, ?>) eObject.eGet(eStructuralFeature);
return observeValue(realm, domain, (EObject) map.get(map.indexOfKey(key)),
eMapValueFeature);
}
/**
* Returns an observable list for the given multi-valued feature of the
* object.
*
* @param domain
* the editing domain used for applying changes.
* @param eObject
* the object to observe.
* @param eStructuralFeature
* the feature of the object to observe.
* @return an observable list for the given multi-valued feature of the
* object.
*/
@SuppressWarnings("deprecation")
public static IObservableList observeList(EditingDomain domain,
EObject eObject, EStructuralFeature eStructuralFeature) {
return new EditingDomainEObjectObservableList(domain, eObject,
eStructuralFeature);
}
/**
* Returns an observable list for the given multi-valued feature of the
* object.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param eObject
* the object to observe.
* @param eStructuralFeature
* the feature of the object to observe.
* @return an observable list for the given multi-valued feature of the
* object.
*/
@SuppressWarnings("deprecation")
public static IObservableList observeList(Realm realm,
EditingDomain domain, EObject eObject,
EStructuralFeature eStructuralFeature) {
return new EditingDomainEObjectObservableList(realm, domain, eObject,
eStructuralFeature);
}
/**
* Returns an observable map in the default realm tracking the current value
* of the given feature for each object in the given set.
*
* @param domain
* the editing domain used for applying changes.
* @param objects
* the objects to track.
* @param eStructuralFeature
* the feature for which to track the value.
* @return an observable map tracking the current value of the given feature
* for each object in the given set.
*/
@SuppressWarnings("deprecation")
public static IObservableMap observeMap(EditingDomain domain,
IObservableSet objects, EStructuralFeature eStructuralFeature) {
return new EditingDomainEObjectObservableMap(domain, objects,
eStructuralFeature);
}
/**
* Returns an array of observable maps in the default realm tracking the
* current value of the given features for each object in the given set.
*
* @param domain
* the editing domain used for applying changes.
* @param objects
* the objects to track.
* @param eStructuralFeatures
* the features for which to track the value.
* @return an array of observable maps tracking the current value of the
* given features for each object in the given set.
*/
public static IObservableMap[] observeMaps(EditingDomain domain,
IObservableSet objects, EStructuralFeature... eStructuralFeatures) {
IObservableMap[] result = new IObservableMap[eStructuralFeatures.length];
for (int i = 0; i < eStructuralFeatures.length; i++) {
result[i] = observeMap(domain, objects, eStructuralFeatures[i]);
}
return result;
}
/**
* Returns an observable value that tracks the current value of the feature
* of the current value of the master observable value.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param value
* the master observable value.
* @param eStructuralFeature
* the feature for which to track the value.
* @return an observable value that tracks the current value of the named
* property for the current value of the master observable value
* @see MasterDetailObservables#detailValue(IObservableValue,
* IObservableFactory, Object)
*/
public static IObservableValue observeDetailValue(Realm realm,
EditingDomain domain, IObservableValue value,
EStructuralFeature eStructuralFeature) {
return MasterDetailObservables.detailValue(value, valueFactory(realm,
domain, eStructuralFeature), eStructuralFeature);
}
/**
* Returns a factory for creating observable values tracking the value of
* the given feature of a particular {@link EObject object}.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param eStructuralFeature
* the feature for which to track the value.
* @return an observable factory.
*/
public static IObservableFactory valueFactory(final Realm realm,
final EditingDomain domain,
final EStructuralFeature eStructuralFeature) {
return new IObservableFactory() {
public IObservable createObservable(Object target) {
return observeValue(realm, domain, (EObject) target,
eStructuralFeature);
}
};
}
/**
* Returns an observable list that tracks the current value of the feature
* of the current value of the master observable value.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param value
* the master observable value.
* @param eStructuralFeature
* the feature for which to track the value.
* @return an observable value that tracks the current value of the named
* property for the current value of the master observable value
* @see MasterDetailObservables#detailList(IObservableValue,
* IObservableFactory, Object)
*/
public static IObservableList observeDetailList(Realm realm,
EditingDomain domain, IObservableValue value,
EStructuralFeature eStructuralFeature) {
return MasterDetailObservables.detailList(value, listFactory(realm,
domain, eStructuralFeature), eStructuralFeature);
}
/**
* Returns a factory for creating observable lists tracking the value of the
* given feature of a particular {@link EObject object}.
*
* @param realm
* the realm in which to observe.
* @param domain
* the editing domain used for applying changes.
* @param eStructuralFeature
* the feature for which to track the value.
* @return an observable factory.
*/
public static IObservableFactory listFactory(final Realm realm,
final EditingDomain domain,
final EStructuralFeature eStructuralFeature) {
return new IObservableFactory() {
public IObservable createObservable(Object target) {
return observeList(realm, domain, (EObject) target,
eStructuralFeature);
}
};
}
/**
* Returns a factory for creating observable maps tracking the value of the
* given feature of a particular {@link EObject object}.
*
* @param domain
* the editing domain used for applying changes.
* @param eStructuralFeature
* the feature for which to track the value.
* @return an observable factory.
*/
public static IObservableFactory mapFactory(final EditingDomain domain,
final EStructuralFeature eStructuralFeature) {
return new IObservableFactory() {
public IObservable createObservable(Object target) {
return observeMap(domain, (IObservableSet) target,
eStructuralFeature);
}
};
}
}