org.kitesdk.data.spi

Class AbstractDatasetRepository

java.lang.Object

org.kitesdk.data.spi.AbstractDatasetRepository

All Implemented Interfaces:

DatasetRepository

public abstract class AbstractDatasetRepository
extends Object
implements DatasetRepository

A common DatasetRepository base class to simplify implementation. Implementers can use this class to maintain compatibility with old API calls, without needing to implement deprecated methods. It also includes backwards- compatible implementations of current API methods so that implementers don't need to implement deprecated methods.

Constructor Summary

Constructors

Constructor and Description
AbstractDatasetRepository()

Method Summary

Methods

Modifier and Type	Method and Description
<E> Dataset<E>	create(String namespace, String name, DatasetDescriptor descriptor) /** Create a Dataset with the supplied descriptor.
<E> Dataset<E>	load(String namespace, String name) Get the latest version of a named Dataset.
<E> Dataset<E>	update(String namespace, String name, DatasetDescriptor descriptor) Update an existing Dataset to reflect the supplied descriptor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitesdk.data.spi.DatasetRepository

create, datasets, delete, exists, getUri, load, namespaces, update

Constructor Detail

AbstractDatasetRepository

public AbstractDatasetRepository()

Method Detail

create

public <E> Dataset<E> create(String namespace,
                    String name,
                    DatasetDescriptor descriptor)

Description copied from interface: DatasetRepository

/** Create a Dataset with the supplied descriptor. Depending on the underlying dataset storage, some schema types or configurations might not be supported. If you supply an illegal schema, the implementing class throws an exception. It is illegal to create more than one dataset with the same name. If you provide a duplicate name, the implementing class throws an exception.

Specified by:

create in interface DatasetRepository

Parameters:

namespace - A namespace, or logical group name, for the dataset.

name - The fully qualified dataset name

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

Returns:

The newly created dataset

load

public <E> Dataset<E> load(String namespace,
                  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:

namespace - A namespace, or logical group name, for the dataset.

name - The name of the dataset.

update

public <E> Dataset<E> update(String namespace,
                    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 might not be supported, such as a change in format or partition strategy. Any attempt to make an unsupported or incompatible update results in an exception being thrown and no changes made to the dataset.

Specified by:

update in interface DatasetRepository

Parameters:

namespace - A namespace, or logical group name, for the dataset.

name - The fully qualified dataset name

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

Returns:

The updated dataset