update javadoc and Override in IdentifiableServiceBase
[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / service / IdentifiableServiceBase.java
index 4d9bf61ce76544b199d1e949b831b90d35b41969..8d0d728cf4fbe270bc355b2bdd51e2a26a60d90b 100644 (file)
@@ -12,21 +12,22 @@ package eu.etaxonomy.cdm.api.service;
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import org.apache.log4j.Logger;
 import org.hibernate.criterion.Criterion;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
 
 import eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator;
 import eu.etaxonomy.cdm.api.service.pager.Pager;
 import eu.etaxonomy.cdm.api.service.pager.impl.DefaultPagerImpl;
-import eu.etaxonomy.cdm.common.DefaultProgressMonitor;
-import eu.etaxonomy.cdm.common.IProgressMonitor;
+import eu.etaxonomy.cdm.common.monitor.DefaultProgressMonitor;
+import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;
+import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;
 import eu.etaxonomy.cdm.model.common.CdmBase;
 import eu.etaxonomy.cdm.model.common.ISourceable;
 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
@@ -34,9 +35,12 @@ import eu.etaxonomy.cdm.model.common.IdentifiableSource;
 import eu.etaxonomy.cdm.model.common.LSID;
 import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;
 import eu.etaxonomy.cdm.model.media.Rights;
+import eu.etaxonomy.cdm.model.name.NonViralName;
 import eu.etaxonomy.cdm.model.reference.Reference;
 import eu.etaxonomy.cdm.model.reference.ReferenceFactory;
 import eu.etaxonomy.cdm.persistence.dao.common.IIdentifiableDao;
+import eu.etaxonomy.cdm.persistence.dao.hibernate.HibernateBeanInitializer;
+import eu.etaxonomy.cdm.persistence.dao.initializer.AutoPropertyInitializer;
 import eu.etaxonomy.cdm.persistence.query.MatchMode;
 import eu.etaxonomy.cdm.persistence.query.OrderHint;
 import eu.etaxonomy.cdm.persistence.query.OrderHint.SortOrder;
@@ -51,14 +55,12 @@ import eu.etaxonomy.cdm.strategy.merge.MergeException;
 
 public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO extends IIdentifiableDao<T>> extends AnnotatableServiceBase<T,DAO> 
                                                implements IIdentifiableEntityService<T>{
-       
-    @Autowired
-    protected ICommonService commonService;
 
        
        protected static final int UPDATE_TITLE_CACHE_DEFAULT_STEP_SIZE = 1000;
        protected static final  Logger logger = Logger.getLogger(IdentifiableServiceBase.class);
 
+       @Override
        @Transactional(readOnly = true)
        public Pager<Rights> getRights(T t, Integer pageSize, Integer pageNumber, List<String> propertyPaths) {
         Integer numberOfResults = dao.countRights(t);
@@ -71,6 +73,7 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                return new DefaultPagerImpl<Rights>(pageNumber, numberOfResults, pageSize, results);
        }
        
+       @Override
        @Transactional(readOnly = true)
        public Pager<IdentifiableSource> getSources(T t, Integer pageSize, Integer pageNumber, List<String> propertyPaths) {
                 Integer numberOfResults = dao.countSources(t);
@@ -85,6 +88,7 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
 
        
        @Transactional(readOnly = false)
+       @Override
        public T replace(T x, T y) {
                return dao.replace(x, y);
        }
@@ -117,6 +121,7 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
         * @see eu.etaxonomy.cdm.api.service.ICommonService#getSourcedObjectById(java.lang.String, java.lang.String)
         */
        @Transactional(readOnly = true)
+       @Override
        public ISourceable getSourcedObjectByIdInSource(Class clazz, String idInSource, String idNamespace) {
                ISourceable result = null;
 
@@ -127,15 +132,14 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                return result;
        }
        
-       /* (non-Javadoc)
-        * @see eu.etaxonomy.cdm.api.service.IIdentifiableEntityService#getUuidAndTitleCache()
-        */
        @Transactional(readOnly = true)
+       @Override
        public List<UuidAndTitleCache<T>> getUuidAndTitleCache() {
                return dao.getUuidAndTitleCache();
        }\r
        
        @Transactional(readOnly = true)\r
+       @Override
        public Pager<T> findByTitle(Class<? extends T> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {\r
                 Integer numberOfResults = dao.countByTitle(clazz, queryString, matchmode, criteria);\r
                        \r
@@ -148,11 +152,13 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
        }
        
        @Transactional(readOnly = true)
+       @Override
        public Pager<T> findByTitle(IIdentifiableEntityServiceConfigurator<T> config){
                return findByTitle(config.getClazz(), config.getTitleSearchStringSqlized(), config.getMatchMode(), config.getCriteria(), config.getPageSize(), config.getPageNumber(), config.getOrderHints(), config.getPropertyPaths());
        }
        
        @Transactional(readOnly = true)
+       @Override
        public List<T> listByTitle(Class<? extends T> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {
                 Integer numberOfResults = dao.countByTitle(clazz, queryString, matchmode, criteria);
                        
@@ -162,8 +168,24 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                 }
                 return results;
        }
+       
+       @Transactional(readOnly = true)
+       @Override
+       public Pager<T> findTitleCache(Class<? extends T> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, MatchMode matchMode){
+               long numberOfResults = dao.countTitleCache(clazz, queryString, matchMode);
+                       
+                List<T> results = new ArrayList<T>();
+                if(numberOfResults > 0) { // no point checking again //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
+                               results = dao.findTitleCache(clazz, queryString, pageSize, pageNumber, orderHints, matchMode);
+                }
+                int r = 0;
+                r += numberOfResults;
+                       
+                 return new DefaultPagerImpl<T>(pageNumber, r , pageSize, results);
+       }
 
        @Transactional(readOnly = true)
+       @Override
        public List<T> listByReferenceTitle(Class<? extends T> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {
                 Integer numberOfResults = dao.countByReferenceTitle(clazz, queryString, matchmode, criteria);
                        
@@ -175,11 +197,13 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
        }
        
        @Transactional(readOnly = true)
+       @Override
        public T find(LSID lsid) {
                return dao.find(lsid);
        }
        
        @Transactional(readOnly = true)
+       @Override
        public Pager<T> search(Class<? extends T> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {
         Integer numberOfResults = dao.count(clazz,queryString);
                
@@ -191,17 +215,14 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                return new DefaultPagerImpl<T>(pageNumber, numberOfResults, pageSize, results);
        }
        
-
-       /* (non-Javadoc)
-        * @see eu.etaxonomy.cdm.api.service.IIdentifiableEntityService#updateTitleCache()
-        */
        @Override
+       @Transactional(readOnly = false)
        public void updateTitleCache() {
                updateTitleCache(null, null, null, null);
        }
        
        @Transactional(readOnly = false)  //TODO check transactional behaviour, e.g. what happens with the session if count is very large 
-       protected void updateTitleCacheImpl(Class<? extends T> clazz, Integer stepSize, IIdentifiableEntityCacheStrategy<T> cacheStrategy, IProgressMonitor monitor) {
+       protected <S extends T > void updateTitleCacheImpl(Class<S> clazz, Integer stepSize, IIdentifiableEntityCacheStrategy<T> cacheStrategy, IProgressMonitor monitor) {
                if (stepSize == null){
                        stepSize = UPDATE_TITLE_CACHE_DEFAULT_STEP_SIZE;
                }
@@ -216,32 +237,29 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                        // not sure if such strict ordering is necessary here, but for safety reasons I do it
                        ArrayList<OrderHint> orderHints = new ArrayList<OrderHint>();
                        orderHints.add( new OrderHint("id", OrderHint.SortOrder.ASCENDING));
-                       List<T> list = this.list(clazz, stepSize, i, orderHints, null);
+                       
+                       
+                       Map<Class<? extends CdmBase>, AutoPropertyInitializer<CdmBase>> oldAutoInit = switchOfAutoinitializer();
+                       List<S> list = this.list(clazz, stepSize, i, orderHints, null);
+                       switchOnOldAutoInitializer(oldAutoInit);
+                       
                        List<T> entitiesToUpdate = new ArrayList<T>();
                        for (T entity : list){
+                               HibernateProxyHelper.deproxy(entity, clazz);
                                if (entity.isProtectedTitleCache() == false){
-                                       IIdentifiableEntityCacheStrategy entityCacheStrategy = cacheStrategy;
-                                       if (entityCacheStrategy == null){
-                                               entityCacheStrategy = entity.getCacheStrategy();
-                                               //FIXME find out why the wrong cache strategy is loaded here, see #1876 
-                                               if (entity instanceof Reference){
-                                                       entityCacheStrategy = ReferenceFactory.newReference(((Reference)entity).getType()).getCacheStrategy();
-                                               }
-                                       }
-                                       entity.setCacheStrategy(entityCacheStrategy);
-                                       //TODO this won't work for those classes that always generate the title cache new
-                                       String titleCache = entity.getTitleCache();
-                                       setOtherCachesNull(entity); //TODO find better solution
-                                       String newTitleCache = entityCacheStrategy.getTitleCache(entity);
-                                       if (titleCache == null || titleCache != null && ! titleCache.equals(newTitleCache)){
-                                               entity.setTitleCache(null, false);
-                                               entity.getTitleCache();
-                                               entitiesToUpdate.add(entity);
-                                       }
+                                       updateTitleCacheForSingleEntity(cacheStrategy, entitiesToUpdate, entity);
+                               }
+                               worked++;
+                       }
+                       for (T entity: entitiesToUpdate){
+                               if (entity.getTitleCache() != null){
+                                       //System.err.println(entity.getTitleCache());
+                               }else{
+                                       //System.err.println("no titleCache" + ((NonViralName)entity).getNameCache());
                                }
                        }
                        saveOrUpdate(entitiesToUpdate);
-                       monitor.worked(worked++);
+                       monitor.worked(list.size());
                        if (monitor.isCanceled()){
                                monitor.done();
                                return;
@@ -249,6 +267,158 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                }
                monitor.done();
        }
+
+       /**
+        * Brings back all auto initializers to the bean initializer
+        * @see #switchOfAutoinitializer()
+        * @param oldAutoInit
+        */
+       protected void switchOnOldAutoInitializer(
+                       Map<Class<? extends CdmBase>, AutoPropertyInitializer<CdmBase>> oldAutoInit) {
+               HibernateBeanInitializer initializer = (HibernateBeanInitializer)this.appContext.getBean("defaultBeanInitializer");
+               initializer.setBeanAutoInitializers(oldAutoInit);
+       }
+
+       /**
+        * Removes all auto initializers from the bean initializer
+        * 
+        * @see #switchOnOldAutoInitializer(Map)
+        * @return 
+        */
+       protected Map<Class<? extends CdmBase>, AutoPropertyInitializer<CdmBase>> switchOfAutoinitializer() {
+               HibernateBeanInitializer initializer = (HibernateBeanInitializer)this.appContext.getBean("defaultBeanInitializer");
+               Map<Class<? extends CdmBase>, AutoPropertyInitializer<CdmBase>> oldAutoInitializers = initializer.getBeanAutoInitializers();
+               Map<Class<? extends CdmBase>, AutoPropertyInitializer<CdmBase>> map = new HashMap<Class<? extends CdmBase>, AutoPropertyInitializer<CdmBase>>();
+               initializer.setBeanAutoInitializers(map);
+               return oldAutoInitializers;
+       }
+
+       /**
+        * @param cacheStrategy
+        * @param entitiesToUpdate
+        * @param entity
+        */
+       /**
+        * @param cacheStrategy
+        * @param entitiesToUpdate
+        * @param entity
+        */
+       private void updateTitleCacheForSingleEntity(
+                       IIdentifiableEntityCacheStrategy<T> cacheStrategy,
+                       List<T> entitiesToUpdate, T entity) {
+               
+               assert (entity.isProtectedTitleCache() == false );
+               
+               //exclude recursive inreferences
+               if (entity.isInstanceOf(Reference.class)){
+                       Reference<?> ref = CdmBase.deproxy(entity, Reference.class);
+                       if (ref.getInReference() != null && ref.getInReference().equals(ref)){
+                               return;
+                       }
+               }
+               
+               
+               //define the correct cache strategy
+               IIdentifiableEntityCacheStrategy entityCacheStrategy = cacheStrategy;
+               if (entityCacheStrategy == null){
+                       entityCacheStrategy = entity.getCacheStrategy();
+                       //FIXME find out why the wrong cache strategy is loaded here, see #1876 
+                       if (entity instanceof Reference){
+                               entityCacheStrategy = ReferenceFactory.newReference(((Reference<?>)entity).getType()).getCacheStrategy();
+                       }
+               }
+               entity.setCacheStrategy(entityCacheStrategy);
+               
+               
+               //old titleCache
+               entity.setProtectedTitleCache(true);
+               String oldTitleCache = entity.getTitleCache();
+               entity.setTitleCache(oldTitleCache, false);   //before we had entity.setProtectedTitleCache(false) but this deleted the titleCache itself
+               
+               //NonViralNames and Reference have more caches //TODO handle in NameService
+               String oldNameCache = null;
+               String oldFullTitleCache = null;
+               String oldAbbrevTitleCache = null;
+               if (entity instanceof NonViralName ){
+                       
+                       try{
+                               NonViralName<?> nvn = (NonViralName) entity;
+                               if (!nvn.isProtectedNameCache()){
+                                       nvn.setProtectedNameCache(true);
+                                       oldNameCache = nvn.getNameCache();
+                                       nvn.setProtectedNameCache(false);
+                               }
+                               if (!nvn.isProtectedFullTitleCache()){
+                                       nvn.setProtectedFullTitleCache(true);
+                                       oldFullTitleCache = nvn.getFullTitleCache();
+                                       nvn.setProtectedFullTitleCache(false);
+                               }
+                       }catch(ClassCastException e){
+                               System.out.println("entity: " + entity.getTitleCache());
+                       }
+                       
+               }else if (entity instanceof Reference){
+                       Reference<?> ref = (Reference<?>) entity;
+                       if (!ref.isProtectedAbbrevTitleCache()){
+                               ref.setProtectedAbbrevTitleCache(true);
+                               oldAbbrevTitleCache = ref.getAbbrevTitleCache();
+                               ref.setProtectedAbbrevTitleCache(false);
+                       }
+               }
+               setOtherCachesNull(entity);
+               String newTitleCache= null;
+               NonViralName<?> nvn = null;//TODO find better solution
+               try{
+                       if (entity instanceof NonViralName){
+                               nvn = (NonViralName) entity;
+                               newTitleCache = entityCacheStrategy.getTitleCache(nvn);
+                       } else{
+                                newTitleCache = entityCacheStrategy.getTitleCache(entity);
+                       }
+               }catch (ClassCastException e){
+                       nvn = HibernateProxyHelper.deproxy(entity, NonViralName.class);
+                       newTitleCache = entityCacheStrategy.getTitleCache(nvn);
+                       //System.out.println("titleCache: " +entity.getTitleCache());
+               }
+               
+               if ( oldTitleCache == null   || oldTitleCache != null && ! oldTitleCache.equals(newTitleCache) ){
+                       entity.setTitleCache(null, false);
+                       String newCache = entity.getTitleCache();
+                       if (newCache == null){
+                               logger.warn("newCache should never be null");
+                       }
+                       if (oldTitleCache == null){
+                               logger.info("oldTitleCache should never be null");
+                       }
+                       if (nvn != null){
+                               //NonViralName<?> nvn = (NonViralName) entity;
+                               nvn.getNameCache();
+                               nvn.getFullTitleCache();
+                       }
+                       if (entity instanceof Reference){
+                               Reference<?> ref = (Reference<?>) entity;
+                               ref.getAbbrevTitleCache();
+                       }
+                       entitiesToUpdate.add(entity);
+               }else if (nvn != null){
+                       //NonViralName<?> nvn = (NonViralName) entity;
+                       String newNameCache = nvn.getNameCache();
+                       String newFullTitleCache = nvn.getFullTitleCache();
+                       if ((oldNameCache == null && !nvn.isProtectedNameCache()) || (oldNameCache != null && !oldNameCache.equals(newNameCache))){
+                               entitiesToUpdate.add(entity);
+                       }else if ((oldFullTitleCache == null && !nvn.isProtectedFullTitleCache()) || (oldFullTitleCache != null && !oldFullTitleCache.equals(newFullTitleCache))){
+                               entitiesToUpdate.add(entity);
+                       }
+               }else if (entity instanceof Reference){
+                       Reference<?> ref = (Reference<?>) entity;
+                       String newAbbrevTitleCache = ref.getAbbrevTitleCache();
+                       if ( (oldAbbrevTitleCache == null && !ref.isProtectedAbbrevTitleCache() ) || (oldAbbrevTitleCache != null && !oldAbbrevTitleCache.equals(newAbbrevTitleCache))){
+                               entitiesToUpdate.add(entity);
+                       }
+               }
+               
+               
+       }
        
        
 
@@ -271,11 +441,8 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                int result; 
        }
        
-       /* (non-Javadoc)
-        * @see eu.etaxonomy.cdm.api.service.IIdentifiableEntityService#deduplicate(java.lang.Class, eu.etaxonomy.cdm.strategy.match.IMatchStrategy, eu.etaxonomy.cdm.strategy.merge.IMergeStrategy)
-        */
        @Override
-       @Transactional(propagation = Propagation.SUPPORTS, readOnly = false)
+       @Transactional(readOnly = false)
        public int deduplicate(Class<? extends T> clazz, IMatchStrategy matchStrategy, IMergeStrategy mergeStrategy) {
                DeduplicateState dedupState = new DeduplicateState();
                
@@ -383,18 +550,24 @@ public abstract class IdentifiableServiceBase<T extends IdentifiableEntity,DAO e
                return result;
        }       
        
-        public Integer countByTitle(Class<? extends T> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria){
+       @Transactional(readOnly = true)
+       @Override
+       public Integer countByTitle(Class<? extends T> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria){
                 Integer numberOfResults = dao.countByTitle(clazz, queryString, matchmode, criteria);
                 
                 return numberOfResults;
-        }
+       }
         
        @Transactional(readOnly = true)
+       @Override
        public Integer countByTitle(IIdentifiableEntityServiceConfigurator<T> config){
                return countByTitle(config.getClazz(), config.getTitleSearchStringSqlized(),
                                config.getMatchMode(), config.getCriteria());
                
        }
+       
+       
+
 
 }\r