3 * Copyright (C) 2014 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.taxeditor
.session
;
12 import java
.util
.ArrayList
;
13 import java
.util
.Arrays
;
14 import java
.util
.Collection
;
15 import java
.util
.List
;
17 import java
.util
.UUID
;
19 import net
.sf
.ehcache
.statistics
.LiveCacheStatistics
;
21 import org
.apache
.log4j
.Logger
;
23 import eu
.etaxonomy
.cdm
.api
.service
.IService
;
24 import eu
.etaxonomy
.cdm
.api
.service
.UpdateResult
;
25 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
26 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CdmTransientEntityCacher
;
27 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.EntityCacherDebugResult
;
32 * NOTE : It would be nice to have this class performing merge / delete operations
33 * using services, but this is only possible if we can 'intelligently'
34 * get from a model class to the correspoding service class
40 public class CdmEntitySession
implements ICdmEntitySession
{
42 private static final Logger logger
= Logger
.getLogger(CdmEntitySession
.class);
44 private final CdmEntitySessionManager cdmEntitySessionManager
;
46 private final ICdmEntitySessionEnabled sessionOwner
;
48 private CdmTransientEntityCacher cdmTransientEntityCacher
;
50 private List
<ICdmEntitySessionEnabled
> changeObservers
;
53 public CdmEntitySession(ICdmEntitySessionEnabled sessionOwner
, CdmEntitySessionManager cdmEntitySessionManager
) {
54 this.sessionOwner
= sessionOwner
;
55 this.cdmEntitySessionManager
= cdmEntitySessionManager
;
56 init(sessionOwner
, cdmEntitySessionManager
);
59 private void init(ICdmEntitySessionEnabled sessionOwner
, CdmEntitySessionManager cdmEntitySessionManager
) {
60 this.cdmTransientEntityCacher
= new CdmTransientEntityCacher(sessionOwner
, cdmEntitySessionManager
);
61 this.changeObservers
= new ArrayList
<ICdmEntitySessionEnabled
>();
62 cdmEntitySessionManager
.addToOwnerSessionMap(sessionOwner
, this);
68 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(java.lang.Object, boolean)
71 public <O
extends Object
> O
load(O obj
, boolean update
) {
72 return cdmTransientEntityCacher
.load(obj
, update
);
77 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(eu.etaxonomy.cdm.model.common.CdmBase, boolean)
80 public <T
extends CdmBase
> T
load(T cdmBase
, boolean update
) {
81 return (T
)cdmTransientEntityCacher
.load(cdmBase
, update
);
87 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(eu.etaxonomy.cdm.api.service.UpdateResult, boolean)
90 public UpdateResult
load(UpdateResult updateResult
, boolean update
) {
91 return cdmTransientEntityCacher
.load(updateResult
, update
);
95 public <T
extends CdmBase
> void update() {
96 Collection
<T
> rootEntities
= getRootEntities();
97 if(rootEntities
!= null) {
98 for(T rootEntity
: rootEntities
) {
99 load(rootEntity
, true);
105 // public <T extends ICdmBase> void update(T cdmBase, Set<CdmBase> affectedObjects) {
106 // addEvent(cdmBase, affectedObjects, EventType.UPDATE);
110 // public <T extends ICdmBase> void update(T cdmBase, CdmBase affectedObject) {
111 // Set<CdmBase> set = new HashSet<CdmBase>();
112 // set.add(affectedObject);
113 // addEvent(cdmBase, set, EventType.UPDATE);
118 // public <T extends ICdmBase> void delete(T cdmBase, Set<CdmBase> affectedObjects) {
119 // addEvent(cdmBase, affectedObjects, EventType.DELETE);
123 // public <T extends ICdmBase> void delete(Set<T> cdmBases, Set<CdmBase> affectedObjects) {
124 // addEvent(cdmBases, affectedObjects, EventType.DELETE);
130 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#debug(eu.etaxonomy.cdm.model.common.CdmBase)
133 public <T
extends CdmBase
> EntityCacherDebugResult
debug(T cdmBase
) {
134 return debug(Arrays
.asList(cdmBase
));
140 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#debug(java.util.List)
143 public <T
extends CdmBase
> EntityCacherDebugResult
debug(Collection
<T
> cdmBases
) {
144 EntityCacherDebugResult entityCacherDebugResult
=
145 new EntityCacherDebugResult(cdmTransientEntityCacher
, cdmBases
);
146 return entityCacherDebugResult
;
151 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#debug()
154 public <T
extends CdmBase
> EntityCacherDebugResult
debug() {
155 return debug(getRootEntities());
159 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(java.util.Collection)
162 public <T
extends CdmBase
> Collection
<T
> load(Collection
<T
> cdmBaseList
, boolean update
) {
163 return cdmTransientEntityCacher
.load(cdmBaseList
, update
);
167 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#setEntitiesAsLatest()
170 public void setEntitiesAsLatest() {
171 //FIXME:Remoting need to think more about whether we really need this
172 // List<CdmBase> entities = cdmTransientEntityCacher.getAllEntities();
173 // for(CdmBase entity : entities) {
174 // cdmEntitySessionManager.setEntityAsLatest(entity);
181 logger
.info("Binding session with owner " + sessionOwner
.toString());
182 if(!cdmEntitySessionManager
.contains(sessionOwner
)) {
183 init(sessionOwner
, cdmEntitySessionManager
);
185 cdmEntitySessionManager
.bind(sessionOwner
);
190 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#dispose()
193 public void dispose() {
195 cdmTransientEntityCacher
.dispose();
196 changeObservers
.clear();
197 cdmEntitySessionManager
.remove(sessionOwner
);
203 // * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#commit()
206 // public void addEvent(ICdmBase cdmBase, Set<CdmBase> affectedObjects, EventType eventType) {
207 // affectedObjects = (Set<CdmBase>) load(affectedObjects, true);
208 // CdmDataChangeEvent cdce = CdmDataChangeEvent.NewInstance((CdmBase)cdmBase, affectedObjects, eventType);
209 // CdmPostDataChangeObservableListener.getDefault().notifyObservers(cdce);
214 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(java.util.UUID, java.lang.Class)
217 public <T
extends CdmBase
> T
remoteLoad(IService
<T
> service
, UUID uuid
) {
218 T cdmBase
= service
.load(uuid
);
219 return load(cdmBase
, false);
224 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(eu.etaxonomy.cdm.api.service.IService, java.util.UUID, java.util.List)
227 public <T
extends CdmBase
> T
remoteLoad(IService
<T
> service
, UUID uuid
, List
<String
> propertyPaths
) {
228 T cdmBase
= service
.load(uuid
, propertyPaths
);
229 return load(cdmBase
, false);
234 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#save(eu.etaxonomy.cdm.api.service.IService, eu.etaxonomy.cdm.model.common.CdmBase)
237 public <T
extends CdmBase
> UUID
remoteSave(IService
<T
> service
, T cdmBase
) {
238 UUID uuid
= service
.save(cdmBase
).getUuid();
245 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#update(eu.etaxonomy.cdm.api.service.IService, eu.etaxonomy.cdm.model.common.CdmBase)
248 public <T
extends CdmBase
> T
remoteUpdate(IService
<T
> service
, T cdmBase
) {
249 T mergedCdmBase
= service
.merge(cdmBase
);
250 return mergedCdmBase
;
255 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#isActive()
258 public boolean isActive() {
259 return cdmEntitySessionManager
.getActiveSession() == this;
264 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#getOwner()
267 public ICdmEntitySessionEnabled
getOwner() {
273 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#getNoOfObjectsInCache()
276 public LiveCacheStatistics
getCacheStatistics() {
277 return cdmTransientEntityCacher
.getCacheStatistics();
282 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#getRootEntities()
285 public <T
extends CdmBase
> Collection
<T
> getRootEntities() {
286 return sessionOwner
.getRootEntities();
289 public CdmTransientEntityCacher
getCacher() {
290 return cdmTransientEntityCacher
;
294 public List
<String
> getPropertyPaths(Object obj
) {
295 Map
<Object
, List
<String
>> propertyPathsMap
= sessionOwner
.getPropertyPathsMap();
296 if(propertyPathsMap
== null || propertyPathsMap
.isEmpty()) {
299 return propertyPathsMap
.get(obj
);