org.jboss.dashboard.displayer

Interface DataDisplayer

All Superinterfaces:

Cloneable

All Known Implementing Classes:

AbstractDataDisplayer

public interface DataDisplayer
extends Cloneable

A data displayer is a component that is able to render graphically the data gathered by a data provider.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(DataDisplayer source) Copies the configuration of one displayer into this.
DataDisplayerRenderer	getDataDisplayerRenderer() The library used to render the displayer.
DataDisplayerType	getDataDisplayerType() The type of this displayer.
DataProvider	getDataProvider() The data provider which feeds this displayer with data.
void	setDataDisplayerRenderer(DataDisplayerRenderer library)
void	setDataDisplayerType(DataDisplayerType type)
void	setDataProvider(DataProvider provider)
void	setDefaultSettings() Restore the default settings.
void	validate(DataProvider provider) Check if the current displayer properties are present in the given data provider.

Method Detail

getDataDisplayerType

DataDisplayerType getDataDisplayerType()

The type of this displayer.

setDataDisplayerType

void setDataDisplayerType(DataDisplayerType type)

getDataProvider

DataProvider getDataProvider()

The data provider which feeds this displayer with data.

Throws:

IllegalArgumentException - If a property in data displayer is not present in the given data provider.

setDataProvider

void setDataProvider(DataProvider provider)
                     throws DataDisplayerInvalidConfiguration

Throws:

DataDisplayerInvalidConfiguration

getDataDisplayerRenderer

DataDisplayerRenderer getDataDisplayerRenderer()

The library used to render the displayer.

setDataDisplayerRenderer

void setDataDisplayerRenderer(DataDisplayerRenderer library)

setDefaultSettings

void setDefaultSettings()

Restore the default settings.

copyFrom

void copyFrom(DataDisplayer source)
              throws DataDisplayerInvalidConfiguration

Copies the configuration of one displayer into this.

Parameters:

source - The displayer with the configuration to copy.

Throws:

IllegalArgumentException - If a property in data displayer is not present in the given data provider.

DataDisplayerInvalidConfiguration

validate

void validate(DataProvider provider)
              throws DataDisplayerInvalidConfiguration

Check if the current displayer properties are present in the given data provider.

Parameters:

provider - The data provider.

Throws:

IllegalArgumentException - If a property in data displayer is not present in the given data provider.

DataDisplayerInvalidConfiguration