com.illumon.modelfarm

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

java.lang.Object

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

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

Type Parameters:

KEYTYPE - unique ID key type

DATATYPE - data type

All Implemented Interfaces:

ModelFarm

public class ModelFarmTick<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE>>
extends ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE>

A multithreaded resource to execute data driven models. Every time a row of the data table ticks, the unique identifier is executed using the data from the tick. Successive executions for a unique identifier are processed in order.

This is useful for executing against historical data at a regular interval.

Nested Class Summary

Nested classes/interfaces inherited from class com.illumon.modelfarm.ModelFarmBase

ModelFarmBase.GetDataLockType, ModelFarmBase.State

Field Summary

Fields inherited from class com.illumon.modelfarm.ModelFarmBase

dataManager, model

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	execute() Executes the next task in the work queue.
protected boolean	isQueueEmpty() Returns true if the model farm queue is empty and false if the queue contains elements to execute.
protected void	onDataUpdate(Index added, Index removed, Index modified) Process a change to the data table.

Methods inherited from class com.illumon.modelfarm.ModelFarmBase

awaitTermination, awaitTermination, getMostRecentDataFactory, getState, shutdown, shutdownAndAwaitTermination, shutdownAndAwaitTermination, start, terminate

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelFarmTick

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

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.

queueSize - number of elements in the work queue backlog before the blocking new updates.

Method Detail

onDataUpdate

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

Description copied from class: ModelFarmBase

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

Specified by:

onDataUpdate in class ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE>>

Parameters:

added - new indexes added to the data table

removed - indexes removed from the data table

modified - indexes modified in the data table.

isQueueEmpty

protected boolean isQueueEmpty()

Description copied from class: ModelFarmBase

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

Specified by:

isQueueEmpty in class ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE>>

Returns:

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

execute

protected void execute()
                throws InterruptedException

Description copied from class: ModelFarmBase

Executes the next task in the work queue.

Specified by:

execute in class ModelFarmBase<KEYTYPE,DATATYPE,ROWDATAMANAGERTYPE extends RowDataManager<KEYTYPE,DATATYPE>>

Throws:

InterruptedException - if interrupted while executing