View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of 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.portal.business.datastore;
35  
36  import java.util.List;
37  
38  /**
39   * This class provides instances management methods (create, find, ...) for Entity objects
40   */
41  public final class DataEntityHome
42  {
43      // Static variable pointed at the DAO instance
44      private static IDataEntityDAO _dao = new DataEntityDAO( );
45  
46      /**
47       * Private constructor - this class need not be instantiated
48       */
49      private DataEntityHome( )
50      {
51      }
52  
53      /**
54       * Create an instance of the entity class
55       * 
56       * @param entity
57       *            The instance of the Entity which contains the informations to store
58       * @return The instance of entity which has been created with its primary key.
59       */
60      public static DataEntity/../../../../../fr/paris/lutece/portal/business/datastore/DataEntity.html#DataEntity">DataEntity create( DataEntity entity )
61      {
62          _dao.insert( entity );
63  
64          return entity;
65      }
66  
67      /**
68       * Update of the entity data specified in parameter
69       * 
70       * @param entity
71       *            The instance of the Entity which contains the data to store
72       * @return The instance of the entity which has been updated
73       */
74      public static DataEntity/../../../../../fr/paris/lutece/portal/business/datastore/DataEntity.html#DataEntity">DataEntity update( DataEntity entity )
75      {
76          _dao.store( entity );
77  
78          return entity;
79      }
80  
81      /**
82       * Remove the entity whose identifier is specified in parameter
83       * 
84       * @param strKey
85       *            The entity Id
86       */
87      public static void remove( String strKey )
88      {
89          _dao.delete( strKey );
90      }
91  
92      // /////////////////////////////////////////////////////////////////////////
93      // Finders
94  
95      /**
96       * Returns an instance of a entity whose identifier is specified in parameter
97       * 
98       * @param strKey
99       *            The entity primary key
100      * @return an instance of Entity
101      */
102     public static DataEntity findByPrimaryKey( String strKey )
103     {
104         return _dao.load( strKey );
105     }
106 
107     /**
108      * Load the data of all the entity objects and returns them in form of a collection
109      * 
110      * @return the list which contains the data of all the entity objects
111      */
112     public static List<DataEntity> findAll( )
113     {
114         return _dao.selectEntitiesList( );
115     }
116 }