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

Introduction

Here is the source code for com.ephesoft.dcma.da.dao.hibernate.PluginDaoImpl.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.Projections;
import org.hibernate.criterion.Restrictions;
import org.hibernate.sql.JoinFragment;
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.PluginDao;
import com.ephesoft.dcma.da.domain.BatchClassPlugin;
import com.ephesoft.dcma.da.domain.Plugin;

/**
 * Dao representing plugin table in database.
 * 
 * @author Ephesoft
 * @version 1.0
 * @see com.ephesoft.dcma.da.dao.PluginDao
 */
@Repository
public class PluginDaoImpl extends HibernateDao<Plugin> implements PluginDao {

    /**
     * PLUGIN_NAME String.
     */
    private static final String PLUGIN_NAME = "pluginName";

    /**
     * PLUGIN String.
     */
    private static final String PLUGIN = "plugin";

    /**
     * MODULE_ID String.
     */
    private static final String MODULE_ID = "module.id";

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

    /**
     * MODULE String.
     */
    private static final String MODULE = "module";

    /**
     * BATCH_CLASS_MODULE_MODULE String.
     */
    private static final String BATCH_CLASS_MODULE_MODULE = "batchClassModule.module";

    /**
     * BATCH_CLASS_MODULE String.
     */
    private static final String BATCH_CLASS_MODULE = "batchClassModule";

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

    /**
     * API to get the plugin properties by plugin Id.
     * 
     * @param pluginId Long
     * @return Plugin
     */
    @Override
    public Plugin getPluginPropertiesForPluginId(Long pluginId) {
        LOG.info("pluginId : " + pluginId);
        DetachedCriteria criteria = criteria();
        criteria.add(Restrictions.eq(PLUGIN_ID, pluginId));
        return this.findSingle(criteria);
    }

    /**
     * API to get plugins.
     * 
     * @param moduleId Long
     * @param startResult int
     * @param maxResult int
     * @return List<Plugin>
     */
    @Override
    public List<Plugin> getPlugins(Long moduleId, int startResult, int maxResult) {
        DetachedCriteria criteria = criteria(BatchClassPlugin.class);
        criteria.createAlias(BATCH_CLASS_MODULE, BATCH_CLASS_MODULE, JoinFragment.INNER_JOIN);
        criteria.createAlias(BATCH_CLASS_MODULE_MODULE, MODULE, JoinFragment.INNER_JOIN);
        criteria.add(Restrictions.eq(MODULE_ID, moduleId));
        criteria.setProjection(Projections.property(PLUGIN));
        return find(criteria, startResult, maxResult);
    }

    /**
     * API to get Plugin by Name.
     * 
     * @param pluginName String
     * @return Plugin
     */
    @Override
    public Plugin getPluginByName(String pluginName) {
        DetachedCriteria criteria = criteria(Plugin.class);
        criteria.add(Restrictions.eq(PLUGIN_NAME, pluginName));
        return this.findSingle(criteria);
    }

    /**
     * API to get all plugin names.
     * 
     * @return List<String>
     */
    @Override
    public List<String> getAllPluginsNames() {
        LOG.info("Getting names of all the plugins.");
        DetachedCriteria criteria = criteria();
        criteria.setProjection(Projections.property(PLUGIN_NAME));
        return find(criteria);
    }
}