ds.granules.dataset

Class DatasetFactory

java.lang.Object

ds.granules.dataset.DatasetFactory

public class DatasetFactory
extends java.lang.Object

A factory for creating different types of datasets. Also contains various utility methods to access information about the datasets.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Constructor and Description
DatasetFactory()

Method Summary

Modifier and Type	Method and Description
DatasetCollection	createDatasetCollection() Creates a dataset collection
FileDataset	createFileDataset(java.lang.String datasetIdentifier, java.lang.String datasetDescription) Creates a file dataset based on the specified arguments.
FileAccess	createLegacyFileDataset(java.lang.String datasetIdentifier, java.lang.String datasetDescription) Deprecated.
StreamDataset	createStreamDataset(java.lang.String datasetIdentifier, java.lang.String datasetDescription) Creates a streaming dataset based on the specified arguments.
StreamingAccess	createStreamingDataset(java.lang.String datasetIdentifier, java.lang.String datasetDescription) Deprecated.
Dataset	getDataset(FormatReader mFormat) Reconstructs the dataset from a set of bytes
DatasetCollection	getDatasetCollection(FormatReader mFormat) Reconstruct the dataset collection from a byte[].
static DatasetFactory	getInstance() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetFactory

public DatasetFactory()

Method Detail

getInstance

@Deprecated
public static DatasetFactory getInstance()

Deprecated.

Retrieve the singleton instance of the dataset factory

Returns:

The singleton instance of the factory.

createDatasetCollection

public DatasetCollection createDatasetCollection()

Creates a dataset collection

Returns:

The created dataset collection.

getDatasetCollection

public DatasetCollection getDatasetCollection(FormatReader mFormat)
                                       throws DatasetException

Reconstruct the dataset collection from a byte[].

Parameters:

marshalledBytes - The byte[] representation of the dataset

Returns:

The reconstructed dataset.

Throws:

DatasetException - If the are problems reconstructing the dataset.

createStreamDataset

public StreamDataset createStreamDataset(java.lang.String datasetIdentifier,
                                         java.lang.String datasetDescription)

Creates a streaming dataset based on the specified arguments.

Parameters:

datasetIdentifier - The identifier for the dataset.

datasetDescription - The description of the dataset.

Returns:

The created streaming dataset.

Throws:

DatasetException - If there are problems creating the streaming dataset.

createFileDataset

public FileDataset createFileDataset(java.lang.String datasetIdentifier,
                                     java.lang.String datasetDescription)

Creates a file dataset based on the specified arguments.

Parameters:

datasetIdentifier - The identifier for the dataset.

datasetDescription - The description of the dataset.

Returns:

The created file dataset.

Throws:

DatasetException - If there are problems creating the file dataset.

createStreamingDataset

@Deprecated
public StreamingAccess createStreamingDataset(java.lang.String datasetIdentifier,
                                                          java.lang.String datasetDescription)

Deprecated.

Creates a legacy NBEvent streaming dataset based on the specified arguments.

Parameters:

datasetIdentifier - The identifier for the dataset.

datasetDescription - The description of the dataset.

Returns:

The created streaming dataset.

Throws:

DatasetException - If there are problems creating the streaming dataset.

createLegacyFileDataset

@Deprecated
public FileAccess createLegacyFileDataset(java.lang.String datasetIdentifier,
                                                      java.lang.String datasetDescription)

Deprecated.

Creates a legacy file dataset based on the specified arguments.

Parameters:

datasetIdentifier - The identifier for the dataset.

datasetDescription - The description of the dataset.

Returns:

The created file dataset.

Throws:

DatasetException - If there are problems creating the file dataset.

getDataset

public Dataset getDataset(FormatReader mFormat)
                   throws DatasetException

Reconstructs the dataset from a set of bytes

Parameters:

datasetBytes - The byte[] representation of the dataset.

Returns:

The reconstructed Dataset.

Throws:

DatasetException - If there are problems in reconstructing the dataset