CityDAO.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.geocodes.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 City objects
*/
public final class CityDAO implements ICityDAO
{
// Constants
private static final String SQL_QUERY_SELECT_BY_ID = "SELECT id_city, code_country, code, value, code_zone FROM geocodes_city WHERE id_city = ?";
private static final String SQL_QUERY_SELECT_BY_CODE = "SELECT id_city, code_country, code, value, code_zone FROM geocodes_city WHERE code = ? ";
private static final String SQL_QUERY_SELECT_BY_VALUE = "SELECT id_city, code_country, code, value, code_zone FROM geocodes_city WHERE value like ? order by value ";
private static final String SQL_QUERY_INSERT = "INSERT INTO geocodes_city ( code_country, code, value, code_zone ) VALUES ( ?, ?, ?, ? ) ";
private static final String SQL_QUERY_DELETE = "DELETE FROM geocodes_city WHERE id_city = ? ";
private static final String SQL_QUERY_UPDATE = "UPDATE geocodes_city SET code_country = ?, code = ?, value = ?, code_zone = ? WHERE id_city = ?";
private static final String SQL_QUERY_SELECTALL = "SELECT id_city, code_country, code, value, code_zone FROM geocodes_city";
private static final String SQL_QUERY_SELECTALL_ID = "SELECT id_city FROM geocodes_city";
private static final String SQL_QUERY_SELECTALL_BY_IDS = "SELECT id_city, code_country, code, value, code_zone FROM geocodes_city WHERE id_city IN ( ";
/**
* {@inheritDoc }
*/
@Override
public void insert( City city, Plugin plugin )
{
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT, Statement.RETURN_GENERATED_KEYS, plugin ) )
{
int nIndex = 1;
daoUtil.setString( nIndex++ , city.getCodeCountry( ) );
daoUtil.setString( nIndex++ , city.getCode( ) );
daoUtil.setString( nIndex++ , city.getValue( ) );
daoUtil.setString( nIndex++ , city.getCodeZone( ) );
daoUtil.executeUpdate( );
if ( daoUtil.nextGeneratedKey( ) )
{
city.setId( daoUtil.getGeneratedKeyInt( 1 ) );
}
}
}
/**
* {@inheritDoc }
*/
@Override
public Optional<City> load( int nKey, Plugin plugin )
{
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_ID, plugin ) )
{
daoUtil.setInt( 1 , nKey );
daoUtil.executeQuery( );
City city = null;
if ( daoUtil.next( ) )
{
city = new City();
int nIndex = 1;
city.setId( daoUtil.getInt( nIndex++ ) );
city.setCodeCountry( daoUtil.getString( nIndex++ ) );
city.setCode( daoUtil.getString( nIndex++ ) );
city.setValue( daoUtil.getString( nIndex++ ) );
city.setCodeZone( daoUtil.getString( nIndex ) );
}
return Optional.ofNullable( city );
}
}
/**
* {@inheritDoc }
*/
@Override
public Optional<City> loadByCode( String strCode, Plugin plugin )
{
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_CODE, plugin ) )
{
daoUtil.setString( 1 , strCode );
daoUtil.executeQuery( );
City city = null;
if ( daoUtil.next( ) )
{
city = new City();
int nIndex = 1;
city.setId( daoUtil.getInt( nIndex++ ) );
city.setCodeCountry( daoUtil.getString( nIndex++ ) );
city.setCode( daoUtil.getString( nIndex++ ) );
city.setValue( daoUtil.getString( nIndex++ ) );
city.setCodeZone( daoUtil.getString( nIndex ) );
}
return Optional.ofNullable( city );
}
}
/**
* {@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( City city, Plugin plugin )
{
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE, plugin ) )
{
int nIndex = 1;
daoUtil.setString( nIndex++ , city.getCodeCountry( ) );
daoUtil.setString( nIndex++ , city.getCode( ) );
daoUtil.setString( nIndex++ , city.getValue( ) );
daoUtil.setString( nIndex++ , city.getCodeZone( ) );
daoUtil.setInt( nIndex , city.getId( ) );
daoUtil.executeUpdate( );
}
}
/**
* {@inheritDoc }
*/
@Override
public List<City> selectCitiesList( Plugin plugin )
{
List<City> cityList = new ArrayList<>( );
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
{
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
City city = new City( );
int nIndex = 1;
city.setId( daoUtil.getInt( nIndex++ ) );
city.setCodeCountry( daoUtil.getString( nIndex++ ) );
city.setCode( daoUtil.getString( nIndex++ ) );
city.setValue( daoUtil.getString( nIndex++ ) );
city.setCodeZone( daoUtil.getString( nIndex ) );
cityList.add( city );
}
return cityList;
}
}
/**
* {@inheritDoc }
*/
@Override
public List<City> selectCitiesListByValue( String strVal, Plugin plugin )
{
List<City> cityList = new ArrayList<>( );
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_VALUE, plugin ) )
{
daoUtil.setString( 1 , strVal + "%" );
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
City city = new City( );
int nIndex = 1;
city.setId( daoUtil.getInt( nIndex++ ) );
city.setCodeCountry( daoUtil.getString( nIndex++ ) );
city.setCode( daoUtil.getString( nIndex++ ) );
city.setValue( daoUtil.getString( nIndex++ ) );
city.setCodeZone( daoUtil.getString( nIndex ) );
cityList.add( city );
}
return cityList;
}
}
/**
* {@inheritDoc }
*/
@Override
public List<Integer> selectIdCitiesList( Plugin plugin )
{
List<Integer> cityList = new ArrayList<>( );
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL_ID, plugin ) )
{
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
cityList.add( daoUtil.getInt( 1 ) );
}
return cityList;
}
}
/**
* {@inheritDoc }
*/
@Override
public ReferenceList selectCitiesReferenceList( Plugin plugin )
{
ReferenceList cityList = new ReferenceList();
try( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
{
daoUtil.executeQuery( );
while ( daoUtil.next( ) )
{
cityList.addItem( daoUtil.getInt( 1 ) , daoUtil.getString( 2 ) );
}
return cityList;
}
}
/**
* {@inheritDoc }
*/
@Override
public List<City> selectCitiesListByIds( Plugin plugin, List<Integer> listIds ) {
List<City> cityList = 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( ) )
{
City city = new City( );
int nIndex = 1;
city.setId( daoUtil.getInt( nIndex++ ) );
city.setCodeCountry( daoUtil.getString( nIndex++ ) );
city.setCode( daoUtil.getString( nIndex++ ) );
city.setValue( daoUtil.getString( nIndex++ ) );
city.setCodeZone( daoUtil.getString( nIndex ) );
cityList.add( city );
}
daoUtil.free( );
}
}
return cityList;
}
}