org.kitesdk.data

Interface Dataset<E>

Type Parameters:

E - The type of entities stored in this Dataset.

All Superinterfaces:

RefinableView<E>, View<E>

All Known Subinterfaces:

RandomAccessDataset<E>

@Immutable
public interface Dataset<E>
extends RefinableView<E>

A logical representation of a set of data entities.

Logically, all datasets have two generic properties: a name, and a descriptor that holds information such as the dataset's schema and its partitioning information. Concrete implementations of Dataset can support additional properties, mandatory or otherwise, as needed. Datasets are not normally instantiated directly, but managed by a repository (also implementation-specific).

Implementations of Dataset are immutable.

See Also:

View, DatasetWriter, DatasetReader, PartitionStrategy, DatasetDescriptor, Schema

Method Summary

Methods

Modifier and Type	Method and Description
DatasetDescriptor	getDescriptor() Get the DatasetDescriptor associated with this dataset.
String	getName() Get the name of a Dataset.
String	getNamespace() Get the namespace that contains this Dataset.
URI	getUri() Return a URI for this Dataset.

Methods inherited from interface org.kitesdk.data.RefinableView

from, fromAfter, to, toBefore, with

Methods inherited from interface org.kitesdk.data.View

deleteAll, getDataset, getType, includes, isEmpty, newReader, newWriter

Method Detail

getName

String getName()

Get the name of a Dataset. No guarantees are made about the format of this name.

getNamespace

String getNamespace()

Get the namespace that contains this Dataset. A namespace is a string that identifies a logical group of datasets.

Since:

0.17.0

getDescriptor

DatasetDescriptor getDescriptor()

Get the DatasetDescriptor associated with this dataset.

getUri

URI getUri()

Return a URI for this Dataset. The returned URI should load a copy of this dataset when passed to Datasets.load(java.net.URI, java.lang.Class).

Specified by:

getUri in interface View<E>

Returns:

a URI that identifies this dataset

Since:

0.15.0