CategoryDAO.java

/*
 * Copyright (c) 2002-2022, City of 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.appointment.business.category;

import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;

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

/**
 * This class provides Data Access methods for Category objects
 * 
 * @author Laurent Payen
 *
 */
public final class CategoryDAO implements ICategoryDAO
{

    private static final String SQL_QUERY_INSERT = "INSERT INTO appointment_category ( label, nb_max_appointments_per_user) VALUES (?, ?)";
    private static final String SQL_QUERY_UPDATE = "UPDATE appointment_category SET label = ?, nb_max_appointments_per_user = ? WHERE id_category = ?";
    private static final String SQL_QUERY_DELETE = "DELETE FROM appointment_category WHERE id_category = ?";
    private static final String SQL_QUERY_SELECT_COLUMNS = "SELECT id_category, label, nb_max_appointments_per_user FROM appointment_category";
    private static final String SQL_QUERY_SELECT_ALL = SQL_QUERY_SELECT_COLUMNS;
    private static final String SQL_QUERY_SELECT = SQL_QUERY_SELECT_COLUMNS + " WHERE id_category = ?";
    private static final String SQL_QUERY_SELECT_BY_LABEL = SQL_QUERY_SELECT_COLUMNS + " WHERE label = ?";

    @Override
    public void insert( Category category, Plugin plugin )
    {
        try ( DAOUtil daoUtil = buildDaoUtil( SQL_QUERY_INSERT, category, plugin, true ) )
        {
            daoUtil.executeUpdate( );
            if ( daoUtil.nextGeneratedKey( ) )
            {
                category.setIdCategory( daoUtil.getGeneratedKeyInt( 1 ) );
            }
        }
    }

    @Override
    public void update( Category category, Plugin plugin )
    {
        try ( DAOUtil daoUtil = buildDaoUtil( SQL_QUERY_UPDATE, category, plugin, false ) )
        {
            daoUtil.executeUpdate( );
        }
    }

    @Override
    public void delete( int nIdCategory, Plugin plugin )
    {
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE, plugin ) )
        {
            daoUtil.setInt( 1, nIdCategory );
            daoUtil.executeUpdate( );
        }
    }

    @Override
    public Category select( int nIdCategory, Plugin plugin )
    {
        Category category = null;
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT, plugin ) )
        {
            daoUtil.setInt( 1, nIdCategory );
            daoUtil.executeQuery( );
            if ( daoUtil.next( ) )
            {
                category = buildCategory( daoUtil );
            }
        }
        return category;
    }

    @Override
    public List<Category> findAllCategories( Plugin plugin )
    {
        List<Category> listCategory = new ArrayList<>( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_ALL, plugin ) )
        {
            daoUtil.executeQuery( );
            while ( daoUtil.next( ) )
            {
                listCategory.add( buildCategory( daoUtil ) );
            }
        }
        return listCategory;
    }

    @Override
    public Category findByLabel( String strLabel, Plugin plugin )
    {
        Category category = null;
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_LABEL, plugin ) )
        {
            daoUtil.setString( 1, strLabel );
            daoUtil.executeQuery( );
            if ( daoUtil.next( ) )
            {
                category = buildCategory( daoUtil );
            }
        }
        return category;
    }

    /**
     * Build a Category business object from the resultset
     * 
     * @param daoUtil
     *            the prepare statement util object
     * @return a new display business object with all its attributes assigned
     */
    private Category buildCategory( DAOUtil daoUtil )
    {
        int nIndex = 0;
        Category category = new Category( );
        category.setIdCategory( daoUtil.getInt( ++nIndex ) );
        category.setLabel( daoUtil.getString( ++nIndex ) );
        category.setNbMaxAppointmentsPerUser( daoUtil.getInt( ++nIndex ) );

        return category;
    }

    /**
     * Build a daoUtil object with the display business object for insert query
     * 
     * @param query
     *            the query
     * @param category
     *            the category
     * @param plugin
     *            the plugin
     * @param isInsert
     *            true if it is an insert query (in this case, need to set the id). If false, it is an update, in this case, there is a where parameter id to
     *            set
     * @return a new daoUtil with all its values assigned
     */
    private DAOUtil buildDaoUtil( String query, Category category, Plugin plugin, boolean isInsert )
    {
        int nIndex = 1;
        DAOUtil daoUtil = null;

        if ( isInsert )
        {
            daoUtil = new DAOUtil( query, Statement.RETURN_GENERATED_KEYS, plugin );
        }
        else
        {
            daoUtil = new DAOUtil( query, plugin );
        }

        daoUtil.setString( nIndex++, category.getLabel( ) );
        daoUtil.setInt( nIndex++, category.getNbMaxAppointmentsPerUser( ) );

        if ( !isInsert )
        {
            daoUtil.setInt( nIndex, category.getIdCategory( ) );
        }
        return daoUtil;
    }
}