org.jboss.dashboard.kpi
Interface KPI

All Superinterfaces:

Cloneable, org.jboss.dashboard.database.Persistent

public interface KPI
extends Cloneable, org.jboss.dashboard.database.Persistent

A Key Performance Indicator is composed by two instances:

• A DataProvider which knows how to retrieve the data set to display.
• And a DataDisplayer which is responsible to render the graph and manage the UI issues.

Method Summary

String	getCode() The kpi code is an unique identifier that is universal and is not tied to the persistent storage.
DataDisplayer	getDataDisplayer() The KPI data diplayer.
DataProvider	getDataProvider() The KPI data provider.
String	getDescription(Locale l) The KPI descripton.
Map<String,String>	getDescriptionI18nMap()
Long	getId() The object identifier.
void	setCode(String code)
void	setDataDisplayer(DataDisplayer displayer)
void	setDataProvider(DataProvider provider)
void	setDescription(String descr, Locale l)
void	setDescriptionI18nMap(Map<String,String> descriptions) The localized descriptions.
void	setId(Long newId)

Methods inherited from interface org.jboss.dashboard.database.Persistent

delete, isPersistent, save, update

Method Detail

getId

Long getId()

The object identifier.

setId

void setId(Long newId)

getCode

String getCode()

The kpi code is an unique identifier that is universal and is not tied to the persistent storage.

setCode

void setCode(String code)

getDescription

String getDescription(Locale l)

The KPI descripton.

setDescription

void setDescription(String descr,
                    Locale l)

setDescriptionI18nMap

void setDescriptionI18nMap(Map<String,String> descriptions)

The localized descriptions.

getDescriptionI18nMap

Map<String,String> getDescriptionI18nMap()

getDataDisplayer

DataDisplayer getDataDisplayer()

The KPI data diplayer.

setDataDisplayer

void setDataDisplayer(DataDisplayer displayer)
                      throws DataDisplayerInvalidConfiguration

Throws:

DataDisplayerInvalidConfiguration

getDataProvider

DataProvider getDataProvider()

The KPI data provider.

setDataProvider

void setDataProvider(DataProvider provider)