org.kitesdk.data

Interface PartitionView<E>

Type Parameters:

E - The type of entities stored in the Dataset underlying this View.

All Superinterfaces:

View<E>

@Immutable
public interface PartitionView<E>
extends View<E>

A PartitionView is a subset of a Dataset that corresponds to a single partition, with a location.

Since:

1.1.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteAll() Deletes the entities included in this View.
URI	getLocation() Returns the location of this partition as a URI.
DatasetWriter<E>	newWriter() Get an appropriate DatasetWriter implementation based on the constraints for this View of the underlying Dataset.

Methods inherited from interface org.kitesdk.data.View

asSchema, asType, getCoveringPartitions, getDataset, getSchema, getType, getUri, includes, isEmpty, newReader

Method Detail

getLocation

URI getLocation()

Returns the location of this partition as a URI.

Returns:

a URI for the location of this partition.

Since:

1.1.0

deleteAll

boolean deleteAll()

Deletes the entities included in this View.

Unlike View.deleteAll(), implementations are not allowed to throw UnsupportedOperationException and must support this method in all PartitionView implementations.

Specified by:

deleteAll in interface View<E>

Returns:

true if any data was deleted, false if the View was already empty

Throws:

DatasetIOException - if the requested delete failed because of an IOException

Since:

1.1.0

newWriter

DatasetWriter<E> newWriter()

Get an appropriate DatasetWriter implementation based on the constraints for this View of the underlying Dataset.

Although the view is limited to a particular location in the dataset when reading, writers returned by this method will not necessarily write to that location. Instead, writers are subject to the logical constraints of this PartitionView.

Implementations are free to return different types of writers depending on the disposition of the data. For example, a partitioned dataset may use a different writer than that of a non-partitioned dataset. Clients should not make any assumptions about the returned implementations: implementations are free to change their internal structure at any time.

Specified by:

newWriter in interface View<E>

Throws:

DatasetException