offlineProcessing

Class OfflineTask<T extends PamDataUnit>

java.lang.Object

offlineProcessing.OfflineTask<T>

Direct Known Subclasses:

AlarmOfflineTask, AnnotationOfflineTask, BatchLocaliseOfflineTask, BatchTMLocalisation, ClickBearingTask, ClickDelayTask, ClickReClassifyTask, DataCopyTask, DbHtSummaryTask, EchoDetectionTask, FindDetectionNOfflineTask, OneBandSummaryTask, ReclassifyTask

public abstract class OfflineTask<T extends PamDataUnit>
extends java.lang.Object

An offline task, such as click species id. Generally controlled and operated from within an OLProcessDialog

Author:

Doug Gillespie

See Also:

OLProcessDialog

Constructor Summary

Constructors

Constructor and Description
OfflineTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAffectedDataBlock(PamDataBlock dataBlock) Add an affected data block.
void	addRequiredDataBlock(PamDataBlock dataBlock) Add a required data block.
boolean	callSettings() Call any task specific settings
boolean	canRun() can the task be run ? This will generally be true, but may be false if the task is dependent on some other module which may not be present.
void	completeTask() Called at the end of the thread which executes this task.
void	deleteOldOutput(long currentViewDataStart, long currentViewDataEnd, OfflineDataMapPoint mapPoint) Delete database outptut data in the list of output datablocks.
PamDataBlock	getAffectedDataBlock(int iBlock) A data block required to run this task.
PamDataBlock<T>	getDataBlock() (Not sure what happens if we need multiple data units to complete a task !)
abstract java.lang.String	getName()
int	getNumAffectedDataBlocks()
int	getNumRequiredDataBlocks()
OfflineTaskGroup	getOfflineTaskGroup()
PamDataBlock	getRequiredDataBlock(int iBlock) A data block required to run this task.
boolean	hasSettings() task has settings which can be called
boolean	isDoRun() return whether or not the task SHOULD be run - i.e.
abstract void	loadedDataComplete() Called when processing of loaded data, or each map point worth of data, is complete.
abstract 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.
abstract boolean	processDataUnit(T dataUnit) Process a single data unit.
void	setDoRun(boolean doRun) Set whether or not this task within a taskGroup should be run.
void	setOfflineTaskGroup(OfflineTaskGroup offlineTaskGroup)
void	setParentDataBlock(PamDataBlock dataBlock)

Methods inherited from class java.lang.Object

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

Constructor Detail

OfflineTask

public OfflineTask()

Method Detail

getDataBlock

public PamDataBlock<T> getDataBlock()

(Not sure what happens if we need multiple data units to complete a task !)

Returns:

the datablock used by the task.

setParentDataBlock

public void setParentDataBlock(PamDataBlock dataBlock)

Parameters:

dataBlock - the dataBlock to set

getName

public abstract java.lang.String getName()

Returns:

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

hasSettings

public boolean hasSettings()

task has settings which can be called

Returns:

true or false

callSettings

public boolean callSettings()

Call any task specific settings

Returns:

true if settings may have changed.

canRun

public boolean canRun()

can the task be run ? This will generally be true, but may be false if the task is dependent on some other module which may not be present.

Returns:

true if it's possible to run the task.

processDataUnit

public abstract boolean processDataUnit(T dataUnit)

Process a single data unit.

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.

newDataLoad

public abstract 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).

Parameters:

startTime - start time of loaded data

endTime - end time of loaded data

loadedDataComplete

public abstract void loadedDataComplete()

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

addRequiredDataBlock

public void addRequiredDataBlock(PamDataBlock dataBlock)

Add a required data block. These are data blocks apart from the main one which are required before this task can complete. Data for these block will be loaded automatically.

Parameters:

dataBlock - required data block.

getNumRequiredDataBlocks

public int getNumRequiredDataBlocks()

Returns:

the number of data blocks required to run this task.

getRequiredDataBlock

public PamDataBlock getRequiredDataBlock(int iBlock)

A data block required to run this task.

Parameters:

iBlock - block index

Returns:

data block .

addAffectedDataBlock

public void addAffectedDataBlock(PamDataBlock dataBlock)

Add an affected data block. These are data blocks apart from the main one which will have their contents changed by tehe task and will require saving / updating as the task progresses.

Parameters:

dataBlock - affected data block.

getNumAffectedDataBlocks

public int getNumAffectedDataBlocks()

Returns:

the number of data blocks required to run this task.

getAffectedDataBlock

public PamDataBlock getAffectedDataBlock(int iBlock)

A data block required to run this task.

Parameters:

iBlock - block index

Returns:

data block .

isDoRun

public boolean isDoRun()

return whether or not the task SHOULD be run - i.e. is it selected in the dialog, etc. ?

Returns:

the doRun

setDoRun

public void setDoRun(boolean doRun)

Set whether or not this task within a taskGroup should be run.

Parameters:

doRun - the doRun to set

getOfflineTaskGroup

public OfflineTaskGroup getOfflineTaskGroup()

Returns:

the offlineTaskGroup

setOfflineTaskGroup

public void setOfflineTaskGroup(OfflineTaskGroup offlineTaskGroup)

Parameters:

offlineTaskGroup - the offlineTaskGroup to set

deleteOldOutput

public void deleteOldOutput(long currentViewDataStart,
                   long currentViewDataEnd,
                   OfflineDataMapPoint mapPoint)

Delete database outptut data in the list of output datablocks. All data in the time range of data read into the primary source data block will be deleted.

Parameters:

currentViewDataStart -

currentViewDataEnd -

mapPoint -

prepareTask

public void prepareTask()

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

completeTask

public void completeTask()

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