org.apache.spark.storage

Class BlockStore

Object

org.apache.spark.storage.BlockStore

All Implemented Interfaces:

Logging

Direct Known Subclasses:

DiskStore, MemoryStore, TachyonStore

public abstract class BlockStore
extends Object
implements Logging

Abstract class to store blocks.

Constructor Summary

Constructors

Constructor and Description
BlockStore(BlockManager blockManager)

Method Summary

Methods

Modifier and Type	Method and Description
BlockManager	blockManager()
void	clear()
abstract boolean	contains(BlockId blockId)
abstract scala.Option<java.nio.ByteBuffer>	getBytes(BlockId blockId)
abstract long	getSize(BlockId blockId) Return the size of a block in bytes.
abstract scala.Option<scala.collection.Iterator<Object>>	getValues(BlockId blockId)
abstract PutResult	putArray(BlockId blockId, Object[] values, StorageLevel level, boolean returnValues)
abstract PutResult	putBytes(BlockId blockId, java.nio.ByteBuffer bytes, StorageLevel level)
abstract PutResult	putIterator(BlockId blockId, scala.collection.Iterator<Object> values, StorageLevel level, boolean returnValues) Put in a block and, possibly, also return its content as either bytes or another Iterator.
abstract boolean	remove(BlockId blockId) Remove a block, if it exists.

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

BlockStore

public BlockStore(BlockManager blockManager)

Method Detail

blockManager

public BlockManager blockManager()

putBytes

public abstract PutResult putBytes(BlockId blockId,
                 java.nio.ByteBuffer bytes,
                 StorageLevel level)

putIterator

public abstract PutResult putIterator(BlockId blockId,
                    scala.collection.Iterator<Object> values,
                    StorageLevel level,
                    boolean returnValues)

Put in a block and, possibly, also return its content as either bytes or another Iterator. This is used to efficiently write the values to multiple locations (e.g. for replication).

Returns:

a PutResult that contains the size of the data, as well as the values put if returnValues is true (if not, the result's data field can be null)

putArray

public abstract PutResult putArray(BlockId blockId,
                 Object[] values,
                 StorageLevel level,
                 boolean returnValues)

getSize

public abstract long getSize(BlockId blockId)

Return the size of a block in bytes.

getBytes

public abstract scala.Option<java.nio.ByteBuffer> getBytes(BlockId blockId)

getValues

public abstract scala.Option<scala.collection.Iterator<Object>> getValues(BlockId blockId)

remove

public abstract boolean remove(BlockId blockId)

Remove a block, if it exists.

Parameters:

blockId - the block to remove.

Returns:

True if the block was found and removed, False otherwise.

contains

public abstract boolean contains(BlockId blockId)

clear

public void clear()