// 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.referential;

/*
 * #%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.technical.hibernate.HibernateDaoSupport;
import java.security.Principal;
import java.sql.Timestamp;
import java.util.Collection;
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>AnalysisInstrument</code>.
 * </p>
 *
 * @see AnalysisInstrument
 */
public abstract class AnalysisInstrumentDaoBase
    extends HibernateDaoSupport    
    implements AnalysisInstrumentDao
{
    /**
     * {@inheritDoc}
     */
    @Override
    public Object get(final int transform, final Integer id)
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "AnalysisInstrument.get - 'id' can not be null");
        }
        final AnalysisInstrument entity = get(AnalysisInstrumentImpl.class, id);
        return transformEntity(transform, entity);
    }
    /**
     * {@inheritDoc}
     */
    @Override
    public AnalysisInstrument get(Integer id)
    {
        return (AnalysisInstrument)this.get(TRANSFORM_NONE, id);
    }

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

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

    /**
     * {@inheritDoc}
     */
    @Override
    @SuppressWarnings({"unchecked"})
    public Collection<AnalysisInstrument> loadAll()
    {
        return (Collection<AnalysisInstrument>) this.loadAll(AnalysisInstrumentDao.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(AnalysisInstrumentDao.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(AnalysisInstrumentImpl.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 AnalysisInstrument create(AnalysisInstrument analysisInstrument)
    {
        return (AnalysisInstrument)this.create(AnalysisInstrumentDao.TRANSFORM_NONE, analysisInstrument);
    }

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

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

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

    /**
     * {@inheritDoc}
     */
    @Override
    public AnalysisInstrument create(
        String name,
        String description,
        Timestamp updateDate,
        String comments)
    {
        return (AnalysisInstrument)this.create(AnalysisInstrumentDao.TRANSFORM_NONE, name, description, updateDate, comments);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object create(
        final int transform,
        String name,
        String description,
        Timestamp updateDate,
        String comments)
    {
        AnalysisInstrument entity = new AnalysisInstrumentImpl();
        entity.setName(name);
        entity.setDescription(description);
        entity.setUpdateDate(updateDate);
        entity.setComments(comments);
        return this.create(transform, entity);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public AnalysisInstrument create(
        String name,
        Status status,
        Timestamp updateDate)
    {
        return (AnalysisInstrument)this.create(AnalysisInstrumentDao.TRANSFORM_NONE, name, status, updateDate);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object create(
        final int transform,
        String name,
        Status status,
        Timestamp updateDate)
    {
        AnalysisInstrument entity = new AnalysisInstrumentImpl();
        entity.setName(name);
        entity.setStatus(status);
        entity.setUpdateDate(updateDate);
        return this.create(transform, entity);
    }

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

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

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

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

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

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

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

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

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