// 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.referential.taxon;
   
   /*-
    * #%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.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>TaxonName</code>.
   * </p>
   *
   * @see TaxonName
   */
  public abstract class TaxonNameDaoBase
      extends HibernateDaoSupport    
      implements TaxonNameDao
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public Object get(final int transform, final Integer taxonNameId)
      {
          if (taxonNameId == null)
          {
              throw new IllegalArgumentException(
                  "TaxonName.get - 'taxonNameId' can not be null");
          }
          final TaxonName entity = get(TaxonNameImpl.class, taxonNameId);
          return transformEntity(transform, entity);
      }
      /**
       * {@inheritDoc}
       */
      @Override
      public TaxonName get(Integer taxonNameId)
      {
          return (TaxonName)this.get(TRANSFORM_NONE, taxonNameId);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Object load(final int transform, final Integer taxonNameId)
      {
          if (taxonNameId == null)
          {
              throw new IllegalArgumentException(
                  "TaxonName.load - 'taxonNameId' can not be null");
          }
          final TaxonName entity = get(TaxonNameImpl.class, taxonNameId);
          return transformEntity(transform, entity);
      }
  
      /**
       * {@inheritDoc}
      */
     @Override
     public TaxonName load(Integer taxonNameId)
     {
         return (TaxonName)this.load(TRANSFORM_NONE, taxonNameId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<TaxonName> loadAll()
     {
         return (Collection<TaxonName>) this.loadAll(TaxonNameDao.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(TaxonNameDao.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(TaxonNameImpl.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 TaxonName create(TaxonName taxonName)
     {
         return (TaxonName)this.create(TaxonNameDao.TRANSFORM_NONE, taxonName);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(final int transform, final TaxonName taxonName)
     {
         if (taxonName == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.create - 'taxonName' can not be null");
         }
         this.getSessionFactory().getCurrentSession().save(taxonName);
         return this.transformEntity(transform, taxonName);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<TaxonName> create(final Collection<TaxonName> entities)
     {
         return (Collection<TaxonName>) create(TaxonNameDao.TRANSFORM_NONE, entities);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> create(final int transform, final Collection<TaxonName> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.create - 'entities' can not be null");
         }
                     for (TaxonName entity : entities)
                     {
                         create(transform, entity);
                     }
         return entities;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public TaxonName create(
         String taxonNameNm,
         String taxonNameCompleteNm,
         Boolean taxonNameIsNaming,
         String taxonNameCm,
         Integer taxonNameUpperRk,
         Boolean taxonNameIsRefer,
         Boolean taxonNameIsVirtual,
         Boolean taxonNameObsol,
         Boolean taxonNameTempor,
         Date taxonNameCreationDt,
         Timestamp updateDt,
         Date taxonStartDt,
         Date taxonEndDt)
     {
         return (TaxonName)this.create(TaxonNameDao.TRANSFORM_NONE, taxonNameNm, taxonNameCompleteNm, taxonNameIsNaming, taxonNameCm, taxonNameUpperRk, taxonNameIsRefer, taxonNameIsVirtual, taxonNameObsol, taxonNameTempor, taxonNameCreationDt, updateDt, taxonStartDt, taxonEndDt);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         String taxonNameNm,
         String taxonNameCompleteNm,
         Boolean taxonNameIsNaming,
         String taxonNameCm,
         Integer taxonNameUpperRk,
         Boolean taxonNameIsRefer,
         Boolean taxonNameIsVirtual,
         Boolean taxonNameObsol,
         Boolean taxonNameTempor,
         Date taxonNameCreationDt,
         Timestamp updateDt,
         Date taxonStartDt,
         Date taxonEndDt)
     {
         TaxonName entity = new TaxonNameImpl();
         entity.setTaxonNameNm(taxonNameNm);
         entity.setTaxonNameCompleteNm(taxonNameCompleteNm);
         entity.setTaxonNameIsNaming(taxonNameIsNaming);
         entity.setTaxonNameCm(taxonNameCm);
         entity.setTaxonNameUpperRk(taxonNameUpperRk);
         entity.setTaxonNameIsRefer(taxonNameIsRefer);
         entity.setTaxonNameIsVirtual(taxonNameIsVirtual);
         entity.setTaxonNameObsol(taxonNameObsol);
         entity.setTaxonNameTempor(taxonNameTempor);
         entity.setTaxonNameCreationDt(taxonNameCreationDt);
         entity.setUpdateDt(updateDt);
         entity.setTaxonStartDt(taxonStartDt);
         entity.setTaxonEndDt(taxonEndDt);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public TaxonName create(
         ReferenceTaxon referenceTaxon,
         TaxonomicLevel taxonomicLevel)
     {
         return (TaxonName)this.create(TaxonNameDao.TRANSFORM_NONE, referenceTaxon, taxonomicLevel);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         ReferenceTaxon referenceTaxon,
         TaxonomicLevel taxonomicLevel)
     {
         TaxonName entity = new TaxonNameImpl();
         entity.setReferenceTaxon(referenceTaxon);
         entity.setTaxonomicLevel(taxonomicLevel);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(TaxonName taxonName)
     {
         if (taxonName == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.update - 'taxonName' can not be null");
         }
         this.getSessionFactory().getCurrentSession().update(taxonName);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(final Collection<TaxonName> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.update - 'entities' can not be null");
         }
                     for (TaxonName entity : entities)
                     {
                         update(entity);
                     }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(TaxonName taxonName)
     {
         if (taxonName == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.remove - 'taxonName' can not be null");
         }
         this.getSessionFactory().getCurrentSession().delete(taxonName);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Integer taxonNameId)
     {
         if (taxonNameId == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.remove - 'taxonNameId' can not be null");
         }
         TaxonName entity = this.get(taxonNameId);
         if (entity != null)
         {
             this.remove(entity);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Collection<TaxonName> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "TaxonName.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>TaxonNameDao</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 TaxonNameDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see TaxonNameDao#transformEntity(int, TaxonName)
      */
     public Object transformEntity(final int transform, final TaxonName entity)
     {
         Object target = null;
         if (entity != null)
         {
             switch (transform)
             {
                 case TaxonNameDao.TRANSFORM_NONE : // fall-through
                 default:
                     target = entity;
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void transformEntities(final int transform, final Collection<?> entities)
     {
         switch (transform)
         {
             case TaxonNameDao.TRANSFORM_NONE : // fall-through
                 default:
                 // do nothing;
         }
     }
 
     /**
      * @see TaxonNameDao#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 TaxonName}
      * 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 TaxonName)
                 {
                     result = input;
                 }
                 return result;
             }
         };
 
     /**
      * @param row
      * @return TaxonName
      */
     protected TaxonName toEntity(Object[] row)
     {
         TaxonName 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 TaxonName)
                 {
                     target = (TaxonName)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(), TaxonNameImpl.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(TaxonNameDao.TRANSFORM_NONE, pageNumber, pageSize, search);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Set<?> search(final int transform, final Search search)
     {
         try
         {
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), TaxonNameImpl.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<TaxonName> search(final Search search)
     {
         return (Set<TaxonName>) this.search(TaxonNameDao.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
 }