org.bluedb.disk

Class BlueCollectionOnDiskBuilder<K extends BlueKey,T extends java.io.Serializable>

java.lang.Object

org.bluedb.disk.BlueCollectionOnDiskBuilder<K,T>

All Implemented Interfaces:

BlueCollectionBuilder<K,T>

public class BlueCollectionOnDiskBuilder<K extends BlueKey,T extends java.io.Serializable>
extends java.lang.Object
implements BlueCollectionBuilder<K,T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlueCollectionOnDiskBuilder(BlueDbOnDisk db, java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<T> valueType)

Method Summary

Modifier and Type	Method and Description
BlueCollectionOnDisk<T>	build()
BlueCollectionOnDiskBuilder<K,T>	withOptimizedClasses(java.util.Collection<java.lang.Class<? extends java.io.Serializable>> classesToRegister) Registers classesToRegister with the serializer to make serialization and deserialization faster and more compact, then returns itself.
BlueCollectionOnDiskBuilder<K,T>	withSegmentSize(SegmentSize<K> segmentSize) Requests a specific segment size to use for the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlueCollectionOnDiskBuilder

protected BlueCollectionOnDiskBuilder(BlueDbOnDisk db,
                                      java.lang.String name,
                                      java.lang.Class<K> keyType,
                                      java.lang.Class<T> valueType)

Method Detail

withOptimizedClasses

public BlueCollectionOnDiskBuilder<K,T> withOptimizedClasses(java.util.Collection<java.lang.Class<? extends java.io.Serializable>> classesToRegister)

Description copied from interface: BlueCollectionBuilder

Registers classesToRegister with the serializer to make serialization and deserialization faster and more compact, then returns itself.

Specified by:

withOptimizedClasses in interface BlueCollectionBuilder<K extends BlueKey,T extends java.io.Serializable>

Parameters:

classesToRegister - classes that will be stored as values, in values, or in keys inside this collection.

Returns:

itself, after classesToRegister is added as classes to register

withSegmentSize

public BlueCollectionOnDiskBuilder<K,T> withSegmentSize(SegmentSize<K> segmentSize)
                                                 throws BlueDbException

Description copied from interface: BlueCollectionBuilder

Requests a specific segment size to use for the collection. Values of the collection are grouped into segments and values in a segment can be vacuumed into a single file. Therefore, segment size will affect how fast you can access a specific value in a segment and how many i-nodes (files and directories) the collection will use on disk. This will be ignored if the collection already exists. In the future BlueDB might support migrating from one segment size to another.

Specified by:

withSegmentSize in interface BlueCollectionBuilder<K extends BlueKey,T extends java.io.Serializable>

Parameters:

segmentSize - the requested segment size for the collection. Values of the collection are grouped into segments and values in a segment can be vacuumed into a single file. Therefore, segment size will affect how fast you can access a specific value in a segment and how many i-nodes (files and directories) the collection will use on disk. This will be ignored if the collection already exists. In the future BlueDB might support migrating from one segment size to another.

Returns:

itself, after segmentSize is added as the requested segment size

Throws:

BlueDbException - if the requested segment size is invalid

build

public BlueCollectionOnDisk<T> build()
                              throws BlueDbException

Specified by:

build in interface BlueCollectionBuilder<K extends BlueKey,T extends java.io.Serializable>

Returns:

the existing BlueCollection or else builds a new one if none exists

Throws:

BlueDbException - if any problems are encountered, such as the collection already existing with a different type