ninja.ugly.prevail.datamodel

Class DataModel

java.lang.Object

ninja.ugly.prevail.datamodel.DataModel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DataModel
extends java.lang.Object
implements java.io.Closeable

An event driven data model giving access to registered 'chunks' of data.

A DataModel is a container of Chunks, optionally registered to different 'segments' of the DataModel. Each Chunk defines its own CRUD operations on its own classes. Some Chunks might merely hold objects in memory, whilst others might persist objects via a network API or local database. In all cases, the Chunks present a consistent interface. Chunks themselves are accessed synchronously, however when registered on a DataModel they can be accessed asynchronously. Chunks are registered on the DataModel with an optional 'segment', that is a key that addresses possibly many Chunks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataModel.CompositeIOException

Constructor Summary

Constructors

Constructor and Description
DataModel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addChunk(Chunk chunk) Add a Chunk to the default segment of this DataModel.
void	addChunk(Chunk chunk, java.util.concurrent.ExecutorService executor) Add a Chunk to the default segment of this DataModel.
void	addChunk(java.lang.String segment, Chunk chunk) Add a Chunk to the given segment of this DataModel.
void	addChunk(java.lang.String segment, Chunk chunk, java.util.concurrent.ExecutorService executor) Add a Chunk to the given segment of this DataModel.
void	close() Close all registered chunks
<K> java.util.concurrent.Future<java.util.List<java.lang.Integer>>	delete(K key, DeleteEventFactory... deleteEventFactories) Delete the given key from all Chunks registered at the default segment of the DataModel.
<K> java.util.concurrent.Future<java.util.List<java.lang.Integer>>	delete(java.lang.String segment, K key, DeleteEventFactory... deleteEventFactories) Delete the given key from all Chunks registered at the default segment of the DataModel.
<V> java.util.concurrent.Future<java.util.List<java.lang.Object>>	insert(java.lang.String segment, V value, InsertEventFactory... insertEventFactories) Insert the given value to all Chunks registered at the given segment of the DataModel.
<V> java.util.concurrent.Future<java.util.List<java.lang.Object>>	insert(V value, InsertEventFactory... insertEventFactories) Insert the given value to all Chunks registered at the default segment of the DataModel.
<K> java.util.concurrent.Future<java.util.List<QueryResult<java.lang.Object>>>	query(K key, QueryEventFactory... queryEventFactories) Query the given key at all Chunks registered at the given segment of the DataModel.
<K> java.util.concurrent.Future<java.util.List<QueryResult<java.lang.Object>>>	query(java.lang.String segment, K key, QueryEventFactory... queryEventFactories) Query the given key at all Chunks registered at the default segment of the DataModel.
<K,V> java.util.concurrent.Future<java.util.List<java.lang.Integer>>	update(K key, V value, UpdateEventFactory... updateEventFactories) Update the given key with the given value at all Chunks registered at the default segment of the DataModel.
<K,V> java.util.concurrent.Future<java.util.List<java.lang.Integer>>	update(java.lang.String segment, K key, V value, UpdateEventFactory... updateEventFactories) Update the given key with the given value at all Chunks registered at the given segment of the DataModel.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataModel

public DataModel()

Method Detail

addChunk

public void addChunk(Chunk chunk)

Add a Chunk to the default segment of this DataModel.

Parameters:

chunk - The Chunk to add

addChunk

public void addChunk(java.lang.String segment,
            Chunk chunk)

Add a Chunk to the given segment of this DataModel.

Parameters:

segment - A String naming the segment

chunk - The Chunk to add

addChunk

public void addChunk(Chunk chunk,
            java.util.concurrent.ExecutorService executor)

Add a Chunk to the default segment of this DataModel. Run its operations on the given ExecutorService.

Parameters:

chunk - The Chunk to add

executor - The ExecutorService on which to run the Chunk operations. If null, a default single-threaded ExecutorService will be used.

addChunk

public void addChunk(java.lang.String segment,
            Chunk chunk,
            java.util.concurrent.ExecutorService executor)

Add a Chunk to the given segment of this DataModel. Run its operations on the given ExecutorService.

Parameters:

segment - A String naming the segment

chunk - The Chunk to add

executor - The ExecutorService on which to run the Chunk operations. If null, a default single-threaded ExecutorService will be used.

delete

public <K> java.util.concurrent.Future<java.util.List<java.lang.Integer>> delete(K key,
                                                                        DeleteEventFactory... deleteEventFactories)

Delete the given key from all Chunks registered at the default segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunk's delete method. These events will be dispatched, in addition to events from any DeleteEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunks' delete operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

K - The type of the key on the Chunks.

Parameters:

key - The key to delete.

deleteEventFactories - An optional list of DeleteEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk delete operation.

delete

public <K> java.util.concurrent.Future<java.util.List<java.lang.Integer>> delete(java.lang.String segment,
                                                                        K key,
                                                                        DeleteEventFactory... deleteEventFactories)

Delete the given key from all Chunks registered at the default segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunk's delete method. These events will be dispatched, in addition to events from any DeleteEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunks' delete operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

K - The type of the key on the Chunks.

Parameters:

segment - A String naming the segment to apply the operation. The delete operation will be propagated to all Chunks registered at the segment.

key - The key to delete.

deleteEventFactories - An optional list of DeleteEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk delete operation.

insert

public <V> java.util.concurrent.Future<java.util.List<java.lang.Object>> insert(V value,
                                                                       InsertEventFactory... insertEventFactories)

Insert the given value to all Chunks registered at the default segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunks' insert method. These events will be dispatched, in addition to events from any InsertEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunk's insert operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

V - The type of the value on the Chunks.

Parameters:

value - The value to insert.

insertEventFactories - An optional list of InsertEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk insert operation.

insert

public <V> java.util.concurrent.Future<java.util.List<java.lang.Object>> insert(java.lang.String segment,
                                                                       V value,
                                                                       InsertEventFactory... insertEventFactories)

Insert the given value to all Chunks registered at the given segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunks' insert method. These events will be dispatched, in addition to events from any InsertEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunk's insert operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

V - The type of the value on the Chunks.

Parameters:

segment - A String naming the segment to apply the operation. The insert operation will be propagated to all Chunks registered at the segment.

value - The value to insert.

insertEventFactories - An optional list of InsertEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk insert operation.

query

public <K> java.util.concurrent.Future<java.util.List<QueryResult<java.lang.Object>>> query(K key,
                                                                                   QueryEventFactory... queryEventFactories)

Query the given key at all Chunks registered at the given segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunks' query method. These events will be dispatched, in addition to events from any QueryEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunk's query operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

K - The type of the key on the Chunks.

Parameters:

key - The key to query.

queryEventFactories - An optional list of QueryEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk query operation.

query

public <K> java.util.concurrent.Future<java.util.List<QueryResult<java.lang.Object>>> query(java.lang.String segment,
                                                                                   K key,
                                                                                   QueryEventFactory... queryEventFactories)

Query the given key at all Chunks registered at the default segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunks' query method. These events will be dispatched, in addition to events from any QueryEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunk's query operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

K - The type of the key on the Chunks.

Parameters:

segment - A String naming the segment to apply the operation. The query operation will be propagated to all Chunks registered at the segment.

key - The key to query.

queryEventFactories - An optional list of QueryEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk query operation.

update

public <K,V> java.util.concurrent.Future<java.util.List<java.lang.Integer>> update(K key,
                                                                          V value,
                                                                          UpdateEventFactory... updateEventFactories)

Update the given key with the given value at all Chunks registered at the default segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunks' query method. These events will be dispatched, in addition to events from any QueryEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunk's query operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

K - The type of the key on the Chunks.

V - The type of the value on the Chunks.

Parameters:

key - The key to update.

value - The value to update.

updateEventFactories - An optional list of UpdateEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk update operation.

update

public <K,V> java.util.concurrent.Future<java.util.List<java.lang.Integer>> update(java.lang.String segment,
                                                                          K key,
                                                                          V value,
                                                                          UpdateEventFactory... updateEventFactories)

Update the given key with the given value at all Chunks registered at the given segment of the DataModel.

Optional event factories may be given, which are forwarded to the Chunks' query method. These events will be dispatched, in addition to events from any QueryEventFactory already added to the respective Chunk.

This method returns a Future containing a List of results from each registered Chunk's query operation. Rather than wait on the result of this future, client code should usually await a event from an EventFactory.

Type Parameters:

K - The type of the key on the Chunks.

V - The type of the value on the Chunks.

Parameters:

segment - A String naming the segment to apply the operation. The update operation will be propagated to all Chunks registered at the segment.

key - The key to update.

value - The value to update.

updateEventFactories - An optional list of UpdateEventFactory used to generate events for this operation.

Returns:

A Future containing a list of results of each Chunk update operation.

close

public void close()
           throws DataModel.CompositeIOException

Close all registered chunks

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

DataModel.CompositeIOException