ds.granules.dataset

Interface DataAvailabilityNotifier

All Known Implementing Classes:

DatasetNotifier

public interface DataAvailabilityNotifier

This is a notifier that keeps track of when data is available on a given dataset and then proceeds to notify the availability of the data to the registered observers. Also, notifies registered entities about dataset closures. In several datasets, data is continually arriving at a rapid rate. To prevent an entity from being deluged with availability notifications, this notifier allows entities to pause and resume their interest in receiving availability notifications.

Author:

Shrideep Pallickara

Method Summary

Methods

Modifier and Type	Method and Description
void	deregisterDataAvailabilityObserver(DataAvailabilityObserver observer) Deregisters a data availability observer
String	getDatasetIdentifier() Indicates the dataset being reported on
void	pauseAvailabilityNotifications(DataAvailabilityObserver observer) Pauses data availability notifications for the specified observer
void	registerDataAvailabilityObserver(DataAvailabilityObserver observer) Registers a data availability observer
void	resumeAvailabilityNotifications(DataAvailabilityObserver observer) Resumes data availability notifications for the specified observer

Method Detail

getDatasetIdentifier

String getDatasetIdentifier()

Indicates the dataset being reported on

registerDataAvailabilityObserver

void registerDataAvailabilityObserver(DataAvailabilityObserver observer)
                                      throws DatasetException

Registers a data availability observer

Parameters:

observer - The entity that needs to register as an observer

Throws:

DatasetException

deregisterDataAvailabilityObserver

void deregisterDataAvailabilityObserver(DataAvailabilityObserver observer)
                                        throws DatasetException

Deregisters a data availability observer

Parameters:

observer - The entity that needs to deregister as an observer

Throws:

DatasetException

pauseAvailabilityNotifications

void pauseAvailabilityNotifications(DataAvailabilityObserver observer)
                                    throws DatasetException

Pauses data availability notifications for the specified observer

Parameters:

observer - The entity that needs to pause data availability notifications

Throws:

DatasetException

resumeAvailabilityNotifications

void resumeAvailabilityNotifications(DataAvailabilityObserver observer)
                                     throws DatasetException

Resumes data availability notifications for the specified observer

Parameters:

observer - The entity that needs to resume data availability notifications

Throws:

DatasetException