com.romeikat.datamessie.core.base.dao.impl.AbstractEntityDao.java Source code

Introduction

Here is the source code for com.romeikat.datamessie.core.base.dao.impl.AbstractEntityDao.java

Source

package com.romeikat.datamessie.core.base.dao.impl;

/*-
 * ============================LICENSE_START============================
 * data.messie (core)
 * =====================================================================
 * Copyright (C) 2013 - 2017 Dr. Raphael Romeikat
 * =====================================================================
 * This program is free software: you can redistribute it and/or modify
it under the terms of the GNU 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 General Public
License along with this program.  If not, see
<http://www.gnu.org/licenses/gpl-3.0.html>.
 * =============================LICENSE_END=============================
 */
import java.util.List;
import org.hibernate.Criteria;
import org.hibernate.SharedSessionContract;
import org.hibernate.StatelessSession;
import org.hibernate.criterion.Order;
import org.hibernate.criterion.Projections;
import org.hibernate.criterion.Restrictions;
import com.romeikat.datamessie.core.base.dao.EntityDao;
import com.romeikat.datamessie.core.domain.entity.Entity;

public abstract class AbstractEntityDao<E extends Entity> implements EntityDao<E> {

    private final Class<E> entityClass;

    public AbstractEntityDao(final Class<E> entityClass) {
        this.entityClass = entityClass;
    }

    protected abstract String defaultSortingProperty();

    /**
     * Returns the class of the entity.
     *
     * @return
     */
    protected Class<E> getEntityClass() {
        return entityClass;
    }

    /**
     * Provides all entities.
     *
     * @param ssc
     * @return
     */
    @Override
    public List<E> getAllEntites(final SharedSessionContract ssc) {
        return getEntites(ssc, null, null);
    }

    /**
     * Provides all entities.
     *
     * @param ssc
     * @return
     */
    @Override
    public List<E> getEntites(final SharedSessionContract ssc, final Integer firstResult,
            final Integer maxResults) {
        // Query
        final Criteria criteria = ssc.createCriteria(entityClass);
        final String defaultSortingProperty = defaultSortingProperty();
        if (defaultSortingProperty != null) {
            criteria.addOrder(Order.asc(defaultSortingProperty));
        }
        if (firstResult != null) {
            criteria.setFirstResult(firstResult);
        }
        if (maxResults != null) {
            criteria.setMaxResults(maxResults);
        }
        // Done
        @SuppressWarnings("unchecked")
        final List<E> entities = criteria.list();
        return entities;
    }

    /**
     * Provides all entities by a given property.
     *
     * @param ssc
     * @param property
     * @param value
     * @return
     */
    @Override
    public List<E> getEntitesByProperty(final SharedSessionContract ssc, final String property,
            final Object value) {
        return getEntitesByProperty(ssc, property, value, null, null);
    }

    /**
     * Provides all entities by a given property.
     *
     * @param ssc
     * @param property
     * @param value
     * @return
     */
    @Override
    public List<E> getEntitesByProperty(final SharedSessionContract ssc, final String property, final Object value,
            final Integer firstResult, final Integer maxResults) {
        // Query
        final Criteria criteria = ssc.createCriteria(entityClass);
        if (property != null && value != null) {
            criteria.add(Restrictions.eq(property, value));
        }
        if (firstResult != null) {
            criteria.setFirstResult(firstResult);
        }
        if (maxResults != null) {
            criteria.setMaxResults(maxResults);
        }
        final String defaultSortingProperty = defaultSortingProperty();
        if (defaultSortingProperty != null) {
            criteria.addOrder(Order.asc(defaultSortingProperty));
        }
        // Done
        @SuppressWarnings("unchecked")
        final List<E> entities = criteria.list();
        return entities;
    }

    /**
     * Provides a unique entity by a given property value.
     *
     * @param ssc
     * @param property
     * @param value
     * @return
     */
    @Override
    public E getUniqueEntityByProperty(final SharedSessionContract ssc, final String property, final Object value) {
        // Query
        final Criteria criteria = ssc.createCriteria(entityClass);
        if (property != null && value != null) {
            criteria.add(Restrictions.eq(property, value));
        }
        // Done
        @SuppressWarnings("unchecked")
        final E entity = (E) criteria.uniqueResult();
        return entity;
    }

    /**
     * Counts all entities.
     *
     * @param ssc
     * @return
     */
    @Override
    public long countAll(final SharedSessionContract ssc) {
        // Query
        final Criteria criteria = ssc.createCriteria(entityClass);
        // Projection
        criteria.setProjection(Projections.count("id"));
        // Done
        Long count = (Long) criteria.uniqueResult();
        if (count == null) {
            count = 0l;
        }
        return count;
    }

    /**
     * Inserts a new entity. If the entity already exists in the database, a copy of it is saved with
     * a new id.
     *
     * @param statelessSession
     * @param entity
     */
    @Override
    public void insert(final StatelessSession statelessSession, final E entity) {
        statelessSession.insert(entity);
    }

    /**
     * Updates an existing entity. If the entity does not exist in the database, an exception is
     * thrown.
     *
     * @param statelessSession
     * @param entity
     */
    @Override
    public void update(final StatelessSession statelessSession, final E entity) {
        statelessSession.update(entity);
    }

    /**
     * Deletes an existing entity. If the entity does not exist in the database, an exception is
     * thrown.
     *
     * @param statelessSession
     * @param entity
     */
    @Override
    public void delete(final StatelessSession statelessSession, final E entity) {
        statelessSession.delete(entity);
    }

}