Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 97d7f77b5c80b80367bf80cce5bb6706c06533aa (plain) (blame)
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
/**
 * <copyright> Copyright (c) 2005, 2006, 2007, 2008 Springsite BV (The Netherlands) 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: Martin Taal </copyright> $Id:
 * EListPropertyHandler.java,v 1.12 2007/03/20 23:33:48 mtaal Exp $
 */

package org.eclipse.emf.teneo.hibernate.mapping.property;

import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.common.util.EMap;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.InternalEObject;
import org.eclipse.emf.ecore.InternalEObject.EStore;
import org.eclipse.emf.ecore.impl.BasicEObjectImpl;
import org.eclipse.emf.ecore.util.BasicFeatureMap;
import org.eclipse.emf.ecore.util.EcoreEMap;
import org.eclipse.emf.teneo.PersistenceOptions;
import org.eclipse.emf.teneo.extension.ExtensionManager;
import org.eclipse.emf.teneo.extension.ExtensionManagerAware;
import org.eclipse.emf.teneo.extension.ExtensionPoint;
import org.eclipse.emf.teneo.hibernate.HbMapperException;
import org.eclipse.emf.teneo.hibernate.mapping.elist.HbExtraLazyPersistableEList;
import org.eclipse.emf.teneo.hibernate.mapping.elist.HbExtraLazyPersistableEMap;
import org.eclipse.emf.teneo.hibernate.mapping.elist.HibernatePersistableEList;
import org.eclipse.emf.teneo.hibernate.mapping.elist.HibernatePersistableEMap;
import org.eclipse.emf.teneo.hibernate.mapping.elist.MapHibernatePersistableEMap;
import org.eclipse.emf.teneo.mapping.elist.MapPersistableEMap;
import org.eclipse.emf.teneo.mapping.elist.PersistableDelegateList;
import org.eclipse.emf.teneo.mapping.elist.PersistableEList;
import org.eclipse.emf.teneo.mapping.elist.PersistableEMap;
import org.eclipse.emf.teneo.type.PersistentStoreAdapter;
import org.eclipse.emf.teneo.util.AssertUtil;
import org.eclipse.emf.teneo.util.FieldUtil;
import org.eclipse.emf.teneo.util.StoreUtil;
import org.hibernate.HibernateException;
import org.hibernate.PropertyNotFoundException;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.property.Getter;
import org.hibernate.property.PropertyAccessor;
import org.hibernate.property.Setter;

/**
 * Implements the accessor for EMF EList members for Hibernate. This can be an EReference or an
 * Eattribute with many=true. This class implements both the getter, setter and propertyaccessor
 * interfaces. When the getGetter and getSetter methods are called it returns itself.
 * 
 * @author <a href="mailto:mtaal@elver.org">Martin Taal</a>
 * @version $Revision: 1.39 $
 */
@SuppressWarnings("unchecked")
public class EListPropertyHandler implements Getter, Setter, PropertyAccessor, ExtensionPoint,
		ExtensionManagerAware {
	/**
	 * Generated Serial Version ID
	 */
	private static final long serialVersionUID = 2255108246093951341L;

	/** The logger */
	private static Log log = LogFactory.getLog(EListPropertyHandler.class);

	/** The EStructuralFeature of this accessor */
	protected EStructuralFeature eFeature;

	/** Extra lazy behavior! */
	private boolean extraLazy;

	/** Map emap as a real map */
	private boolean newEMapMapping;

	/** It this a map */
	private boolean isAMap;

	/** The extension manager */
	private ExtensionManager extensionManager;

	private PersistenceOptions persistenceOptions;

	/** Initialize this instance */
	public void initialize(EStructuralFeature eFeature, boolean extraLazy, boolean newEMapMapping) {
		this.extraLazy = extraLazy;
		this.eFeature = eFeature;
		if (log.isDebugEnabled()) {
			log.debug("Created getter/setter for " + StoreUtil.toString(eFeature));
		}
		AssertUtil.assertTrue(
				"Many must be true but this isn't the case for " + StoreUtil.toString(eFeature),
				eFeature.isMany());
		isAMap = StoreUtil.isMap(eFeature);
		this.newEMapMapping = newEMapMapping;
	}

	public EStructuralFeature getEFeature() {
		return eFeature;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Getter#getMember()
	 */
	public Member getMember() {
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.PropertyAccessor#getGetter(java.lang.Class, java.lang.String)
	 */
	@SuppressWarnings("rawtypes")
	public Getter getGetter(Class theClass, String propertyName) throws PropertyNotFoundException {
		return this;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.PropertyAccessor#getSetter(java.lang.Class, java.lang.String)
	 */
	@SuppressWarnings("rawtypes")
	public Setter getSetter(Class theClass, String propertyName) throws PropertyNotFoundException {
		return this;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Getter#get(java.lang.Object)
	 */
	public Object get(Object owner) throws HibernateException {

		final PersistentStoreAdapter adapter = StoreUtil.getPersistentStoreAdapter((EObject) owner);
		final Object value = adapter.getStoreCollection(eFeature);
		if (value != null) {
			return value;
		}

		Object obj = ((EObject) owner).eGet(eFeature);

		if (StoreUtil.isEStoreList(obj)) {
			final EStore eStore = ((InternalEObject) owner).eStore();
			// the call to size forces a load, this is a trick to
			// force the estore to create a list, otherwise the .get
			// will return a null value.
			if (eStore.size((InternalEObject) owner, eFeature) != -1) {
				obj = eStore.get((InternalEObject) owner, eFeature, EStore.NO_INDEX);
			}
		}

		if (obj instanceof PersistableDelegateList<?>) {
			return ((PersistableDelegateList<?>) obj).getDelegate();
		}
		if (obj instanceof EcoreEMap<?, ?> && newEMapMapping) {
			return ((EcoreEMap<?, ?>) obj).map();
		}

		if (adapter.isTargetCreatedByORM() && obj instanceof BasicFeatureMap) {
			// this one is replaced here
			// because the entries
			// need to be changed to hibernate entries
			final PersistableDelegateList<?> pelist = (PersistableDelegateList<?>) createPersistableList(
					(InternalEObject) owner, eFeature, (List<?>) obj);
			final EObject eobj = (EObject) owner;
			if (!EcoreAccess.isStaticFeature(eFeature, (BasicEObjectImpl) eobj)) {
				if (log.isDebugEnabled()) {
					log.debug("Dynamic elist, set using the esettings");
				}
				EcoreAccess.setManyEFeatureValue(eFeature, pelist, (BasicEObjectImpl) owner);
			} else {
				// TODO: currently it is required to use the field setter
				// instead of the eSet method
				// because EMF does not support direct setting of the elist
				// feature.
				// UPDATE: for dynamic eclasses now elists are also supported
				// the reason that the javafield is determined here and not at
				// construction time
				// is that the owner passed in the construction can be an
				// interface while there
				// are multiple implementors. FieldUtil does caching of
				// fieldnames and fields.
				final Field javaField = FieldUtil.getField(owner.getClass(), getFieldName(owner));
				try {
					javaField.set(owner, pelist);
				} catch (Exception e) {
					throw new HbMapperException("The field " + javaField.getName()
							+ " can not be set using object " + pelist.getClass().getName() + " on target "
							+ owner.getClass().getName(), e);
				}
			}
		}

		if (obj instanceof EList<?>) {
			return processList(obj);
		}

		return obj;
	}

	protected String getFieldName(Object owner) {
		return eFeature.getName();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Getter#getForInsert(java.lang.Object, java.util.Map,
	 * org.hibernate.engine.SessionImplementor)
	 */
	@SuppressWarnings("rawtypes")
	public Object getForInsert(Object owner, Map mergeMap, SessionImplementor session)
			throws HibernateException {
		final PersistentStoreAdapter adapter = StoreUtil.getPersistentStoreAdapter((EObject) owner);
		final Object value = adapter.getStoreCollection(eFeature);
		if (value != null) {
			return value;
		}

		Object obj = ((EObject) owner).eGet(eFeature);

		if (StoreUtil.isEStoreList(obj)) {
			final EStore eStore = ((InternalEObject) owner).eStore();
			// the call to size forces a load, this is a trick to
			// force the estore to create a list, otherwise the .get
			// will return a null value.
			if (eStore.size((InternalEObject) owner, eFeature) != -1) {
				obj = eStore.get((InternalEObject) owner, eFeature, EStore.NO_INDEX);
			}
		}

		if (obj instanceof PersistableDelegateList) {
			return ((PersistableDelegateList) obj).getDelegate();
		}
		if (obj instanceof EcoreEMap && newEMapMapping) {
			return ((EcoreEMap<?, ?>) obj).map();
		}

		// if this is a elist then give a normal arraylist to
		// hibernate otherwise hb will wrap the elist, the hb wrapper
		// is again wrapped by teneo resulting in notifications being send
		// out by both the teneo wrapper as the wrapped elist
		if (obj instanceof EList<?>) {
			final List<Object> objects = processList(obj);
			if (extraLazy) {
				int index = 0;
				for (Object object : objects) {
					if (object instanceof EObject) {
						final PersistentStoreAdapter elementAdapter = StoreUtil
								.getPersistentStoreAdapter((EObject) object);
						elementAdapter.setSyntheticProperty(
								StoreUtil.getExtraLazyInverseIndexPropertyName(eFeature), index);
						elementAdapter.setSyntheticProperty(
								StoreUtil.getExtraLazyInversePropertyName(eFeature), owner);
					}
					index++;
				}
			}
			return objects;
		}

		// todo maybe throw error in all other cases?
		return obj;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Getter#getMethod()
	 */
	public Method getMethod() {
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Getter#getMethodName()
	 */
	public String getMethodName() {
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Getter#getReturnType()
	 */
	@SuppressWarnings("rawtypes")
	public Class getReturnType() {
		return EList.class;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.hibernate.property.Setter#set(java.lang.Object, java.lang.Object,
	 * org.hibernate.engine.SessionFactoryImplementor)
	 */
	@SuppressWarnings("rawtypes")
	public void set(Object target, Object value, SessionFactoryImplementor factory)
			throws HibernateException {

		final PersistentStoreAdapter adapter = StoreUtil.getPersistentStoreAdapter((EObject) target);
		if (!adapter.isTargetCreatedByORM()) {
			adapter.addStoreCollection(eFeature, value);
			return;
		}

		if (!EcoreAccess.isStaticFeature(eFeature, (BasicEObjectImpl) target)) {
			if (log.isDebugEnabled()) {
				log.debug("Dynamic elist, set using the esettings");
			}
			Object currentValue = EcoreAccess.getManyEFeatureValue(eFeature, (BasicEObjectImpl) target);

			if (StoreUtil.isEStoreList(currentValue)) {
				final EStore eStore = ((InternalEObject) target).eStore();
				if (eStore.size((InternalEObject) target, eFeature) != -1) {
					currentValue = eStore.get((InternalEObject) target, eFeature, EStore.NO_INDEX);
				}
			}

			// if currentvalue is not null then use the passed value
			if (currentValue != null && currentValue instanceof PersistableEList<?>) {
				((PersistableEList<?>) currentValue).replaceDelegate((List) value);
			} else {
				if (value instanceof Map<?, ?>) {
					EcoreAccess.setManyEFeatureValue(eFeature,
							createPersistableMap((InternalEObject) target, eFeature, (Map<?, ?>) value),
							(BasicEObjectImpl) target);
				} else {
					EcoreAccess.setManyEFeatureValue(eFeature,
							createPersistableList((InternalEObject) target, eFeature, (List<?>) value),
							(BasicEObjectImpl) target);
				}
			}
			if (log.isDebugEnabled()) {
				log.debug("Set value " + value.getClass().getName() + " for target "
						+ target.getClass().getName() + " field " + getFieldName(target));
			}

		} else {
			// the reason that the javafield is determined here and not at
			// construction time
			// is that the owner passed in the construction can be an interface
			// while there
			// are multiple implementors. FieldUtil does caching of fieldnames
			// and fields.
			final Field javaField = FieldUtil.getField(target.getClass(), getFieldName(target));

			// do not set the java field if not present, but use the store
			// adapter
			// this happens in case of gmf see bugzilla: 280040
			if (javaField == null) {
				adapter.addStoreCollection(eFeature, value);
				return;
			}

			try {
				final Object currentValue = javaField.get(target);

				// if already set then ignore it
				if (currentValue == value) {
					return; // nothing to do here
				}

				// the delegating map was passed to hibernate, now getting it
				// back
				if (value instanceof EMap.InternalMapView<?, ?>
						&& (currentValue == ((EMap.InternalMapView<?, ?>) value).eMap())) {
					return;
				}

				// already handled
				if (currentValue instanceof PersistableDelegateList<?>
						&& value == ((PersistableDelegateList<?>) currentValue).getDelegate()) {
					return;
				}

				// the follow 3 if statements handle the refresh action, the
				// underlying orm
				// collection is replaced
				if (currentValue != null && currentValue instanceof PersistableEList<?>
						&& value != ((PersistableEList<?>) currentValue).getDelegate()) {
					((PersistableEList<?>) currentValue).replaceDelegate((List) value);
				} else if (currentValue != null && currentValue instanceof PersistableEMap<?, ?>
						&& value != ((PersistableEMap<?, ?>) currentValue).getDelegate()) {
					((PersistableEMap<?, ?>) currentValue).replaceDelegate(value);
				} else if (currentValue != null && currentValue instanceof MapPersistableEMap<?, ?>
						&& value != ((MapPersistableEMap<?, ?>) currentValue).getORMMapDelegate()) {
					((PersistableEMap<?, ?>) currentValue).replaceDelegate(value);
				} else { // then wrap the hibernate collection
					if (value instanceof Map<?, ?>) {
						javaField.set(target,
								createPersistableMap((InternalEObject) target, eFeature, (Map<?, ?>) value));
					} else {
						javaField.set(target,
								createPersistableList((InternalEObject) target, eFeature, (List<?>) value));
					}
				}
				if (log.isDebugEnabled()) {
					log.debug("Set value " + value.getClass().getName() + " for target "
							+ target.getClass().getName() + " field " + getFieldName(target));
				}
			} catch (Exception e) {
				throw new HbMapperException("The field "
						+ (javaField != null ? javaField.getName() : getFieldName(target))
						+ " can not be set using object " + value.getClass().getName() + " on target "
						+ target.getClass().getName(), e);
			}
		}
	}

	/**
	 * Create a EMap. Create method can be overridden
	 */
	protected EList<?> createPersistableMap(InternalEObject target, EStructuralFeature estruct,
			Map<?, ?> map) {
		final EReference eref = (EReference) estruct;
		if (log.isDebugEnabled()) {
			log.debug("Detected EMAP for " + estruct.getName());
		}
		assert (isAMap);
		assert (newEMapMapping);
		return getExtensionManager().getExtension(MapHibernatePersistableEMap.class,
				new Object[] { target, eref, map });
	}

	/** Creates a persistablemap or list */
	protected EList<?> createPersistableList(InternalEObject target, EStructuralFeature estruct,
			List<?> list) {
		if (estruct instanceof EReference) {
			final EReference eref = (EReference) estruct;
			// the test for emap checks: the entry class must have a
			// instanceclass: Map.Entry
			// and the entry class must have two efeatures with the name key and
			// value
			if (StoreUtil.isMap(estruct)) {
				if (log.isDebugEnabled()) {
					log.debug("Detected EMAP for " + estruct.getName());
				}
				if (extraLazy) {
					return getExtensionManager().getExtension(HbExtraLazyPersistableEMap.class,
							new Object[] { target, eref, list });
				} else {
					return getExtensionManager().getExtension(HibernatePersistableEMap.class,
							new Object[] { target, eref, list });
				}
			}
		}
		if (extraLazy) {
			final HbExtraLazyPersistableEList<?> persistableEList = getExtensionManager().getExtension(
					HbExtraLazyPersistableEList.class, new Object[] { target, estruct, list });
			if (persistenceOptions != null) {
				persistableEList.setEfficientSizeOperation(persistenceOptions
						.isEListEfficientSizeOperation());
			}
			return persistableEList;
		}
		HibernatePersistableEList<?> persistableEList = getExtensionManager().getExtension(
				HibernatePersistableEList.class, new Object[] { target, estruct, list });
		if (persistenceOptions != null) {
			persistableEList
					.setEfficientSizeOperation(persistenceOptions.isEListEfficientSizeOperation());
		}
		return persistableEList;
	}

	protected List<Object> processList(Object list) {
		return new ArrayList<Object>((List<Object>) list);
	}

	/**
	 * @return the extensionManager
	 */
	public ExtensionManager getExtensionManager() {
		return extensionManager;
	}

	/**
	 * @param extensionManager
	 *          the extensionManager to set
	 */
	public void setExtensionManager(ExtensionManager extensionManager) {
		this.extensionManager = extensionManager;
	}

	public void setPersistenceOptions(PersistenceOptions po) {
		persistenceOptions = po;
	}
}

Back to the top