// 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.adagio.core.dao.data.batch;

/*
 * #%L
 * SIH-Adagio :: Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2012 - 2014 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.adagio.core.dao.PrincipalStore;
import fr.ifremer.adagio.core.dao.PropertySearch;
import fr.ifremer.adagio.core.dao.Search;
import fr.ifremer.adagio.core.dao.referential.QualityFlag;
import fr.ifremer.adagio.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>CatchBatch</code>.
 * </p>
 *
 * @see CatchBatch
 */
public abstract class CatchBatchDaoBase
    extends HibernateDaoSupport    
    implements CatchBatchDao
{
    /**
     * {@inheritDoc}
     */
    @Override
    public Object get(final int transform, final Integer id)
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.get - 'id' can not be null");
        }
        final CatchBatch entity = get(CatchBatchImpl.class, id);
        return transformEntity(transform, entity);
    }
    /**
     * {@inheritDoc}
     */
    @Override
    public CatchBatch get(Integer id)
    {
        return (CatchBatch)this.get(TRANSFORM_NONE, id);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object load(final int transform, final Integer id)
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.load - 'id' can not be null");
        }
        final CatchBatch entity = get(CatchBatchImpl.class, id);
        return transformEntity(transform, entity);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public CatchBatch load(Integer id)
    {
        return (CatchBatch)this.load(TRANSFORM_NONE, id);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    @SuppressWarnings({"unchecked"})
    public Collection<CatchBatch> loadAll()
    {
        return (Collection<CatchBatch>) this.loadAll(CatchBatchDao.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(CatchBatchDao.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(CatchBatchImpl.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 CatchBatch create(CatchBatch catchBatch)
    {
        return (CatchBatch)this.create(CatchBatchDao.TRANSFORM_NONE, catchBatch);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object create(final int transform, final CatchBatch catchBatch)
    {
        if (catchBatch == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.create - 'catchBatch' can not be null");
        }
        this.getSessionFactory().getCurrentSession().save(catchBatch);
        return this.transformEntity(transform, catchBatch);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    @SuppressWarnings({"unchecked"})
    public Collection<CatchBatch> create(final Collection<CatchBatch> entities)
    {
        return (Collection<CatchBatch>) create(CatchBatchDao.TRANSFORM_NONE, entities);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Collection<?> create(final int transform, final Collection<CatchBatch> entities)
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.create - 'entities' can not be null");
        }
                    for (CatchBatch entity : entities)
                    {
                        create(transform, entity);
                    }
        return entities;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public CatchBatch create(
        
        Date controlDate,
        Date validationDate,
        Date qualificationDate,
        String qualificationComments,
        Timestamp updateDate,
        Short rankOrder,
        String label,
        Float subgroupCount,
        Integer individualCount,
        Boolean childBatchsReplication,
        Boolean exhaustiveInventory,
        String comments)
    {
        return (CatchBatch)this.create(CatchBatchDao.TRANSFORM_NONE, controlDate, validationDate, qualificationDate, qualificationComments, updateDate, rankOrder, label, subgroupCount, individualCount, childBatchsReplication, exhaustiveInventory, comments);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object create(
        final int transform,
        
        Date controlDate,
        Date validationDate,
        Date qualificationDate,
        String qualificationComments,
        Timestamp updateDate,
        Short rankOrder,
        String label,
        Float subgroupCount,
        Integer individualCount,
        Boolean childBatchsReplication,
        Boolean exhaustiveInventory,
        String comments)
    {
        CatchBatch entity = new CatchBatchImpl();
        
        entity.setControlDate(controlDate);
        entity.setValidationDate(validationDate);
        entity.setQualificationDate(qualificationDate);
        entity.setQualificationComments(qualificationComments);
        entity.setUpdateDate(updateDate);
        entity.setRankOrder(rankOrder);
        entity.setLabel(label);
        entity.setSubgroupCount(subgroupCount);
        entity.setIndividualCount(individualCount);
        entity.setChildBatchsReplication(childBatchsReplication);
        entity.setExhaustiveInventory(exhaustiveInventory);
        entity.setComments(comments);
        return this.create(transform, entity);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public CatchBatch create(
        Boolean childBatchsReplication,
        Boolean exhaustiveInventory,
        QualityFlag qualityFlag,
        Short rankOrder,
        
        Timestamp updateDate)
    {
        return (CatchBatch)this.create(CatchBatchDao.TRANSFORM_NONE, childBatchsReplication, exhaustiveInventory, qualityFlag, rankOrder, updateDate);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object create(
        final int transform,
        Boolean childBatchsReplication,
        Boolean exhaustiveInventory,
        QualityFlag qualityFlag,
        Short rankOrder,
        
        Timestamp updateDate)
    {
        CatchBatch entity = new CatchBatchImpl();
        entity.setChildBatchsReplication(childBatchsReplication);
        entity.setExhaustiveInventory(exhaustiveInventory);
        entity.setQualityFlag(qualityFlag);
        entity.setRankOrder(rankOrder);
        
        entity.setUpdateDate(updateDate);
        return this.create(transform, entity);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void update(CatchBatch catchBatch)
    {
        if (catchBatch == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.update - 'catchBatch' can not be null");
        }
        this.getSessionFactory().getCurrentSession().update(catchBatch);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void update(final Collection<CatchBatch> entities)
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.update - 'entities' can not be null");
        }
                    for (CatchBatch entity : entities)
                    {
                        update(entity);
                    }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void remove(CatchBatch catchBatch)
    {
        if (catchBatch == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.remove - 'catchBatch' can not be null");
        }
        this.getSessionFactory().getCurrentSession().delete(catchBatch);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void remove(Integer id)
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.remove - 'id' can not be null");
        }
        CatchBatch entity = this.get(id);
        if (entity != null)
        {
            this.remove(entity);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void remove(Collection<CatchBatch> entities)
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "CatchBatch.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>CatchBatchDao</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 CatchBatchDao}
     * @param entity an entity that was found
     * @return the transformed entity (i.e. new value object, etc)
     * @see CatchBatchDao#transformEntity(int, CatchBatch)
     */
    public Object transformEntity(final int transform, final CatchBatch entity)
    {
        Object target = null;
        if (entity != null)
        {
            switch (transform)
            {
                case CatchBatchDao.TRANSFORM_NONE : // fall-through
                default:
                    target = entity;
            }
        }
        return target;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void transformEntities(final int transform, final Collection<?> entities)
    {
        switch (transform)
        {
            case CatchBatchDao.TRANSFORM_NONE : // fall-through
                default:
                // do nothing;
        }
    }

    /**
     * @see CatchBatchDao#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 CatchBatch}
     * 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 CatchBatch)
                {
                    result = input;
                }
                return result;
            }
        };

    /**
     * @param row
     * @return CatchBatch
     */
    protected CatchBatch toEntity(Object[] row)
    {
        CatchBatch 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 CatchBatch)
                {
                    target = (CatchBatch)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(), CatchBatchImpl.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(CatchBatchDao.TRANSFORM_NONE, pageNumber, pageSize, search);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Set<?> search(final int transform, final Search search)
    {
        try
        {
            final PropertySearch propertySearch = new PropertySearch(
                this.getSession(), CatchBatchImpl.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<CatchBatch> search(final Search search)
    {
        return (Set<CatchBatch>) this.search(CatchBatchDao.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
}