org.cafesip.gwtcomp.server
Interface LiveDataSource

All Known Implementing Classes:

SimpleLiveDataSource

public interface LiveDataSource

This interface must be implemented by the "data source" class that provides data to one or more LiveDataPanel objects for your GWT application. The methods in this class are invoked by the LiveDataServiceImpl servlet during initial data fetch and subsequently when a refresh request is received from the client-side.

Method Summary

ChartInitData	getChartInfoAndInitialData(java.security.Principal user, javax.servlet.http.HttpSession session, java.lang.String identifier, java.lang.String instance, java.lang.String param) This method is invoked by the LiveDataServiceImpl servlet when the chart is intialized at the client-side.
ChartData[]	getNextData(java.security.Principal user, javax.servlet.http.HttpSession session, java.lang.String identifier, java.lang.String instance, java.lang.String param) This method is invoked by the LiveDataServiceImpl servlet periodically to retrieve data that is used to refresh the live data panel.

Method Detail

getChartInfoAndInitialData

ChartInitData getChartInfoAndInitialData(java.security.Principal user,
                                         javax.servlet.http.HttpSession session,
                                         java.lang.String identifier,
                                         java.lang.String instance,
                                         java.lang.String param)

This method is invoked by the LiveDataServiceImpl servlet when the chart is intialized at the client-side. The method must return a ChartInitData object that specifies the property of the chart and the initial data. The client-side of the application displays the chart and the data accordingly.

Parameters:

user - the user who is displaying the live data panel. The parameter has a null value of the user has not been authenticated by the servlet container.

session - the HTTPSession object is passed so that you application can use session-scope variables to maintain states.

identifier - the chart identifier (see LiveDataPanel for details.

instance - the chart instance (see LiveDataPanel for details.

param - the chart param (see LiveDataPanel for details.

Returns:

the ChartInitData object

getNextData

ChartData[] getNextData(java.security.Principal user,
                        javax.servlet.http.HttpSession session,
                        java.lang.String identifier,
                        java.lang.String instance,
                        java.lang.String param)

This method is invoked by the LiveDataServiceImpl servlet periodically to retrieve data that is used to refresh the live data panel. The method returns the ChartData object that contains the data.

Parameters:

user - the user who is displaying the live data panel. The parameter has a null value of the user has not been authenticated by the servlet container.

session - the HTTPSession object is passed so that you application can use session-scope variables to maintain states.

identifier - the chart identifier (see LiveDataPanel for details.

instance - the chart instance (see LiveDataPanel for details.

param - the chart param (see LiveDataPanel for details.

Returns:

the chart data