NoticeGroupDAO

/*
 * Copyright (c) 2002-2014, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.formengine.business;

import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.util.sql.DAOUtil;

import java.util.ArrayList;
import java.util.List;


/**
 *
 * NoticeGroupDAO
 */
public class NoticeGroupDAO implements INoticeGroupDAO
{
    private static final String SQL_QUERY_NEW_PK = "SELECT max( id_group_notice ) FROM formengine_group_notice";
    private static final String SQL_QUERY_SELECT = "SELECT id_group_notice, title, id_form, is_enabled, workgroup_key " +
        "FROM formengine_group_notice ";
    private static final String SQL_QUERY_SELECT_BY_PRIMARY_KEY = SQL_QUERY_SELECT + " WHERE id_group_notice = ?";
    private static final String SQL_QUERY_INSERT = "INSERT INTO formengine_group_notice(id_group_notice, title, id_form, is_enabled, workgroup_key)" +
        "VALUES (?,?,?,?,?)";
    private static final String SQL_QUERY_UPDATE = "UPDATE formengine_group_notice " +
        "SET title = ?, id_form = ?, is_enabled = ?, workgroup_key = ? WHERE id_group_notice = ? ";
    private static final String SQL_QUERY_DELETE = "DELETE FROM formengine_group_notice WHERE id_group_notice = ? ";
    private static final String SQL_FILTER_ID_FORM = " id_form = ? ";
    private static final String SQL_FILTER_ENABLED = " is_enabled = ? ";
    private static final String SQL_FILTER_WORKGROUP = " workgroup_key = ? ";
    private static final String CONSTANT_WHERE = " WHERE ";
    private static final String CONSTANT_AND = " AND ";
    private static final String SQL_QUERY_SELECT_BY_ID_FORM = SQL_QUERY_SELECT + CONSTANT_WHERE + SQL_FILTER_ID_FORM;
    private static final String SQL_QUERY_SELECT_IS_ENABLED = "SELECT is_enabled " + "FROM formengine_group_notice " +
        CONSTANT_WHERE + SQL_FILTER_ENABLED;

    /**
     * Finds a new primary key
     * @param plugin the plugin
     * @return the new primary key
     */
    private int newPrimaryKey( Plugin plugin )
    {
        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_NEW_PK, plugin );

        daoUtil.executeQuery(  );

        int nKey = 1;

        if ( daoUtil.next(  ) )
        {
            nKey = daoUtil.getInt( 1 ) + 1;
        }

        daoUtil.free(  );

        return nKey;
    }

    /**
     *
     *{@inheritDoc}
     */
    public void delete( int nIdNoticeGroup, Plugin plugin )
    {
        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE, plugin );
        daoUtil.setInt( 1, nIdNoticeGroup );

        daoUtil.executeUpdate(  );

        daoUtil.free(  );
    }

    /**
     *
     *{@inheritDoc}
     */
    public List<NoticeGroup> getNoticeGroupByIdForm( String strIdForm, Plugin plugin )
    {
        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_ID_FORM, plugin );

        daoUtil.setString( 1, strIdForm );

        daoUtil.executeQuery(  );

        List<NoticeGroup> listNoticeGroup = new ArrayList<NoticeGroup>(  );

        while ( daoUtil.next(  ) )
        {
            NoticeGroup noticeGroup = new NoticeGroup(  );
            fillNoticeGroup( noticeGroup, daoUtil );

            listNoticeGroup.add( noticeGroup );
        }

        daoUtil.free(  );

        return listNoticeGroup;
    }

    /**
     *
     *{@inheritDoc}
     */
    public int insert( NoticeGroup noticeGroup, Plugin plugin )
    {
        int nKey = newPrimaryKey( plugin );
        noticeGroup.setId( nKey );

        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT, plugin );

        daoUtil.setInt( 1, nKey );
        setInsertOrUpdateValues( 2, noticeGroup, daoUtil );

        daoUtil.executeUpdate(  );

        daoUtil.free(  );

        return nKey;
    }

    /**
     *
     *{@inheritDoc}
     */
    public boolean isEnable( NoticeGroup noticeGroup, Plugin plugin )
    {
        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_IS_ENABLED, plugin );

        daoUtil.setInt( 1, noticeGroup.getId(  ) );

        daoUtil.executeQuery(  );

        boolean bEnabled = false;

        if ( daoUtil.next(  ) )
        {
            bEnabled = daoUtil.getBoolean( 1 );
        }

        daoUtil.free(  );

        return bEnabled;
    }

    /**
     *
     *{@inheritDoc}
     */
    public NoticeGroup load( int nKey, Plugin plugin )
    {
        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_PRIMARY_KEY, plugin );

        daoUtil.setInt( 1, nKey );

        daoUtil.executeQuery(  );

        NoticeGroup noticeGroup = null;

        if ( daoUtil.next(  ) )
        {
            noticeGroup = new NoticeGroup(  );
            fillNoticeGroup( noticeGroup, daoUtil );
        }

        daoUtil.free(  );

        return noticeGroup;
    }

    /**
     *
     *{@inheritDoc}
     */
    public void store( NoticeGroup noticeGroup, Plugin plugin )
    {
        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE, plugin );

        int nIndex = setInsertOrUpdateValues( 1, noticeGroup, daoUtil );

        daoUtil.setInt( nIndex, noticeGroup.getId(  ) );

        daoUtil.executeUpdate(  );

        daoUtil.free(  );
    }

    /**
     * Fills the noticeGroup with values form daoUtil
     * @param noticeGroup the notice group
     * @param daoUtil daoUtil
     */
    private void fillNoticeGroup( NoticeGroup noticeGroup, DAOUtil daoUtil )
    {
        int nIndex = 1;
        noticeGroup.setId( daoUtil.getInt( nIndex++ ) );
        noticeGroup.setTitle( daoUtil.getString( nIndex++ ) );
        noticeGroup.setForm( daoUtil.getString( nIndex++ ) );
        noticeGroup.setEnabled( daoUtil.getBoolean( nIndex++ ) );
        noticeGroup.setWorkgroupKey( daoUtil.getString( nIndex++ ) );
    }

    /**
     * Fills insert (or update) values in daoUtil
     * @param nStartIndex start index
     * @param noticeGroup the notice group
     * @param daoUtil daoUtil
     * @return end index
     */
    private int setInsertOrUpdateValues( int nStartIndex, NoticeGroup noticeGroup, DAOUtil daoUtil )
    {
        int nIndex = nStartIndex;

        daoUtil.setString( nIndex++, noticeGroup.getTitle(  ) );
        daoUtil.setString( nIndex++, noticeGroup.getForm(  ) );
        daoUtil.setBoolean( nIndex++, noticeGroup.isEnabled(  ) );
        daoUtil.setString( nIndex++, noticeGroup.getWorkgroupKey(  ) );

        return nIndex;
    }

    /**
     *
     *{@inheritDoc}
     */
    public List<NoticeGroup> selectNoticeGroupByFilter( NoticeGroupFilter filter, Plugin plugin )
    {
        StringBuilder sbSQL = new StringBuilder( SQL_QUERY_SELECT );
        buildSQLFilter( sbSQL, filter );

        DAOUtil daoUtil = new DAOUtil( sbSQL.toString(  ), plugin );

        addSQLFilterParameters( 1, daoUtil, filter );

        daoUtil.executeQuery(  );

        List<NoticeGroup> listNoticeGroup = new ArrayList<NoticeGroup>(  );

        while ( daoUtil.next(  ) )
        {
            NoticeGroup noticeGroup = new NoticeGroup(  );
            fillNoticeGroup( noticeGroup, daoUtil );

            listNoticeGroup.add( noticeGroup );
        }

        daoUtil.free(  );

        return listNoticeGroup;
    }

    /**
     * Add SQL parameters
     * @param nStartIndex the start index
     * @param daoUtil daoUtil
     * @param filter the filter to apply
     * @return the end index
     */
    private int addSQLFilterParameters( int nStartIndex, DAOUtil daoUtil, NoticeGroupFilter filter )
    {
        int nIndex = nStartIndex;

        if ( filter.containsIsEnabled(  ) )
        {
            daoUtil.setInt( nIndex++, filter.getIsEnabled(  ) );
        }

        if ( filter.containsWorkgroupCriteria(  ) )
        {
            daoUtil.setString( nIndex++, filter.getWorkgroup(  ) );
        }

        if ( filter.containsFormCriteria(  ) )
        {
            daoUtil.setString( nIndex++, filter.getForm(  ) );
        }

        return nIndex;
    }

    /**
     * Adds SQL filter to buffer
     * @param sbSQL buffer
     * @param filter filter
     */
    private void buildSQLFilter( StringBuilder sbSQL, NoticeGroupFilter filter )
    {
        List<String> listFilters = new ArrayList<String>(  );

        if ( filter.containsIsEnabled(  ) )
        {
            listFilters.add( SQL_FILTER_ENABLED );
        }

        if ( filter.containsWorkgroupCriteria(  ) )
        {
            listFilters.add( SQL_FILTER_WORKGROUP );
        }

        if ( filter.containsFormCriteria(  ) )
        {
            listFilters.add( SQL_FILTER_ID_FORM );
        }

        boolean bFirstFilter = true;

        for ( String strFilter : listFilters )
        {
            if ( bFirstFilter )
            {
                sbSQL.append( CONSTANT_WHERE );
                bFirstFilter = false;
            }
            else
            {
                sbSQL.append( CONSTANT_AND );
            }

            sbSQL.append( strFilter );
        }
    }
}