ninja.ugly.prevail.chunk

Class DefaultChunk<K,V>

java.lang.Object

ninja.ugly.prevail.chunk.DefaultChunk<K,V>

Type Parameters:

K - The type of keys on this Chunk

V - The type of values on this Chunk

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Chunk<K,V>

Direct Known Subclasses:

VolatileChunk

public abstract class DefaultChunk<K,V>
extends java.lang.Object
implements Chunk<K,V>

A default implementation of the Chunk interface that implements dispatching events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultChunk.OnProgressUpdateListener

Nested classes/interfaces inherited from interface ninja.ugly.prevail.chunk.Chunk

Chunk.EmptyChunk<K,V>

Constructor Summary

Constructors

Constructor and Description
DefaultChunk()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventFactory(DeleteEventFactory deleteEventFactory) Add an DeleteEventFactory to use when generating insert events.
void	addEventFactory(InsertEventFactory insertEventFactory) Add an InsertEventFactory to use when generating insert events.
void	addEventFactory(QueryEventFactory queryEventFactory) Add an QueryEventFactory to use when generating insert events.
void	addEventFactory(UpdateEventFactory updateEventFactory) Add an UpdateEventFactory to use when generating insert events.
int	delete(K key, DeleteEventFactory<K>... customEventFactories) Delete a key from this Chunk, returning the number of values deleted.
protected abstract int	doDelete(K key, DefaultChunk.OnProgressUpdateListener onProgressUpdateListener) Update the value at the given key in the Chunk.
protected abstract K	doInsert(V value, DefaultChunk.OnProgressUpdateListener onProgressUpdateListener) Insert a value to the Chunk.
protected abstract QueryResult	doQuery(K key, DefaultChunk.OnProgressUpdateListener onProgressUpdateListener) Query values from the Chunk.
protected abstract int	doUpdate(K key, V value, DefaultChunk.OnProgressUpdateListener progressUpdateListener) Update the value at the given key in the Chunk.
K	insert(V value, InsertEventFactory<K,V>... customEventFactories) Insert a value into this Chunk, returning the key at which the get can be retrieved later.
QueryResult<V>	query(K key, QueryEventFactory<K,V>... customEventFactories) Query a key at this Chunk, returning a QueryResult contianing the queried values.
void	setEventDispatcher(EventDispatcher eventDispatcher) Set the EventDispatcher on this Chunk.
int	update(K key, V value, UpdateEventFactory<K,V>... customEventFactories) Update a key with a value at this Chunk, returning the number of values updated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

DefaultChunk

public DefaultChunk()

Method Detail

insert

public K insert(V value,
       InsertEventFactory<K,V>... customEventFactories)
         throws InsertException

Insert a value into this Chunk, returning the key at which the get can be retrieved later. If an EventDispatcher is set on this Chunk, then events generated by the given list of InsertEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any InsertEventFactory previously added to the Chunk.

Specified by:

insert in interface Chunk<K,V>

Parameters:

value - the value to insert

customEventFactories - optional InsertEventFactories used to generate events for this operation.

Throws:

InsertException

doInsert

protected abstract K doInsert(V value,
         DefaultChunk.OnProgressUpdateListener onProgressUpdateListener)
                       throws InsertException

Insert a value to the Chunk.

This method should be overriden by subclasses in order to store the value in an implementation specific manner. There is no requirement to send any events from this method.

The semantics of this method is implementation specific. That is, some implementations may choose to throw an InsertException if the given key already exists in the Chunk, whilst other implementations may wish to replace the value in that case.

Parameters:

value - The value to be stored

onProgressUpdateListener -

Returns:

a Key into the chunk for later retrieval of the given value.

Throws:

InsertException

query

public QueryResult<V> query(K key,
                   QueryEventFactory<K,V>... customEventFactories)
                     throws QueryException

Query a key at this Chunk, returning a QueryResult contianing the queried values. If an EventDispatcher is set on this Chunk, then events generated by the given list of QueryEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any QueryEventFactory previously added to the Chunk.

Specified by:

query in interface Chunk<K,V>

Parameters:

key - the key to query

customEventFactories - optional QueryEventFactories used to generate events for this operation.

Throws:

QueryException

doQuery

protected abstract QueryResult doQuery(K key,
                  DefaultChunk.OnProgressUpdateListener onProgressUpdateListener)
                                throws QueryException

Query values from the Chunk.

This method should be overriden by subclasses in order to obtain the values in an implementation specific manner. There is no requirement to send any events from this method.

Parameters:

key - The key to obtain the required values

Returns:

a QueryResult containing the returned values.

Throws:

QueryException

update

public int update(K key,
         V value,
         UpdateEventFactory<K,V>... customEventFactories)
           throws UpdateException

Update a key with a value at this Chunk, returning the number of values updated. If an EventDispatcher is set on this Chunk, then events generated by the given list of QueryEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any UpdateEventFactory previously added to the Chunk.

Specified by:

update in interface Chunk<K,V>

Parameters:

key - the key to update

value - the value to update

customEventFactories - optional UpdateEventFactories used to generate events for this operation.

Throws:

UpdateException

doUpdate

protected abstract int doUpdate(K key,
           V value,
           DefaultChunk.OnProgressUpdateListener progressUpdateListener)
                         throws UpdateException

Update the value at the given key in the Chunk.

This method should be overriden by subclasses in order to update the value in an implementation specific manner. There is no requirement to send any events from this method.

The semantics of this method is implementation specific. That is, some implementations may choose to throw an UpdateException if the given key does not exist in the Chunk, whilst other implementations may wish to insert the value in that case.

Parameters:

key - The key of the value to be updated.

value - The value to be stored.

progressUpdateListener -

Returns:

the number of values updated.

Throws:

UpdateException

delete

public int delete(K key,
         DeleteEventFactory<K>... customEventFactories)
           throws DeleteException

Delete a key from this Chunk, returning the number of values deleted. If an EventDispatcher is set on this Chunk, then events generated by the given list of DeleteEventFactories will be dispatched thereon. Additionally, events will be dispatched as generated by any DeleteEventFactory previously added to the Chunk.

Specified by:

delete in interface Chunk<K,V>

Parameters:

key - the key to delete

customEventFactories - optional DeleteEventFactories used to generate events for this operation.

Throws:

DeleteException

doDelete

protected abstract int doDelete(K key,
           DefaultChunk.OnProgressUpdateListener onProgressUpdateListener)
                         throws DeleteException

Update the value at the given key in the Chunk.

This method should be overriden by subclasses in order to update the value in an implementation specific manner. There is no requirement to send any events from this method.

The semantics of this method is implementation specific. That is, some implementations may choose to throw an DeleteException if the given key does not exist in the Chunk, whilst other implementations may wish to do nothing.

Parameters:

key - The key of the value to be deleted.

onProgressUpdateListener -

Returns:

the number of values deleted.

Throws:

DeleteException

setEventDispatcher

public void setEventDispatcher(EventDispatcher eventDispatcher)

Set the EventDispatcher on this Chunk.

Operations on this Chunk will dispatch events to the given EventDispatcher. The events dispatched are generated by EventFactories that are either previously added to this Chunk, or else passed in as a parameter to the Chunk operation.

Specified by:

setEventDispatcher in interface Chunk<K,V>

Parameters:

eventDispatcher - The EventDispatcher to be used for events on this Chunk.

addEventFactory

public void addEventFactory(InsertEventFactory insertEventFactory)

Add an InsertEventFactory to use when generating insert events.

Specified by:

addEventFactory in interface Chunk<K,V>

addEventFactory

public void addEventFactory(QueryEventFactory queryEventFactory)

Add an QueryEventFactory to use when generating insert events.

Specified by:

addEventFactory in interface Chunk<K,V>

addEventFactory

public void addEventFactory(UpdateEventFactory updateEventFactory)

Add an UpdateEventFactory to use when generating insert events.

Specified by:

addEventFactory in interface Chunk<K,V>

addEventFactory

public void addEventFactory(DeleteEventFactory deleteEventFactory)

Add an DeleteEventFactory to use when generating insert events.

Specified by:

addEventFactory in interface Chunk<K,V>