/**
 * Example license header for Java files
 *
 *      http://www.andromda.org/
 */
//
// Attention: Generated code! Do not modify by hand!
// Generated by: SpringHibernateDaoBase.vsl in andromda-spring-cartridge.
//
package org.andromda.test.6;

/**
 * <p>
 * Base Spring DAO Class: is able to create, update, remove, load, and find
 * objects of type <code>org.andromda.test.6.Car</code>.
 * </p>
 *
 * @see org.andromda.test.6.Car
 */
public abstract class CarDaoBase
    extends org.springframework.orm.hibernate.support.HibernateDaoSupport
    implements org.andromda.test.6.CarDao
{

    /**
     * @see org.andromda.test.6.CarDao#load(int, java.lang.Long)
     */
    public java.lang.Object load(final int transform, final java.lang.Long id)
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "Car.load - 'id' can not be null");
        }
        final java.lang.Object entity = this.getHibernateTemplate().get(org.andromda.test.6.CarImpl.class, id);
        return transformEntity(transform, (org.andromda.test.6.Car)entity);
    }

    /**
     * @see org.andromda.test.6.CarDao#load(java.lang.Long)
     */
    public org.andromda.test.6.Car load(java.lang.Long id)
    {
        return (org.andromda.test.6.Car)this.load(TRANSFORM_NONE, id);
    }

    /**
     * @see org.andromda.test.6.CarDao#loadAll()
     */
    public java.util.Collection loadAll()
    {
        return this.loadAll(TRANSFORM_NONE);
    }

    /**
     * @see org.andromda.test.6.CarDao#loadAll(int)
     */
    public java.util.Collection loadAll(final int transform)
    {
        final java.util.Collection results = this.getHibernateTemplate().loadAll(org.andromda.test.6.CarImpl.class);
        this.transformEntities(transform, results);
        return results;
    }


    /**
     * @see org.andromda.test.6.CarDao#create(org.andromda.test.6.Car)
     */
    public org.andromda.test.6.Car create(org.andromda.test.6.Car car)
    {
        return (org.andromda.test.6.Car)this.create(TRANSFORM_NONE, car);
    }

    /**
     * @see org.andromda.test.6.CarDao#create(int transform, org.andromda.test.6.Car)
     */
    public java.lang.Object create(final int transform, final org.andromda.test.6.Car car)
    {
        if (car == null)
        {
            throw new IllegalArgumentException(
                "Car.create - 'car' can not be null");
        }
        this.getHibernateTemplate().save(car);
        return this.transformEntity(transform, car);
    }

    /**
     * @see org.andromda.test.6.CarDao#create(java.util.Collection)
     */
    public java.util.Collection create(final java.util.Collection entities)
    {
        return create(TRANSFORM_NONE, entities);
    }

    /**
     * @see org.andromda.test.6.CarDao#create(int, java.util.Collection)
     */
    public java.util.Collection create(final int transform, final java.util.Collection entities)
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "Car.create - 'entities' can not be null");
        }
        this.getHibernateTemplate().execute(
            new org.springframework.orm.hibernate.HibernateCallback()
            {
                public java.lang.Object doInHibernate(net.sf.hibernate.Session session)
                    throws net.sf.hibernate.HibernateException
                {
                    for (java.util.Iterator entityIterator = entities.iterator(); entityIterator.hasNext();)
                    {
                        create(transform, (org.andromda.test.6.Car)entityIterator.next());
                    }
                    return null;
                }
            },
            true);
        return entities;
    }

    /**
     * @see org.andromda.test.6.CarDao#create(java.lang.String, java.lang.String, org.andromda.test.6.CarType)
     */
    public org.andromda.test.6.Car create(
        java.lang.String serial,
        java.lang.String name,
        org.andromda.test.6.CarType type)
    {
        return (org.andromda.test.6.Car)this.create(TRANSFORM_NONE, serial, name, type);
    }

    /**
     * @see org.andromda.test.6.CarDao#create(int, java.lang.String, java.lang.String, org.andromda.test.6.CarType)
     */
    public java.lang.Object create(
        final int transform,
        java.lang.String serial,
        java.lang.String name,
        org.andromda.test.6.CarType type)
    {
        org.andromda.test.6.Car entity = new org.andromda.test.6.CarImpl();
        entity.setSerial(serial);
        entity.setName(name);
        entity.setType(type);
        return this.create(transform, entity);
    }

    /**
     * @see org.andromda.test.6.CarDao#create(java.lang.String, org.andromda.test.6.Person, java.lang.String, org.andromda.test.6.CarType)
     */
    public org.andromda.test.6.Car create(
        java.lang.String name,
        org.andromda.test.6.Person owner,
        java.lang.String serial,
        org.andromda.test.6.CarType type)
    {
        return (org.andromda.test.6.Car)this.create(TRANSFORM_NONE, name, owner, serial, type);
    }

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

    /**
     * @see org.andromda.test.6.CarDao#update(org.andromda.test.6.Car)
     */
    public void update(org.andromda.test.6.Car car)
    {
        if (car == null)
        {
            throw new IllegalArgumentException(
                "Car.update - 'car' can not be null");
        }
        this.getHibernateTemplate().update(car);
    }

    /**
     * @see org.andromda.test.6.CarDao#update(java.util.Collection)
     */
    public void update(final java.util.Collection entities)
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "Car.update - 'entities' can not be null");
        }
        this.getHibernateTemplate().execute(
            new org.springframework.orm.hibernate.HibernateCallback()
            {
                public java.lang.Object doInHibernate(net.sf.hibernate.Session session)
                    throws net.sf.hibernate.HibernateException
                {
                    for (java.util.Iterator entityIterator = entities.iterator(); entityIterator.hasNext();)
                    {
                        update((org.andromda.test.6.Car)entityIterator.next());
                    }
                    return null;
                }
            },
            true);
    }

    /**
     * @see org.andromda.test.6.CarDao#remove(org.andromda.test.6.Car)
     */
    public void remove(org.andromda.test.6.Car car)
    {
        if (car == null)
        {
            throw new IllegalArgumentException(
                "Car.remove - 'car' can not be null");
        }
        this.getHibernateTemplate().delete(car);
    }

    /**
     * @see org.andromda.test.6.CarDao#remove(java.lang.Long)
     */
    public void remove(java.lang.Long id)
    {
        if (id == null)
        {
            throw new IllegalArgumentException(
                "Car.remove - 'id' can not be null");
        }
        org.andromda.test.6.Car entity = this.load(id);
        if (entity != null)
        {
            this.remove(entity);
        }
    }

    /**
     * @see org.andromda.test.6.CarDao#remove(java.util.Collection)
     */
    public void remove(java.util.Collection entities)
    {
        if (entities == null)
        {
            throw new IllegalArgumentException(
                "Car.remove - 'entities' can not be null");
        }
        this.getHibernateTemplate().deleteAll(entities);
    }
    /**
     * @see org.andromda.test.6.CarDao#findByType(org.andromda.test.6.CarType)
     */
    public java.util.List findByType(org.andromda.test.6.CarType type)
    {
        return this.findByType(TRANSFORM_NONE, type);
    }

    /**
     * @see org.andromda.test.6.CarDao#findByType(java.lang.String, org.andromda.test.6.CarType)
     */
    public java.util.List findByType(final java.lang.String queryString, final org.andromda.test.6.CarType type)
    {
        return this.findByType(TRANSFORM_NONE, queryString, type);
    }

    /**
     * @see org.andromda.test.6.CarDao#findByType(int, org.andromda.test.6.CarType)
     */
    public java.util.List findByType(final int transform, final org.andromda.test.6.CarType type)
    {
        return this.findByType(transform, "from org.andromda.test.6.Car as car where car.type = :type", type);
    }

    /**
     * @see org.andromda.test.6.CarDao#findByType(int, java.lang.String, org.andromda.test.6.CarType)
     */
    public java.util.List findByType(final int transform, final java.lang.String queryString, final org.andromda.test.6.CarType type)
    {
        try
        {
            net.sf.hibernate.Query queryObject = super.getSession(false).createQuery(queryString);
            queryObject.setParameter("type", type.getValue());
            java.util.List results = queryObject.list();
            transformEntities(transform, results);
            return results;
        }
        catch (net.sf.hibernate.HibernateException ex)
        {
            throw super.convertHibernateAccessException(ex);
        }
    }

    /**
     * @see org.andromda.test.6.CarDao#findByCriteria(org.andromda.test.6.CarSearchCriteria)
     */
    public java.util.List findByCriteria(org.andromda.test.6.CarSearchCriteria criteria)
    {
        return this.findByCriteria(TRANSFORM_NONE, criteria);
    }

    /**
     * @see org.andromda.test.6.CarDao#findByCriteria(int, java.lang.String, org.andromda.test.6.CarSearchCriteria)
     */
    public java.util.List findByCriteria(final int transform, final org.andromda.test.6.CarSearchCriteria criteria)
    {
        try
        {
            org.andromda.spring.CriteriaSearch criteriaSearch = new org.andromda.spring.CriteriaSearch(super.getSession(false), org.andromda.test.6.CarImpl.class);
            criteriaSearch.getConfiguration().setFirstResult(criteria.getFirstResult());
            criteriaSearch.getConfiguration().setFetchSize(criteria.getFetchSize());
            criteriaSearch.getConfiguration().setMaximumResultSize(criteria.getMaximumResultSize());
            org.andromda.spring.CriteriaSearchParameter parameter1 =
                new org.andromda.spring.CriteriaSearchParameter(
                    criteria.getSerial(),
                    "serial");
            criteriaSearch.addParameter(parameter1);
            org.andromda.spring.CriteriaSearchParameter parameter2 =
                new org.andromda.spring.CriteriaSearchParameter(
                    criteria.getName(),
                    "name");
            criteriaSearch.addParameter(parameter2);
            java.util.List results = criteriaSearch.executeAsList();
            transformEntities(transform, results);
            return results;
        }
        catch (net.sf.hibernate.HibernateException ex)
        {
            throw super.convertHibernateAccessException(ex);
        }
    }

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

     /**
      * Performs the core logic for {@link #allCarsAreRented()}
      */
    protected abstract boolean handleAllCarsAreRented()
        throws java.lang.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>org.andromda.test.6.CarDao</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 org.andromda.test.6.Car} - {@link #TRANSFORM_NONE}</li>
     *   <li>{@link org.andromda.test.6.CarListItem} - {@link TRANSFORM_CARLISTITEM}</li>
     *   <li>{@link org.andromda.test.6.CarDetails} - {@link TRANSFORM_CARDETAILS}</li>
     * </ul>
     *
     * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
     *
     * @param transform one of the constants declared in {@link org.andromda.test.6.CarDao}
     * @param entity an entity that was found
     * @return the transformed entity (i.e. new value object, etc)
     * @see #transformEntities(int,java.util.Collection)
     */
    protected java.lang.Object transformEntity(final int transform, final org.andromda.test.6.Car entity)
    {
        java.lang.Object target = null;
        if (entity != null)
        {
            switch (transform)
            {
                case TRANSFORM_CARLISTITEM :
                    target = toCarListItem(entity);
                    break;
                case TRANSFORM_CARDETAILS :
                    target = toCarDetails(entity);
                    break;
                case TRANSFORM_NONE : // fall-through
                default:
                    target = entity;
            }
        }
        return target;
    }

    /**
     * Transforms a collection of entities using the
     * {@link #transformEntity(int,org.andromda.test.6.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>org.andromda.test.6.CarDao</code>
     * @param entities the collection of entities to transform
     * @see #transformEntity(int,org.andromda.test.6.Car)
     */
    protected void transformEntities(final int transform, final java.util.Collection entities)
    {
        switch (transform)
        {
            case TRANSFORM_CARLISTITEM :
                toCarListItemCollection(entities);
                break;
            case TRANSFORM_CARDETAILS :
                toCarDetailsCollection(entities);
                break;
            case TRANSFORM_NONE : // fall-through
                default:
                // do nothing;
        }
    }

    /**
     * @see org.andromda.test.6.CarDao#toCarListItemCollection(java.util.Collection)
     */
    public final void toCarListItemCollection(java.util.Collection entities)
    {
        if (entities != null)
        {
            org.apache.commons.collections.CollectionUtils.transform(entities, CARLISTITEM_TRANSFORMER);
        }
    }

    /**
     * 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 CarDaoImpl} class if you intend to use reporting queries.
     * @see org.andromda.test.6.CarDao#toCarListItem(org.andromda.test.6.Car)
     */
    protected org.andromda.test.6.CarListItem toCarListItem(java.lang.Object[] row)
    {
        org.andromda.test.6.CarListItem target = null;
        if (row != null)
        {
            final int numberOfObjects = row.length;
            for (int ctr = 0; ctr < numberOfObjects; ctr++)
            {
                final java.lang.Object object = row[ctr];
                if (object instanceof org.andromda.test.6.Car)
                {
                    target = this.toCarListItem((org.andromda.test.6.Car)object);
                    break;
                }
            }
        }
        return target;
    }

    /**
     * This anonymous transformer is designed to transform entities or report query results
     * (which result in an array of objects) to {@link org.andromda.test.6.CarListItem}
     * using the Jakarta Commons-Collections Transformation API.
     */
    private org.apache.commons.collections.Transformer CARLISTITEM_TRANSFORMER =
        new org.apache.commons.collections.Transformer()
        {
            public java.lang.Object transform(java.lang.Object input)
            {
                java.lang.Object result = null;
                if (input instanceof org.andromda.test.6.Car)
                {
                    result = toCarListItem((org.andromda.test.6.Car)input);
                }
                else if (input instanceof java.lang.Object[])
                {
                    result = toCarListItem((java.lang.Object[])input);
                }
                return result;
            }
        };

    /**
     * @see org.andromda.test.6.CarDao#carListItemToEntityCollection(java.util.Collection)
     */
    public final void carListItemToEntityCollection(java.util.Collection instances)
    {
        if (instances != null)
        {
            for (final java.util.Iterator iterator = instances.iterator(); iterator.hasNext();)
            {
                // - remove an objects that are null or not of the correct instance
                if (!(iterator.next() instanceof org.andromda.test.6.CarListItem))
                {
                    iterator.remove();
                }
            }
            org.apache.commons.collections.CollectionUtils.transform(instances, CarListItemToEntityTransformer);
        }
    }

    private final org.apache.commons.collections.Transformer CarListItemToEntityTransformer =
        new org.apache.commons.collections.Transformer()
        {
            public java.lang.Object transform(java.lang.Object input)
            {
                return carListItemToEntity((org.andromda.test.6.CarListItem)input);
            }
        };


    /**
     * @see org.andromda.test.6.CarDao#toCarListItem(org.andromda.test.6.Car, org.andromda.test.6.CarListItem)
     */
    public void toCarListItem(
        org.andromda.test.6.Car source,
        org.andromda.test.6.CarListItem target)
    {
        target.setName(source.getName());
        target.setSerial(source.getSerial());
    }

    /**
     * @see org.andromda.test.6.CarDao#toCarListItem(org.andromda.test.6.Car)
     */
    public org.andromda.test.6.CarListItem toCarListItem(final org.andromda.test.6.Car entity)
    {
        final org.andromda.test.6.CarListItem target = new org.andromda.test.6.CarListItem();
        this.toCarListItem(entity, target);
        return target;
    }
    
    /**
     * @see org.andromda.test.6.CarDao#carListItemToEntity(org.andromda.test.6.CarListItem, org.andromda.test.6.Car)
     */
    public void carListItemToEntity(
        org.andromda.test.6.CarListItem source,
        org.andromda.test.6.Car target,
        boolean copyIfNull)
    {
        if (copyIfNull || source.getSerial() != null)
        {
            target.setSerial(source.getSerial());
        }
        if (copyIfNull || source.getName() != null)
        {
            target.setName(source.getName());
        }
    }
    
    /**
     * @see org.andromda.test.6.CarDao#toCarDetailsCollection(java.util.Collection)
     */
    public final void toCarDetailsCollection(java.util.Collection entities)
    {
        if (entities != null)
        {
            org.apache.commons.collections.CollectionUtils.transform(entities, CARDETAILS_TRANSFORMER);
        }
    }

    /**
     * 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 CarDaoImpl} class if you intend to use reporting queries.
     * @see org.andromda.test.6.CarDao#toCarDetails(org.andromda.test.6.Car)
     */
    protected org.andromda.test.6.CarDetails toCarDetails(java.lang.Object[] row)
    {
        org.andromda.test.6.CarDetails target = null;
        if (row != null)
        {
            final int numberOfObjects = row.length;
            for (int ctr = 0; ctr < numberOfObjects; ctr++)
            {
                final java.lang.Object object = row[ctr];
                if (object instanceof org.andromda.test.6.Car)
                {
                    target = this.toCarDetails((org.andromda.test.6.Car)object);
                    break;
                }
            }
        }
        return target;
    }

    /**
     * This anonymous transformer is designed to transform entities or report query results
     * (which result in an array of objects) to {@link org.andromda.test.6.CarDetails}
     * using the Jakarta Commons-Collections Transformation API.
     */
    private org.apache.commons.collections.Transformer CARDETAILS_TRANSFORMER =
        new org.apache.commons.collections.Transformer()
        {
            public java.lang.Object transform(java.lang.Object input)
            {
                java.lang.Object result = null;
                if (input instanceof org.andromda.test.6.Car)
                {
                    result = toCarDetails((org.andromda.test.6.Car)input);
                }
                else if (input instanceof java.lang.Object[])
                {
                    result = toCarDetails((java.lang.Object[])input);
                }
                return result;
            }
        };

    /**
     * @see org.andromda.test.6.CarDao#carDetailsToEntityCollection(java.util.Collection)
     */
    public final void carDetailsToEntityCollection(java.util.Collection instances)
    {
        if (instances != null)
        {
            for (final java.util.Iterator iterator = instances.iterator(); iterator.hasNext();)
            {
                // - remove an objects that are null or not of the correct instance
                if (!(iterator.next() instanceof org.andromda.test.6.CarDetails))
                {
                    iterator.remove();
                }
            }
            org.apache.commons.collections.CollectionUtils.transform(instances, CarDetailsToEntityTransformer);
        }
    }

    private final org.apache.commons.collections.Transformer CarDetailsToEntityTransformer =
        new org.apache.commons.collections.Transformer()
        {
            public java.lang.Object transform(java.lang.Object input)
            {
                return carDetailsToEntity((org.andromda.test.6.CarDetails)input);
            }
        };


    /**
     * @see org.andromda.test.6.CarDao#toCarDetails(org.andromda.test.6.Car, org.andromda.test.6.CarDetails)
     */
    public void toCarDetails(
        org.andromda.test.6.Car source,
        org.andromda.test.6.CarDetails target)
    {
        target.setName(source.getName());
        target.setSerial(source.getSerial());
    }

    /**
     * @see org.andromda.test.6.CarDao#toCarDetails(org.andromda.test.6.Car)
     */
    public org.andromda.test.6.CarDetails toCarDetails(final org.andromda.test.6.Car entity)
    {
        final org.andromda.test.6.CarDetails target = new org.andromda.test.6.CarDetails();
        this.toCarDetails(entity, target);
        return target;
    }
    
    /**
     * @see org.andromda.test.6.CarDao#carDetailsToEntity(org.andromda.test.6.CarDetails, org.andromda.test.6.Car)
     */
    public void carDetailsToEntity(
        org.andromda.test.6.CarDetails source,
        org.andromda.test.6.Car target,
        boolean copyIfNull)
    {
        if (copyIfNull || source.getSerial() != null)
        {
            target.setSerial(source.getSerial());
        }
        if (copyIfNull || source.getName() != null)
        {
            target.setName(source.getName());
        }
    }
    
}