org.diirt.datasource.timecache

Interface PVCache

All Known Implementing Classes:

PVCacheImpl

public interface PVCache

Cache interface for a single PV. Retrieves samples from sources via DataSource interface and stores them into storage via DataStorage interface. Notifies the registered PVCacheListener when new samples have been retrieved. Manages the lists of requested/completed intervals.

Author:

Fred Arnaud (Sopra Group) - ITER

Method Summary

Modifier and Type	Method and Description
void	addListener(PVCacheListener listener) Add a PVCacheListener to be notified when new samples are available.
void	flush()
String	getChannelName()
IntervalsList	getCompletedIntervalsList() Get the completed intervals list.
PVCacheStatistics	getStatistics()
boolean	isProcessingSources()
boolean	isStatisticsEnabled()
void	removeListener(PVCacheListener listener) Remove a PVCacheListener.
DataRequestThread	retrieveDataAsync(TimeInterval interval) Asynchronously retrieves samples from sources for the requested TimeInterval and asynchronously requests DataStorage for immediately available samples.
SortedSet<Data>	retrieveDataSync(TimeInterval interval) Synchronously requests DataStorage for immediately available samples.
void	setStatisticsEnabled(boolean enabled)
void	startLiveDataProcessing() Start processing live data samples.
void	stopLiveDataProcessing() Stop processing live data samples.

Method Detail

startLiveDataProcessing

void startLiveDataProcessing()

Start processing live data samples. NOT IMPLEMENTED IN FIRST VERSION.

stopLiveDataProcessing

void stopLiveDataProcessing()

Stop processing live data samples. NOT IMPLEMENTED IN FIRST VERSION.

addListener

void addListener(PVCacheListener listener)

Add a PVCacheListener to be notified when new samples are available.

Parameters:

listener - to be added

removeListener

void removeListener(PVCacheListener listener)

Remove a PVCacheListener.

Parameters:

listener - to be removed

retrieveDataAsync

DataRequestThread retrieveDataAsync(TimeInterval interval)

Asynchronously retrieves samples from sources for the requested TimeInterval and asynchronously requests DataStorage for immediately available samples.

Parameters:

interval - TimeInterval to be retrieved.

retrieveDataSync

SortedSet<Data> retrieveDataSync(TimeInterval interval)

Synchronously requests DataStorage for immediately available samples.

Parameters:

interval - TimeInterval to be retrieved.

getCompletedIntervalsList

IntervalsList getCompletedIntervalsList()

Get the completed intervals list. An TimeInterval is completed when all DataSource have finished responding.

Returns:

IntervalsList the list of completed intervals.

setStatisticsEnabled

void setStatisticsEnabled(boolean enabled)

isStatisticsEnabled

boolean isStatisticsEnabled()

getStatistics

PVCacheStatistics getStatistics()

isProcessingSources

boolean isProcessingSources()

getChannelName

String getChannelName()

flush

void flush()