com.yize.broadcast.core.hibernate.SimpleHibernateDao.java Source code

Introduction

Here is the source code for com.yize.broadcast.core.hibernate.SimpleHibernateDao.java

Source

/**
 * Copyright (c) 2005-2010 springside.org.cn
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 
 * $Id: SimpleHibernateDao.java 1205 2010-09-09 15:12:17Z calvinxiu $
 */
package com.yize.broadcast.core.hibernate;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import com.yize.broadcast.core.util.ReflectionUtils;
import org.hibernate.*;
import org.hibernate.criterion.CriteriaSpecification;
import org.hibernate.criterion.Criterion;
import org.hibernate.criterion.Order;
import org.hibernate.criterion.Restrictions;
import org.hibernate.metadata.ClassMetadata;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.util.Assert;

/**
 * ?HibernateAPIDAO.
 * 
 * ?Service, ?DAO?, ?. ?Spring2.5Petlinc?,
 * ?HibernateTemplate, HibernateAPI.
 * 
 * @param <T>
 *            DAO?
 * @param <PK>
 *            
 * 
 * @author calvin
 */
@SuppressWarnings("unchecked")
public class SimpleHibernateDao<T, PK extends Serializable> {
    protected static final Logger LOGGER = LoggerFactory.getLogger(SimpleHibernateDao.class);

    protected SessionFactory sessionFactory;

    protected Class<T> entityClass;

    /**
     * Dao?. ??Class. eg. public class UserDao extends
     * SimpleHibernateDao<User, Long>
     */
    public SimpleHibernateDao() {
        this.entityClass = ReflectionUtils.getSuperClassGenricType(getClass());
    }

    /**
     * ?Dao, ServiceSimpleHibernateDao. Class.
     * eg. SimpleHibernateDao<User, Long> userDao = new SimpleHibernateDao<User,
     * Long>(sessionFactory, User.class);
     */
    public SimpleHibernateDao(final SessionFactory sessionFactory, final Class<T> entityClass) {
        this.sessionFactory = sessionFactory;
        this.entityClass = entityClass;
    }

    /**
     * ?sessionFactory.
     */
    public SessionFactory getSessionFactory() {
        return sessionFactory;
    }

    /**
     * @AutowiredSessionFactory, SesionFactory??.
     */
    @Autowired
    public void setSessionFactory(final SessionFactory sessionFactory) {
        this.sessionFactory = sessionFactory;
    }

    /**
     * ??Session.
     */
    public Session getSession() {
        return sessionFactory.getCurrentSession();
    }

    /**
     * ?.
     */
    @Transactional
    public void save(final T entity) {
        Assert.notNull(entity, "entity?");
        getSession().saveOrUpdate(entity);
        LOGGER.debug("save entity: {}", entity);
    }

    /**
     * ??.
     */
    @Transactional
    public void batchSave(final List<T> entities) {
        Assert.notNull(entities, "entity?");
        Session session = getSession();
        int count = 0;
        for (T entity : entities) {
            session.saveOrUpdate(entity);
            ++count;
            if (count % 50 == 0) {
                session.flush();
                session.clear();
            }
        }
    }

    /**
     * .
     * 
     * @param entity
     *            session?idtransient.
     */
    @Transactional
    public void delete(final T entity) {
        Assert.notNull(entity, "entity?");
        getSession().delete(entity);
        LOGGER.debug("delete entity: {}", entity);
    }

    /**
     * id.
     */
    @Transactional
    public void delete(final PK id) {
        Assert.notNull(id, "id?");
        delete(get(id));
        LOGGER.debug("delete entity {},id is {}", entityClass.getSimpleName(), id);
    }

    /**
     * id?.
     */
    @Transactional(readOnly = true)
    public T get(final PK id) {
        Assert.notNull(id, "id?");
        return (T) getSession().get(entityClass, id);
    }

    /**
     * id?.
     */
    @Transactional(readOnly = true)
    public List<T> get(final Collection<PK> ids) {
        return find(Restrictions.in(getIdName(), ids));
    }

    /**
     * ?.
     */
    @Transactional(readOnly = true)
    public List<T> getAll() {
        return find();
    }

    /**
     * ?, ??.
     */
    @Transactional(readOnly = true)
    public List<T> getAll(String orderByProperty, boolean isAsc) {
        Criteria c = createCriteria();
        if (isAsc) {
            c.addOrder(Order.asc(orderByProperty));
        } else {
            c.addOrder(Order.desc(orderByProperty));
        }
        return c.list();
    }

    /**
     * , ??.
     */
    @Transactional(readOnly = true)
    public List<T> findBy(final String propertyName, final Object value) {
        Assert.hasText(propertyName, "propertyName?");
        Criterion criterion = Restrictions.eq(propertyName, value);
        return find(criterion);
    }

    /**
     * , ??.
     */
    @Transactional(readOnly = true)
    public T findUniqueBy(final String propertyName, final Object value) {
        Assert.hasText(propertyName, "propertyName?");
        Criterion criterion = Restrictions.eq(propertyName, value);
        return (T) createCriteria(criterion).uniqueResult();
    }

    /**
     * HQL.
     * 
     * @param values
     *            ????,?.
     */
    @Transactional(readOnly = true)
    public <X> List<X> find(final String hql, final Object... values) {
        return createQuery(hql, values).list();
    }

    /**
     * HQL.
     * 
     * @param values
     *            ???,??.
     */
    @Transactional(readOnly = true)
    public <X> List<X> find(final String hql, final Map<String, ?> values) {
        return createQuery(hql, values).list();
    }

    /**
     * HQL.
     * 
     * @param values
     *            ????,?.
     */
    @Transactional(readOnly = true)
    public <X> X findUnique(final String hql, final Object... values) {
        return (X) createQuery(hql, values).uniqueResult();
    }

    /**
     * HQL.
     * 
     * @param values
     *            ???,??.
     */
    @Transactional(readOnly = true)
    public <X> X findUnique(final String hql, final Map<String, ?> values) {
        return (X) createQuery(hql, values).uniqueResult();
    }

    /**
     * HQL?/?.
     * 
     * @param values
     *            ????,?.
     * @return .
     */
    @Transactional
    public int batchExecute(final String hql, final Object... values) {
        return createQuery(hql, values).executeUpdate();
    }

    /**
     * HQL?/?.
     * 
     * @param values
     *            ???,??.
     * @return .
     */
    @Transactional
    public int batchExecute(final String hql, final Map<String, ?> values) {
        return createQuery(hql, values).executeUpdate();
    }

    /**
     * ?HQL?Query. find()???.
     * 
     * @param values
     *            ????,?.
     */
    public Query createQuery(final String queryString, final Object... values) {
        Assert.hasText(queryString, "queryString?");
        Query query = getSession().createQuery(queryString);
        if (values != null) {
            for (int i = 0; i < values.length; i++) {
                query.setParameter(i, values[i]);
            }
        }
        return query;
    }

    /**
     * ?HQL?Query. find()???.
     *
     * @param values
     *            ????,?.
     */
    public SQLQuery createSQLQuery(final String queryString, final Object... values) {
        Assert.hasText(queryString, "queryString?");
        SQLQuery query = getSession().createSQLQuery(queryString);
        if (values != null) {
            for (int i = 0; i < values.length; i++) {
                query.setParameter(i, values[i]);
            }
        }
        return query;
    }

    /**
     * ?HQL?Query. find()???.
     * 
     * @param values
     *            ???,??.
     */
    public Query createQuery(final String queryString, final Map<String, ?> values) {
        Assert.hasText(queryString, "queryString?");
        Query query = getSession().createQuery(queryString);
        if (values != null) {
            query.setProperties(values);
        }
        return query;
    }

    /**
     * ?HQL?Query. find()???.
     *
     * @param values
     *            ???,??.
     */
    public SQLQuery createSQLQuery(final String queryString, final Map<String, ?> values) {
        Assert.hasText(queryString, "queryString?");
        SQLQuery query = getSession().createSQLQuery(queryString);
        if (values != null) {
            query.setProperties(values);
        }
        return query;
    }

    /**
     * Criteria.
     * 
     * @param criterions
     *            ???Criterion.
     */
    @Transactional(readOnly = true)
    public List<T> find(final Criterion... criterions) {
        return createCriteria(criterions).list();
    }

    /**
     * Criteria.
     * 
     * @param criterions
     *            ???Criterion.
     */
    @Transactional(readOnly = true)
    public T findUnique(final Criterion... criterions) {
        return (T) createCriteria(criterions).uniqueResult();
    }

    /**
     * ?Criterion?Criteria. find()???.
     * 
     * @param criterions
     *            ???Criterion.
     */
    public Criteria createCriteria(final Criterion... criterions) {
        Criteria criteria = getSession().createCriteria(entityClass);
        for (Criterion c : criterions) {
            criteria.add(c);
        }
        return criteria;
    }

    /**
     * ?. load()Proxy, View???. entity,
     * ??entity,????. ??,:
     * Hibernate.initialize(user.getRoles())?User??.
     * Hibernate.initialize
     * (user.getDescription())?UserDescription.
     */
    public void initProxyObject(Object proxy) {
        Hibernate.initialize(proxy);
    }

    /**
     * Flush?Session.
     */
    public void flush() {
        getSession().flush();
    }

    /**
     * Querydistinct transformer. ?HQL??, ?distinct?.
     */
    public Query distinct(Query query) {
        query.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);
        return query;
    }

    /**
     * Criteriadistinct transformer. ?HQL??, ?distinct?.
     */
    public Criteria distinct(Criteria criteria) {
        criteria.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);
        return criteria;
    }

    /**
     * ???.
     */
    public String getIdName() {
        ClassMetadata meta = getSessionFactory().getClassMetadata(entityClass);
        return meta.getIdentifierPropertyName();
    }

    /**
     * ??.
     * 
     * ,(value)?(orgValue)?.
     */
    public boolean isPropertyUnique(final String propertyName, final Object newValue, final Object oldValue) {
        if (newValue == null || newValue.equals(oldValue)) {
            return true;
        }
        Object object = findUniqueBy(propertyName, newValue);
        return (object == null);
    }
}