org.kitesdk.data.spi

Interface PartitionedDataset<E>

All Superinterfaces:

Dataset<E>, RefinableView<E>, View<E>

public interface PartitionedDataset<E>
extends Dataset<E>

Method Summary

Methods

Modifier and Type	Method and Description
void	dropPartition(PartitionKey key) Drop a partition for a PartitionKey.
PartitionedDataset<E>	getPartition(PartitionKey key, boolean autoCreate) Get a partition for a PartitionKey, optionally creating the partition if it doesn't already exist.
Iterable<PartitionedDataset<E>>	getPartitions() Return partitions.

Methods inherited from interface org.kitesdk.data.Dataset

getDescriptor, getName, getNamespace, getUri

Methods inherited from interface org.kitesdk.data.RefinableView

from, fromAfter, to, toBefore, with

Methods inherited from interface org.kitesdk.data.View

asSchema, asType, deleteAll, getCoveringPartitions, getDataset, getSchema, getType, includes, isEmpty, newReader, newWriter

Method Detail

getPartition

PartitionedDataset<E> getPartition(PartitionKey key,
                                 boolean autoCreate)

Get a partition for a PartitionKey, optionally creating the partition if it doesn't already exist.

Parameters:

key - The key used to look up the partition.

autoCreate - If true, automatically creates the partition if it doesn't exist.

Throws:

DatasetException

dropPartition

void dropPartition(PartitionKey key)

Drop a partition for a PartitionKey. Dropping a partition that doesn't exist results in a DatasetException being thrown.

Parameters:

key - The key used to look up the partition.

Throws:

DatasetException

Since:

0.2.0

getPartitions

Iterable<PartitionedDataset<E>> getPartitions()

Return partitions.

Note that, depending on the implementation, the returned iterable can hold system resources until exhausted and/or finalized.

Returns:

an iterable over all partitions of this dataset

Throws:

DatasetException