// 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.sample;
   
   /*-
    * #%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.data.samplingoperation.SamplingOperation;
  import fr.ifremer.quadrige3.core.dao.referential.QualityFlag;
  import fr.ifremer.quadrige3.core.dao.referential.pmfm.Matrix;
  import fr.ifremer.quadrige3.core.dao.technical.hibernate.HibernateDaoSupport;
  import java.security.Principal;
  import java.sql.Timestamp;
  import java.util.Collection;
  import java.util.Date;
  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>Sample</code>.
   * </p>
   *
   * @see Sample
   */
  public abstract class SampleDaoBase
      extends HibernateDaoSupport    
      implements SampleDao
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public Object get(final int transform, final Integer sampleId)
      {
          if (sampleId == null)
          {
              throw new IllegalArgumentException(
                  "Sample.get - 'sampleId' can not be null");
          }
          final Sample entity = get(SampleImpl.class, sampleId);
          return transformEntity(transform, entity);
      }
      /**
       * {@inheritDoc}
       */
      @Override
      public Sample get(Integer sampleId)
      {
          return (Sample)this.get(TRANSFORM_NONE, sampleId);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Object load(final int transform, final Integer sampleId)
      {
          if (sampleId == null)
          {
              throw new IllegalArgumentException(
                  "Sample.load - 'sampleId' can not be null");
          }
          final Sample entity = get(SampleImpl.class, sampleId);
          return transformEntity(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Sample load(Integer sampleId)
     {
         return (Sample)this.load(TRANSFORM_NONE, sampleId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<Sample> loadAll()
     {
         return (Collection<Sample>) this.loadAll(SampleDao.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(SampleDao.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(SampleImpl.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 Sample create(Sample sample)
     {
         return (Sample)this.create(SampleDao.TRANSFORM_NONE, sample);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(final int transform, final Sample sample)
     {
         if (sample == null)
         {
             throw new IllegalArgumentException(
                 "Sample.create - 'sample' can not be null");
         }
         this.getSessionFactory().getCurrentSession().save(sample);
         return this.transformEntity(transform, sample);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<Sample> create(final Collection<Sample> entities)
     {
         return (Collection<Sample>) create(SampleDao.TRANSFORM_NONE, entities);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> create(final int transform, final Collection<Sample> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Sample.create - 'entities' can not be null");
         }
                     for (Sample entity : entities)
                     {
                         create(transform, entity);
                     }
         return entities;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Sample create(
         String sampleLb,
         Integer sampleNumberIndiv,
         Float sampleSize,
         String sampleCm,
         Date sampleControlDt,
         Date sampleValidDt,
         Date sampleQualifDt,
         String sampleQualifCm,
         String sampleScope,
         String sampleHasMeas,
         Timestamp updateDt,
         Integer remoteId)
     {
         return (Sample)this.create(SampleDao.TRANSFORM_NONE, sampleLb, sampleNumberIndiv, sampleSize, sampleCm, sampleControlDt, sampleValidDt, sampleQualifDt, sampleQualifCm, sampleScope, sampleHasMeas, updateDt, remoteId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         String sampleLb,
         Integer sampleNumberIndiv,
         Float sampleSize,
         String sampleCm,
         Date sampleControlDt,
         Date sampleValidDt,
         Date sampleQualifDt,
         String sampleQualifCm,
         String sampleScope,
         String sampleHasMeas,
         Timestamp updateDt,
         Integer remoteId)
     {
         Sample entity = new SampleImpl();
         entity.setSampleLb(sampleLb);
         entity.setSampleNumberIndiv(sampleNumberIndiv);
         entity.setSampleSize(sampleSize);
         entity.setSampleCm(sampleCm);
         entity.setSampleControlDt(sampleControlDt);
         entity.setSampleValidDt(sampleValidDt);
         entity.setSampleQualifDt(sampleQualifDt);
         entity.setSampleQualifCm(sampleQualifCm);
         entity.setSampleScope(sampleScope);
         entity.setSampleHasMeas(sampleHasMeas);
         entity.setUpdateDt(updateDt);
         entity.setRemoteId(remoteId);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Sample create(
         Department recorderDepartment,
         Matrix matrix,
         QualityFlag qualityFlag,
         SamplingOperation samplingOperation)
     {
         return (Sample)this.create(SampleDao.TRANSFORM_NONE, recorderDepartment, matrix, qualityFlag, samplingOperation);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         Department recorderDepartment,
         Matrix matrix,
         QualityFlag qualityFlag,
         SamplingOperation samplingOperation)
     {
         Sample entity = new SampleImpl();
         entity.setRecorderDepartment(recorderDepartment);
         entity.setMatrix(matrix);
         entity.setQualityFlag(qualityFlag);
         entity.setSamplingOperation(samplingOperation);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(Sample sample)
     {
         if (sample == null)
         {
             throw new IllegalArgumentException(
                 "Sample.update - 'sample' can not be null");
         }
         this.getSessionFactory().getCurrentSession().update(sample);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(final Collection<Sample> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Sample.update - 'entities' can not be null");
         }
                     for (Sample entity : entities)
                     {
                         update(entity);
                     }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Sample sample)
     {
         if (sample == null)
         {
             throw new IllegalArgumentException(
                 "Sample.remove - 'sample' can not be null");
         }
         this.getSessionFactory().getCurrentSession().delete(sample);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Integer sampleId)
     {
         if (sampleId == null)
         {
             throw new IllegalArgumentException(
                 "Sample.remove - 'sampleId' can not be null");
         }
         Sample entity = this.get(sampleId);
         if (entity != null)
         {
             this.remove(entity);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Collection<Sample> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Sample.remove - 'entities' can not be null");
         }
         deleteAll(entities);
     }
     /**
      * 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>SampleDao</code>, please note
      * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
      * will be returned.
      *
      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
      *
      * @param transform one of the constants declared in {@link SampleDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see SampleDao#transformEntity(int, Sample)
      */
     public Object transformEntity(final int transform, final Sample entity)
     {
         Object target = null;
         if (entity != null)
         {
             switch (transform)
             {
                 case SampleDao.TRANSFORM_NONE : // fall-through
                 default:
                     target = entity;
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void transformEntities(final int transform, final Collection<?> entities)
     {
         switch (transform)
         {
             case SampleDao.TRANSFORM_NONE : // fall-through
                 default:
                 // do nothing;
         }
     }
 
     /**
      * @see SampleDao#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 Sample}
      * 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 Sample)
                 {
                     result = input;
                 }
                 return result;
             }
         };
 
     /**
      * @param row
      * @return Sample
      */
     protected Sample toEntity(Object[] row)
     {
         Sample 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 Sample)
                 {
                     target = (Sample)object;
                     break;
                 }
             }
         }
         return target;
     }
 
     /**
      * 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(), SampleImpl.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(SampleDao.TRANSFORM_NONE, pageNumber, pageSize, search);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Set<?> search(final int transform, final Search search)
     {
         try
         {
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), SampleImpl.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<Sample> search(final Search search)
     {
         return (Set<Sample>) this.search(SampleDao.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
 }