// 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.technical.hibernate.HibernateDaoSupport;
  import fr.ifremer.quadrige3.core.vo.system.rule.RuleVO;
  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>Rule</code>.
   * </p>
   *
   * @see Rule
   */
  public abstract class RuleDaoBase
      extends HibernateDaoSupport    
      implements RuleDao
  {
      /**
       * {@inheritDoc}
       */
      @Override
      public Object get(final int transform, final String ruleCd)
      {
          if (ruleCd == null)
          {
              throw new IllegalArgumentException(
                  "Rule.get - 'ruleCd' can not be null");
          }
          final Rule entity = get(RuleImpl.class, ruleCd);
          return transformEntity(transform, entity);
      }
      /**
       * {@inheritDoc}
       */
      @Override
      public Rule get(String ruleCd)
      {
          return (Rule)this.get(TRANSFORM_NONE, ruleCd);
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Object load(final int transform, final String ruleCd)
      {
          if (ruleCd == null)
          {
              throw new IllegalArgumentException(
                  "Rule.load - 'ruleCd' can not be null");
          }
          final Rule entity = get(RuleImpl.class, ruleCd);
          return transformEntity(transform, entity);
      }
  
     /**
      * {@inheritDoc}
      */
     @Override
     public Rule load(String ruleCd)
     {
         return (Rule)this.load(TRANSFORM_NONE, ruleCd);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<Rule> loadAll()
     {
         return (Collection<Rule>) this.loadAll(RuleDao.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(RuleDao.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(RuleImpl.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 Rule create(Rule rule)
     {
         return (Rule)this.create(RuleDao.TRANSFORM_NONE, rule);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(final int transform, final Rule rule)
     {
         if (rule == null)
         {
             throw new IllegalArgumentException(
                 "Rule.create - 'rule' can not be null");
         }
         this.getSessionFactory().getCurrentSession().save(rule);
         return this.transformEntity(transform, rule);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public Collection<Rule> create(final Collection<Rule> entities)
     {
         return (Collection<Rule>) create(RuleDao.TRANSFORM_NONE, entities);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Collection<?> create(final int transform, final Collection<Rule> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Rule.create - 'entities' can not be null");
         }
                     for (Rule entity : entities)
                     {
                         create(transform, entity);
                     }
         return entities;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Rule create(
         String ruleControledAttribut,
         String ruleDc,
         String ruleIsActive,
         String ruleIsBlocking,
         String ruleErrorMsg,
         Timestamp updateDt)
     {
         return (Rule)this.create(RuleDao.TRANSFORM_NONE, ruleControledAttribut, ruleDc, ruleIsActive, ruleIsBlocking, ruleErrorMsg, updateDt);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         String ruleControledAttribut,
         String ruleDc,
         String ruleIsActive,
         String ruleIsBlocking,
         String ruleErrorMsg,
         Timestamp updateDt)
     {
         Rule entity = new RuleImpl();
         entity.setRuleControledAttribut(ruleControledAttribut);
         entity.setRuleDc(ruleDc);
         entity.setRuleIsActive(ruleIsActive);
         entity.setRuleIsBlocking(ruleIsBlocking);
         entity.setRuleErrorMsg(ruleErrorMsg);
         entity.setUpdateDt(updateDt);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Rule create(
         String ruleControledAttribut,
         Function function)
     {
         return (Rule)this.create(RuleDao.TRANSFORM_NONE, ruleControledAttribut, function);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Object create(
         final int transform,
         String ruleControledAttribut,
         Function function)
     {
         Rule entity = new RuleImpl();
         entity.setRuleControledAttribut(ruleControledAttribut);
         entity.setFunction(function);
         return this.create(transform, entity);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(Rule rule)
     {
         if (rule == null)
         {
             throw new IllegalArgumentException(
                 "Rule.update - 'rule' can not be null");
         }
         this.getSessionFactory().getCurrentSession().update(rule);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void update(final Collection<Rule> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Rule.update - 'entities' can not be null");
         }
                     for (Rule entity : entities)
                     {
                         update(entity);
                     }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Rule rule)
     {
         if (rule == null)
         {
             throw new IllegalArgumentException(
                 "Rule.remove - 'rule' can not be null");
         }
         this.getSessionFactory().getCurrentSession().delete(rule);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(String ruleCd)
     {
         if (ruleCd == null)
         {
             throw new IllegalArgumentException(
                 "Rule.remove - 'ruleCd' can not be null");
         }
         Rule entity = this.get(ruleCd);
         if (entity != null)
         {
             this.remove(entity);
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void remove(Collection<Rule> entities)
     {
         if (entities == null)
         {
             throw new IllegalArgumentException(
                 "Rule.remove - 'entities' can not be null");
         }
         deleteAll(entities);
     }
     /**
      * {@inheritDoc}
      */
     @Override
     public RuleVO save(final RuleVO rule, final Timestamp updateDt)
     {
         if (rule == null)
         {
             throw new IllegalArgumentException(
                 "fr.ifremer.quadrige3.core.dao.system.rule.RuleDao.save(RuleVO rule, Timestamp updateDt) - 'rule' can not be null");
         }
         try
         {
             return this.handleSave(rule, updateDt);
         }
         catch (Throwable th)
         {
             throw new RuntimeException(
             "Error performing 'RuleDao.save(RuleVO rule, Timestamp updateDt)' --> " + th,
             th);
         }
     }
 
     /**
      * Performs the core logic for {@link #save(RuleVO, Timestamp)}
      * @param rule
      * @param updateDt
      * @return RuleVO
      * @throws Exception
      */
     protected abstract RuleVO handleSave(RuleVO rule, Timestamp updateDt)
         throws Exception;
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void removeByCds(final String[] ruleCds)
     {
         if (ruleCds == null)
         {
             throw new IllegalArgumentException(
                 "fr.ifremer.quadrige3.core.dao.system.rule.RuleDao.removeByCds(String[] ruleCds) - 'ruleCds' can not be null");
         }
         try
         {
             this.handleRemoveByCds(ruleCds);
         }
         catch (Throwable th)
         {
             throw new RuntimeException(
             "Error performing 'RuleDao.removeByCds(String[] ruleCds)' --> " + th,
             th);
         }
     }
 
     /**
      * Performs the core logic for {@link #removeByCds(String[])}
      * @param ruleCds
      * @return void
      * @throws Exception
      */
     protected abstract void handleRemoveByCds(String[] ruleCds)
         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>RuleDao</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 Rule} - {@link #TRANSFORM_NONE}</li>
      *   <li>{@link RuleVO} - {@link #TRANSFORM_RULEVO}</li>
      * </ul>
      *
      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
      *
      * @param transform one of the constants declared in {@link RuleDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see RuleDao#transformEntity(int, Rule)
      */
     public Object transformEntity(final int transform, final Rule entity)
     {
         Object target = null;
         if (entity != null)
         {
             switch (transform)
             {
                 case TRANSFORM_RULEVO :
                     target = toRuleVO(entity);
                     break;
                 case RuleDao.TRANSFORM_NONE : // fall-through
                 default:
                     target = entity;
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void transformEntities(final int transform, final Collection<?> entities)
     {
         switch (transform)
         {
             case TRANSFORM_RULEVO :
                 toRuleVOCollection(entities);
                 break;
             case RuleDao.TRANSFORM_NONE : // fall-through
                 default:
                 // do nothing;
         }
     }
 
     /**
      * @see RuleDao#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 Rule}
      * 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 Rule)
                 {
                     result = input;
                 }
                 return result;
             }
         };
 
     /**
      * @param row
      * @return Rule
      */
     protected Rule toEntity(Object[] row)
     {
         Rule 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 Rule)
                 {
                     target = (Rule)object;
                     break;
                 }
             }
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({"unchecked"})
     public final Collection<RuleVO> toRuleVOCollection(Collection<?> entities)
     {
         Collection<RuleVO> result = new ArrayList<RuleVO>();
         if (entities != null)
         {
             CollectionUtils.transform(entities, this.RULEVO_TRANSFORMER);
             result.addAll((Collection<? extends RuleVO>) entities);
         }
         return result;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     @SuppressWarnings({ "unchecked" })
     public final RuleVO[] toRuleVOArray(Collection<?> entities)
     {
         RuleVO[] result = null;
         if (entities != null)
         {
             // Unchecked transformation: reuses entities Collection
             final Collection collection = new ArrayList(entities);
             this.toRuleVOCollection(collection);
             result = (RuleVO[]) collection.toArray(new RuleVO[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 RuleDaoImpl} class if you intend to use reporting queries.
      * @param row
      * @return toRuleVO(this.toEntity(row))
      * @see RuleDao#toRuleVO(Rule)
      */
     protected RuleVO toRuleVO(Object[] row)
     {
         return this.toRuleVO(this.toEntity(row));
     }
 
     /**
      * This anonymous transformer is designed to transform entities or report query results
      * (which result in an array of objects) to {@link RuleVO}
      * using the Jakarta Commons-Collections Transformation API.
      */
     private Transformer RULEVO_TRANSFORMER =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 Object result = null;
                 if (input instanceof Rule)
                 {
                     result = toRuleVO((Rule)input);
                 }
                 else if (input instanceof Object[])
                 {
                     result = toRuleVO((Object[])input);
                 }
                 return result;
             }
         };
 
     /**
      * {@inheritDoc}
      */
     @Override
     public final void ruleVOToEntityCollection(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 RuleVO))
                 {
                     iterator.remove();
                 }
             }
             CollectionUtils.transform(instances, this.RuleVOToEntityTransformer);
         }
     }
 
     private final Transformer RuleVOToEntityTransformer =
         new Transformer()
         {
             public Object transform(Object input)
             {
                 return ruleVOToEntity((RuleVO)input);
             }
         };
 
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void toRuleVO(
         Rule source,
         RuleVO target)
     {
         target.setRuleCd(source.getRuleCd());
         target.setRuleControledAttribut(source.getRuleControledAttribut());
         target.setRuleDc(source.getRuleDc());
         target.setRuleIsActive(source.getRuleIsActive());
         target.setRuleIsBlocking(source.getRuleIsBlocking());
         target.setRuleErrorMsg(source.getRuleErrorMsg());
         target.setUpdateDt(source.getUpdateDt());
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public RuleVO toRuleVO(final Rule entity)
     {
         RuleVO target = null;
         if (entity != null)
         {
             target =  new RuleVO();
             this.toRuleVO(entity, target);
         }
         return target;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void ruleVOToEntity(
         RuleVO source,
         Rule target,
         boolean copyIfNull)
     {
         if (copyIfNull || source.getRuleControledAttribut() != null)
         {
             target.setRuleControledAttribut(source.getRuleControledAttribut());
         }
         if (copyIfNull || source.getRuleDc() != null)
         {
             target.setRuleDc(source.getRuleDc());
         }
         if (copyIfNull || source.getRuleIsActive() != null)
         {
             target.setRuleIsActive(source.getRuleIsActive());
         }
         if (copyIfNull || source.getRuleIsBlocking() != null)
         {
             target.setRuleIsBlocking(source.getRuleIsBlocking());
         }
         if (copyIfNull || source.getRuleErrorMsg() != null)
         {
             target.setRuleErrorMsg(source.getRuleErrorMsg());
         }
         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(), RuleImpl.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(RuleDao.TRANSFORM_NONE, pageNumber, pageSize, search);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Set<?> search(final int transform, final Search search)
     {
         try
         {
             final PropertySearch propertySearch = new PropertySearch(
                 this.getSession(), RuleImpl.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<Rule> search(final Search search)
     {
         return (Set<Rule>) this.search(RuleDao.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
 }