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.formengine.business.parameter;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.util.ReferenceItem;
38  import fr.paris.lutece.util.ReferenceList;
39  import fr.paris.lutece.util.sql.DAOUtil;
40  
41  
42  /**
43   *
44   * FormEngineParameterDAO
45   *
46   */
47  public class FormEngineParameterDAO implements IFormEngineParameterDAO
48  {
49      private static final String TRUE = "1";
50      private static final String SQL_QUERY_SELECT = " SELECT parameter_value FROM formengine_formengine_parameter WHERE parameter_key = ? ";
51      private static final String SQL_QUERY_UPDATE = " UPDATE formengine_formengine_parameter SET parameter_value = ? WHERE parameter_key = ? ";
52      private static final String SQL_QUERY_SELECT_ALL = " SELECT parameter_key, parameter_value FROM formengine_formengine_parameter ORDER BY parameter_key ASC ";
53  
54      /**
55       * Load all the default values
56       * @param plugin Plugin
57       * @return a list of ReferenceItem
58       */
59      public ReferenceList selectAll( Plugin plugin )
60      {
61          ReferenceList listParams = new ReferenceList(  );
62          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_ALL, plugin );
63          daoUtil.executeQuery(  );
64  
65          while ( daoUtil.next(  ) )
66          {
67              int nIndex = 1;
68              ReferenceItem param = new ReferenceItem(  );
69              param.setCode( daoUtil.getString( nIndex++ ) );
70              param.setName( daoUtil.getString( nIndex++ ) );
71              param.setChecked( param.getName(  ).equals( TRUE ) ? true : false );
72              listParams.add( param );
73          }
74  
75          daoUtil.free(  );
76  
77          return listParams;
78      }
79  
80      /**
81       * Load the parameter value
82       * @param strParameterKey the parameter key
83       * @param plugin {@link Plugin}
84       * @return The parameter value
85       */
86      public ReferenceItem load( String strParameterKey, Plugin plugin )
87      {
88          ReferenceItem param = null;
89          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT, plugin );
90          daoUtil.setString( 1, strParameterKey );
91          daoUtil.executeQuery(  );
92  
93          if ( daoUtil.next(  ) )
94          {
95              param = new ReferenceItem(  );
96              param.setCode( strParameterKey );
97              param.setName( daoUtil.getString( 1 ) );
98              param.setChecked( param.getName(  ).equals( TRUE ) ? true : false );
99          }
100 
101         daoUtil.free(  );
102 
103         return param;
104     }
105 
106     /**
107      * Update the parameter
108      * @param param the parameter
109      * @param plugin {@link Plugin}
110      */
111     public void store( ReferenceItem param, Plugin plugin )
112     {
113         int nIndex = 1;
114 
115         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE, plugin );
116         daoUtil.setString( nIndex++, param.getName(  ) );
117         daoUtil.setString( nIndex++, param.getCode(  ) );
118 
119         daoUtil.executeUpdate(  );
120         daoUtil.free(  );
121     }
122 }