fr.paris.lutece.portal.service.dashboard
Class DashboardService

java.lang.Object
  extended by fr.paris.lutece.portal.service.dashboard.DashboardService

public final class DashboardService
extends Object

Dashboard Service


Method Summary
 void doMoveDashboard(IDashboardComponent dashboard, int nOldColumn, int nOldOrder, boolean bCreate)
          Moves the dashboard.
 void doReorderColumn(int nColumn)
          Reorders column's dashboard
 List<IDashboardComponent> getAllDashboardComponents()
          All known dashboards as declared in SpringContext
 Map<String,List<IDashboardComponent>> getAllSetDashboards(AdminUser user)
          Finds all dashboard with column and order set.
 int getColumnCount()
          Returns the column count, with PROPERTY_COLUMN_COUNT.
 List<IDashboardComponent> getDashboardComponents(int nColumn)
           
 String getDashboardData(AdminUser user, int nZone, javax.servlet.http.HttpServletRequest request)
          Gets Data from all components of the zone
 String getDashboardData(List<IDashboardComponent> listDashboards, AdminUser user, int nZone, javax.servlet.http.HttpServletRequest request)
          Gets Data from all components of the zone
 List<IDashboardComponent> getDashboards(AdminUser user, javax.servlet.http.HttpServletRequest request)
          Get the list of dashboard from plugins
static DashboardService getInstance()
          Return the unique instance
 ReferenceList getListAvailableColumns()
          Returns list with available column
 ReferenceList getListAvailableOrders(int nColumn)
          Orders reference list for the given column
 Map<String,ReferenceList> getMapAvailableOrders()
          Builds all refList order for all columns
 List<IDashboardComponent> getNotSetDashboards()
          Returns all dashboards with no column/order set
 Map<String,Boolean> getOrderedColumnsStatus()
          Builds the map to with column id as key, and true as value if column is well ordered, false otherwise.
 void registerDashboardComponent(DashboardComponentEntry entry, Plugin plugin)
          Register a Dashboard Component
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static DashboardService getInstance()
Return the unique instance

Returns:
The instance

getColumnCount

public int getColumnCount()
Returns the column count, with PROPERTY_COLUMN_COUNT. Default is CONSTANTE_DEFAULT_COLUMN_COUNT

Returns:
the column count

getAllDashboardComponents

public List<IDashboardComponent> getAllDashboardComponents()
All known dashboards as declared in SpringContext

Returns:
dashboards list

getDashboardComponents

public List<IDashboardComponent> getDashboardComponents(int nColumn)
Parameters:
nColumn - the column id
Returns:
all dashboards for this column

registerDashboardComponent

public void registerDashboardComponent(DashboardComponentEntry entry,
                                       Plugin plugin)
Register a Dashboard Component

Parameters:
entry - The DashboardComponent entry defined in the plugin's XML file
plugin - The plugin

doMoveDashboard

public void doMoveDashboard(IDashboardComponent dashboard,
                            int nOldColumn,
                            int nOldOrder,
                            boolean bCreate)
Moves the dashboard.

Parameters:
dashboard - to move, with new values
nOldColumn - previous column id
nOldOrder - previous order
bCreate - true if this is a new dashboard, false otherwise.

getNotSetDashboards

public List<IDashboardComponent> getNotSetDashboards()
Returns all dashboards with no column/order set

Returns:
all dashboards with no column/order set

getAllSetDashboards

public Map<String,List<IDashboardComponent>> getAllSetDashboards(AdminUser user)
Finds all dashboard with column and order set.

Parameters:
user - the current user
Returns:
a map where key is the column id, and value is the column's dashboard list.

getDashboardData

public String getDashboardData(AdminUser user,
                               int nZone,
                               javax.servlet.http.HttpServletRequest request)
Gets Data from all components of the zone

Parameters:
user - The user
nZone - The dasboard zone
request - HttpServletRequest
Returns:
Data of all components of the zone

getDashboards

public List<IDashboardComponent> getDashboards(AdminUser user,
                                               javax.servlet.http.HttpServletRequest request)
Get the list of dashboard from plugins

Parameters:
user - the current user
request - HttpServletRequest
Returns:
the list of dashboards

getDashboardData

public String getDashboardData(List<IDashboardComponent> listDashboards,
                               AdminUser user,
                               int nZone,
                               javax.servlet.http.HttpServletRequest request)
Gets Data from all components of the zone

Parameters:
listDashboards - the list of dashboards
user - The user
nZone - The dasboard zone
request - HttpServletRequest
Returns:
Data of all components of the zone

doReorderColumn

public void doReorderColumn(int nColumn)
Reorders column's dashboard

Parameters:
nColumn - the column to reorder

getOrderedColumnsStatus

public Map<String,Boolean> getOrderedColumnsStatus()
Builds the map to with column id as key, and true as value if column is well ordered, false otherwise.

Returns:
the map

getListAvailableColumns

public ReferenceList getListAvailableColumns()
Returns list with available column

Returns:
all available columns

getMapAvailableOrders

public Map<String,ReferenceList> getMapAvailableOrders()
Builds all refList order for all columns

Returns:
the map with column id as key

getListAvailableOrders

public ReferenceList getListAvailableOrders(int nColumn)
Orders reference list for the given column

Parameters:
nColumn - column
Returns:
the refList


Copyright © 2014 Mairie de Paris. All Rights Reserved.