com.illumon.modelfarm

Class ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE>>

java.lang.Object

com.illumon.modelfarm.ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE>

Type Parameters:

KEYTYPE - unique ID key type

DATATYPE - data type

All Implemented Interfaces:

ModelFarm

Direct Known Subclasses:

ModelFarmRealTime, ModelFarmTick

public abstract class ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE>>
extends Object
implements ModelFarm

A multithreaded resource to execute data driven models.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelFarmBase.GetDataLockType Type of locking used when loading data from the data manager.
protected static class	ModelFarmBase.State Run state of the farm.

Field Summary

Fields

Modifier and Type	Field and Description
protected ROWDATAMANAGERTYPE	dataManager
protected Model<DATATYPE>	model

Constructor Summary

Constructors

Constructor and Description
ModelFarmBase(int nThreads, Model<DATATYPE> model, ROWDATAMANAGERTYPE dataManager) Create a multithreaded resource to execute data driven models.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination() Blocks until all tasks have completed execution after a shutdown request.
boolean	awaitTermination(long timeout, TimeUnit unit) Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, whichever happens first.
protected abstract void	execute() Executes the next task in the work queue.
protected com.illumon.modelfarm.ModelFarmBase.MostRecentDataGetter<KEYTYPE,DATATYPE>	getMostRecentDataFactory(ModelFarmBase.GetDataLockType lockType) Factory that creates a function to retrieve the most recent row data for a unique identifier.
protected ModelFarmBase.State	getState() Gets the current run state of the model farm.
protected abstract boolean	isQueueEmpty() Returns true if the model farm queue is empty and false if the queue contains elements to execute.
protected abstract void	onDataUpdate(Index added, Index removed, Index modified) Process a change to the data table.
void	shutdown() Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
void	shutdownAndAwaitTermination() Shuts down and then awaits termination.
boolean	shutdownAndAwaitTermination(long timeout, TimeUnit unit) Shuts down and then awaits termination.
void	start() Initiates execution.
void	terminate() Initiates an immediate termination of all tasks.

Methods inherited from class java.lang.Object

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

Field Detail

model

protected final Model<DATATYPE> model

dataManager

protected final ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE> dataManager

Constructor Detail

ModelFarmBase

public ModelFarmBase(int nThreads,
                     Model<DATATYPE> model,
                     ROWDATAMANAGERTYPE dataManager)

Create a multithreaded resource to execute data driven models.

Parameters:

nThreads - number of worker threads.

model - model to execute.

dataManager - interface for accessing and querying data contained in rows of a dynamic table.

Method Detail

onDataUpdate

protected abstract void onDataUpdate(Index added,
                                     Index removed,
                                     Index modified)

Process a change to the data table. If the data table is being accessed, use the protected column source fields.

Parameters:

added - new indexes added to the data table

removed - indexes removed from the data table

modified - indexes modified in the data table.

execute

protected abstract void execute()
                         throws InterruptedException

Executes the next task in the work queue.

Throws:

InterruptedException - if interrupted while executing

getMostRecentDataFactory

protected com.illumon.modelfarm.ModelFarmBase.MostRecentDataGetter<KEYTYPE,DATATYPE> getMostRecentDataFactory(ModelFarmBase.GetDataLockType lockType)

Factory that creates a function to retrieve the most recent row data for a unique identifier.

Parameters:

lockType - locking algorithm used to ensure that data read from the table is consistent.

Returns:

function to retrieve the most recent row data for a unique identifier.

getState

protected ModelFarmBase.State getState()

Gets the current run state of the model farm.

Returns:

current run state of the model farm.

start

public void start()

Description copied from interface: ModelFarm

Initiates execution.

Specified by:

start in interface ModelFarm

shutdown

public void shutdown()

Description copied from interface: ModelFarm

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Specified by:

shutdown in interface ModelFarm

terminate

public void terminate()

Description copied from interface: ModelFarm

Initiates an immediate termination of all tasks. Unexecuted tasks will not be executed. Tasks already executing may not be interrupted.

Specified by:

terminate in interface ModelFarm

awaitTermination

public boolean awaitTermination()

Description copied from interface: ModelFarm

Blocks until all tasks have completed execution after a shutdown request.

Specified by:

awaitTermination in interface ModelFarm

Returns:

true if this executor terminated and false if the timeout elapsed before termination

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)

Description copied from interface: ModelFarm

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, whichever happens first.

Specified by:

awaitTermination in interface ModelFarm

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if this executor terminated and false if the timeout elapsed before termination

shutdownAndAwaitTermination

public void shutdownAndAwaitTermination()

Description copied from interface: ModelFarm

Shuts down and then awaits termination.

Specified by:

shutdownAndAwaitTermination in interface ModelFarm

shutdownAndAwaitTermination

public boolean shutdownAndAwaitTermination(long timeout,
                                           TimeUnit unit)

Description copied from interface: ModelFarm

Shuts down and then awaits termination.

Specified by:

shutdownAndAwaitTermination in interface ModelFarm

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if this executor terminated and false if the timeout elapsed before termination

isQueueEmpty

protected abstract boolean isQueueEmpty()

Returns true if the model farm queue is empty and false if the queue contains elements to execute.

Returns:

true if the model farm queue is empty and false if the queue contains elements to execute.