com.ephesoft.dcma.da.dao.hibernate.ModuleDaoImpl.java Source code

Introduction

Here is the source code for com.ephesoft.dcma.da.dao.hibernate.ModuleDaoImpl.java

Source

/********************************************************************************* 
* Ephesoft is a Intelligent Document Capture and Mailroom Automation program 
* developed by Ephesoft, Inc. Copyright (C) 2010-2012 Ephesoft Inc. 
* 
* This program is free software; you can redistribute it and/or modify it under 
* the terms of the GNU Affero General Public License version 3 as published by the 
* Free Software Foundation with the addition of the following permission added 
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK 
* IN WHICH THE COPYRIGHT IS OWNED BY EPHESOFT, EPHESOFT DISCLAIMS THE WARRANTY 
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 
* 
* 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 Affero General Public License for more 
* details. 
* 
* You should have received a copy of the GNU Affero General Public License along with 
* this program; if not, see http://www.gnu.org/licenses or write to the Free 
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 
* 02110-1301 USA. 
* 
* You can contact Ephesoft, Inc. headquarters at 111 Academy Way, 
* Irvine, CA 92617, USA. or at email address info@ephesoft.com. 
* 
* The interactive user interfaces in modified source and object code versions 
* of this program must display Appropriate Legal Notices, as required under 
* Section 5 of the GNU Affero General Public License version 3. 
* 
* In accordance with Section 7(b) of the GNU Affero General Public License version 3, 
* these Appropriate Legal Notices must retain the display of the "Ephesoft" logo. 
* If the display of the logo is not reasonably feasible for 
* technical reasons, the Appropriate Legal Notices must display the words 
* "Powered by Ephesoft". 
********************************************************************************/

package com.ephesoft.dcma.da.dao.hibernate;

import java.util.List;

import org.hibernate.criterion.DetachedCriteria;
import org.hibernate.criterion.Order;
import org.hibernate.criterion.Projections;
import org.hibernate.criterion.Restrictions;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Repository;

import com.ephesoft.dcma.core.dao.hibernate.HibernateDao;
import com.ephesoft.dcma.da.dao.ModuleDao;
import com.ephesoft.dcma.da.domain.Module;

/**
 * A Dao representing module table in database.
 * 
 * @author Ephesoft
 * @version 1.0
 * @see com.ephesoft.dcma.da.dao.ModuleDao
 */
@Repository
public class ModuleDaoImpl extends HibernateDao<Module> implements ModuleDao {

    /**
     * ID_STRING String.
     */
    private static final String ID_STRING = "id";

    /**
     * LOGGER to print the logging information.
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(ModuleDaoImpl.class);

    /**
     * MODULE_NAME String.
     */
    private static final String MODULE_NAME = "name";

    /**
     * API to get Module by name.
     * 
     * @param moduleName name of the module
     * @return Module
     */
    @Override
    public Module getModuleByName(String moduleName) {
        LOGGER.debug(moduleName);
        DetachedCriteria criteria = criteria();
        criteria.add(Restrictions.eq(MODULE_NAME, moduleName));
        return this.findSingle(criteria);
    }

    /**
     * API to get Module by Id.
     * 
     * @param moduleId id of the module
     */
    @Override
    public Module getModulePropertiesForModuleId(Long moduleId) {
        LOGGER.debug("moduleId : " + moduleId);
        DetachedCriteria criteria = criteria();
        criteria.add(Restrictions.eq(ID_STRING, moduleId));
        return this.findSingle(criteria);
    }

    /**
     * API to get all Module names.
     * 
     * @return {@link List}<{@link String}>
     */
    @Override
    public List<String> getModuleNames() {
        LOGGER.info("Retrieving list of all module names in ascending order.");
        DetachedCriteria criteria = criteria();
        criteria.setProjection(Projections.property(MODULE_NAME));
        criteria.addOrder(Order.asc(MODULE_NAME));
        return find(criteria);
    }
}