Package clickTrainDetector.offline

Class ClickTrainOfflineTask

java.lang.Object

offlineProcessing.OfflineTask<PamDataUnit<?,?>>

clickTrainDetector.offline.ClickTrainOfflineTask

public class ClickTrainOfflineTask
extends OfflineTask<PamDataUnit<?,?>>

Run the click train detector in viewer mode, including the click train classifier.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
ClickTrainOfflineTask(ClickTrainControl clickTrainControl)	Constructor for the click train offline processing

Method Summary

Modifier and Type	Method	Description
boolean	callSettings()	Call any task specific settings use callSettings(Component component) instead wherever possible.
void	completeTask()	Called at the end of the thread which executes this task.
void	deleteOldData(TaskGroupParams taskGroupParams)	Gets called at the start of data processing, called oncer per run, i.e.
String	getName()
PamControlledUnit	getTaskControlledUnit()	Get the PAMControlled unit associated with a task.
boolean	hasSettings()	task has settings which can be modified.
void	loadedDataComplete()	Called when processing of loaded data, or each map point worth of data, is complete.
void	newDataLoad(long startTime, long endTime, OfflineDataMapPoint mapPoint)	Called when new data are loaded for offline processing (or once at the start of processing loaded data).
void	prepareTask()	Called at the start of the thread which executes this task.
boolean	processDataUnit(PamDataUnit dataUnit)	Process a single data unit.

Methods inherited from class offlineProcessing.OfflineTask

addAffectedDataBlock, addRequiredDataBlock, addRequiredDataBlock, addRequiredDataBlock, callSettings, canRun, deleteOldOutput, getAffectedBlocksList, getAffectedDataBlock, getDataBlock, getLongName, getNumAffectedDataBlocks, getNumRequiredDataBlocks, getOfflineTaskGroup, getParentControlledUnit, getRequiredDataBlock, getSettingsProviders, getUnitName, getUnitType, isDoRun, setDoRun, setOfflineTaskGroup, setParentDataBlock, whyNot

Methods inherited from class java.lang.Object

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

Constructor Details

ClickTrainOfflineTask

public ClickTrainOfflineTask(ClickTrainControl clickTrainControl)

Constructor for the click train offline processing

Parameters:

clickTrainContol - - the click train control.

Method Details

getName

public String getName()

Specified by:

getName in class OfflineTask<PamDataUnit<?,?>>

Returns:

a name for the task, to be displayed in the dialog.

processDataUnit

public boolean processDataUnit(PamDataUnit dataUnit)

Description copied from class: OfflineTask

Process a single data unit.

Specified by:

processDataUnit in class OfflineTask<PamDataUnit<?,?>>

Returns:

true if the data unit has changed in some way so that it will need re-writing to it's binary file or database.

prepareTask

public void prepareTask()

Called at the start of the thread which executes this task.

Overrides:

prepareTask in class OfflineTask<PamDataUnit<?,?>>

completeTask

public void completeTask()

Called at the end of the thread which executes this task.

Overrides:

completeTask in class OfflineTask<PamDataUnit<?,?>>

newDataLoad

public void newDataLoad(long startTime,
 long endTime,
 OfflineDataMapPoint mapPoint)

Description copied from class: OfflineTask

Called when new data are loaded for offline processing (or once at the start of processing loaded data).

Specified by:

newDataLoad in class OfflineTask<PamDataUnit<?,?>>

Parameters:

startTime - start time of loaded data

endTime - end time of loaded data

loadedDataComplete

public void loadedDataComplete()

Description copied from class: OfflineTask

Called when processing of loaded data, or each map point worth of data, is complete.

Specified by:

loadedDataComplete in class OfflineTask<PamDataUnit<?,?>>

hasSettings

public boolean hasSettings()

Description copied from class: OfflineTask

task has settings which can be modified. If this is true, then callSettings(Component component) should do something such as open a dialog or show a menu, or something.

Overrides:

hasSettings in class OfflineTask<PamDataUnit<?,?>>

Returns:

true or false

callSettings

public boolean callSettings()

Description copied from class: OfflineTask

Call any task specific settings
use callSettings(Component component) instead wherever possible.

Overrides:

callSettings in class OfflineTask<PamDataUnit<?,?>>

Returns:

true if settings may have changed.

deleteOldData

public void deleteOldData(TaskGroupParams taskGroupParams)

Description copied from class: OfflineTask

Gets called at the start of data processing, called oncer per run, i.e. not called again each time more data are loaded.

Overrides:

deleteOldData in class OfflineTask<PamDataUnit<?,?>>

Parameters:

taskGroupParams -

getTaskControlledUnit

public PamControlledUnit getTaskControlledUnit()

Description copied from class: OfflineTask

Get the PAMControlled unit associated with a task.

Overrides:

getTaskControlledUnit in class OfflineTask<PamDataUnit<?,?>>

Returns:

PAMControlled unit associated with a task.