// 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.system.rule;
   
   /*-
    * #%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.pmfm.Parameter;
  import fr.ifremer.quadrige3.core.dao.technical.hibernate.HibernateDaoSupport;
  import fr.ifremer.quadrige3.core.vo.system.rule.RulePmfmVO;
  import java.security.Principal;
  import java.sql.Timestamp;
  import java.util.ArrayList;
  import java.util.Collection;
  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>RulePmfm</code>.
   * </p>
   *
   * @see RulePmfm
   */
  public abstract class RulePmfmDaoBase
      extends HibernateDaoSupport    
      implements RulePmfmDao
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public Object get(final int transform, final Integer rulePmfmId)
      {
          if (rulePmfmId == null)
          {
              throw new IllegalArgumentException(
                  "RulePmfm.get - 'rulePmfmId' can not be null");
          }
          final RulePmfm entity = get(RulePmfmImpl.class, rulePmfmId);
          return transformEntity(transform, entity);
      }
      /**
       * {@inheritDoc}
       */
      @Override
      public RulePmfm get(Integer rulePmfmId)
      {
          return (RulePmfm)this.get(TRANSFORM_NONE, rulePmfmId);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Object load(final int transform, final Integer rulePmfmId)
      {
          if (rulePmfmId == null)
          {
              throw new IllegalArgumentException(
                  "RulePmfm.load - 'rulePmfmId' can not be null");
          }
          final RulePmfm entity = get(RulePmfmImpl.class, rulePmfmId);
          return transformEntity(transform, entity);
      }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public RulePmfm load(Integer rulePmfmId)
     {
         return (RulePmfm)this.load(TRANSFORM_NONE, rulePmfmId);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<RulePmfm> loadAll()
     {
         return (Collection<RulePmfm>) this.loadAll(RulePmfmDao.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(RulePmfmDao.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(RulePmfmImpl.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 RulePmfm create(RulePmfm rulePmfm)
     {
         return (RulePmfm)this.create(RulePmfmDao.TRANSFORM_NONE, rulePmfm);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(final int transform, final RulePmfm rulePmfm)
     {
         if (rulePmfm == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.create - 'rulePmfm' can not be null");
         }
         this.getSessionFactory().getCurrentSession().save(rulePmfm);
         return this.transformEntity(transform, rulePmfm);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<RulePmfm> create(final Collection<RulePmfm> entities)
     {
         return (Collection<RulePmfm>) create(RulePmfmDao.TRANSFORM_NONE, entities);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> create(final int transform, final Collection<RulePmfm> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.create - 'entities' can not be null");
         }
                     for (RulePmfm entity : entities)
                     {
                         create(transform, entity);
                     }
         return entities;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public RulePmfm create(
         Timestamp updateDt)
     {
         return (RulePmfm)this.create(RulePmfmDao.TRANSFORM_NONE, updateDt);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         Timestamp updateDt)
     {
         RulePmfm entity = new RulePmfmImpl();
         entity.setUpdateDt(updateDt);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public RulePmfm create(
         Parameter parameter,
         Rule rule)
     {
         return (RulePmfm)this.create(RulePmfmDao.TRANSFORM_NONE, parameter, rule);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         Parameter parameter,
         Rule rule)
     {
         RulePmfm entity = new RulePmfmImpl();
         entity.setParameter(parameter);
         entity.setRule(rule);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(RulePmfm rulePmfm)
     {
         if (rulePmfm == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.update - 'rulePmfm' can not be null");
         }
         this.getSessionFactory().getCurrentSession().update(rulePmfm);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(final Collection<RulePmfm> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.update - 'entities' can not be null");
         }
                     for (RulePmfm entity : entities)
                     {
                         update(entity);
                     }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(RulePmfm rulePmfm)
     {
         if (rulePmfm == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.remove - 'rulePmfm' can not be null");
         }
         this.getSessionFactory().getCurrentSession().delete(rulePmfm);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Integer rulePmfmId)
     {
         if (rulePmfmId == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.remove - 'rulePmfmId' can not be null");
         }
         RulePmfm entity = this.get(rulePmfmId);
         if (entity != null)
         {
             this.remove(entity);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Collection<RulePmfm> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "RulePmfm.remove - 'entities' can not be null");
         }
         deleteAll(entities);
     }
     /**
      * {@inheritDoc}
      */
     @Override
     public RulePmfmVO save(final RulePmfmVO rulePmfm, final Timestamp updateDt)
     {
         if (rulePmfm == null)
         {
             throw new IllegalArgumentException(
                 "fr.ifremer.quadrige3.core.dao.system.rule.RulePmfmDao.save(RulePmfmVO rulePmfm, Timestamp updateDt) - 'rulePmfm' can not be null");
         }
         try
         {
             return this.handleSave(rulePmfm, updateDt);
         }
         catch (Throwable th)
         {
             throw new RuntimeException(
             "Error performing 'RulePmfmDao.save(RulePmfmVO rulePmfm, Timestamp updateDt)' --> " + th,
             th);
         }
     }
 
     /**
      * Performs the core logic for {@link #save(RulePmfmVO, Timestamp)}
      * @param rulePmfm
      * @param updateDt
      * @return RulePmfmVO
      * @throws Exception
      */
     protected abstract RulePmfmVO handleSave(RulePmfmVO rulePmfm, Timestamp updateDt)
         throws Exception;
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void removeByIds(final Collection<Integer> rulePmfmIds)
     {
         if (rulePmfmIds == null)
         {
             throw new IllegalArgumentException(
                 "fr.ifremer.quadrige3.core.dao.system.rule.RulePmfmDao.removeByIds(Collection<Integer> rulePmfmIds) - 'rulePmfmIds' can not be null");
         }
         try
         {
             this.handleRemoveByIds(rulePmfmIds);
         }
         catch (Throwable th)
         {
             throw new RuntimeException(
             "Error performing 'RulePmfmDao.removeByIds(Collection<Integer> rulePmfmIds)' --> " + th,
             th);
         }
     }
 
     /**
      * Performs the core logic for {@link #removeByIds(Collection<Integer>)}
      * @param rulePmfmIds
      * @return void
      * @throws Exception
      */
     protected abstract void handleRemoveByIds(Collection<Integer> rulePmfmIds)
         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>RulePmfmDao</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 RulePmfm} - {@link #TRANSFORM_NONE}</li>
      *   <li>{@link RulePmfmVO} - {@link #TRANSFORM_RULEPMFMVO}</li>
      * </ul>
      *
      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
      *
      * @param transform one of the constants declared in {@link RulePmfmDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see RulePmfmDao#transformEntity(int, RulePmfm)
      */
     public Object transformEntity(final int transform, final RulePmfm entity)
     {
         Object target = null;
         if (entity != null)
         {
             switch (transform)
             {
                 case TRANSFORM_RULEPMFMVO :
                     target = toRulePmfmVO(entity);
                     break;
                 case RulePmfmDao.TRANSFORM_NONE : // fall-through
                 default:
                     target = entity;
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void transformEntities(final int transform, final Collection<?> entities)
     {
         switch (transform)
         {
             case TRANSFORM_RULEPMFMVO :
                 toRulePmfmVOCollection(entities);
                 break;
             case RulePmfmDao.TRANSFORM_NONE : // fall-through
                 default:
                 // do nothing;
         }
     }
 
     /**
      * @see RulePmfmDao#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 RulePmfm}
      * 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 RulePmfm)
                 {
                     result = input;
                 }
                 return result;
             }
         };
 
     /**
      * @param row
      * @return RulePmfm
      */
     protected RulePmfm toEntity(Object[] row)
     {
         RulePmfm 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 RulePmfm)
                 {
                     target = (RulePmfm)object;
                     break;
                 }
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public final Collection<RulePmfmVO> toRulePmfmVOCollection(Collection<?> entities)
     {
         Collection<RulePmfmVO> result = new ArrayList<RulePmfmVO>();
         if (entities != null)
         {
             CollectionUtils.transform(entities, this.RULEPMFMVO_TRANSFORMER);
             result.addAll((Collection<? extends RulePmfmVO>) entities);
         }
         return result;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({ "unchecked" })
     public final RulePmfmVO[] toRulePmfmVOArray(Collection<?> entities)
     {
         RulePmfmVO[] result = null;
         if (entities != null)
         {
             // Unchecked transformation: reuses entities Collection
             final Collection collection = new ArrayList(entities);
             this.toRulePmfmVOCollection(collection);
             result = (RulePmfmVO[]) collection.toArray(new RulePmfmVO[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 RulePmfmDaoImpl} class if you intend to use reporting queries.
      * @param row
      * @return toRulePmfmVO(this.toEntity(row))
      * @see RulePmfmDao#toRulePmfmVO(RulePmfm)
      */
     protected RulePmfmVO toRulePmfmVO(Object[] row)
     {
         return this.toRulePmfmVO(this.toEntity(row));
     }
 
     /**
      * This anonymous transformer is designed to transform entities or report query results
      * (which result in an array of objects) to {@link RulePmfmVO}
      * using the Jakarta Commons-Collections Transformation API.
      */
     private Transformer RULEPMFMVO_TRANSFORMER =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 Object result = null;
                 if (input instanceof RulePmfm)
                 {
                     result = toRulePmfmVO((RulePmfm)input);
                 }
                 else if (input instanceof Object[])
                 {
                     result = toRulePmfmVO((Object[])input);
                 }
                 return result;
             }
         };
 
     /**
      * {@inheritDoc}
      */
     @Override
     public final void rulePmfmVOToEntityCollection(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 RulePmfmVO))
                 {
                     iterator.remove();
                 }
             }
             CollectionUtils.transform(instances, this.RulePmfmVOToEntityTransformer);
         }
     }
 
     private final Transformer RulePmfmVOToEntityTransformer =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 return rulePmfmVOToEntity((RulePmfmVO)input);
             }
         };
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void toRulePmfmVO(
         RulePmfm source,
         RulePmfmVO target)
     {
         target.setRulePmfmId(source.getRulePmfmId());
         target.setUpdateDt(source.getUpdateDt());
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public RulePmfmVO toRulePmfmVO(final RulePmfm entity)
     {
         RulePmfmVO target = null;
         if (entity != null)
         {
             target =  new RulePmfmVO();
             this.toRulePmfmVO(entity, target);
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void rulePmfmVOToEntity(
         RulePmfmVO source,
         RulePmfm target,
         boolean copyIfNull)
     {
         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(), RulePmfmImpl.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(RulePmfmDao.TRANSFORM_NONE, pageNumber, pageSize, search);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Set<?> search(final int transform, final Search search)
     {
         try
         {
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), RulePmfmImpl.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<RulePmfm> search(final Search search)
     {
         return (Set<RulePmfm>) this.search(RulePmfmDao.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
 }