ds.granules.dataset

Class DatasetNotifier

java.lang.Object

ds.granules.dataset.DatasetNotifier

All Implemented Interfaces:

DataAvailabilityNotifier

public class DatasetNotifier
extends java.lang.Object
implements DataAvailabilityNotifier

This is a class which implements the DataAvailabilityNotifier interface. This class allows implementations of the dataset to use composition to notify the availability or closure of the dataset to the registered observers.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Constructor and Description
DatasetNotifier(java.lang.String datasetIdentifier, java.lang.String datasetBinding)

Method Summary

Modifier and Type	Method and Description
void	dataAvailable(java.lang.String inDatasetBinding) Called by the dataset as soon as additional data is available.
void	datasetClosure(java.lang.String inDatasetBinding) Called by the dataset, just before it is ready to close down.
void	deregisterDataAvailabilityObserver(DataAvailabilityObserver observer) Deregisters a data availability observer
java.lang.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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatasetNotifier

public DatasetNotifier(java.lang.String datasetIdentifier,
                       java.lang.String datasetBinding)

Method Detail

pauseAvailabilityNotifications

public void pauseAvailabilityNotifications(DataAvailabilityObserver observer)
                                    throws DatasetException

Description copied from interface: DataAvailabilityNotifier

Pauses data availability notifications for the specified observer

Specified by:

pauseAvailabilityNotifications in interface DataAvailabilityNotifier

Parameters:

observer - The entity that needs to pause data availability notifications

Throws:

DatasetException

resumeAvailabilityNotifications

public void resumeAvailabilityNotifications(DataAvailabilityObserver observer)
                                     throws DatasetException

Description copied from interface: DataAvailabilityNotifier

Resumes data availability notifications for the specified observer

Specified by:

resumeAvailabilityNotifications in interface DataAvailabilityNotifier

Parameters:

observer - The entity that needs to resume data availability notifications

Throws:

DatasetException

dataAvailable

public void dataAvailable(java.lang.String inDatasetBinding)

Called by the dataset as soon as additional data is available.

Parameters:

inDatasetBinding -

datasetClosure

public void datasetClosure(java.lang.String inDatasetBinding)

Called by the dataset, just before it is ready to close down.

Parameters:

inDatasetBinding -

deregisterDataAvailabilityObserver

public void deregisterDataAvailabilityObserver(DataAvailabilityObserver observer)
                                        throws DatasetException

Description copied from interface: DataAvailabilityNotifier

Deregisters a data availability observer

Specified by:

deregisterDataAvailabilityObserver in interface DataAvailabilityNotifier

Parameters:

observer - The entity that needs to deregister as an observer

Throws:

DatasetException

getDatasetIdentifier

public java.lang.String getDatasetIdentifier()

Description copied from interface: DataAvailabilityNotifier

Indicates the dataset being reported on

Specified by:

getDatasetIdentifier in interface DataAvailabilityNotifier

registerDataAvailabilityObserver

public void registerDataAvailabilityObserver(DataAvailabilityObserver observer)
                                      throws DatasetException

Description copied from interface: DataAvailabilityNotifier

Registers a data availability observer

Specified by:

registerDataAvailabilityObserver in interface DataAvailabilityNotifier

Parameters:

observer - The entity that needs to register as an observer

Throws:

DatasetException