org.bluedb.api

Interface BlueCollectionBuilder<K extends BlueKey,V extends java.io.Serializable>

Type Parameters:

V - object type of values to be serialized into the collection being built

All Known Implementing Classes:

BlueCollectionOnDiskBuilder

public interface BlueCollectionBuilder<K extends BlueKey,V extends java.io.Serializable>

A builder for the BlueCollection class

Method Summary

Modifier and Type	Method and Description
BlueCollection<V>	build()
BlueCollectionBuilder<K,V>	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.
BlueCollectionBuilder<K,V>	withSegmentSize(SegmentSize<K> segmentSize) Requests a specific segment size to use for the collection.

Method Detail

withOptimizedClasses

BlueCollectionBuilder<K,V> 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.

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

BlueCollectionBuilder<K,V> withSegmentSize(SegmentSize<K> segmentSize)
                                    throws BlueDbException

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.

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

BlueCollection<V> build()
                 throws BlueDbException

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