AttributeFieldDAO.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.portal.business.user.attribute;
- import fr.paris.lutece.portal.service.util.AppLogService;
- import fr.paris.lutece.util.sql.DAOUtil;
- import java.sql.Statement;
- import java.util.ArrayList;
- import java.util.List;
- /**
- *
- * AttributeFieldDAO
- *
- */
- public class AttributeFieldDAO implements IAttributeFieldDAO
- {
- // NEW POSITION
- private static final String SQL_QUERY_NEW_POSITION = "SELECT MAX(field_position)" + " FROM core_attribute_field ";
- // SELECT
- private static final String SQL_QUERY_SELECT = " SELECT id_field, id_attribute, title, DEFAULT_value, is_DEFAULT_value, height, width, max_size_enter, is_multiple, field_position "
- + " FROM core_attribute_field WHERE id_field = ? ";
- private static final String SQL_QUERY_SELECT_ATTRIBUTE_BY_ID_FIELD = " SELECT a.type_class_name, a.id_attribute, a.title, a.help_message, a.is_mandatory, a.attribute_position "
- + " FROM core_attribute a INNER JOIN core_attribute_field af ON a.id_attribute = af.id_attribute " + " WHERE af.id_field = ? ";
- private static final String SQL_QUERY_SELECT_ATTRIBUTE_FIELDS_BY_ID_ATTRIBUTE = " SELECT id_field, id_attribute, title, DEFAULT_value, is_DEFAULT_value, height, width, max_size_enter, is_multiple, field_position "
- + " FROM core_attribute_field WHERE id_attribute = ? ORDER BY field_position ";
- // INSERT
- private static final String SQL_QUERY_INSERT = " INSERT INTO core_attribute_field (id_attribute, title, DEFAULT_value, is_DEFAULT_value, height, width, max_size_enter, is_multiple, field_position) "
- + " VALUES(?,?,?,?,?,?,?,?,?) ";
- // UPDATE
- private static final String SQL_QUERY_UPDATE = " UPDATE core_attribute_field SET title = ?, DEFAULT_value = ?, is_DEFAULT_value = ?, height = ?, width = ?, max_size_enter = ?, is_multiple = ?, field_position = ? "
- + " WHERE id_field = ? ";
- // DELETE
- private static final String SQL_QUERY_DELETE = " DELETE FROM core_attribute_field WHERE id_field = ? ";
- private static final String SQL_QUERY_DELETE_BY_ID_ATTRIBUTE = " DELETE FROM core_attribute_field WHERE id_attribute = ? ";
- /**
- * Generates a new field position
- *
- * @return the new entry position
- */
- private int newPosition( )
- {
- int nPos;
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_NEW_POSITION ) )
- {
- daoUtil.executeQuery( );
- if ( !daoUtil.next( ) )
- {
- // if the table is empty
- nPos = 1;
- }
- nPos = daoUtil.getInt( 1 ) + 1;
- }
- return nPos;
- }
- /**
- * Load attribute field
- *
- * @param nIdField
- * ID Field
- * @return Attribute Field
- */
- @Override
- public AttributeField load( int nIdField )
- {
- AttributeField attributeField = null;
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT ) )
- {
- daoUtil.setInt( 1, nIdField );
- daoUtil.executeQuery( );
- if ( daoUtil.next( ) )
- {
- attributeField = new AttributeField( );
- attributeField.setIdField( daoUtil.getInt( 1 ) );
- IAttribute attribute = selectAttributeByIdField( nIdField );
- attributeField.setAttribute( attribute );
- attributeField.setTitle( daoUtil.getString( 3 ) );
- attributeField.setValue( daoUtil.getString( 4 ) );
- attributeField.setDefaultValue( daoUtil.getBoolean( 5 ) );
- attributeField.setHeight( daoUtil.getInt( 6 ) );
- attributeField.setWidth( daoUtil.getInt( 7 ) );
- attributeField.setMaxSizeEnter( daoUtil.getInt( 8 ) );
- attributeField.setMultiple( daoUtil.getBoolean( 9 ) );
- attributeField.setPosition( daoUtil.getInt( 10 ) );
- }
- }
- return attributeField;
- }
- /**
- * Select attribute by id field
- *
- * @param nIdField
- * id field
- * @return user attribute
- */
- @Override
- public IAttribute selectAttributeByIdField( int nIdField )
- {
- IAttribute attribute = null;
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_ATTRIBUTE_BY_ID_FIELD ) )
- {
- daoUtil.setInt( 1, nIdField );
- daoUtil.executeQuery( );
- if ( daoUtil.next( ) )
- {
- try
- {
- attribute = (IAttribute) Class.forName( daoUtil.getString( 1 ) ).newInstance( );
- }
- catch( IllegalAccessException | InstantiationException | ClassNotFoundException e )
- {
- AppLogService.error( e.getMessage( ), e );
- }
- if ( attribute != null )
- {
- attribute.setIdAttribute( daoUtil.getInt( 2 ) );
- attribute.setTitle( daoUtil.getString( 3 ) );
- attribute.setHelpMessage( daoUtil.getString( 4 ) );
- attribute.setMandatory( daoUtil.getBoolean( 5 ) );
- attribute.setPosition( daoUtil.getInt( 6 ) );
- }
- }
- }
- return attribute;
- }
- /**
- * Load the lists of attribute field associated to an attribute
- *
- * @param nIdAttribute
- * the ID attribute
- * @return the list of attribute fields
- */
- @Override
- public List<AttributeField> selectAttributeFieldsByIdAttribute( int nIdAttribute )
- {
- List<AttributeField> listAttributeFields = new ArrayList<>( );
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_ATTRIBUTE_FIELDS_BY_ID_ATTRIBUTE ) )
- {
- daoUtil.setInt( 1, nIdAttribute );
- daoUtil.executeQuery( );
- while ( daoUtil.next( ) )
- {
- AttributeField attributeField = new AttributeField( );
- attributeField.setIdField( daoUtil.getInt( 1 ) );
- IAttribute attribute = selectAttributeByIdField( attributeField.getIdField( ) );
- attributeField.setAttribute( attribute );
- attributeField.setTitle( daoUtil.getString( 3 ) );
- attributeField.setValue( daoUtil.getString( 4 ) );
- attributeField.setDefaultValue( daoUtil.getBoolean( 5 ) );
- attributeField.setHeight( daoUtil.getInt( 6 ) );
- attributeField.setWidth( daoUtil.getInt( 7 ) );
- attributeField.setMaxSizeEnter( daoUtil.getInt( 8 ) );
- attributeField.setMultiple( daoUtil.getBoolean( 9 ) );
- attributeField.setPosition( daoUtil.getInt( 10 ) );
- listAttributeFields.add( attributeField );
- }
- }
- return listAttributeFields;
- }
- /**
- * Insert a new attribute field
- *
- * @param attributeField
- * the attribute field
- * @return new PK
- */
- @Override
- public int insert( AttributeField attributeField )
- {
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT, Statement.RETURN_GENERATED_KEYS ) )
- {
- int nIndex = 1;
- daoUtil.setInt( nIndex++, attributeField.getAttribute( ).getIdAttribute( ) );
- daoUtil.setString( nIndex++, attributeField.getTitle( ) );
- daoUtil.setString( nIndex++, attributeField.getValue( ) );
- daoUtil.setBoolean( nIndex++, attributeField.isDefaultValue( ) );
- daoUtil.setInt( nIndex++, attributeField.getHeight( ) );
- daoUtil.setInt( nIndex++, attributeField.getWidth( ) );
- daoUtil.setInt( nIndex++, attributeField.getMaxSizeEnter( ) );
- daoUtil.setBoolean( nIndex++, attributeField.isMultiple( ) );
- daoUtil.setInt( nIndex, newPosition( ) );
- daoUtil.executeUpdate( );
- if ( daoUtil.nextGeneratedKey( ) )
- {
- attributeField.setIdField( daoUtil.getGeneratedKeyInt( 1 ) );
- }
- }
- return attributeField.getIdField( );
- }
- /**
- * Update an attribute field
- *
- * @param attributeField
- * the attribute field
- */
- @Override
- public void store( AttributeField attributeField )
- {
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE ) )
- {
- daoUtil.setString( 1, attributeField.getTitle( ) );
- daoUtil.setString( 2, attributeField.getValue( ) );
- daoUtil.setBoolean( 3, attributeField.isDefaultValue( ) );
- daoUtil.setInt( 4, attributeField.getHeight( ) );
- daoUtil.setInt( 5, attributeField.getWidth( ) );
- daoUtil.setInt( 6, attributeField.getMaxSizeEnter( ) );
- daoUtil.setBoolean( 7, attributeField.isMultiple( ) );
- daoUtil.setInt( 8, attributeField.getPosition( ) );
- daoUtil.setInt( 9, attributeField.getIdField( ) );
- daoUtil.executeUpdate( );
- }
- }
- /**
- * Delete an attribute field
- *
- * @param nIdField
- * The id field
- */
- @Override
- public void delete( int nIdField )
- {
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE ) )
- {
- daoUtil.setInt( 1, nIdField );
- daoUtil.executeUpdate( );
- }
- }
- /**
- * Delete all attribute field from an attribute id
- *
- * @param nIdAttribute
- * the ID attribute
- */
- @Override
- public void deleteAttributeFieldsFromIdAttribute( int nIdAttribute )
- {
- try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE_BY_ID_ATTRIBUTE ) )
- {
- daoUtil.setInt( 1, nIdAttribute );
- daoUtil.executeUpdate( );
- }
- }
- }