org.jboss.dashboard.dataset

Interface DataSetManager

public interface DataSetManager

Main interface for accessing data sets. It acts as a data set cache.

Method Summary

Methods

Modifier and Type	Method and Description
DataSet	filterDataSet(DataProvider dataProvider, DataFilter dataFilter) Apply a filter on the specified DataProvider's data set and save a reference to the resulting data set.
DataSet	getDataSet(DataProvider dataProvider) Get the current data set for the given provider.
DataSet	refreshDataSet(DataProvider dataProvider) Discard any active filter and ensure the most up to date data is loaded and returned.
void	registerDataSet(DataProvider dataProvider, DataSet dataSet) Registers the specified DataSet instance as the given DataProvider's data set.

Method Detail

getDataSet

DataSet getDataSet(DataProvider dataProvider)
                   throws Exception

Get the current data set for the given provider. The data set returned might vary depending whether there are active filters applied on the provider or not.

Throws:

Exception

registerDataSet

void registerDataSet(DataProvider dataProvider,
                   DataSet dataSet)
                     throws Exception

Registers the specified DataSet instance as the given DataProvider's data set.

Throws:

Exception

refreshDataSet

DataSet refreshDataSet(DataProvider dataProvider)
                       throws Exception

Discard any active filter and ensure the most up to date data is loaded and returned.

Throws:

Exception

filterDataSet

DataSet filterDataSet(DataProvider dataProvider,
                    DataFilter dataFilter)
                      throws Exception

Apply a filter on the specified DataProvider's data set and save a reference to the resulting data set.

Parameters:

dataFilter - The filter to apply on current provider's data set. If null or empty then the current filter is unset and the original data set is returned.data set is

Throws:

Exception