ds.granules.dataset

Interface DatasetCollection

All Superinterfaces:

FormatMarshaller

All Known Implementing Classes:

DatasetCollectionManagement

public interface DatasetCollection
extends FormatMarshaller

The DataCollection interface manages a collection of datasets that would be operated upon by an application instance.

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.
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.
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

Methods inherited from interface ds.funnel.data.format.FormatMarshaller

marshall

Method Detail

isDataAvailable

boolean isDataAvailable()

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

Returns:

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

isClosed

boolean isClosed()

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

Returns:

true if this dataset is closed; false otherwise.

getNumberOfDatasets

int getNumberOfDatasets()

Get the number of datasets in this collection.

Returns:

the total number of datasets now in this collection.

addDataset

int addDataset(Dataset dataset)
        throws DatasetException

Add a dataset to this collection.

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

removeDataset

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

Remove a dataset from this collection

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.

hasDataset

boolean hasDataset()

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

Returns:

true if there are registered datasets, and false otherwise.

hasDataset

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

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

Parameters:

datasetIdentifier -

Returns:

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

Throws:

DatasetException - If the specified datasetIdentifier is a NULL

getDataset

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

Retrieve a specific dataset

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

java.util.Iterator<Dataset> getDatasets()

Retrieve an iterator to iterate over the datasets.

Returns:

The iterator to iterate over the datasets.

setDatasetCollectionObserver

void setDatasetCollectionObserver(DatasetCollectionObserver observer)

Register an observer for the DatasetCollection

Parameters:

observer - The observer being registered.

resumeAvailabilityNotifications

void resumeAvailabilityNotifications()

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

initializeDatasets

void initializeDatasets()
                 throws DatasetException

Initializes all the constituent datasets in this collection.

Throws:

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