// license-header java merge-point
   //
   // Attention: Generated code! Do not modify by hand!
   // Generated by: hibernate/SpringHibernateDaoBase.vsl in <project>/mda/src/main/cartridge/custom/...
   //
   package fr.ifremer.quadrige3.core.dao.data.survey;
   
   /*-
    * #%L
   * Quadrige3 Core :: Client API
   * %%
   * Copyright (C) 2017 - 2024 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  import fr.ifremer.quadrige3.core.dao.PrincipalStore;
  import fr.ifremer.quadrige3.core.dao.PropertySearch;
  import fr.ifremer.quadrige3.core.dao.Search;
  import fr.ifremer.quadrige3.core.dao.administration.user.Department;
  import fr.ifremer.quadrige3.core.dao.technical.hibernate.HibernateDaoSupport;
  import fr.ifremer.quadrige3.core.vo.data.survey.OccasionVO;
  import java.security.Principal;
  import java.sql.Timestamp;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Date;
  import java.util.Iterator;
  import java.util.LinkedHashSet;
  import java.util.List;
  import java.util.Set;
  import javax.annotation.Resource;
  import org.andromda.spring.PaginationResult;
  import org.apache.commons.collections.CollectionUtils;
  import org.apache.commons.collections.Transformer;
  import org.hibernate.Criteria;
  import org.hibernate.HibernateException;
  import org.hibernate.Query;
  import org.hibernate.ScrollableResults;
  
  /**
   * <p>
   * Base Spring DAO Class: is able to create, update, remove, load, and find
   * objects of type <code>Occasion</code>.
   * </p>
   *
   * @see Occasion
   */
  public abstract class OccasionDaoBase
      extends HibernateDaoSupport    
      implements OccasionDao
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public Object get(final int transform, final Integer occasId)
      {
          if (occasId == null)
          {
              throw new IllegalArgumentException(
                  "Occasion.get - 'occasId' can not be null");
          }
          final Occasion entity = get(OccasionImpl.class, occasId);
          return transformEntity(transform, entity);
      }
      /**
       * {@inheritDoc}
       */
      @Override
      public Occasion get(Integer occasId)
      {
          return (Occasion)this.get(TRANSFORM_NONE, occasId);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Object load(final int transform, final Integer occasId)
      {
          if (occasId == null)
          {
              throw new IllegalArgumentException(
                  "Occasion.load - 'occasId' can not be null");
          }
          final Occasion entity = get(OccasionImpl.class, occasId);
          return transformEntity(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Occasion load(Integer occasId)
     {
         return (Occasion)this.load(TRANSFORM_NONE, occasId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<Occasion> loadAll()
     {
         return (Collection<Occasion>) this.loadAll(OccasionDao.TRANSFORM_NONE);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> loadAll(final int transform)
     {
         return this.loadAll(transform, -1, -1);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> loadAll(final int pageNumber, final int pageSize)
     {
         return this.loadAll(OccasionDao.TRANSFORM_NONE, pageNumber, pageSize);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize)
     {
         try
         {
             final Criteria criteria = this.getSession().createCriteria(OccasionImpl.class);
             if (pageNumber > 0 && pageSize > 0)
             {
                 criteria.setFirstResult(this.calculateFirstResult(pageNumber, pageSize));
                 criteria.setMaxResults(pageSize);
             }
             final Collection<?> results = criteria.list();
             this.transformEntities(transform, results);
             return results;
         }
         catch (HibernateException ex)
         {
             throw ex;
         }
     }
 
     /**
      * firstResult = (pageNumber - 1) * pageSize
      * @param pageNumber
      * @param pageSize
      * @return firstResult
      */
     protected int calculateFirstResult(int pageNumber, int pageSize)
     {
         int firstResult = 0;
         if (pageNumber > 0)
         {
             firstResult = (pageNumber - 1) * pageSize;
         }
         return firstResult;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Occasion create(Occasion occasion)
     {
         return (Occasion)this.create(OccasionDao.TRANSFORM_NONE, occasion);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(final int transform, final Occasion occasion)
     {
         if (occasion == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.create - 'occasion' can not be null");
         }
         this.getSessionFactory().getCurrentSession().save(occasion);
         return this.transformEntity(transform, occasion);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<Occasion> create(final Collection<Occasion> entities)
     {
         return (Collection<Occasion>) create(OccasionDao.TRANSFORM_NONE, entities);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> create(final int transform, final Collection<Occasion> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.create - 'entities' can not be null");
         }
                     for (Occasion entity : entities)
                     {
                         create(transform, entity);
                     }
         return entities;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Occasion create(
         Date occasDt,
         String occasNm,
         String occasCm,
         String occasPositionCm,
         Timestamp updateDt,
         Integer remoteId)
     {
         return (Occasion)this.create(OccasionDao.TRANSFORM_NONE, occasDt, occasNm, occasCm, occasPositionCm, updateDt, remoteId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         Date occasDt,
         String occasNm,
         String occasCm,
         String occasPositionCm,
         Timestamp updateDt,
         Integer remoteId)
     {
         Occasion entity = new OccasionImpl();
         entity.setOccasDt(occasDt);
         entity.setOccasNm(occasNm);
         entity.setOccasCm(occasCm);
         entity.setOccasPositionCm(occasPositionCm);
         entity.setUpdateDt(updateDt);
         entity.setRemoteId(remoteId);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Occasion create(
         Date occasDt,
         String occasNm,
         Campaign campaign,
         Department recorderDepartment)
     {
         return (Occasion)this.create(OccasionDao.TRANSFORM_NONE, occasDt, occasNm, campaign, recorderDepartment);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         Date occasDt,
         String occasNm,
         Campaign campaign,
         Department recorderDepartment)
     {
         Occasion entity = new OccasionImpl();
         entity.setOccasDt(occasDt);
         entity.setOccasNm(occasNm);
         entity.setCampaign(campaign);
         entity.setRecorderDepartment(recorderDepartment);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(Occasion occasion)
     {
         if (occasion == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.update - 'occasion' can not be null");
         }
         this.getSessionFactory().getCurrentSession().update(occasion);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(final Collection<Occasion> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.update - 'entities' can not be null");
         }
                     for (Occasion entity : entities)
                     {
                         update(entity);
                     }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Occasion occasion)
     {
         if (occasion == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.remove - 'occasion' can not be null");
         }
         this.getSessionFactory().getCurrentSession().delete(occasion);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Integer occasId)
     {
         if (occasId == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.remove - 'occasId' can not be null");
         }
         Occasion entity = this.get(occasId);
         if (entity != null)
         {
             this.remove(entity);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Collection<Occasion> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Occasion.remove - 'entities' can not be null");
         }
         deleteAll(entities);
     }
     /**
      * {@inheritDoc}
      */
     @Override
     public OccasionVO save(final OccasionVO occasion, final Timestamp updateDt)
     {
         if (occasion == null)
         {
             throw new IllegalArgumentException(
                 "fr.ifremer.quadrige3.core.dao.data.survey.OccasionDao.save(OccasionVO occasion, Timestamp updateDt) - 'occasion' can not be null");
         }
         try
         {
             return this.handleSave(occasion, updateDt);
         }
         catch (Throwable th)
         {
             throw new RuntimeException(
             "Error performing 'OccasionDao.save(OccasionVO occasion, Timestamp updateDt)' --> " + th,
             th);
         }
     }
 
     /**
      * Performs the core logic for {@link #save(OccasionVO, Timestamp)}
      * @param occasion
      * @param updateDt
      * @return OccasionVO
      * @throws Exception
      */
     protected abstract OccasionVO handleSave(OccasionVO occasion, Timestamp updateDt)
         throws Exception;
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void removeByIds(final Collection<Integer> occasIds)
     {
         if (occasIds == null)
         {
             throw new IllegalArgumentException(
                 "fr.ifremer.quadrige3.core.dao.data.survey.OccasionDao.removeByIds(Collection<Integer> occasIds) - 'occasIds' can not be null");
         }
         try
         {
             this.handleRemoveByIds(occasIds);
         }
         catch (Throwable th)
         {
             throw new RuntimeException(
             "Error performing 'OccasionDao.removeByIds(Collection<Integer> occasIds)' --> " + th,
             th);
         }
     }
 
     /**
      * Performs the core logic for {@link #removeByIds(Collection<Integer>)}
      * @param occasIds
      * @return void
      * @throws Exception
      */
     protected abstract void handleRemoveByIds(Collection<Integer> occasIds)
         throws Exception;
 
     /**
      * Allows transformation of entities into value objects
      * (or something else for that matter), when the <code>transform</code>
      * flag is set to one of the constants defined in <code>OccasionDao</code>, please note
      * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
      * will be returned.
      * <p>
      * This method will return instances of these types:
      * <ul>
      *   <li>{@link Occasion} - {@link #TRANSFORM_NONE}</li>
      *   <li>{@link OccasionVO} - {@link #TRANSFORM_OCCASIONVO}</li>
      * </ul>
      *
      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
      *
      * @param transform one of the constants declared in {@link OccasionDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see OccasionDao#transformEntity(int, Occasion)
      */
     public Object transformEntity(final int transform, final Occasion entity)
     {
         Object target = null;
         if (entity != null)
         {
             switch (transform)
             {
                 case TRANSFORM_OCCASIONVO :
                     target = toOccasionVO(entity);
                     break;
                 case OccasionDao.TRANSFORM_NONE : // fall-through
                 default:
                     target = entity;
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void transformEntities(final int transform, final Collection<?> entities)
     {
         switch (transform)
         {
             case TRANSFORM_OCCASIONVO :
                 toOccasionVOCollection(entities);
                 break;
             case OccasionDao.TRANSFORM_NONE : // fall-through
                 default:
                 // do nothing;
         }
     }
 
     /**
      * @see OccasionDao#toEntities(Collection)
      */
     public void toEntities(final Collection<?> results)
     {
         if (results != null)
         {
             CollectionUtils.transform(results, this.ENTITYTRANSFORMER);
         }
     }
 
     /**
      * This anonymous transformer is designed to transform report query results
      * (which result in an array of entities) to {@link Occasion}
      * using the Jakarta Commons-Collections Transformation API.
      */
     private Transformer ENTITYTRANSFORMER =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 Object result = null;
                 if (input instanceof Object[])
                 {
                     result = toEntity((Object[])input);
                 }
                 else if (input instanceof Occasion)
                 {
                     result = input;
                 }
                 return result;
             }
         };
 
     /**
      * @param row
      * @return Occasion
      */
     protected Occasion toEntity(Object[] row)
     {
         Occasion target = null;
         if (row != null)
         {
             final int numberOfObjects = row.length;
             for (int ctr = 0; ctr < numberOfObjects; ctr++)
             {
                 final Object object = row[ctr];
                 if (object instanceof Occasion)
                 {
                     target = (Occasion)object;
                     break;
                 }
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public final Collection<OccasionVO> toOccasionVOCollection(Collection<?> entities)
     {
         Collection<OccasionVO> result = new ArrayList<OccasionVO>();
         if (entities != null)
         {
             CollectionUtils.transform(entities, this.OCCASIONVO_TRANSFORMER);
             result.addAll((Collection<? extends OccasionVO>) entities);
         }
         return result;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({ "unchecked" })
     public final OccasionVO[] toOccasionVOArray(Collection<?> entities)
     {
         OccasionVO[] result = null;
         if (entities != null)
         {
             // Unchecked transformation: reuses entities Collection
             final Collection collection = new ArrayList(entities);
             this.toOccasionVOCollection(collection);
             result = (OccasionVO[]) collection.toArray(new OccasionVO[collection.size()]);
         }
         return result;
     }
 
     /**
      * Default implementation for transforming the results of a report query into a value object. This
      * implementation exists for convenience reasons only. It needs only be overridden in the
      * {@link OccasionDaoImpl} class if you intend to use reporting queries.
      * @param row
      * @return toOccasionVO(this.toEntity(row))
      * @see OccasionDao#toOccasionVO(Occasion)
      */
     protected OccasionVO toOccasionVO(Object[] row)
     {
         return this.toOccasionVO(this.toEntity(row));
     }
 
     /**
      * This anonymous transformer is designed to transform entities or report query results
      * (which result in an array of objects) to {@link OccasionVO}
      * using the Jakarta Commons-Collections Transformation API.
      */
     private Transformer OCCASIONVO_TRANSFORMER =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 Object result = null;
                 if (input instanceof Occasion)
                 {
                     result = toOccasionVO((Occasion)input);
                 }
                 else if (input instanceof Object[])
                 {
                     result = toOccasionVO((Object[])input);
                 }
                 return result;
             }
         };
 
     /**
      * {@inheritDoc}
      */
     @Override
     public final void occasionVOToEntityCollection(Collection<?> instances)
     {
         if (instances != null)
         {
             for (final Iterator<?> iterator = instances.iterator(); iterator.hasNext();)
             {
                 // - remove an objects that are null or not of the correct instance
                 if (!(iterator.next() instanceof OccasionVO))
                 {
                     iterator.remove();
                 }
             }
             CollectionUtils.transform(instances, this.OccasionVOToEntityTransformer);
         }
     }
 
     private final Transformer OccasionVOToEntityTransformer =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 return occasionVOToEntity((OccasionVO)input);
             }
         };
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void toOccasionVO(
         Occasion source,
         OccasionVO target)
     {
         target.setOccasId(source.getOccasId());
         target.setOccasDt(source.getOccasDt());
         target.setOccasNm(source.getOccasNm());
         target.setOccasCm(source.getOccasCm());
         target.setOccasPositionCm(source.getOccasPositionCm());
         target.setUpdateDt(source.getUpdateDt());
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public OccasionVO toOccasionVO(final Occasion entity)
     {
         OccasionVO target = null;
         if (entity != null)
         {
             target =  new OccasionVO();
             this.toOccasionVO(entity, target);
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void occasionVOToEntity(
         OccasionVO source,
         Occasion target,
         boolean copyIfNull)
     {
         if (copyIfNull || source.getOccasDt() != null)
         {
             target.setOccasDt(source.getOccasDt());
         }
         if (copyIfNull || source.getOccasNm() != null)
         {
             target.setOccasNm(source.getOccasNm());
         }
         if (copyIfNull || source.getOccasCm() != null)
         {
             target.setOccasCm(source.getOccasCm());
         }
         if (copyIfNull || source.getOccasPositionCm() != null)
         {
             target.setOccasPositionCm(source.getOccasPositionCm());
         }
         if (copyIfNull || source.getUpdateDt() != null)
         {
             target.setUpdateDt(source.getUpdateDt());
         }
     }
 
     /**
      * Gets the current <code>principal</code> if one has been set,
      * otherwise returns <code>null</code>.
      *
      * @return the current principal
      */
     protected Principal getPrincipal()
     {
         return PrincipalStore.get();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({ "unchecked" })
     public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search)
     {
         try
         {
             search.setPageNumber(pageNumber);
             search.setPageSize(pageSize);
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), OccasionImpl.class, search);
             final List results = propertySearch.executeAsList();
             this.transformEntities(transform, results);
             return new PaginationResult(results.toArray(new Object[results.size()]), propertySearch.getTotalCount());
         }
         catch (HibernateException ex)
         {
             throw ex; /*super.convertHibernateAccessException(ex);*/
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public PaginationResult search(final int pageNumber, final int pageSize, final Search search)
     {
         return this.search(OccasionDao.TRANSFORM_NONE, pageNumber, pageSize, search);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Set<?> search(final int transform, final Search search)
     {
         try
         {
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), OccasionImpl.class, search);
             final Set<?> results = propertySearch.executeAsSet();
             this.transformEntities(transform, results);
             return results;
         }
         catch (HibernateException ex)
         {
             throw ex; /*super.convertHibernateAccessException(ex);*/
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings("unchecked")
     public Set<Occasion> search(final Search search)
     {
         return (Set<Occasion>) this.search(OccasionDao.TRANSFORM_NONE, search);
     }
 
     /**
      * Executes and returns the given Hibernate queryObject as a {@link PaginationResult} instance.
      * @param queryObject
      * @param transform
      * @param pageNumber
      * @param pageSize
      * @return PaginationResult
      */
     @SuppressWarnings({ "unchecked" })
     protected PaginationResult getPaginationResult(
         final Query queryObject,
         final int transform, int pageNumber, int pageSize)
     {
         try
         {
             final ScrollableResults scrollableResults = queryObject.scroll();
             scrollableResults.last();
             int totalCount = scrollableResults.getRowNumber();
             totalCount = totalCount >= 0 ? totalCount + 1 : 0;
             if (pageNumber > 0 && pageSize > 0)
             {
                 queryObject.setFirstResult(this.calculateFirstResult(pageNumber, pageSize));
                 queryObject.setMaxResults(pageSize);
             }
             // Unchecked transformation because Set object is reused, cannot be strongly typed.
             Set results = new LinkedHashSet(queryObject.list());
             transformEntities(transform, results);
             return new PaginationResult(results.toArray(new Object[results.size()]), totalCount);
         }
         catch (HibernateException ex)
         {
             throw ex; /*super.convertHibernateAccessException(ex);*/
         }
     }
 
     // spring-hibernate-dao-base merge-point
 }