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

Class FileBlock<K extends Serializable>

java.lang.Object

edu.snu.coral.runtime.executor.data.block.FileBlock<K>

Type Parameters:

K - the key type of its partitions.

All Implemented Interfaces:

Block<K>

public final class FileBlock<K extends Serializable>
extends Object
implements Block<K>

This class represents a block which is stored in (local or remote) file.

Constructor Summary

Constructors

Constructor and Description
FileBlock(Coder coder, String filePath, FileMetadata<K> metadata) Constructor.

Method Summary

Modifier and Type	Method and Description
List<FileArea>	asFileAreas(KeyRange keyRange) Retrieves the list of FileAreas for the specified KeyRange.
void	commit() Commits this block to prevent further write.
void	deleteFile() Deletes the file that contains this block data.
Iterable<NonSerializedPartition<K>>	getPartitions(KeyRange keyRange) Retrieves the partitions of this block from the file in a specific key range and deserializes it.
Iterable<SerializedPartition<K>>	getSerializedPartitions(KeyRange keyRange) Retrieves the SerializedPartitions in a specific key range.
Optional<List<Long>>	putPartitions(Iterable<NonSerializedPartition<K>> partitions) Writes NonSerializedPartitions to this block.
List<Long>	putSerializedPartitions(Iterable<SerializedPartition<K>> partitions) Writes SerializedPartitions to this block.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBlock

public FileBlock(Coder coder,
                 String filePath,
                 FileMetadata<K> metadata)

Constructor.

Parameters:

coder - the Coder.

filePath - the path of the file that this block will be stored.

metadata - the metadata for this block.

Method Detail

putPartitions

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

Writes NonSerializedPartitions to this block.

Specified by:

putPartitions in interface Block<K extends Serializable>

Parameters:

partitions - the NonSerializedPartitions to write.

Returns:

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

Throws:

IOException - if fail to write.

putSerializedPartitions

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

Writes SerializedPartitions to this block.

Specified by:

putSerializedPartitions in interface Block<K extends Serializable>

Parameters:

partitions - the SerializedPartitions to store.

Returns:

the size of the data per partition.

Throws:

IOException - if fail to store.

getPartitions

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

Retrieves the partitions of this block from the file in a specific key range and deserializes it.

Specified by:

getPartitions in interface Block<K extends Serializable>

Parameters:

keyRange - the key range.

Returns:

an iterable of NonSerializedPartitions.

Throws:

IOException - if failed to retrieve.

getSerializedPartitions

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

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

Specified by:

getSerializedPartitions in interface Block<K extends Serializable>

Parameters:

keyRange - the key range to retrieve.

Returns:

an iterable of SerializedPartitions.

Throws:

IOException - if failed to retrieve.

asFileAreas

public List<FileArea> asFileAreas(KeyRange keyRange)
                           throws IOException

Retrieves the list of FileAreas for the specified KeyRange.

Parameters:

keyRange - the key range

Returns:

list of the file areas

Throws:

IOException - if failed to open a file channel

deleteFile

public void deleteFile()
                throws IOException

Deletes the file that contains this block data. This method have to be called after all read is completed (or failed).

Throws:

IOException - if failed to delete.

commit

public void commit()
            throws IOException

Commits this block to prevent further write.

Specified by:

commit in interface Block<K extends Serializable>

Throws:

IOException - if failed to commit.