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.portal.business.dashboard;
35  
36  import fr.paris.lutece.portal.service.dashboard.admin.IAdminDashboardComponent;
37  import fr.paris.lutece.portal.service.util.AppLogService;
38  
39  import java.util.ArrayList;
40  import java.util.HashMap;
41  import java.util.List;
42  import java.util.Map;
43  
44  
45  /**
46   * Factory for {@link IAdminDashboardComponent}
47   *
48   */
49  public final class AdminDashboardFactory
50  {
51      private static Map<String, IAdminDashboardComponent> _mapAdminDashboardComponents = new HashMap<String, IAdminDashboardComponent>(  );
52  
53      /**
54       * Empty constructor
55       */
56      private AdminDashboardFactory(  )
57      {
58          // nothing
59      }
60  
61      /**
62       * Registers the new component. Name must be unique
63       * @param adminDashboardComponent the component to register
64       * @return <code>true</code> if registered, <code>false</code> otherwise.
65       */
66      public static boolean registerDashboardComponent( IAdminDashboardComponent adminDashboardComponent )
67      {
68          String strName = adminDashboardComponent.getName(  );
69  
70          if ( _mapAdminDashboardComponents.containsKey( strName ) )
71          {
72              AppLogService.error( "Error while registering admin dashboard for " + strName + " class=" +
73                  adminDashboardComponent.getClass(  ) + ", factory already contains class=" +
74                  _mapAdminDashboardComponents.get( strName ) );
75  
76              return false;
77          }
78  
79          _mapAdminDashboardComponents.put( strName, adminDashboardComponent );
80  
81          return true;
82      }
83  
84      /**
85       * Gets the {@link IAdminDashboardComponent} for the given name
86       * @param strName the name
87       * @return The component found, <code>null</code> otherwise.
88       */
89      public static IAdminDashboardComponent getDashboardComponent( String strName )
90      {
91          return _mapAdminDashboardComponents.get( strName );
92      }
93  
94      /**
95       * Finds all registered admin dashboards
96       * @return the list
97       */
98      public static List<IAdminDashboardComponent> getAllAdminDashboardComponents(  )
99      {
100         return new ArrayList<IAdminDashboardComponent>( _mapAdminDashboardComponents.values(  ) );
101     }
102 }