1 /*
2 * Copyright (c) 2002-2021, 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.plugins.grafana.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.plugin.PluginService;
38 import fr.paris.lutece.portal.service.spring.SpringContextService;
39 import fr.paris.lutece.util.ReferenceList;
40
41 import java.util.List;
42
43 /**
44 * This class provides instances management methods (create, find, ...) for Dashboard objects
45 */
46 public final class DashboardHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IDashboardDAO _dao = SpringContextService.getBean( "grafana.dashboardDAO" );
50 private static Plugin _plugin = PluginService.getPlugin( "grafana" );
51
52 /**
53 * Private constructor - this class need not be instantiated
54 */
55 private DashboardHome( )
56 {
57 }
58
59 /**
60 * Create an instance of the dashboard class
61 *
62 * @param dashboard
63 * The instance of the Dashboard which contains the informations to store
64 * @return The instance of dashboard which has been created with its primary key.
65 */
66 public static Dashboard./../../../../../fr/paris/lutece/plugins/grafana/business/Dashboard.html#Dashboard">Dashboard create( Dashboard dashboard )
67 {
68 _dao.insert( dashboard, _plugin );
69
70 return dashboard;
71 }
72
73 /**
74 * Returns an instance of a dashboard whose identifier is specified in parameter
75 *
76 * @param nKey
77 * The dashboard primary key
78 * @return an instance of Dashboard
79 */
80 public static Dashboard findByPrimaryKey( int nKey )
81 {
82 return _dao.load( nKey, _plugin );
83 }
84
85 /**
86 * Load the data of all the dashboard objects and returns them as a list
87 *
88 * @return the list which contains the data of all the dashboard objects
89 */
90 public static List<Dashboard> getDashboardsList( )
91 {
92 return _dao.selectDashboardsList( _plugin );
93 }
94
95 /**
96 * Load the id of all the dashboard objects and returns them as a list
97 *
98 * @return the list which contains the id of all the dashboard objects
99 */
100 public static List<Integer> getIdDashboardsList( )
101 {
102 return _dao.selectIdDashboardsList( _plugin );
103 }
104
105 /**
106 * Load the data of all the dashboard objects and returns them as a referenceList
107 *
108 * @return the referenceList which contains the data of all the dashboard objects
109 */
110 public static ReferenceList getDashboardsReferenceList( )
111 {
112 return _dao.selectDashboardsReferenceList( _plugin );
113 }
114
115 /**
116 * Delete the given dashboard
117 *
118 * @param nIdDashboard
119 * The dashboard id
120 */
121 public static void delete( int nIdDashboard )
122 {
123 _dao.delete( nIdDashboard, _plugin );
124 }
125
126 /**
127 * Delete all grafanas dashboards
128 */
129
130 public static void deleteAllGrafanaDasboards( )
131 {
132 _dao.deleteAll( _plugin );
133 }
134
135 /**
136 * Create or update given dashboard
137 *
138 * @param dashboard
139 * @return the created or updated dashboard
140 */
141 public static Dashboard../../../fr/paris/lutece/plugins/grafana/business/Dashboard.html#Dashboard">Dashboard createOrUpdate( Dashboard dashboard )
142 {
143 if ( _dao.isDashboardExists( dashboard, _plugin ) )
144 {
145 _dao.store( dashboard, _plugin );
146 }
147 else
148 {
149 _dao.insert( dashboard, _plugin );
150 }
151 return dashboard;
152 }
153
154 /**
155 * Find Grafana dashboard with given grafana dashboard id
156 *
157 * @param strIdGrafana
158 * @return the dashboard found
159 */
160 public static Dashboard findByGrafanaId( String strIdGrafana )
161 {
162 return _dao.loadByGrafanaId( strIdGrafana, _plugin );
163 }
164 }