View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.folderlisting.business.portlet;
35  
36  import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
37  import fr.paris.lutece.portal.business.portlet.Portlet;
38  import fr.paris.lutece.util.sql.DAOUtil;
39  
40  
41  /**
42   * this class provides Data Access methods for FolderListingPortlet objects
43   */
44  public final class FolderListingPortletDAO implements IFolderListingPortletDAO
45  {
46      ////////////////////////////////////////////////////////////////////////////
47      // Constants
48      private static final String SQL_QUERY_SELECT = "SELECT id_portlet, code_folder FROM folderlisting_portlet WHERE id_portlet = ? ";
49      private static final String SQL_QUERY_INSERT = "INSERT INTO folderlisting_portlet ( id_portlet, code_folder ) VALUES ( ?, ? )";
50      private static final String SQL_QUERY_DELETE = "DELETE FROM folderlisting_portlet WHERE id_portlet = ? ";
51      private static final String SQL_QUERY_UPDATE = "UPDATE folderlisting_portlet SET id_portlet = ?, code_folder = ? WHERE id_portlet = ? ";
52      private static final String SQL_QUERY_CHECK = "SELECT code_folder FROM folderlisting_portlet WHERE code_folder = ? ";
53  
54      ///////////////////////////////////////////////////////////////////////////////////////
55      // Access methods to data
56  
57      /**
58       * Delete record from table
59       *
60       * @param nPortletId The indentifier of the Portlet
61       */
62      public void delete( int nPortletId )
63      {
64          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE );
65          daoUtil.setInt( 1, nPortletId );
66          daoUtil.executeUpdate(  );
67          daoUtil.free(  );
68      }
69  
70      /**
71       * Insert a new record in the table.
72       *
73       * @param portlet The Instance of the Portlet
74       */
75      public void insert( Portlet portlet )
76      {
77          FolderListingPortlet p = (FolderListingPortlet) portlet;
78          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT );
79          daoUtil.setInt( 1, p.getId(  ) );
80          daoUtil.setString( 2, p.getRootFolderId(  ) );
81          daoUtil.executeUpdate(  );
82          daoUtil.free(  );
83      }
84  
85      /**
86       * load the data of FolderListingPortlet from the table
87       *
88       * @param nIdPortlet The indentifier of the  portlet
89       *
90       * @return portlet The instance of the object portlet
91       */
92      public Portlet load( int nIdPortlet )
93      {
94          FolderListingPortlet portlet = new FolderListingPortlet(  );
95          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT );
96          daoUtil.setInt( 1, nIdPortlet );
97          daoUtil.executeQuery(  );
98  
99          if ( daoUtil.next(  ) )
100         {
101             portlet.setId( daoUtil.getInt( 1 ) );
102 
103             portlet.setRootFolderId( daoUtil.getString( 2 ) );
104         }
105 
106         daoUtil.free(  );
107 
108         return portlet;
109     }
110 
111     /**
112      * Update the record in the table
113      *
114      * @param portlet The reference of the portlet
115      */
116     public void store( Portlet portlet )
117     {
118         FolderListingPortlet p = (FolderListingPortlet) portlet;
119         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE );
120         daoUtil.setInt( 1, p.getId(  ) );
121 
122         daoUtil.setString( 2, p.getRootFolderId(  ) );
123         daoUtil.setInt( 3, p.getId(  ) );
124 
125         daoUtil.executeUpdate(  );
126         daoUtil.free(  );
127     }
128 
129     /**
130      * Checks whether the folder is registered in a Portlet
131      * @param nIdFolder The identifier of the Folder
132      * @return The boolean result
133      */
134     public boolean checkNoFolderInPortlet( int nIdFolder )
135     {
136         boolean bValue = true;
137         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_CHECK );
138         daoUtil.setInt( 1, nIdFolder );
139         daoUtil.executeQuery(  );
140 
141         if ( daoUtil.next(  ) )
142         {
143             bValue = false;
144         }
145 
146         daoUtil.free(  );
147 
148         return bValue;
149     }
150 }