org.jboss.dashboard.provider
Interface DataLoader

All Known Implementing Classes:

AbstractDataLoader

public interface DataLoader

Method Summary

DataProviderType	getDataProviderType() The provider type.
Long	getMaxDataSetFilterTimeInMillis() Maximum time in milliseconds a data set filter operation may last.
Long	getMaxDataSetGroupTimeInMillis() Maximum time in milliseconds a data set group operation may last.
Long	getMaxDataSetLoadTimeInMillis() Maximum time in milliseconds a data set load operation may last.
Long	getMaxDataSetSizeInBytes() Maximum size in bytes a data set may have.
Long	getMaxDataSetSortTimeInMillis() Maximum time in milliseconds a data set sort operation may last.
Long	getMaxMemoryUsedInDataLoad() Maximum memory in bytes a data set load operation may consume.
boolean	isReady() Returns whether the loader is ready to gather data.
DataSet	load(DataProvider provider) Load the data set.
void	setDataProviderType(DataProviderType type)
void	setMaxDataSetFilterTimeInMillis(Long maxDataSetLoadTimeInMillis)
void	setMaxDataSetGroupTimeInMillis(Long maxDataSetLoadTimeInMillis)
void	setMaxDataSetLoadTimeInMillis(Long maxDataSetLoadTimeInMillis)
void	setMaxDataSetSizeInBytes(Long maxDataSetSizeInBytes)
void	setMaxDataSetSortTimeInMillis(Long maxDataSetSortTimeInMillis)
void	setMaxMemoryUsedInDataLoad(Long maxMemoryUsedInDataLoad)

Method Detail

getDataProviderType

DataProviderType getDataProviderType()

The provider type.

setDataProviderType

void setDataProviderType(DataProviderType type)

isReady

boolean isReady()

Returns whether the loader is ready to gather data. This implies must be well configured.

load

DataSet load(DataProvider provider)
             throws Exception

Load the data set.

Throws:

Exception

getMaxMemoryUsedInDataLoad

Long getMaxMemoryUsedInDataLoad()

Maximum memory in bytes a data set load operation may consume.

setMaxMemoryUsedInDataLoad

void setMaxMemoryUsedInDataLoad(Long maxMemoryUsedInDataLoad)

getMaxDataSetSizeInBytes

Long getMaxDataSetSizeInBytes()

Maximum size in bytes a data set may have.

setMaxDataSetSizeInBytes

void setMaxDataSetSizeInBytes(Long maxDataSetSizeInBytes)

getMaxDataSetLoadTimeInMillis

Long getMaxDataSetLoadTimeInMillis()

Maximum time in milliseconds a data set load operation may last.

setMaxDataSetLoadTimeInMillis

void setMaxDataSetLoadTimeInMillis(Long maxDataSetLoadTimeInMillis)

getMaxDataSetFilterTimeInMillis

Long getMaxDataSetFilterTimeInMillis()

Maximum time in milliseconds a data set filter operation may last.

setMaxDataSetFilterTimeInMillis

void setMaxDataSetFilterTimeInMillis(Long maxDataSetLoadTimeInMillis)

getMaxDataSetGroupTimeInMillis

Long getMaxDataSetGroupTimeInMillis()

Maximum time in milliseconds a data set group operation may last.

setMaxDataSetGroupTimeInMillis

void setMaxDataSetGroupTimeInMillis(Long maxDataSetLoadTimeInMillis)

getMaxDataSetSortTimeInMillis

Long getMaxDataSetSortTimeInMillis()

Maximum time in milliseconds a data set sort operation may last.

setMaxDataSetSortTimeInMillis

void setMaxDataSetSortTimeInMillis(Long maxDataSetSortTimeInMillis)