minor
[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / service / NameServiceImpl.java
index 190d36f313c94683bbff3421aee15907dc2da7fe..2a40aa4f1af71457956a1914fdd3e1ccf8e950fc 100644 (file)
@@ -1,3 +1,4 @@
+// $Id$\r
 /**\r
 * Copyright (C) 2007 EDIT\r
 * European Distributed Institute of Taxonomy \r
@@ -16,20 +17,22 @@ import java.util.Map;
 import java.util.UUID;\r
 \r
 import org.apache.log4j.Logger;\r
+import org.hibernate.criterion.Criterion;\r
 import org.springframework.beans.factory.annotation.Autowired;\r
 import org.springframework.beans.factory.annotation.Qualifier;\r
 import org.springframework.stereotype.Service;\r
+import org.springframework.transaction.annotation.Propagation;\r
 import org.springframework.transaction.annotation.Transactional;\r
 \r
+import eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator;\r
 import eu.etaxonomy.cdm.api.service.pager.Pager;\r
 import eu.etaxonomy.cdm.api.service.pager.impl.DefaultPagerImpl;\r
-import eu.etaxonomy.cdm.model.common.Annotation;\r
 import eu.etaxonomy.cdm.model.common.CdmBase;\r
 import eu.etaxonomy.cdm.model.common.OrderedTermVocabulary;\r
 import eu.etaxonomy.cdm.model.common.ReferencedEntityBase;\r
-import eu.etaxonomy.cdm.model.common.RelationshipTermBase;\r
+import eu.etaxonomy.cdm.model.common.RelationshipBase;\r
 import eu.etaxonomy.cdm.model.common.TermVocabulary;\r
-import eu.etaxonomy.cdm.model.name.BotanicalName;\r
+import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;\r
 import eu.etaxonomy.cdm.model.name.HomotypicalGroup;\r
 import eu.etaxonomy.cdm.model.name.HybridRelationship;\r
 import eu.etaxonomy.cdm.model.name.HybridRelationshipType;\r
@@ -37,10 +40,11 @@ import eu.etaxonomy.cdm.model.name.NameRelationship;
 import eu.etaxonomy.cdm.model.name.NameRelationshipType;\r
 import eu.etaxonomy.cdm.model.name.NomenclaturalStatus;\r
 import eu.etaxonomy.cdm.model.name.NomenclaturalStatusType;\r
+import eu.etaxonomy.cdm.model.name.NonViralName;\r
 import eu.etaxonomy.cdm.model.name.Rank;\r
+import eu.etaxonomy.cdm.model.name.SpecimenTypeDesignationStatus;\r
 import eu.etaxonomy.cdm.model.name.TaxonNameBase;\r
 import eu.etaxonomy.cdm.model.name.TypeDesignationBase;\r
-import eu.etaxonomy.cdm.model.name.TypeDesignationStatus;\r
 import eu.etaxonomy.cdm.persistence.dao.common.IOrderedTermVocabularyDao;\r
 import eu.etaxonomy.cdm.persistence.dao.common.IReferencedEntityDao;\r
 import eu.etaxonomy.cdm.persistence.dao.common.ITermVocabularyDao;\r
@@ -48,10 +52,12 @@ import eu.etaxonomy.cdm.persistence.dao.name.IHomotypicalGroupDao;
 import eu.etaxonomy.cdm.persistence.dao.name.INomenclaturalStatusDao;\r
 import eu.etaxonomy.cdm.persistence.dao.name.ITaxonNameDao;\r
 import eu.etaxonomy.cdm.persistence.dao.name.ITypeDesignationDao;\r
+import eu.etaxonomy.cdm.persistence.query.MatchMode;\r
+import eu.etaxonomy.cdm.persistence.query.OrderHint;\r
 \r
 \r
 @Service\r
-@Transactional(readOnly = true)\r
+@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)\r
 public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxonNameDao> implements INameService {\r
        static private final Logger logger = Logger.getLogger(NameServiceImpl.class);\r
        \r
@@ -73,7 +79,7 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
         * Constructor\r
         */\r
        public NameServiceImpl(){\r
-               logger.debug("Load NameService Bean");\r
+               if (logger.isDebugEnabled()) { logger.debug("Load NameService Bean"); }\r
        }\r
 \r
 //********************* METHODS ****************************************************************//     \r
@@ -82,6 +88,11 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
                return super.findCdmObjectsByTitle(name);\r
        }\r
        \r
+       public List<NonViralName> getNamesByNameCache(String nameCache){\r
+               List result = dao.findByName(nameCache, MatchMode.EXACT, null, null, null, null);\r
+               return result;\r
+       }\r
+       \r
        public List getNamesByName(String name, CdmBase sessionObject){\r
                return super.findCdmObjectsByTitle(name, sessionObject);\r
        }\r
@@ -93,19 +104,9 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
        public List findNamesByTitle(String title, CdmBase sessionObject){\r
                return super.findCdmObjectsByTitle(title, sessionObject);\r
        }\r
-       \r
-       public TaxonNameBase<?,?> getTaxonNameByUuid(UUID uuid) {\r
-               return super.getCdmObjectByUuid(uuid);\r
-       }\r
-\r
-       @Transactional(readOnly = false)\r
-       public UUID saveTaxonName(TaxonNameBase taxonName) {\r
-               return super.saveCdmObject(taxonName);\r
-       }\r
-       \r
-       @Transactional(readOnly = false)\r
-       public Map<UUID, TaxonNameBase> saveTaxonNameAll(Collection<? extends TaxonNameBase> taxonNameCollection){\r
-               return saveCdmObjectAll(taxonNameCollection);\r
+       \r
+       public List<TaxonNameBase> findByTitle(IIdentifiableEntityServiceConfigurator config) {\r
+               return super.findByTitle(config);\r
        }\r
        \r
        @Transactional(readOnly = false)\r
@@ -122,11 +123,6 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
        public Map<UUID, ReferencedEntityBase> saveReferencedEntitiesAll(Collection<ReferencedEntityBase> referencedEntityCollection){\r
                return referencedEntityDao.saveAll(referencedEntityCollection);\r
        }\r
-       \r
-       @Transactional(readOnly = false)\r
-       public UUID removeTaxonName(TaxonNameBase taxonName) {\r
-               return super.removeCdmObject(taxonName);\r
-       }\r
 \r
        public List<TaxonNameBase> getAllNames(int limit, int start){\r
                return dao.list(limit, start);\r
@@ -139,12 +135,27 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
        public List<TypeDesignationBase> getAllTypeDesignations(int limit, int start){\r
                return typeDesignationDao.getAllTypeDesignations(limit, start);\r
        }\r
-       \r
+        /**\r
+        * FIXME Candidate for harmonization\r
+        * homotypicalGroupService.list\r
+        */\r
        public List<HomotypicalGroup> getAllHomotypicalGroups(int limit, int start){\r
                return homotypicalGroupDao.list(limit, start);\r
        }\r
        \r
-       /* (non-Javadoc)\r
+       /**\r
+        * FIXME Candidate for harmonization\r
+        * remove\r
+        */\r
+       @Deprecated\r
+       public List<RelationshipBase> getAllRelationships(int limit, int start){\r
+               return dao.getAllRelationships(limit, start);\r
+       }\r
+       \r
+       /**\r
+        * FIXME Candidate for harmonization\r
+        * is this the same as termService.getVocabulary(VocabularyEnum.Rank) \r
+        * (non-Javadoc)\r
         * @see eu.etaxonomy.cdm.api.service.INameService#getRankVocabulary()\r
         */\r
        public OrderedTermVocabulary<Rank> getRankVocabulary() {\r
@@ -155,7 +166,10 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
                return rankVocabulary;\r
        }\r
 \r
-       /* (non-Javadoc)\r
+       /**\r
+        * FIXME Candidate for harmonization\r
+        * is this the same as termService.getVocabulary(VocabularyEnum.NameRelationshipType) \r
+        *  (non-Javadoc)\r
         * @see eu.etaxonomy.cdm.api.service.INameService#getNameRelationshipTypeVocabulary()\r
         */\r
        public TermVocabulary<NameRelationshipType> getNameRelationshipTypeVocabulary() {\r
@@ -166,7 +180,10 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
                return nameRelTypeVocabulary;\r
        }\r
 \r
-       /* (non-Javadoc)\r
+       /**\r
+        * FIXME Candidate for harmonization\r
+        * is this the same as termService.getVocabulary(VocabularyEnum.StatusType) \r
+        * (non-Javadoc)\r
         * @see eu.etaxonomy.cdm.api.service.INameService#getStatusTypeVocabulary()\r
         */\r
        public TermVocabulary<NomenclaturalStatusType> getStatusTypeVocabulary() {\r
@@ -177,69 +194,183 @@ public class NameServiceImpl extends IdentifiableServiceBase<TaxonNameBase,ITaxo
                return nomStatusTypeVocabulary;\r
        }\r
 \r
-       /* (non-Javadoc)\r
+       /**\r
+        * FIXME Candidate for harmonization\r
+        * is this the same as termService.getVocabulary(VocabularyEnum.SpecimenTypeDesignationStatus) \r
+        *  (non-Javadoc)\r
         * @see eu.etaxonomy.cdm.api.service.INameService#getTypeDesignationStatusVocabulary()\r
         */\r
-       public TermVocabulary<TypeDesignationStatus> getTypeDesignationStatusVocabulary() {\r
+       public TermVocabulary<SpecimenTypeDesignationStatus> getSpecimenTypeDesignationStatusVocabulary() {\r
                String uuidString = "ab177bd7-d3c8-4e58-a388-226fff6ba3c2";\r
                UUID uuid = UUID.fromString(uuidString);\r
-               TermVocabulary<TypeDesignationStatus> typeDesigStatusVocabulary = \r
+               TermVocabulary<SpecimenTypeDesignationStatus> typeDesigStatusVocabulary = \r
                        (TermVocabulary)vocabularyDao.findByUuid(uuid);\r
                return typeDesigStatusVocabulary;\r
        }\r
        \r
-       public void generateTitleCache() {\r
-               logger.warn("Not yet implemented");\r
-               // TODO Auto-generated method stub\r
+       /**\r
+        * FIXME Candidate for harmonization\r
+        * is this the same as termService.getVocabulary(VocabularyEnum.SpecimenTypeDesignationStatus)\r
+        * and also seems to duplicate the above method, differing only in the DAO used and the return type \r
+        * (non-Javadoc)\r
+        * @see eu.etaxonomy.cdm.api.service.INameService#getTypeDesignationStatusVocabulary()\r
+        */\r
+       public OrderedTermVocabulary<SpecimenTypeDesignationStatus> getSpecimenTypeDesignationVocabulary() {\r
+               String uuidString = "ab177bd7-d3c8-4e58-a388-226fff6ba3c2";\r
+               UUID uuid = UUID.fromString(uuidString);\r
+               OrderedTermVocabulary<SpecimenTypeDesignationStatus> typeDesignationVocabulary = \r
+                       (OrderedTermVocabulary)orderedVocabularyDao.findByUuid(uuid);\r
+               return typeDesignationVocabulary;\r
        }\r
 \r
+\r
        @Autowired\r
        protected void setDao(ITaxonNameDao dao) {\r
                this.dao = dao;\r
        }\r
 \r
-       public Pager<HybridRelationship> getHybridNames(BotanicalName name,     HybridRelationshipType type, Integer pageSize, Integer pageNumber) {\r
+       public Pager<HybridRelationship> getHybridNames(NonViralName name,      HybridRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {\r
         Integer numberOfResults = dao.countHybridNames(name, type);\r
                \r
                List<HybridRelationship> results = new ArrayList<HybridRelationship>();\r
                if(numberOfResults > 0) { // no point checking again\r
-                       results = dao.getHybridNames(name, type, pageSize, pageNumber); \r
+                       results = dao.getHybridNames(name, type, pageSize, pageNumber,orderHints,propertyPaths); \r
                }\r
                \r
                return new DefaultPagerImpl<HybridRelationship>(pageNumber, numberOfResults, pageSize, results);\r
        }\r
-\r
-       public Pager<NameRelationship> getRelatedNames(TaxonNameBase name,NameRelationshipType type, Integer pageSize, Integer pageNumber) {\r
-        Integer numberOfResults = dao.countRelatedNames(name, type);\r
+       \r
+       public List<NameRelationship> listFromNameRelationships(TaxonNameBase name, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {\r
+               Integer numberOfResults = dao.countNameRelationships(name, NameRelationship.Direction.relatedFrom, type);\r
                \r
                List<NameRelationship> results = new ArrayList<NameRelationship>();\r
                if(numberOfResults > 0) { // no point checking again\r
-                       results = dao.getRelatedNames(name, type, pageSize, pageNumber); \r
+                       results = dao.getNameRelationships(name, NameRelationship.Direction.relatedFrom, type, pageSize, pageNumber, orderHints, propertyPaths); \r
                }\r
+               return results;\r
+       }\r
+\r
+       public Pager<NameRelationship> pageFromNameRelationships(TaxonNameBase name, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {\r
+        Integer numberOfResults = dao.countNameRelationships(name, NameRelationship.Direction.relatedFrom, type);\r
                \r
+               List<NameRelationship> results = new ArrayList<NameRelationship>();\r
+               if(numberOfResults > 0) { // no point checking again\r
+                       results = dao.getNameRelationships(name, NameRelationship.Direction.relatedFrom, type, pageSize, pageNumber, orderHints, propertyPaths); \r
+               }\r
                return new DefaultPagerImpl<NameRelationship>(pageNumber, numberOfResults, pageSize, results);\r
        }\r
+       \r
+       public List<NameRelationship> listToNameRelationships(TaxonNameBase name, NameRelationshipType type,\r
+                       Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {\r
+\r
+               Integer numberOfResults = dao.countNameRelationships(name, NameRelationship.Direction.relatedTo, type);\r
+\r
+               List<NameRelationship> results = new ArrayList<NameRelationship>();\r
+               if (numberOfResults > 0) { // no point checking again\r
+                       results = dao.getNameRelationships(name, \r
+                                                                                          NameRelationship.Direction.relatedTo, \r
+                                                                                          type, \r
+                                                                                          pageSize, \r
+                                                                                          pageNumber,\r
+                                                              orderHints, \r
+                                                              propertyPaths);\r
+               }\r
+               return results;\r
+       }\r
+       \r
+       public Pager<NameRelationship> pageToNameRelationships(TaxonNameBase name, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) {\r
+               Integer numberOfResults = dao.countNameRelationships(name, NameRelationship.Direction.relatedTo, type);\r
 \r
-       public Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name,TypeDesignationStatus status, Integer pageSize, Integer pageNumber) {\r
+               List<NameRelationship> results = new ArrayList<NameRelationship>();\r
+               if (numberOfResults > 0) { // no point checking again\r
+                       results = dao.getNameRelationships(name, NameRelationship.Direction.relatedTo, type, pageSize, pageNumber,\r
+                               orderHints, propertyPaths);\r
+               }\r
+\r
+               return new DefaultPagerImpl<NameRelationship>(pageNumber, numberOfResults, pageSize, results);\r
+       }\r
+\r
+       \r
+       public Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name, SpecimenTypeDesignationStatus status, \r
+                       Integer pageSize, Integer pageNumber) { \r
+               return getTypeDesignations(name, status, pageSize, pageNumber, null);\r
+       }\r
+       \r
+       public Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name, SpecimenTypeDesignationStatus status, \r
+                               Integer pageSize, Integer pageNumber, List<String> propertyPaths){\r
         Integer numberOfResults = dao.countTypeDesignations(name, status);\r
                \r
                List<TypeDesignationBase> results = new ArrayList<TypeDesignationBase>();\r
                if(numberOfResults > 0) { // no point checking again\r
-                       results = dao.getTypeDesignations(name, status, pageSize, pageNumber); \r
+                       results = dao.getTypeDesignations(name, status, pageSize, pageNumber, propertyPaths); \r
                }\r
                \r
                return new DefaultPagerImpl<TypeDesignationBase>(pageNumber, numberOfResults, pageSize, results);\r
        }\r
-\r
-       public Pager<TaxonNameBase> searchNames(String uninomial,String infraGenericEpithet, String specificEpithet, String infraspecificEpithet, Rank rank, Integer pageSize,  Integer pageNumber) {\r
+       \r
+    /**\r
+     * FIXME Candidate for harmonization\r
+        * rename search\r
+     */\r
+       public Pager<TaxonNameBase> searchNames(String uninomial,String infraGenericEpithet, String specificEpithet, String infraspecificEpithet, Rank rank, Integer pageSize,  Integer pageNumber, List<OrderHint> orderHints,\r
+                       List<String> propertyPaths) {\r
         Integer numberOfResults = dao.countNames(uninomial, infraGenericEpithet, specificEpithet, infraspecificEpithet, rank);\r
                \r
                List<TaxonNameBase> results = new ArrayList<TaxonNameBase>();\r
                if(numberOfResults > 0) { // no point checking again\r
-                       results = dao.searchNames(uninomial, infraGenericEpithet, specificEpithet, infraspecificEpithet, rank, pageSize, pageNumber); \r
+                       results = dao.searchNames(uninomial, infraGenericEpithet, specificEpithet, infraspecificEpithet, rank, pageSize, pageNumber, orderHints, propertyPaths); \r
                }\r
                \r
                return new DefaultPagerImpl<TaxonNameBase>(pageNumber, numberOfResults, pageSize, results);\r
        }\r
 \r
+       /* (non-Javadoc)\r
+        * @see eu.etaxonomy.cdm.api.service.INameService#getUuidAndTitleCacheOfNames()\r
+        */\r
+       public List<UuidAndTitleCache> getUuidAndTitleCacheOfNames() {\r
+               return dao.getUuidAndTitleCacheOfNames();\r
+       }\r
+\r
+       public Pager<TaxonNameBase> findByName(Class<? extends TaxonNameBase> clazz, String queryString, MatchMode matchmode, List<Criterion> criteria, Integer pageSize,Integer pageNumber, List<OrderHint> orderHints,List<String> propertyPaths) {\r
+               Integer numberOfResults = dao.countByName(clazz, queryString, matchmode, criteria);\r
+               \r
+                List<TaxonNameBase> results = new ArrayList<TaxonNameBase>();\r
+                if(numberOfResults > 0) { // no point checking again\r
+                               results = dao.findByName(clazz, queryString, matchmode, criteria, pageSize, pageNumber, orderHints, propertyPaths); \r
+                }\r
+                       \r
+                 return new DefaultPagerImpl<TaxonNameBase>(pageNumber, numberOfResults, pageSize, results);\r
+       }\r
+\r
+       public HomotypicalGroup findHomotypicalGroup(UUID uuid) {\r
+               return homotypicalGroupDao.findByUuid(uuid);\r
+       }\r
+\r
+\r
+       /* (non-Javadoc)\r
+        * @see eu.etaxonomy.cdm.api.service.IIdentifiableEntityService#updateTitleCache()\r
+        */\r
+       @Override\r
+       public void updateTitleCache() {\r
+               Class<TaxonNameBase> clazz = TaxonNameBase.class;\r
+               super.updateTitleCache(clazz, null, null);\r
+       }\r
+       \r
+       @Override\r
+       protected void setOtherCachesNull(TaxonNameBase name) {\r
+               if (name.isInstanceOf(NonViralName.class)){\r
+                       NonViralName nvn = CdmBase.deproxy(name, NonViralName.class);\r
+                       if (! nvn.isProtectedNameCache()){\r
+                               nvn.setNameCache(null, false);\r
+                       }\r
+                       if (! nvn.isProtectedAuthorshipCache()){\r
+                               nvn.setAuthorshipCache(null, false);\r
+                       }\r
+                       if (! nvn.isProtectedFullTitleCache()){\r
+                               nvn.setFullTitleCache(null, false);\r
+                       }\r
+               }\r
+       }\r
+       \r
+       \r
 }\r