/*
    * 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.document.business;
  
  import fr.paris.lutece.util.sql.DAOUtil;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * This class provides Data Access methods for DocumentPageTemplate objects
   */
  public final class DocumentPageTemplateDAO implements IDocumentPageTemplateDAO
  {
      // Constants
      private static final String SQL_QUERY_NEW_PK = " SELECT max( id_page_template_document ) FROM document_page_template";
      private static final String SQL_QUERY_SELECT = " SELECT id_page_template_document, description, page_template_path, picture_path FROM document_page_template WHERE id_page_template_document = ?";
      private static final String SQL_QUERY_INSERT = " INSERT INTO document_page_template ( id_page_template_document, description, page_template_path, picture_path ) VALUES ( ?, ?, ?, ? )";
      private static final String SQL_QUERY_DELETE = " DELETE FROM document_page_template WHERE id_page_template_document = ?";
      private static final String SQL_QUERY_UPDATE = " UPDATE document_page_template SET id_page_template_document = ?, description = ?, page_template_path = ?, picture_path = ? "
              + " WHERE id_page_template_document = ?";
      private static final String SQL_QUERY_SELECTALL = " SELECT id_page_template_document , description, page_template_path, picture_path FROM document_page_template ORDER BY id_page_template_document ";
  
      ///////////////////////////////////////////////////////////////////////////////////////
      // Access methods to data
  
      /**
       * Generates a new primary key
       * 
       * @return The new primary key
       */
      int newPrimaryKey( )
      {
          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_NEW_PK );
          daoUtil.executeQuery( );
  
          int nKey;
  
          if ( !daoUtil.next( ) )
          {
              // if the table is empty
              nKey = 1;
          }
  
          nKey = daoUtil.getInt( 1 ) + 1;
  
          daoUtil.free( );
  
          return nKey;
      }
  
      /**
       * Insert a new record in the table.
       * 
       * @param documentPageTemplate
       *            The Instance of the object DocumentPageTemplate
       */
      public synchronized void insert( DocumentPageTemplate documentPageTemplate )
      {
          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT );
  
          documentPageTemplate.setId( newPrimaryKey( ) );
  
          daoUtil.setInt( 1, documentPageTemplate.getId( ) );
          daoUtil.setString( 2, documentPageTemplate.getDescription( ) );
          daoUtil.setString( 3, documentPageTemplate.getFile( ) );
          daoUtil.setString( 4, documentPageTemplate.getPicture( ) );
  
         daoUtil.executeUpdate( );
         daoUtil.free( );
     }
 
     /**
      * load the data of DocumentPageTemplate from the table
      *
      * @param nPageTemplateId
      *            The indentifier of the object DocumentPageTemplate
      * @return The Instance of the object PageTemplate
      */
     public DocumentPageTemplate load( int nPageTemplateId )
     {
         DocumentPageTemplate documentPageTemplate = null;
         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT );
         daoUtil.setInt( 1, nPageTemplateId );
 
         daoUtil.executeQuery( );
 
         if ( daoUtil.next( ) )
         {
             documentPageTemplate = new DocumentPageTemplate( );
             documentPageTemplate.setId( daoUtil.getInt( 1 ) );
             documentPageTemplate.setDescription( daoUtil.getString( 2 ) );
             documentPageTemplate.setFile( daoUtil.getString( 3 ) );
             documentPageTemplate.setPicture( daoUtil.getString( 4 ) );
         }
 
         daoUtil.free( );
 
         return documentPageTemplate;
     }
 
     /**
      * Delete a record from the table
      * 
      * @param nPageTemplateId
      *            The indentifier of the object PageTemplate
      */
     public void delete( int nPageTemplateId )
     {
         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE );
         daoUtil.setInt( 1, nPageTemplateId );
         daoUtil.executeUpdate( );
         daoUtil.free( );
     }
 
     /**
      * Update the record in the table
      * 
      * @param documentPageTemplate
      *            The instance of the PageTemplate to update
      */
     public void store( DocumentPageTemplate documentPageTemplate )
     {
         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE );
 
         daoUtil.setInt( 1, documentPageTemplate.getId( ) );
         daoUtil.setString( 2, documentPageTemplate.getDescription( ) );
         daoUtil.setString( 3, documentPageTemplate.getFile( ) );
         daoUtil.setString( 4, documentPageTemplate.getPicture( ) );
         daoUtil.setInt( 5, documentPageTemplate.getId( ) );
 
         daoUtil.executeUpdate( );
         daoUtil.free( );
     }
 
     /**
      * Returns a list of all the page templates
      * 
      * @return A list of PageTemplates objects
      */
     public List<DocumentPageTemplate> selectPageTemplatesList( )
     {
         List<DocumentPageTemplate> listDocumentPageTemplates = new ArrayList<DocumentPageTemplate>( );
         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL );
         daoUtil.executeQuery( );
 
         while ( daoUtil.next( ) )
         {
             DocumentPageTemplatePageTemplate.html#DocumentPageTemplate">DocumentPageTemplate documentPageTemplate = new DocumentPageTemplate( );
 
             documentPageTemplate.setId( daoUtil.getInt( 1 ) );
             documentPageTemplate.setDescription( daoUtil.getString( 2 ) );
             documentPageTemplate.setFile( daoUtil.getString( 3 ) );
             documentPageTemplate.setPicture( daoUtil.getString( 4 ) );
             listDocumentPageTemplates.add( documentPageTemplate );
         }
 
         daoUtil.free( );
 
         return listDocumentPageTemplates;
     }
 }