cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/ServiceBase.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   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.
   9 */
  10
  11 package eu.etaxonomy.cdm.api.service;
  12
  13 import java.util.ArrayList;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.UUID;
  19
  20 import org.apache.log4j.Logger;
  21 import org.hibernate.LockOptions;
  22 import org.hibernate.Session;
  23 import org.springframework.context.ApplicationContext;
  24 import org.springframework.context.ApplicationContextAware;
  25 import org.springframework.dao.DataAccessException;
  26 import org.springframework.transaction.annotation.Transactional;
  27
  28 import eu.etaxonomy.cdm.api.service.pager.Pager;
  29 import eu.etaxonomy.cdm.api.service.pager.impl.DefaultPagerImpl;
  30 import eu.etaxonomy.cdm.model.common.CdmBase;
  31 import eu.etaxonomy.cdm.persistence.dao.common.ICdmEntityDao;
  32 import eu.etaxonomy.cdm.persistence.query.Grouping;
  33 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  34
  35 public abstract class ServiceBase<T extends CdmBase, DAO extends ICdmEntityDao<T>> implements IService<T>, ApplicationContextAware {
  36     @SuppressWarnings("unused")
  37     private static final Logger logger = Logger.getLogger(ServiceBase.class);
  38
  39     //flush after saving this number of objects
  40     int flushAfterNo = 2000;
  41     protected ApplicationContext appContext;
  42
  43     protected DAO dao;
  44
  45     @Override
  46     @Transactional(readOnly = true)
  47     public void lock(T t, LockOptions lockOptions) {
  48         dao.lock(t, lockOptions);
  49     }
  50
  51     @Override
  52     @Transactional(readOnly = true)
  53     public void refresh(T t, LockOptions lockOptions, List<String> propertyPaths) {
  54         dao.refresh(t, lockOptions, propertyPaths);
  55     }
  56
  57     @Override
  58     @Transactional(readOnly = false)
  59     public void clear() {
  60         dao.clear();
  61     }
  62
  63     @Override
  64     @Transactional(readOnly = true)
  65     public int count(Class<? extends T> clazz) {
  66         return dao.count(clazz);
  67     }
  68
  69     @Override
  70     @Transactional(readOnly = false)
  71     public DeleteResult delete(UUID persistentObjectUUID) {
  72         T persistentObject = dao.findByUuid(persistentObjectUUID);
  73         return delete(persistentObject);
  74     }
  75
  76     @Override
  77     @Transactional(readOnly = false)
  78     public DeleteResult delete(Collection<UUID> persistentObjectUUIDs) {
  79         DeleteResult result = new DeleteResult();
  80         for(UUID persistentObjectUUID : persistentObjectUUIDs) {
  81             T persistentObject = dao.findByUuid(persistentObjectUUID);
  82             DeleteResult dr = delete(persistentObject);
  83             result.includeResult(dr);
  84         }
  85         return result;
  86     }
  87
  88     @Override
  89     @Transactional(readOnly = false)
  90     public DeleteResult delete(T persistentObject) {
  91         DeleteResult result = new DeleteResult();
  92         try{
  93                 dao.delete(persistentObject);
  94                 result.setCdmEntity(persistentObject);
  95         } catch(DataAccessException e){
  96                 result.setError();
  97                 result.addException(e);
  98         }
  99         return result;
 100     }
 101
 102
 103
 104     @Override
 105     @Transactional(readOnly = true)
 106     public boolean exists(UUID uuid) {
 107         return dao.exists(uuid);
 108     }
 109
 110     @Override
 111     @Transactional(readOnly = true)
 112     public List<T> find(Set<UUID> uuidSet) {
 113         return dao.list(uuidSet, null, null, null, null);
 114     }
 115
 116     @Override
 117     @Transactional(readOnly = true)
 118     public List<T> findById(Set<Integer> idSet) {  //can't be called find(Set<Integer>) as this conflicts with find(Set<UUID)
 119         return dao.listByIds(idSet, null, null, null, null);
 120     }
 121
 122     @Override
 123     @Transactional(readOnly = true)
 124     public T find(UUID uuid) {
 125         return uuid == null ? null : dao.findByUuid(uuid);
 126     }
 127
 128     @Override
 129     @Transactional(readOnly = true)
 130     public T findWithoutFlush(UUID uuid) {
 131         return uuid == null ? null : dao.findByUuidWithoutFlush(uuid);
 132     }
 133
 134     @Override
 135     @Transactional(readOnly = true)
 136     public T find(int id) {
 137         return dao.findById(id);
 138     }
 139
 140     @Override
 141     @Transactional(readOnly = true)
 142     public Session getSession() {
 143         return dao.getSession();
 144     }
 145
 146     @Override
 147     @Transactional(readOnly = true)
 148     public List<Object[]> group(Class<? extends T> clazz,Integer limit, Integer start, List<Grouping> groups, List<String> propertyPaths) {
 149         return dao.group(clazz, limit, start, groups, propertyPaths);
 150     }
 151
 152     @Override
 153     @Transactional(readOnly = true)
 154     public <S extends T> List<S> list(Class<S> type, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths){
 155         return dao.list(type,limit, start, orderHints,propertyPaths);
 156     }
 157
 158     @Override
 159     @Transactional(readOnly = true)
 160     public T load(UUID uuid) {
 161         return uuid == null ? null : dao.load(uuid);
 162     }
 163
 164     @Override
 165     @Transactional(readOnly = true)
 166     public T load(UUID uuid, List<String> propertyPaths){
 167         return uuid == null ? null : dao.load(uuid, propertyPaths);
 168     }
 169
 170     @Override
 171     @Transactional(readOnly = false)
 172     public T merge(T newInstance) {
 173         return dao.merge(newInstance);
 174     }
 175
 176     @Override
 177     @Transactional(readOnly = false)
 178     public List<T> merge(List<T> detachedObjects) {
 179         List<T> mergedObjects = new ArrayList<T>();
 180         for(T obj : detachedObjects) {
 181             mergedObjects.add(dao.merge(obj));
 182         }
 183         return mergedObjects;
 184     }
 185
 186     @Override
 187     @Transactional(readOnly = true)
 188     public  <S extends T> Pager<S> page(Class<S> type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths){
 189         Integer numberOfResults = dao.count(type);
 190         List<S> results = new ArrayList<S>();
 191         pageNumber = pageNumber == null ? 0 : pageNumber;
 192         if(numberOfResults > 0) { // no point checking again  //TODO use AbstractPagerImpl.hasResultsInRange(numberOfResults, pageNumber, pageSize)
 193             Integer start = pageSize == null ? 0 : pageSize * pageNumber;
 194             results = dao.list(type, pageSize, start, orderHints,propertyPaths);
 195         }
 196         return new DefaultPagerImpl<S>(pageNumber, numberOfResults, pageSize, results);
 197     }
 198
 199     @Override
 200     @Transactional(readOnly = true)
 201     public UUID refresh(T persistentObject) {
 202         return dao.refresh(persistentObject);
 203     }
 204
 205     /**
 206      * FIXME Candidate for harmonization
 207      * is this method used, and if so, should it be exposed in the service layer?
 208      * it seems a bit incongruous that we use an ORM to hide the fact that there is a
 209      * database, then expose a method that talks about "rows" . . .
 210      */
 211     @Override
 212     @Transactional(readOnly = true)
 213     public List<T> rows(String tableName, int limit, int start) {
 214         return dao.rows(tableName, limit, start);
 215     }
 216
 217     @Override
 218     @Transactional(readOnly = false)
 219     public Map<UUID, T> save(Collection<T> newInstances) {
 220         return dao.saveAll(newInstances);
 221     }
 222
 223     @Override
 224     @Transactional(readOnly = false)
 225     public T save(T newInstance) {
 226         return dao.save(newInstance);
 227     }
 228
 229     @Override
 230     @Transactional(readOnly = false)
 231     public UUID saveOrUpdate(T transientObject) {
 232         return dao.saveOrUpdate(transientObject);
 233     }
 234
 235     @Override
 236     @Transactional(readOnly = false)
 237     public Map<UUID, T> saveOrUpdate(Collection<T> transientInstances) {
 238         return dao.saveOrUpdateAll(transientInstances);
 239     }
 240
 241     @Override
 242     public void setApplicationContext(ApplicationContext appContext){
 243         this.appContext = appContext;
 244     }
 245
 246
 247     protected abstract void setDao(DAO dao);
 248
 249     @Override
 250     @Transactional(readOnly = false)
 251     public UUID update(T transientObject) {
 252         return dao.update(transientObject);
 253     }
 254
 255     @Override
 256     @Transactional(readOnly = true)
 257     public List<T> list(T example, Set<String> includeProperties, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths) {
 258         return dao.list(example, includeProperties, limit, start, orderHints, propertyPaths);
 259     }
 260
 261
 262
 263 }