org.kitesdk.data
Interface RandomAccessDatasetRepository

All Superinterfaces:

DatasetRepository

@Immutable
public interface RandomAccessDatasetRepository
extends DatasetRepository

A logical repository (storage system) of RandomAccessDatasets.

RandomAccessDatasetRepositorys are DatasetRepositorys that return the Dataset sub-interface RandomAccessDataset from the load, create, and update methods. See DatasetRepository for more details.

Implementations of DatasetRepository are immutable.

Since:

0.9.0

See Also:

RandomAccessDataset, DatasetRepository, DatasetDescriptor

Method Summary

<E> RandomAccessDataset<E>	create(String name, DatasetDescriptor descriptor) Create a Dataset with the supplied descriptor.
<E> RandomAccessDataset<E>	load(String name) Get the latest version of a named Dataset.
<E> RandomAccessDataset<E>	update(String name, DatasetDescriptor descriptor) Update an existing Dataset to reflect the supplied descriptor.

Methods inherited from interface org.kitesdk.data.DatasetRepository

delete, exists, list

Method Detail

load

<E> RandomAccessDataset<E> load(String name)

Description copied from interface: DatasetRepository

Get the latest version of a named Dataset. If no dataset with the provided name exists, a DatasetNotFoundException is thrown.

Specified by:

load in interface DatasetRepository

Parameters:

name - The name of the dataset.

create

<E> RandomAccessDataset<E> create(String name,
                                  DatasetDescriptor descriptor)

Description copied from interface: DatasetRepository

Create a Dataset with the supplied descriptor. Depending on the underlying dataset storage, some schemas types or configurations may not be supported. If an illegal schema is supplied, an exception will be thrown by the implementing class. It is illegal to create a more than one dataset with a given name. If a duplicate name is provided, an exception is thrown.

Specified by:

create in interface DatasetRepository

Parameters:

name - The fully qualified dataset name

descriptor - A descriptor that describes the schema and other properties of the dataset

Returns:

The newly created dataset

update

<E> RandomAccessDataset<E> update(String name,
                                  DatasetDescriptor descriptor)

Description copied from interface: DatasetRepository

Update an existing Dataset to reflect the supplied descriptor. The common case is updating a dataset schema. Depending on the underlying dataset storage, some updates may not be supported, such as a change in format or partition strategy. Any attempt to make an unsupported or incompatible update will result in an exception being thrown and no change being made to the dataset.

Specified by:

update in interface DatasetRepository

Parameters:

name - The fully qualified dataset name

descriptor - A descriptor that describes the schema and other properties of the dataset

Returns:

The updated dataset