edu.snu.coral.runtime.executor.data.block

Interface Block<K extends Serializable>

Type Parameters:

K - the key type of its partitions.

All Known Implementing Classes:

FileBlock, NonSerializedMemoryBlock, SerializedMemoryBlock

public interface Block<K extends Serializable>

This interface represents a block, which is the output of a specific task.

Method Summary

Modifier and Type	Method and Description
void	commit() Commits this block to prevent further write.
Iterable<NonSerializedPartition<K>>	getPartitions(KeyRange<K> keyRange) Retrieves the NonSerializedPartitions in a specific key range from this block.
Iterable<SerializedPartition<K>>	getSerializedPartitions(KeyRange<K> keyRange) Retrieves the SerializedPartitions in a specific key range.
Optional<List<Long>>	putPartitions(Iterable<NonSerializedPartition<K>> partitions) Stores NonSerializedPartitions to this block.
List<Long>	putSerializedPartitions(Iterable<SerializedPartition<K>> partitions) Stores SerializedPartitions to this block.

Method Detail

putPartitions

Optional<List<Long>> putPartitions(Iterable<NonSerializedPartition<K>> partitions)
                            throws IOException

Stores NonSerializedPartitions to this block. Invariant: This should not be invoked after this block is committed.

Parameters:

partitions - the NonSerializedPartitions to store.

Returns:

the size of the data per partition (only when the data is serialized in this method).

Throws:

IOException - if fail to store.

putSerializedPartitions

List<Long> putSerializedPartitions(Iterable<SerializedPartition<K>> partitions)
                            throws IOException

Stores SerializedPartitions to this block. Invariant: This should not be invoked after this block is committed.

Parameters:

partitions - the SerializedPartitions to store.

Returns:

the size of the data per partition.

Throws:

IOException - if fail to store.

getPartitions

Iterable<NonSerializedPartition<K>> getPartitions(KeyRange<K> keyRange)
                                           throws IOException

Retrieves the NonSerializedPartitions in a specific key range from this block. If the data is serialized, deserializes it. Invariant: This should not be invoked before this block is committed.

Parameters:

keyRange - the key range to retrieve.

Returns:

an iterable of NonSerializedPartitions.

Throws:

IOException - if failed to retrieve.

getSerializedPartitions

Iterable<SerializedPartition<K>> getSerializedPartitions(KeyRange<K> keyRange)
                                                  throws IOException

Retrieves the SerializedPartitions in a specific key range. Invariant: This should not be invoked before this block is committed.

Parameters:

keyRange - the hash range to retrieve.

Returns:

an iterable of SerializedPartitions.

Throws:

IOException - if failed to retrieve.

commit

void commit()
     throws IOException

Commits this block to prevent further write.

Throws:

IOException - if failed to commit.