public interface DatasetCollection
extends ds.funnel.data.format.FormatMarshaller
DataCollection
interface manages a collection of datasets
that would be operated upon by an application instance.Modifier and Type | Method and Description |
---|---|
int |
addDataset(Dataset dataset)
Add a dataset to this collection.
|
Dataset |
getDataset(String datasetIdentifier)
Retrieve a specific dataset
|
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(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(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
|
boolean isDataAvailable()
true
if data is available on any of the underlying
datasets;false
otherwise.boolean isClosed()
true
if this dataset is closed;
false
otherwise.int getNumberOfDatasets()
int addDataset(Dataset dataset) throws DatasetException
dataset
- The dataset to be added to the collection in question.DatasetException
- If there are problems adding this dataset to the collectionint removeDataset(String datasetIdentifier) throws DatasetException
datasetIdentifier
- The identifier of the dataset that needs to be removed.DatasetException
- If there are problems removing this dataset from the collection.boolean hasDataset()
true
if there are registered datasets, and
false
otherwise.boolean hasDataset(String datasetIdentifier) throws DatasetException
datasetIdentifier
- true
if the dataset with specified identifier is
part of this collection;false
otherwise.DatasetException
- If the specified datasetIdentifier is a NULLDataset getDataset(String datasetIdentifier) throws DatasetException
datasetIdentifier
- The identifier of the dataset.DatasetException
- If there are problems retrieving the dataset.Iterator<Dataset> getDatasets()
void setDatasetCollectionObserver(DatasetCollectionObserver observer)
observer
- The observer being registered.void resumeAvailabilityNotifications()
void initializeDatasets() throws DatasetException
DatasetException
- If there are problems initializing any of the datasets within
the dataset collection.Copyright © 2015. All rights reserved.