ApplicationDAO.java

/*
 * Copyright (c) 2002-2023, 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.vault.business;

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

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

/**
 * This class provides Data Access methods for Application objects
 */
public final class ApplicationDAO implements IApplicationDAO
{
    // Constants
    private static final String SQL_QUERY_SELECT = "SELECT id_application, name, code FROM vault_application WHERE id_application = ?";
    private static final String SQL_QUERY_INSERT = "INSERT INTO vault_application ( name, code ) VALUES ( ?, ? ) ";
    private static final String SQL_QUERY_DELETE = "DELETE FROM vault_application WHERE id_application = ? ";
    private static final String SQL_QUERY_UPDATE = "UPDATE vault_application SET name = ?, code = ? WHERE id_application = ?";
    private static final String SQL_QUERY_SELECTALL = "SELECT id_application, name, code FROM vault_application";
    private static final String SQL_QUERY_SELECTALL_ID = "SELECT id_application FROM vault_application";
    private static final String SQL_QUERY_SELECTALL_BY_IDS = "SELECT id_application, name, code FROM vault_application WHERE id_application IN (  ";

    /**
     * {@inheritDoc }
     */
    @Override
    public void insert( Application application, Plugin plugin )
    {
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT, Statement.RETURN_GENERATED_KEYS, plugin ) )
        {
            int nIndex = 1;
            daoUtil.setString( nIndex++, application.getName( ) );
            daoUtil.setString( nIndex++, application.getCode( ) );

            daoUtil.executeUpdate( );
            if ( daoUtil.nextGeneratedKey( ) )
            {
                application.setId( daoUtil.getGeneratedKeyInt( 1 ) );
            }
        }

    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Optional<Application> load( int nKey, Plugin plugin )
    {
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT, plugin ) )
        {
            daoUtil.setInt( 1, nKey );
            daoUtil.executeQuery( );
            Application application = null;

            if ( daoUtil.next( ) )
            {
                application = new Application( );
                int nIndex = 1;

                application.setId( daoUtil.getInt( nIndex++ ) );
                application.setName( daoUtil.getString( nIndex++ ) );
                application.setCode( daoUtil.getString( nIndex ) );
            }

            return Optional.ofNullable( application );
        }
    }

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

    /**
     * {@inheritDoc }
     */
    @Override
    public void store( Application application, Plugin plugin )
    {
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE, plugin ) )
        {
            int nIndex = 1;

            daoUtil.setString( nIndex++, application.getName( ) );
            daoUtil.setString( nIndex++, application.getCode( ) );
            daoUtil.setInt( nIndex, application.getId( ) );

            daoUtil.executeUpdate( );
        }
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public List<Application> selectApplicationsList( Plugin plugin )
    {
        List<Application> applicationList = new ArrayList<>( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
        {
            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                Application application = new Application( );
                int nIndex = 1;

                application.setId( daoUtil.getInt( nIndex++ ) );
                application.setName( daoUtil.getString( nIndex++ ) );
                application.setCode( daoUtil.getString( nIndex ) );

                applicationList.add( application );
            }

            return applicationList;
        }
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public List<Integer> selectIdApplicationsList( Plugin plugin )
    {
        List<Integer> applicationList = new ArrayList<>( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL_ID, plugin ) )
        {
            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                applicationList.add( daoUtil.getInt( 1 ) );
            }

            return applicationList;
        }
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public ReferenceList selectApplicationsReferenceList( Plugin plugin )
    {
        ReferenceList applicationList = new ReferenceList( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
        {
            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                applicationList.addItem( daoUtil.getInt( 1 ), daoUtil.getString( 2 ) );
            }

            return applicationList;
        }
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public List<Application> selectApplicationsListByIds( Plugin plugin, List<Integer> listIds )
    {
        List<Application> applicationList = new ArrayList<>( );

        StringBuilder builder = new StringBuilder( );

        if ( !listIds.isEmpty( ) )
        {
            for ( int i = 0; i < listIds.size( ); i++ )
            {
                builder.append( "?," );
            }

            String placeHolders = builder.deleteCharAt( builder.length( ) - 1 ).toString( );
            String stmt = SQL_QUERY_SELECTALL_BY_IDS + placeHolders + ")";

            try ( DAOUtil daoUtil = new DAOUtil( stmt, plugin ) )
            {
                int index = 1;
                for ( Integer n : listIds )
                {
                    daoUtil.setInt( index++, n );
                }

                daoUtil.executeQuery( );
                while ( daoUtil.next( ) )
                {
                    Application application = new Application( );
                    int nIndex = 1;

                    application.setId( daoUtil.getInt( nIndex++ ) );
                    application.setName( daoUtil.getString( nIndex++ ) );
                    application.setCode( daoUtil.getString( nIndex ) );

                    applicationList.add( application );
                }

                daoUtil.free( );

            }
        }
        return applicationList;

    }
}