io.dropwizard.hibernate.AbstractDAO Maven / Gradle / Ivy
package io.dropwizard.hibernate;
import io.dropwizard.util.Generics;
import org.hibernate.Criteria;
import org.hibernate.Hibernate;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.query.Query;
import org.hibernate.query.internal.AbstractProducedQuery;
import java.io.Serializable;
import java.util.List;
import javax.persistence.criteria.CriteriaQuery;
import static java.util.Objects.requireNonNull;
/**
* An abstract base class for Hibernate DAO classes.
*
* @param the class which this DAO manages
*/
public class AbstractDAO {
private final SessionFactory sessionFactory;
private final Class entityClass;
/**
* Creates a new DAO with a given session provider.
*
* @param sessionFactory a session provider
*/
public AbstractDAO(SessionFactory sessionFactory) {
this.sessionFactory = requireNonNull(sessionFactory);
this.entityClass = Generics.getTypeParameter(getClass());
}
/**
* Returns the current {@link Session}.
*
* @return the current session
*/
protected Session currentSession() {
return sessionFactory.getCurrentSession();
}
/**
* Creates a new {@link Criteria} query for {@code }.
*
* @return a new {@link Criteria} query
* @see Session#createCriteria(Class)
* @deprecated Use {@link AbstractDAO#criteriaQuery()} instead.
*/
@Deprecated
protected Criteria criteria() {
return currentSession().createCriteria(entityClass);
}
/**
* Creates a new {@link CriteriaQuery} for {@code }.
*
* @return a new {@link CriteriaQuery} query
*/
protected CriteriaQuery criteriaQuery() {
return this.currentSession().getCriteriaBuilder().createQuery(getEntityClass());
}
/**
* Returns a named {@link Query}.
*
* @param queryName the name of the query
* @return the named query
* @see Session#getNamedQuery(String)
*/
protected Query namedQuery(String queryName) throws HibernateException {
return currentSession().getNamedQuery(requireNonNull(queryName));
}
/**
* Returns a named and type-safe {@link Query}.
*
* @param queryName the name of the query
* @return the named query
* @see Session#createNamedQuery(String, Class)
* @since 2.0.22
*/
protected Query namedTypedQuery(String queryName) throws HibernateException {
return currentSession().createNamedQuery(queryName, getEntityClass());
}
/**
* Returns a typed {@link Query}
*
* @param queryString HQL query
* @return typed query
*/
protected Query query(String queryString) {
return currentSession().createQuery(requireNonNull(queryString), getEntityClass());
}
/**
* Returns the entity class managed by this DAO.
*
* @return the entity class managed by this DAO
*/
@SuppressWarnings("unchecked")
public Class getEntityClass() {
return (Class) entityClass;
}
/**
* Convenience method to return a single instance that matches the criteria query,
* or null if the criteria returns no results.
*
* @param criteriaQuery the {@link CriteriaQuery} query to run
* @return the single result or {@code null}
* @throws HibernateException if there is more than one matching result
*/
protected E uniqueResult(CriteriaQuery criteriaQuery) throws HibernateException {
return AbstractProducedQuery.uniqueElement(
currentSession()
.createQuery(requireNonNull(criteriaQuery))
.getResultList()
);
}
/**
* Convenience method to return a single instance that matches the criteria, or null if the
* criteria returns no results.
*
* @param criteria the {@link Criteria} query to run
* @return the single result or {@code null}
* @throws HibernateException if there is more than one matching result
* @see Criteria#uniqueResult()
*/
@SuppressWarnings("unchecked")
protected E uniqueResult(Criteria criteria) throws HibernateException {
return (E) requireNonNull(criteria).uniqueResult();
}
/**
* Convenience method to return a single instance that matches the query, or null if the query
* returns no results.
*
* @param query the query to run
* @return the single result or {@code null}
* @throws HibernateException if there is more than one matching result
* @see Query#uniqueResult()
*/
protected E uniqueResult(Query query) throws HibernateException {
return requireNonNull(query).uniqueResult();
}
/**
* Get the results of a {@link Criteria} query.
*
* @param criteria the {@link Criteria} query to run
* @return the list of matched query results
* @see Criteria#list()
*/
@SuppressWarnings("unchecked")
protected List list(Criteria criteria) throws HibernateException {
return requireNonNull(criteria).list();
}
/**
* Get the results of a {@link CriteriaQuery} query.
*
* @param criteria the {@link CriteriaQuery} query to run
* @return the list of matched query results
*/
protected List list(CriteriaQuery criteria) throws HibernateException {
return currentSession().createQuery(requireNonNull(criteria)).getResultList();
}
/**
* Get the results of a query.
*
* @param query the query to run
* @return the list of matched query results
* @see Query#list()
*/
protected List list(Query query) throws HibernateException {
return requireNonNull(query).list();
}
/**
* Return the persistent instance of {@code } with the given identifier, or {@code null} if
* there is no such persistent instance. (If the instance, or a proxy for the instance, is
* already associated with the session, return that instance or proxy.)
*
* @param id an identifier
* @return a persistent instance or {@code null}
* @throws HibernateException
* @see Session#get(Class, Serializable)
*/
@SuppressWarnings("unchecked")
protected E get(Serializable id) {
return (E) currentSession().get(entityClass, requireNonNull(id));
}
/**
* Either save or update the given instance, depending upon resolution of the unsaved-value
* checks (see the manual for discussion of unsaved-value checking).
*
* This operation cascades to associated instances if the association is mapped with
* cascade="save-update".
*
* @param entity a transient or detached instance containing new or updated state
* @throws HibernateException
* @see Session#saveOrUpdate(Object)
*/
protected E persist(E entity) throws HibernateException {
currentSession().saveOrUpdate(requireNonNull(entity));
return entity;
}
/**
* Force initialization of a proxy or persistent collection.
*
* Note: This only ensures initialization of a proxy object or collection;
* it is not guaranteed that the elements INSIDE the collection will be initialized/materialized.
*
* @param proxy a persistable object, proxy, persistent collection or {@code null}
* @throws HibernateException if we can't initialize the proxy at this time, eg. the {@link Session} was closed
*/
protected T initialize(T proxy) throws HibernateException {
if (!Hibernate.isInitialized(proxy)) {
Hibernate.initialize(proxy);
}
return proxy;
}
}