// 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.referential.Status;
  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>ReferenceDocument</code>.
   * </p>
   *
   * @see ReferenceDocument
   */
  public abstract class ReferenceDocumentDaoBase
      extends HibernateDaoSupport    
      implements ReferenceDocumentDao
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public Object get(final int transform, final Integer refDocId)
      {
          if (refDocId == null)
          {
              throw new IllegalArgumentException(
                  "ReferenceDocument.get - 'refDocId' can not be null");
          }
          final ReferenceDocument entity = get(ReferenceDocumentImpl.class, refDocId);
          return transformEntity(transform, entity);
      }
      /**
       * {@inheritDoc}
       */
      @Override
      public ReferenceDocument get(Integer refDocId)
      {
          return (ReferenceDocument)this.get(TRANSFORM_NONE, refDocId);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Object load(final int transform, final Integer refDocId)
      {
          if (refDocId == null)
          {
              throw new IllegalArgumentException(
                  "ReferenceDocument.load - 'refDocId' can not be null");
          }
          final ReferenceDocument entity = get(ReferenceDocumentImpl.class, refDocId);
          return transformEntity(transform, entity);
      }
  
      /**
      * {@inheritDoc}
      */
     @Override
     public ReferenceDocument load(Integer refDocId)
     {
         return (ReferenceDocument)this.load(TRANSFORM_NONE, refDocId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<ReferenceDocument> loadAll()
     {
         return (Collection<ReferenceDocument>) this.loadAll(ReferenceDocumentDao.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(ReferenceDocumentDao.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(ReferenceDocumentImpl.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 ReferenceDocument create(ReferenceDocument referenceDocument)
     {
         return (ReferenceDocument)this.create(ReferenceDocumentDao.TRANSFORM_NONE, referenceDocument);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(final int transform, final ReferenceDocument referenceDocument)
     {
         if (referenceDocument == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.create - 'referenceDocument' can not be null");
         }
         this.getSessionFactory().getCurrentSession().save(referenceDocument);
         return this.transformEntity(transform, referenceDocument);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<ReferenceDocument> create(final Collection<ReferenceDocument> entities)
     {
         return (Collection<ReferenceDocument>) create(ReferenceDocumentDao.TRANSFORM_NONE, entities);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> create(final int transform, final Collection<ReferenceDocument> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.create - 'entities' can not be null");
         }
                     for (ReferenceDocument entity : entities)
                     {
                         create(transform, entity);
                     }
         return entities;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public ReferenceDocument create(
         String refDocRefer,
         Date refDocDt,
         String refDocCm,
         Date refDocCreationDt,
         Timestamp updateDt)
     {
         return (ReferenceDocument)this.create(ReferenceDocumentDao.TRANSFORM_NONE, refDocRefer, refDocDt, refDocCm, refDocCreationDt, updateDt);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         String refDocRefer,
         Date refDocDt,
         String refDocCm,
         Date refDocCreationDt,
         Timestamp updateDt)
     {
         ReferenceDocument entity = new ReferenceDocumentImpl();
         entity.setRefDocRefer(refDocRefer);
         entity.setRefDocDt(refDocDt);
         entity.setRefDocCm(refDocCm);
         entity.setRefDocCreationDt(refDocCreationDt);
         entity.setUpdateDt(updateDt);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public ReferenceDocument create(
         Status status)
     {
         return (ReferenceDocument)this.create(ReferenceDocumentDao.TRANSFORM_NONE, status);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         Status status)
     {
         ReferenceDocument entity = new ReferenceDocumentImpl();
         entity.setStatus(status);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(ReferenceDocument referenceDocument)
     {
         if (referenceDocument == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.update - 'referenceDocument' can not be null");
         }
         this.getSessionFactory().getCurrentSession().update(referenceDocument);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(final Collection<ReferenceDocument> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.update - 'entities' can not be null");
         }
                     for (ReferenceDocument entity : entities)
                     {
                         update(entity);
                     }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(ReferenceDocument referenceDocument)
     {
         if (referenceDocument == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.remove - 'referenceDocument' can not be null");
         }
         this.getSessionFactory().getCurrentSession().delete(referenceDocument);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Integer refDocId)
     {
         if (refDocId == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.remove - 'refDocId' can not be null");
         }
         ReferenceDocument entity = this.get(refDocId);
         if (entity != null)
         {
             this.remove(entity);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Collection<ReferenceDocument> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "ReferenceDocument.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>ReferenceDocumentDao</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 ReferenceDocumentDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see ReferenceDocumentDao#transformEntity(int, ReferenceDocument)
      */
     public Object transformEntity(final int transform, final ReferenceDocument entity)
     {
         Object target = null;
         if (entity != null)
         {
             switch (transform)
             {
                 case ReferenceDocumentDao.TRANSFORM_NONE : // fall-through
                 default:
                     target = entity;
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void transformEntities(final int transform, final Collection<?> entities)
     {
         switch (transform)
         {
             case ReferenceDocumentDao.TRANSFORM_NONE : // fall-through
                 default:
                 // do nothing;
         }
     }
 
     /**
      * @see ReferenceDocumentDao#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 ReferenceDocument}
      * 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 ReferenceDocument)
                 {
                     result = input;
                 }
                 return result;
             }
         };
 
     /**
      * @param row
      * @return ReferenceDocument
      */
     protected ReferenceDocument toEntity(Object[] row)
     {
         ReferenceDocument 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 ReferenceDocument)
                 {
                     target = (ReferenceDocument)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(), ReferenceDocumentImpl.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(ReferenceDocumentDao.TRANSFORM_NONE, pageNumber, pageSize, search);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Set<?> search(final int transform, final Search search)
     {
         try
         {
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), ReferenceDocumentImpl.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<ReferenceDocument> search(final Search search)
     {
         return (Set<ReferenceDocument>) this.search(ReferenceDocumentDao.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
 }