ds.granules.dataset

Class DatasetCollectionManagement

java.lang.Object

ds.granules.dataset.DatasetCollectionManagement

All Implemented Interfaces:

FormatMarshaller, DataAvailabilityObserver, DatasetCollection

public class DatasetCollectionManagement
extends java.lang.Object
implements DatasetCollection, DataAvailabilityObserver

This is an implementation of the DataCollection Interface.

Author:

Shrideep Pallickara

Method Summary

Modifier and Type	Method and Description
int	addDataset(Dataset dataset) Add a dataset to this collection.
Dataset	getDataset(java.lang.String datasetIdentifier) Retrieve a specific dataset
java.util.Iterator<Dataset>	getDatasets() Retrieve an iterator to iterate over the datasets.
java.lang.String	getIdentifier() This retrieves the identifier associated with the observer.
int	getNumberOfDatasets() Get the number of datasets in this collection.
boolean	hasDataset() Check to see if any dataset is part of this collection.
boolean	hasDataset(java.lang.String datasetIdentifier) Check to see if a dataset with the specified identifier is part of this collection
void	initializeDatasets() Initializes all the constituent datasets in this collection.
boolean	isClosed() This method indicates whether this dataset collection is closed.
boolean	isDataAvailable() Reports on the availability of data in any of the underlying datasets that are part of this collection.
void	marshall(FormatWriter mFormat)
void	onDataAvailability(java.lang.String datasetIdentifier) This method is invoked on the observers to reflect the availability of new data in the input dataset
void	onDatasetClosure(java.lang.String datasetIdentifier) This method is invoked on the observer when the dataset will be closed and thus no more data will be available.
int	removeDataset(java.lang.String datasetIdentifier) Remove a dataset from this collection
void	resumeAvailabilityNotifications() Resume data availability notifications for this collection.
void	setDatasetCollectionObserver(DatasetCollectionObserver observer) Register an observer for the DatasetCollection
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isClosed

public boolean isClosed()

Description copied from interface: DatasetCollection

This method indicates whether this dataset collection is closed. If all the constituent datasets report on their closure, this method will return true.

Specified by:

isClosed in interface DatasetCollection

Returns:

true if this dataset is closed; false otherwise.

initializeDatasets

public void initializeDatasets()
                        throws DatasetException

Description copied from interface: DatasetCollection

Initializes all the constituent datasets in this collection.

Specified by:

initializeDatasets in interface DatasetCollection

Throws:

DatasetException - If there are problems initializing any of the datasets within the dataset collection.

addDataset

public int addDataset(Dataset dataset)
               throws DatasetException

Description copied from interface: DatasetCollection

Add a dataset to this collection.

Specified by:

addDataset in interface DatasetCollection

Parameters:

dataset - The dataset to be added to the collection in question.

Returns:

the total number of datasets now in this collection.

Throws:

DatasetException - If there are problems adding this dataset to the collection

getDataset

public Dataset getDataset(java.lang.String datasetIdentifier)
                   throws DatasetException

Description copied from interface: DatasetCollection

Retrieve a specific dataset

Specified by:

getDataset in interface DatasetCollection

Parameters:

datasetIdentifier - The identifier of the dataset.

Returns:

The dataset with the specified dataset identifier

Throws:

DatasetException - If there are problems retrieving the dataset.

getDatasets

public java.util.Iterator<Dataset> getDatasets()

Description copied from interface: DatasetCollection

Retrieve an iterator to iterate over the datasets.

Specified by:

getDatasets in interface DatasetCollection

Returns:

The iterator to iterate over the datasets.

getNumberOfDatasets

public int getNumberOfDatasets()

Description copied from interface: DatasetCollection

Get the number of datasets in this collection.

Specified by:

getNumberOfDatasets in interface DatasetCollection

Returns:

the total number of datasets now in this collection.

hasDataset

public boolean hasDataset()

Description copied from interface: DatasetCollection

Check to see if any dataset is part of this collection.

Specified by:

hasDataset in interface DatasetCollection

Returns:

true if there are registered datasets, and false otherwise.

hasDataset

public boolean hasDataset(java.lang.String datasetIdentifier)
                   throws DatasetException

Description copied from interface: DatasetCollection

Check to see if a dataset with the specified identifier is part of this collection

Specified by:

hasDataset in interface DatasetCollection

Returns:

true if the dataset with specified identifier is part of this collection;false otherwise.

Throws:

DatasetException - If the specified datasetIdentifier is a NULL

removeDataset

public int removeDataset(java.lang.String datasetIdentifier)
                  throws DatasetException

Description copied from interface: DatasetCollection

Remove a dataset from this collection

Specified by:

removeDataset in interface DatasetCollection

Parameters:

datasetIdentifier - The identifier of the dataset that needs to be removed.

Returns:

the total number of datasets now in this collection.

Throws:

DatasetException - If there are problems removing this dataset from the collection.

isDataAvailable

public boolean isDataAvailable()

Description copied from interface: DatasetCollection

Reports on the availability of data in any of the underlying datasets that are part of this collection.

Specified by:

isDataAvailable in interface DatasetCollection

Returns:

true if data is available on any of the underlying datasets;false otherwise.

setDatasetCollectionObserver

public void setDatasetCollectionObserver(DatasetCollectionObserver observer)

Description copied from interface: DatasetCollection

Register an observer for the DatasetCollection

Specified by:

setDatasetCollectionObserver in interface DatasetCollection

Parameters:

observer - The observer being registered.

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: DataAvailabilityObserver

This retrieves the identifier associated with the observer. This identifier helps in the registration and deregistration of observers with the corresponding notifiers.

Specified by:

getIdentifier in interface DataAvailabilityObserver

Returns:

identifier: The id associated with the observer

marshall

public void marshall(FormatWriter mFormat)
              throws FormatException

Specified by:

marshall in interface FormatMarshaller

Parameters:

mFormat - - The format writer to write to

Throws:

FormatException - If there was a problem while writing

onDataAvailability

public void onDataAvailability(java.lang.String datasetIdentifier)

Description copied from interface: DataAvailabilityObserver

This method is invoked on the observers to reflect the availability of new data in the input dataset

Specified by:

onDataAvailability in interface DataAvailabilityObserver

Parameters:

datasetIdentifier - The identifier of the dataset whose availability is being reported on

onDatasetClosure

public void onDatasetClosure(java.lang.String datasetIdentifier)

Description copied from interface: DataAvailabilityObserver

This method is invoked on the observer when the dataset will be closed and thus no more data will be available.

Specified by:

onDatasetClosure in interface DataAvailabilityObserver

Parameters:

datasetIdentifier - The identifier of the dataset whose availability is being reported on

resumeAvailabilityNotifications

public void resumeAvailabilityNotifications()

Description copied from interface: DatasetCollection

Resume data availability notifications for this collection. Notifications are automatically paused, when an availability is reported once.

Specified by:

resumeAvailabilityNotifications in interface DatasetCollection

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object