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