repicea.app

Class AbstractGenericEngine

java.lang.Object

repicea.app.AbstractGenericEngine

Direct Known Subclasses:

AbstractServer, CarbonAccountingTool, ServerInterfaceEngine, Trigger

public abstract class AbstractGenericEngine
extends java.lang.Object

The AbstractGenericEngine class implements all the methods to run an application. Some GenericTask instances are stored in a queue, and processed in order by an internal SwingWorker.

Field Summary

Fields

Modifier and Type	Field and Description
protected repicea.app.AbstractGenericEngine.EnsuringShutdownTask	finalTask
protected Logger	logger
protected java.util.concurrent.LinkedBlockingQueue<GenericTask>	queue
protected java.util.List<java.lang.String>	tasksDone

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGenericEngine() Protected constructor for derived class.

Method Summary

Modifier and Type	Method and Description
void	addTask(GenericTask task) This method add a GenericTask instance in the queue of tasks.
void	addTasks(java.util.List<GenericTask> tasks) This method add a bunch of tasks in the queue of tasks.
void	cancelRunningTask() This method cancels the current task if the queue is not empty.
protected void	decideWhatToDoInCaseOfFailure(GenericTask task) This method is called whenever an exception is thrown while running a task.
protected abstract void	firstTasksToDo() This method sets the first tasks to execute when the engine starts.
SettingMemory	getSettingMemory() This method returns the settings of the application.
protected void	lockEngine() This method locks the engine while the interface can be doing something else.
protected void	lockEngine(long millisec) This method locks the engine while the interface can be doing something else.
void	requestShutdown() This method requests the Engine to shut down.
protected void	setSettingMemory(SettingMemory settings) This method sets the settings of the application.
protected void	shutdown(int shutdownCode)
void	startApplication() This method starts the client application.
protected void	unlockEngine() This method unlock the engine if locked.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected Logger logger

queue

protected java.util.concurrent.LinkedBlockingQueue<GenericTask> queue

tasksDone

protected java.util.List<java.lang.String> tasksDone

finalTask

protected repicea.app.AbstractGenericEngine.EnsuringShutdownTask finalTask

Constructor Detail

AbstractGenericEngine

protected AbstractGenericEngine()

Protected constructor for derived class.

Method Detail

decideWhatToDoInCaseOfFailure

protected void decideWhatToDoInCaseOfFailure(GenericTask task)

This method is called whenever an exception is thrown while running a task. If the Engine has a user interface and this interface is visible, an error message is displayed. The queue of tasks is cleared.

Parameters:

task - a GenericTask instance

firstTasksToDo

protected abstract void firstTasksToDo()

This method sets the first tasks to execute when the engine starts. Typically, it would retrieve the settings, show the user interface and so on.

setSettingMemory

protected void setSettingMemory(SettingMemory settings)

This method sets the settings of the application. Should be stated in the constructor.

Parameters:

settings - a SettingMemory instance

getSettingMemory

public final SettingMemory getSettingMemory()

This method returns the settings of the application.

Returns:

a Settings derived instance

startApplication

public final void startApplication()

This method starts the client application. The abstract method firstTasksToDo() serves to pile tasks in the queue as soon as the application starts.

shutdown

protected void shutdown(int shutdownCode)

addTask

public void addTask(GenericTask task)

This method add a GenericTask instance in the queue of tasks.

Parameters:

task - a GenericTask instance

addTasks

public void addTasks(java.util.List<GenericTask> tasks)

This method add a bunch of tasks in the queue of tasks.

Parameters:

tasks - a List of GenericTask instances

lockEngine

protected void lockEngine(long millisec)
                   throws java.lang.InterruptedException

This method locks the engine while the interface can be doing something else.

Parameters:

millisec - the number of milliseconds to wait

Throws:

java.lang.InterruptedException

lockEngine

protected void lockEngine()
                   throws java.lang.InterruptedException

This method locks the engine while the interface can be doing something else. The engine can be locked only if the executing thread is not the internal worker.

Throws:

java.lang.InterruptedException

unlockEngine

protected void unlockEngine()

This method unlock the engine if locked.

cancelRunningTask

public void cancelRunningTask()

This method cancels the current task if the queue is not empty.

requestShutdown

public void requestShutdown()

This method requests the Engine to shut down. It first clears the queue of tasks and then it sends the FinalTask static member in the queue in order to ensures the shutting down.