// license-header java merge-point
//
// Attention: Generated code! Do not modify by hand!
// Generated by: SessionDaoBase.vsl in andromda-ejb3-cartridge.
//
package org.andromda.howto2.rental;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import javax.annotation.Resource;
import javax.ejb.Local;
import javax.ejb.SessionContext;
import javax.ejb.TransactionAttribute;
import javax.ejb.TransactionAttributeType;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import javax.persistence.Query;

/**
 * <p>
 * Base EJB3 DAO Class: is able to create, update, remove, load, and find
 * objects of type <code>Car</code>.
 * </p>
 *
 * @see CarDao
 */
@TransactionAttribute(TransactionAttributeType.REQUIRED)
@Local({CarDao.class})
public abstract class CarDaoBase
    implements CarDao
{
    // ------ Session Context Injection ------

    @Resource
    protected SessionContext context;

    // ------ Persistence Context Injection --------

    /**
     * Inject persistence context howtomodelcaching
     */
    @PersistenceContext(unitName = "howtomodelcaching")
    protected EntityManager emanager;

    /**
     * @see CarDao#load(int,)
     */
    public Object load(final int transform, final Long id)
        throws CarDaoException
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "Car.load - 'id' can not be null");
        }
        try
        {
            final Object entity = (Car)emanager.find(Car.class, id);
            return transformEntity(transform, (Car)entity);
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#load()
     */
    public Car load( final Long id)
        throws CarDaoException
    {
        return (Car)this.load(TRANSFORM_NONE, id);
    }

    /**
     * @see CarDao#loadAll()
     */
    @SuppressWarnings({"unchecked"})
    public Collection<Car> loadAll()
        throws CarDaoException
    {
        return (Collection<Car>)this.loadAll(TRANSFORM_NONE);
    }

    /**
     * @see CarDao#loadAll(int)
     */
    public Collection loadAll(final int transform)
        throws CarDaoException
    {
        try
        {
            Query query = emanager.createNamedQuery("Car.findAll");
            List<Car> results = query.getResultList();
            this.transformEntities(transform, results);
            return results;
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#create(Car)
     */
    public Car create(Car car)
        throws CarDaoException
    {
        return (Car)this.create(TRANSFORM_NONE, car);
    }

    /**
     * @see CarDao#create(int transform, Car)
     */
    public Object create(final int transform, final Car car)
        throws CarDaoException
    {
        if (car == null)
        {
            throw new IllegalArgumentException(
                "Car.create - 'car' can not be null");
        }

        try
        {
            emanager.persist(car);
            emanager.flush();
            return this.transformEntity(transform, car);
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#create(Collection<Car>)
     */
    @SuppressWarnings({"unchecked"})
    public Collection<Car> create(final Collection<Car> entities)
        throws CarDaoException
    {
        return create(TRANSFORM_NONE, entities);
    }

    /**
     * @see CarDao#create(int, Collection<Car>)
     */
    @SuppressWarnings({"unchecked"})
    public Collection create(final int transform, final Collection<Car> entities)
        throws CarDaoException
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "Car.create - 'entities' can not be null");
        }
        Collection results = new ArrayList();
        try
        {
            for (final Iterator entityIterator = entities.iterator(); entityIterator.hasNext();)
            {
                results.add(create(transform, (Car)entityIterator.next()));
            }
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
        return results;
    }

    /**
     * @see CarDao#create(String, String, CarType)
     */
    public Car create(
        String serial,
        String name,
        CarType type)
        throws CarDaoException
    {
        return (Car)this.create(TRANSFORM_NONE, serial, name, type);
    }

    /**
     * @see CarDao#create(int, String, String, CarType)
     */
    public Object create(
        final int transform,
        String serial,
        String name,
        CarType type)
        throws CarDaoException
    {
        Car entity = new Car();
        entity.setSerial(serial);
        entity.setName(name);
        entity.setType(type);
        return this.create(transform, entity);
    }

    /**
     * @see CarDao#create(String, Person, String, CarType)
     */
    public Car create(
        String name,
        Person owner,
        String serial,
        CarType type)
        throws CarDaoException
    {
        return (Car)this.create(TRANSFORM_NONE, name, owner, serial, type);
    }

    /**
     * @see CarDao#create(int, String, Person, String, CarType)
     */
    public Object create(
        final int transform,
        String name,
        Person owner,
        String serial,
        CarType type)
        throws CarDaoException
    {
        Car entity = new Car();
        entity.setName(name);
        entity.setOwner(owner);
        entity.setSerial(serial);
        entity.setType(type);
        return this.create(transform, entity);
    }

    /**
     * @see CarDao#update(Car)
     */
    public void update(Car car)
        throws CarDaoException
    {
        if (car == null)
        {
            throw new IllegalArgumentException(
                "Car.update - 'car' can not be null");
        }
        try
        {
            emanager.merge(car);
            emanager.flush();
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#update(Collection<Car>)
     */
    public void update(final Collection<Car> entities)
        throws CarDaoException
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "Car.update - 'entities' can not be null");
        }
        try
        {
            for (final Iterator entityIterator = entities.iterator(); entityIterator.hasNext();)
            {
                update((Car)entityIterator.next());
            }
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#remove(Car)
     */
    public void remove(Car car)
        throws CarDaoException
    {
        if (car == null)
        {
            throw new IllegalArgumentException(
                "Car.remove - 'car' can not be null");
        }
        try
        {
            emanager.remove(car);
            emanager.flush();
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#remove(Long)
     */
    public void remove(Long id)
        throws CarDaoException
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "Car.remove - 'id' can not be null");
        }
        try
        {
            final Car entity = this.load(id);
            if (entity != null)
            {
                this.remove(entity);
            }
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#remove(Collection<Car>)
     */
    public void remove(Collection<Car> entities)
        throws CarDaoException
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "Car.remove - 'entities' can not be null");
        }
        try
        {
            for (final Iterator entityIterator = entities.iterator(); entityIterator.hasNext();)
            {
                remove((Car)entityIterator.next());
            }
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#findByType(CarType)
     */
    public List findByType(CarType type)
        throws CarDaoException
    {
        return this.findByType(TRANSFORM_NONE, type);
    }

    /**
     * @see CarDao#findByType(String, CarType)
     */
    public List findByType(final String queryString, final CarType type)
        throws CarDaoException
    {
        return this.findByType(TRANSFORM_NONE, queryString, type);
    }

    /**
     * @see CarDao#findByType(int, CarType)
     */
    public List findByType(final int transform, final CarType type)
        throws CarDaoException
    {
        try
        {
            Query queryObject = emanager.createNamedQuery("Car.findByType");
            queryObject.setParameter("type", type.name());
            queryObject.setHint("org.hibernate.cacheRegion", "/Car_findByType");
            List results = queryObject.getResultList();
            transformEntities(transform, results);
            return results;
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#findByType(int, String, CarType)
     */
    public List findByType(final int transform, final String queryString, final CarType type)
        throws CarDaoException
    {
        try
        {
            Query queryObject = emanager.createQuery(queryString);
            queryObject.setParameter("type", type.name());
            queryObject.setHint("org.hibernate.cacheRegion", "/Car_findByType");
            List results = queryObject.getResultList();
            transformEntities(transform, results);
            return results;
        }
        catch (Exception ex)
        {
            throw new CarDaoException(ex);
        }
    }

    /**
     * @see CarDao#allCarsAreRented()
     */
    public boolean allCarsAreRented()
    {
        try
        {
            return this.handleAllCarsAreRented();
        }
        catch (Throwable th)
        {
            throw new RuntimeException(
            "Error performing 'CarDao.allCarsAreRented()' --> " + th,
            th);
        }
    }

     /**
      * Performs the core logic for {@link #allCarsAreRented()}
      */
    protected abstract boolean handleAllCarsAreRented()
        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>CarDao</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 CarDao}
     * @param entity an entity that was found
     * @return the transformed entity (i.e. new value object, etc)
     * @see #transformEntities(int,Collection)
     */
    protected Object transformEntity(final int transform, final Car entity)
    {
        Object target = null;
        if (entity != null)
        {
            switch (transform)
            {
                case TRANSFORM_NONE : // fall-through
                default:
                    target = entity;
            }
        }
        return target;
    }

    /**
     * Transforms a collection of entities using the
     * {@link #transformEntity(int,Car)}
     * method. This method does not instantiate a new collection.
     * <p/>
     * This method is to be used internally only.
     *
     * @param transform one of the constants declared in <code>CarDao</code>
     * @param entities the collection of entities to transform
     * @return the same collection as the argument, but this time containing the transformed entities
     * @see #transformEntity(int,Car)
     */
    protected void transformEntities(final int transform, final Collection entities)
    {
        switch (transform)
        {
            case TRANSFORM_NONE : // fall-through
                default:
                // do nothing;
        }
    }
}