org.bluedb.disk.collection

Class BlueCollectionOnDisk<T extends java.io.Serializable>

java.lang.Object

org.bluedb.disk.collection.BlueCollectionOnDisk<T>

All Implemented Interfaces:

BlueCollection<T>, Rollupable

public class BlueCollectionOnDisk<T extends java.io.Serializable>
extends java.lang.Object
implements BlueCollection<T>, Rollupable

Constructor Summary

Constructors

Constructor and Description
BlueCollectionOnDisk(BlueDbOnDisk db, java.lang.String name, java.lang.Class<? extends BlueKey> requestedKeyType, java.lang.Class<T> valueType, java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalRegisteredClasses)
BlueCollectionOnDisk(BlueDbOnDisk db, java.lang.String name, java.lang.Class<? extends BlueKey> requestedKeyType, java.lang.Class<T> valueType, java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalRegisteredClasses, SegmentSizeSetting segmentSize)

Method Summary

Modifier and Type	Method and Description
void	batchDelete(java.util.Collection<BlueKey> keys) Deletes the values for the given keys.
void	batchUpsert(java.util.Map<BlueKey,T> values) Inserts or replaces the given key value pairs.
boolean	contains(BlueKey key) Returns true if the collection contains a value for the given key.
<I extends ValueKey> BlueIndex<I,T>	createIndex(java.lang.String name, java.lang.Class<I> keyType, KeyExtractor<I,T> keyExtractor) Creates (or returns existing) BlueIndex that maps objects of type ValueKey (UUIDKey, StringKey, IntegerKey, LongKey) to values in the collection.
void	delete(BlueKey key) Deletes the value for the given key
protected static java.lang.Class<? extends BlueKey>	determineKeyType(CollectionMetaData metaData, java.lang.Class<? extends BlueKey> providedKeyType)
protected static SegmentSizeSetting	determineSegmentSize(CollectionMetaData metaData, java.lang.Class<? extends BlueKey> keyType, SegmentSizeSetting requestedSegmentSize, boolean isNewCollection)
protected void	ensureCorrectKeyType(BlueKey key)
protected void	ensureCorrectKeyTypes(java.util.Collection<BlueKey> keys)
void	executeTask(java.lang.Runnable task)
java.util.List<BlueEntity<T>>	findMatches(Range range, java.util.List<Condition<T>> conditions, boolean byStartTime)
T	get(BlueKey key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key
FileManager	getFileManager()
<I extends ValueKey> BlueIndex<I,T>	getIndex(java.lang.String indexName, java.lang.Class<I> keyType) Returns existing BlueIndex that maps objects of type keyType to values in the collection.
IndexManager<T>	getIndexManager()
java.lang.Class<? extends BlueKey>	getKeyType()
BlueKey	getLastKey() Returns the key with the highest grouping number that exists in this collection
CollectionMetaData	getMetaData()
java.nio.file.Path	getPath()
int	getQueuedTaskCount()
RecoveryManager<T>	getRecoveryManager()
RollupScheduler	getRollupScheduler()
SegmentManager<T>	getSegmentManager()
BlueSerializer	getSerializer()
BlueExecutor	getSharedExecutor()
java.lang.Class<T>	getType()
void	insert(BlueKey key, T value) Inserts the given key value pair
BlueQuery<T>	query() Creates a BlueQuery object which can be used to build and execute a query against this collection.
void	replace(BlueKey key, Mapper<T> mapper) Replaces the value for the given key by passing it to the given updater
void	reportReads(java.util.List<RollupTarget> rollupTargets)
void	reportWrites(java.util.List<RollupTarget> rollupTargets)
void	rollup(Range timeRange)
void	rollupIndex(java.lang.String indexName, Range range)
void	submitTask(java.lang.Runnable task)
void	update(BlueKey key, Updater<T> updater) Mutates the value for the given key by passing it to the given updater

Methods inherited from class java.lang.Object

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

Constructor Detail

BlueCollectionOnDisk

public BlueCollectionOnDisk(BlueDbOnDisk db,
                            java.lang.String name,
                            java.lang.Class<? extends BlueKey> requestedKeyType,
                            java.lang.Class<T> valueType,
                            java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalRegisteredClasses)
                     throws BlueDbException

Throws:

BlueDbException

BlueCollectionOnDisk

public BlueCollectionOnDisk(BlueDbOnDisk db,
                            java.lang.String name,
                            java.lang.Class<? extends BlueKey> requestedKeyType,
                            java.lang.Class<T> valueType,
                            java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalRegisteredClasses,
                            SegmentSizeSetting segmentSize)
                     throws BlueDbException

Throws:

BlueDbException

Method Detail

getQueuedTaskCount

public int getQueuedTaskCount()

query

public BlueQuery<T> query()

Description copied from interface: BlueCollection

Creates a BlueQuery object which can be used to build and execute a query against this collection.

Specified by:

query in interface BlueCollection<T extends java.io.Serializable>

Returns:

a BlueQuery object which can be used to build and execute a query against this collection.

contains

public boolean contains(BlueKey key)
                 throws BlueDbException

Description copied from interface: BlueCollection

Returns true if the collection contains a value for the given key.

Specified by:

contains in interface BlueCollection<T extends java.io.Serializable>

Parameters:

key - the key that may or may not be in collection

Returns:

true if the collection contains a value for the given key, else false

Throws:

BlueDbException - if the type of key was not the type specified when the collection was created

get

public T get(BlueKey key)
      throws BlueDbException

Description copied from interface: BlueCollection

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key

Specified by:

get in interface BlueCollection<T extends java.io.Serializable>

Parameters:

key - the key for the desired value

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Throws:

BlueDbException - if the key is not the same type specified when the collection was created

insert

public void insert(BlueKey key,
                   T value)
            throws BlueDbException

Description copied from interface: BlueCollection

Inserts the given key value pair

Specified by:

insert in interface BlueCollection<T extends java.io.Serializable>

Parameters:

key - key where value should be saved (must match the keyType specified when the collection was created)

value - value to be saved for the key

Throws:

BlueDbException - if the key type is not the type specified when the collection was created

batchUpsert

public void batchUpsert(java.util.Map<BlueKey,T> values)
                 throws BlueDbException

Description copied from interface: BlueCollection

Inserts or replaces the given key value pairs. Batch methods are much more efficient than calling non-batch methods many times.

Specified by:

batchUpsert in interface BlueCollection<T extends java.io.Serializable>

Parameters:

values - the key value pairs to insert. Key types must match the keyType specified when the collection was created.

Throws:

BlueDbException - if the key types do not match the type specified when the collection was created

batchDelete

public void batchDelete(java.util.Collection<BlueKey> keys)
                 throws BlueDbException

Description copied from interface: BlueCollection

Deletes the values for the given keys. Batch methods are much more efficient than calling non-batch methods many times.

Specified by:

batchDelete in interface BlueCollection<T extends java.io.Serializable>

Parameters:

keys - the keys for the values which will be deleted

Throws:

BlueDbException - if type of key is not the type specified when the collection was created

replace

public void replace(BlueKey key,
                    Mapper<T> mapper)
             throws BlueDbException

Description copied from interface: BlueCollection

Replaces the value for the given key by passing it to the given updater

Specified by:

replace in interface BlueCollection<T extends java.io.Serializable>

Parameters:

key - the key for the value which will be replaced

mapper - a function that returns the value that should replace the value to which the specified key is mapped

Throws:

BlueDbException - if type of key is not the type specified when the collection was created or if updater throws an exception

update

public void update(BlueKey key,
                   Updater<T> updater)
            throws BlueDbException

Description copied from interface: BlueCollection

Mutates the value for the given key by passing it to the given updater

Specified by:

update in interface BlueCollection<T extends java.io.Serializable>

Parameters:

key - The key for the value which will be updated

updater - a function that mutates the value to which the specified key is mapped

Throws:

BlueDbException - if type of key is not the type specified when the collection was created or if updater throws an exception

delete

public void delete(BlueKey key)
            throws BlueDbException

Description copied from interface: BlueCollection

Deletes the value for the given key

Specified by:

delete in interface BlueCollection<T extends java.io.Serializable>

Parameters:

key - the key for the value which will be deleted

Throws:

BlueDbException - if type of key is not the type specified when the collection was created

getLastKey

public BlueKey getLastKey()

Description copied from interface: BlueCollection

Returns the key with the highest grouping number that exists in this collection

Specified by:

getLastKey in interface BlueCollection<T extends java.io.Serializable>

Returns:

the key with the highest grouping number that exists in this collection

findMatches

public java.util.List<BlueEntity<T>> findMatches(Range range,
                                                 java.util.List<Condition<T>> conditions,
                                                 boolean byStartTime)
                                          throws BlueDbException

Throws:

BlueDbException

getSharedExecutor

public BlueExecutor getSharedExecutor()

submitTask

public void submitTask(java.lang.Runnable task)

executeTask

public void executeTask(java.lang.Runnable task)
                 throws BlueDbException

Throws:

BlueDbException

rollup

public void rollup(Range timeRange)
            throws BlueDbException

Throws:

BlueDbException

getSegmentManager

public SegmentManager<T> getSegmentManager()

getRecoveryManager

public RecoveryManager<T> getRecoveryManager()

getPath

public java.nio.file.Path getPath()

getFileManager

public FileManager getFileManager()

getSerializer

public BlueSerializer getSerializer()

getMetaData

public CollectionMetaData getMetaData()

getType

public java.lang.Class<T> getType()

getKeyType

public java.lang.Class<? extends BlueKey> getKeyType()

ensureCorrectKeyType

protected void ensureCorrectKeyType(BlueKey key)
                             throws BlueDbException

Throws:

BlueDbException

ensureCorrectKeyTypes

protected void ensureCorrectKeyTypes(java.util.Collection<BlueKey> keys)
                              throws BlueDbException

Throws:

BlueDbException

determineSegmentSize

protected static SegmentSizeSetting determineSegmentSize(CollectionMetaData metaData,
                                                         java.lang.Class<? extends BlueKey> keyType,
                                                         SegmentSizeSetting requestedSegmentSize,
                                                         boolean isNewCollection)
                                                  throws BlueDbException

Throws:

BlueDbException

determineKeyType

protected static java.lang.Class<? extends BlueKey> determineKeyType(CollectionMetaData metaData,
                                                                     java.lang.Class<? extends BlueKey> providedKeyType)
                                                              throws BlueDbException

Throws:

BlueDbException

createIndex

public <I extends ValueKey> BlueIndex<I,T> createIndex(java.lang.String name,
                                                       java.lang.Class<I> keyType,
                                                       KeyExtractor<I,T> keyExtractor)
                                                throws BlueDbException

Description copied from interface: BlueCollection

Creates (or returns existing) BlueIndex that maps objects of type ValueKey (UUIDKey, StringKey, IntegerKey, LongKey) to values in the collection.

Specified by:

createIndex in interface BlueCollection<T extends java.io.Serializable>

Type Parameters:

I - the key type of the index or the type of data that the collection is being indexed on. It must be a concretion of ValueKey (UUIDKey, StringKey, LongKey, or IntegerKey).

Parameters:

name - index name (one index per name per each collection)

keyType - the type of each key which is used to lookup a value using the index (this must match the keyType of any existing index with the same name)

keyExtractor - a function that maps a value to the keys by which the value should be indexed. The appropriate subclass can be used and would be more simple to implement. These include UUIDIndexKeyExtractor, StringIndexKeyExtractor, IntegerIndexKeyExtractor, and LongIndexKeyExtractor

Returns:

a BlueIndex object (existing index if it exists, otherwise a newly created index)

Throws:

BlueDbException - if the index exists but is not compatible with these types

getIndex

public <I extends ValueKey> BlueIndex<I,T> getIndex(java.lang.String indexName,
                                                    java.lang.Class<I> keyType)
                                             throws BlueDbException

Description copied from interface: BlueCollection

Returns existing BlueIndex that maps objects of type keyType to values in the collection.

Specified by:

getIndex in interface BlueCollection<T extends java.io.Serializable>

Type Parameters:

I - the key type of the index or the type of data that the collection is being indexed on. It must be a concretion of ValueKey (UUIDKey, StringKey, LongKey, or IntegerKey).

Parameters:

indexName - index name (one index per name per each collection)

keyType - the type of each key which is used to lookup a value using the index (this must match the keyType of any existing index with the same name)

Returns:

a BlueIndex with the same name if it exists and has the same keyType

Throws:

BlueDbException - if index doesn't exist or has a different keyType

rollupIndex

public void rollupIndex(java.lang.String indexName,
                        Range range)
                 throws BlueDbException

Throws:

BlueDbException

getIndexManager

public IndexManager<T> getIndexManager()

reportReads

public void reportReads(java.util.List<RollupTarget> rollupTargets)

Specified by:

reportReads in interface Rollupable

reportWrites

public void reportWrites(java.util.List<RollupTarget> rollupTargets)

Specified by:

reportWrites in interface Rollupable

getRollupScheduler

public RollupScheduler getRollupScheduler()