- added service method deleteDerivateHierarchy()
[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / service / TermServiceImpl.java
index b2f155b6ea976a83a20850201a439698cfe54c7f..7fbcf4e6840acda54e1c5dfdea935d390cc86ce2 100644 (file)
@@ -1,9 +1,9 @@
 // $Id$
 /**
 * Copyright (C) 2007 EDIT
-* European Distributed Institute of Taxonomy 
+* European Distributed Institute of Taxonomy
 * http://www.e-taxonomy.eu
-* 
+*
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * See LICENSE.TXT at the top of this package for the full license terms.
 */
@@ -12,6 +12,7 @@ package eu.etaxonomy.cdm.api.service;
 
 import java.net.URI;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Enumeration;
 import java.util.HashSet;
 import java.util.List;
@@ -19,28 +20,30 @@ import java.util.Locale;
 import java.util.Set;
 import java.util.UUID;
 
+import org.apache.commons.lang.StringUtils;
 import org.apache.log4j.Logger;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Service;
-import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
 
 import eu.etaxonomy.cdm.api.service.DeleteResult.DeleteStatus;
 import eu.etaxonomy.cdm.api.service.config.TermDeletionConfigurator;
+import eu.etaxonomy.cdm.api.service.exception.DataChangeNoRollbackException;
 import eu.etaxonomy.cdm.api.service.pager.Pager;
 import eu.etaxonomy.cdm.api.service.pager.impl.DefaultPagerImpl;
 import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;
+import eu.etaxonomy.cdm.model.common.CdmBase;
 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
 import eu.etaxonomy.cdm.model.common.Language;
 import eu.etaxonomy.cdm.model.common.LanguageString;
 import eu.etaxonomy.cdm.model.common.LanguageStringBase;
 import eu.etaxonomy.cdm.model.common.Representation;
+import eu.etaxonomy.cdm.model.common.TermType;
 import eu.etaxonomy.cdm.model.common.TermVocabulary;
 import eu.etaxonomy.cdm.model.location.NamedArea;
 import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
 import eu.etaxonomy.cdm.model.location.NamedAreaType;
-import eu.etaxonomy.cdm.model.location.TdwgArea;
 import eu.etaxonomy.cdm.model.media.Media;
 import eu.etaxonomy.cdm.persistence.dao.common.IDefinedTermDao;
 import eu.etaxonomy.cdm.persistence.dao.common.ILanguageStringBaseDao;
@@ -50,104 +53,138 @@ import eu.etaxonomy.cdm.persistence.query.OrderHint;
 import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;
 
 @Service
-@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+@Transactional(readOnly = true)
 public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDefinedTermDao> implements ITermService{
        @SuppressWarnings("unused")
        private static final Logger logger = Logger.getLogger(TermServiceImpl.class);
+
        private ILanguageStringDao languageStringDao;
+
        @Autowired
        @Qualifier("langStrBaseDao")
        private ILanguageStringBaseDao languageStringBaseDao;
        private IRepresentationDao representationDao;
-       
+
        @Autowired
        public void setLanguageStringDao(ILanguageStringDao languageStringDao) {
                this.languageStringDao = languageStringDao;
-       } 
-       
+       }
+
        @Autowired
        public void setRepresentationDao(IRepresentationDao representationDao) {
                this.representationDao = representationDao;
        }
-       
-       @Autowired
+
+       @Override
+    @Autowired
        protected void setDao(IDefinedTermDao dao) {
                this.dao = dao;
        }
-               
-       public <TERM extends DefinedTermBase> List<TERM> listByTermClass(Class<TERM> clazz, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths) {
-               return dao.listByTermClass(clazz, limit, start, orderHints, propertyPaths);
-       }       
-       
-       /**
-        * @see eu.etaxonomy.cdm.api.service.ITermService#getTermByUri(java.net.URI)
+
+       /* (non-Javadoc)
+        * @see eu.etaxonomy.cdm.api.service.ITermService#listByTermType(eu.etaxonomy.cdm.model.common.TermType, java.lang.Integer, java.lang.Integer, java.util.List, java.util.List)
         */
+       @Override
+       public List<DefinedTermBase<?>> listByTermType(TermType termType, Integer limit, Integer start,
+               List<OrderHint> orderHints, List<String> propertyPaths) {
+           return dao.listByTermType(termType, limit, start, orderHints, propertyPaths);
+       }
+
+       @Override
        public DefinedTermBase getByUri(URI uri) {
                return dao.findByUri(uri);
        }
-       
+
+       @Override
        public Language getLanguageByIso(String iso639) {
                return dao.getLanguageByIso(iso639);
        }
-       
+
+       @Override
        public List<Language> getLanguagesByLocale(Enumeration<Locale> locales){
                return dao.getLanguagesByLocale(locales);
        }
 
-       /**
-        *  (non-Javadoc)
-        * @see eu.etaxonomy.cdm.api.service.ITermService#getAreaByTdwgAbbreviation(java.lang.String)
-        */
+       @Override
+    public <TERM extends DefinedTermBase> TERM findByIdInVocabulary(String id, UUID vocabularyUuid, Class<TERM> clazz) throws IllegalArgumentException {
+        List<TERM> list = dao.getDefinedTermByIdInVocabulary(id, vocabularyUuid, clazz, null, null);
+               if (list.isEmpty()){
+                       return null;
+               }else if (list.size() == 1){
+                       return list.get(0);
+               }else{
+                       String message = "There is more then 1 (%d) term with the same id in vocabulary. This is forbidden. Check the state of your database.";
+                       throw new IllegalStateException(String.format(message, list.size()));
+               }
+       }
+
+
+       @Override
        public NamedArea getAreaByTdwgAbbreviation(String tdwgAbbreviation) {
-               //FIXME this is just a placeholder until it is decided where to implement this method 
-               //(see also FIXMEs in TdwgArea)
-               return TdwgArea.getAreaByTdwgAbbreviation(tdwgAbbreviation);
+               if (StringUtils.isBlank(tdwgAbbreviation)){ //TDWG areas should always have a label
+                       return null;
+               }
+               List<NamedArea> list = dao.getDefinedTermByIdInVocabulary(tdwgAbbreviation, NamedArea.uuidTdwgAreaVocabulary, NamedArea.class, null, null);
+               if (list.isEmpty()){
+                       return null;
+               }else if (list.size() == 1){
+                       return list.get(0);
+               }else{
+                       String message = "There is more then 1 (%d) TDWG area with the same abbreviated label. This is forbidden. Check the state of your database.";
+                       throw new IllegalStateException(String.format(message, list.size()));
+               }
+
        }
 
+       @Override
        public <T extends DefinedTermBase> Pager<T> getGeneralizationOf(T definedTerm, Integer pageSize, Integer pageNumber) {
         Integer numberOfResults = dao.countGeneralizationOf(definedTerm);
-               
+
                List<T> results = new ArrayList<T>();
                if(numberOfResults > 0) { // no point checking again  //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
-                       results = dao.getGeneralizationOf(definedTerm, pageSize, pageNumber); 
+                       results = dao.getGeneralizationOf(definedTerm, pageSize, pageNumber);
                }
-               
+
                return new DefaultPagerImpl<T>(pageNumber, numberOfResults, pageSize, results);
        }
 
-       public <T extends DefinedTermBase> Pager<T> getIncludes(Set<T> definedTerms, Integer pageSize, Integer pageNumber, List<String> propertyPaths) {
+       @Override
+       public <T extends DefinedTermBase> Pager<T> getIncludes(Collection<T> definedTerms, Integer pageSize, Integer pageNumber, List<String> propertyPaths) {
         Integer numberOfResults = dao.countIncludes(definedTerms);
-               
+
                List<T> results = new ArrayList<T>();
                if(numberOfResults > 0) { // no point checking again  //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
-                       results = dao.getIncludes(definedTerms, pageSize, pageNumber,propertyPaths); 
+                       results = dao.getIncludes(definedTerms, pageSize, pageNumber,propertyPaths);
                }
-               
+
                return new DefaultPagerImpl<T>(pageNumber, numberOfResults, pageSize, results);
        }
 
+       @Override
        public Pager<Media> getMedia(DefinedTermBase definedTerm, Integer pageSize,     Integer pageNumber) {
         Integer numberOfResults = dao.countMedia(definedTerm);
-               
+
                List<Media> results = new ArrayList<Media>();
                if(numberOfResults > 0) { // no point checking again  //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
-                       results = dao.getMedia(definedTerm, pageSize, pageNumber); 
+                       results = dao.getMedia(definedTerm, pageSize, pageNumber);
                }
-               
+
                return new DefaultPagerImpl<Media>(pageNumber, numberOfResults, pageSize, results);
        }
 
+       @Override
        public <T extends DefinedTermBase> Pager<T> getPartOf(Set<T> definedTerms,Integer pageSize, Integer pageNumber, List<String> propertyPaths) {
         Integer numberOfResults = dao.countPartOf(definedTerms);
-               
+
                List<T> results = new ArrayList<T>();
                if(numberOfResults > 0) { // no point checking again //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
-                       results = dao.getPartOf(definedTerms, pageSize, pageNumber, propertyPaths); 
+                       results = dao.getPartOf(definedTerms, pageSize, pageNumber, propertyPaths);
                }
-               
+
                return new DefaultPagerImpl<T>(pageNumber, numberOfResults, pageSize, results);
        }
 
+       @Override
        public Pager<NamedArea> list(NamedAreaLevel level, NamedAreaType type, Integer pageSize, Integer pageNumber,
                        List<OrderHint> orderHints, List<String> propertyPaths) {
                Integer numberOfResults = dao.count(level, type);
@@ -160,50 +197,57 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                return new DefaultPagerImpl<NamedArea>(pageNumber, numberOfResults, pageSize, results);
        }
 
+       @Override
        public <T extends DefinedTermBase> Pager<T> findByRepresentationText(String label, Class<T> clazz, Integer pageSize, Integer pageNumber) {
         Integer numberOfResults = dao.countDefinedTermByRepresentationText(label,clazz);
-               
+
                List<T> results = new ArrayList<T>();
                if(numberOfResults > 0) { // no point checking again //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
                        results = dao.getDefinedTermByRepresentationText(label, clazz, pageSize, pageNumber);
                }
-               
+
                return new DefaultPagerImpl<T>(pageNumber, numberOfResults, pageSize, results);
        }
-       
+
+       @Override
        public <T extends DefinedTermBase> Pager<T> findByRepresentationAbbreviation(String abbrev, Class<T> clazz, Integer pageSize, Integer pageNumber) {
         Integer numberOfResults = dao.countDefinedTermByRepresentationAbbrev(abbrev,clazz);
-               
+
                List<T> results = new ArrayList<T>();
                if(numberOfResults > 0) { // no point checking again //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
                        results = dao.getDefinedTermByRepresentationAbbrev(abbrev, clazz, pageSize, pageNumber);
                }
-               
+
                return new DefaultPagerImpl<T>(pageNumber, numberOfResults, pageSize, results);
        }
 
+       @Override
        public List<LanguageString> getAllLanguageStrings(int limit, int start) {
                return languageStringDao.list(limit, start);
        }
 
+       @Override
        public List<Representation> getAllRepresentations(int limit, int start) {
                return representationDao.list(limit,start);
        }
 
+       @Override
        public UUID saveLanguageData(LanguageStringBase languageData) {
                return languageStringBaseDao.save(languageData);
        }
-       
+
        /* (non-Javadoc)
         * @see eu.etaxonomy.cdm.api.service.ServiceBase#delete(eu.etaxonomy.cdm.model.common.CdmBase)
         */
        /** @deprecated use {@link #delete(DefinedTermBase, TermDeletionConfigurator)} instead
         * to allow DeleteResult return type*/
+       @Override
        @Deprecated
-       public UUID delete(DefinedTermBase term){
-               UUID result = term.getUuid();
+       public DeleteResult delete(DefinedTermBase term){
+               DeleteResult result = new DeleteResult();
+
                TermDeletionConfigurator defaultConfig = new TermDeletionConfigurator();
-               delete(term, defaultConfig);
+               result = delete(term, defaultConfig);
                return result;
        }
 
@@ -215,7 +259,8 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
 //             boolean isInternal = config.isInternal();
                DeleteResult result = new DeleteResult();
                Set<DefinedTermBase> termsToSave = new HashSet<DefinedTermBase>();
-               
+               CdmBase.deproxy(dao.merge(term), DefinedTermBase.class);
+
                try {
                        //generalization of
                        Set<DefinedTermBase> specificTerms = term.getGeneralizationOf();
@@ -234,7 +279,7 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                                        String message = "This term has specifing terms. Move or delete specifiing terms prior to delete or change delete configuration.";
                                        result.addRelatedObjects(specificTerms);
                                        result.setAbort();
-                                       Exception ex = new Exception(message);
+                                       Exception ex = new DataChangeNoRollbackException(message);
                                        result.addException(ex);
                                }
                        }
@@ -249,7 +294,7 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                                        String message = "This term is kind of another term. Move or delete kind of relationship prior to delete or change delete configuration.";
                                        result.addRelatedObject(generalTerm);
                                        result.setAbort();
-                                       Exception ex = new Exception(message);
+                                       DataChangeNoRollbackException ex = new DataChangeNoRollbackException(message);
                                        result.addException(ex);
                                        throw ex;
                                }
@@ -263,12 +308,12 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                                        String message = "This term is included in another term. Remove from parent term prior to delete or change delete configuration.";
                                        result.addRelatedObject(parentTerm);
                                        result.setAbort();
-                                       Exception ex = new Exception(message);
+                                       DataChangeNoRollbackException ex = new DataChangeNoRollbackException(message);
                                        result.addException(ex);
                                }
-                       }                       
+                       }
+
 
-                       
                        //included in
                        Set<DefinedTermBase> includedTerms = term.getIncludes();
                        if (includedTerms.size()> 0){
@@ -279,7 +324,7 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
 ////                                           config.setCheck(isCheck);
 //                                             result.includeResult(includedResult);
 //                                     }
-//                             }else 
+//                             }else
                                        if (config.isDeleteIncludedRelations()){
                                        DefinedTermBase parent = term.getPartOf();
                                        for (DefinedTermBase includedTerm: includedTerms){
@@ -294,7 +339,7 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                                        String message = "This term includes other terms. Move or delete included terms prior to delete or change delete configuration.";
                                        result.addRelatedObjects(includedTerms);
                                        result.setAbort();
-                                       Exception ex = new Exception(message);
+                                       Exception ex = new DataChangeNoRollbackException(message);
                                        result.addException(ex);
                                }
                        }
@@ -308,13 +353,15 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                                        //handelede before "included in"
                                }
                        }
-                       
+
 //                     relatedObjects;
-                       
-                       
+
+
                        if (result.isOk()){
                                TermVocabulary voc = term.getVocabulary();
-                               voc.removeTerm(term);
+                               if (voc!= null){
+                                       voc.removeTerm(term);
+                               }
                                //TODO save voc
                                if (true /*!config.isInternal()*/){
                                        dao.delete(term);
@@ -325,19 +372,15 @@ public class TermServiceImpl extends IdentifiableServiceBase<DefinedTermBase,IDe
                                        for (DeleteResult.PersistPair persistPair : result.getObjectsToSave()){
                                                persistPair.dao.saveOrUpdate(persistPair.objectToPersist);
                                        }
-                                       
+
                                }
                        }
-               } catch (Exception e) {
+               } catch (DataChangeNoRollbackException e) {
                        result.setStatus(DeleteStatus.ERROR);
                }
                return result;
        }
 
-
-       /* (non-Javadoc)
-        * @see eu.etaxonomy.cdm.api.service.IIdentifiableEntityService#updateTitleCache(java.lang.Integer, eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy)
-        */
        @Override
        @Transactional(readOnly = false)
     public void updateTitleCache(Class<? extends DefinedTermBase> clazz, Integer stepSize, IIdentifiableEntityCacheStrategy<DefinedTermBase> cacheStrategy, IProgressMonitor monitor) {