Package tethys.tasks

Class ExportDataBlockTask

java.lang.Object

offlineProcessing.OfflineTask

tethys.tasks.TethysTask

tethys.tasks.ExportDataBlockTask

All Implemented Interfaces:

DetectionExportObserver

public class ExportDataBlockTask
extends TethysTask
implements DetectionExportObserver

Field Summary

Fields inherited from class tethys.tasks.TethysTask

whyNot

Constructor Summary

Constructors

Constructor	Description
ExportDataBlockTask(TethysControl tethysControl, TethysTaskManager tethysTaskManager, PamDataBlock parentDataBlock)

Method Summary

Modifier and Type	Method	Description
boolean	callSettings(Component component, Point point)	Call any task specific settings.
boolean	canRun()	Check the Tethys server, reset the whyNot flag to null, return false is server not OK.
protected void	exportOptions(Component component, Point point)
String	getName()
ArrayList<PamSettings>	getSettingsProviders()
boolean	hasSettings()	task has settings which can be modified.
protected void	itisCodes(Component component, Point point)
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).
boolean	processDataUnit(PamDataUnit dataUnit)	Process a single data unit.
void	runEntireTask(OfflineTaskGroup.TaskGroupWorker taskGroupWorker, ExportDatablockGroup exportDatablockGroup)	Called back from modified offlinetaskgroup which will let the detectionshander do all the data load / management in it's own way
void	update(DetectionExportProgress progress)	Update message and state of export
String	whyNot()	If a task can't run, try to return a string to say why not.

Methods inherited from class tethys.tasks.TethysTask

getTethysControl, getTethysTaskManager

Methods inherited from class offlineProcessing.OfflineTask

addAffectedDataBlock, addRequiredDataBlock, addRequiredDataBlock, addRequiredDataBlock, callSettings, completeTask, deleteOldData, deleteOldOutput, getAffectedBlocksList, getAffectedDataBlock, getDataBlock, getLongName, getNumAffectedDataBlocks, getNumRequiredDataBlocks, getOfflineTaskGroup, getParentControlledUnit, getRequiredDataBlock, getTaskControlledUnit, getUnitName, getUnitType, isDoRun, prepareTask, setDoRun, setOfflineTaskGroup, setParentDataBlock

Methods inherited from class java.lang.Object

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

Constructor Details

ExportDataBlockTask

public ExportDataBlockTask(TethysControl tethysControl,
 TethysTaskManager tethysTaskManager,
 PamDataBlock parentDataBlock)

Method Details

getName

public String getName()

Specified by:

getName in class OfflineTask

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

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 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

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

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

Returns:

true or false

callSettings

public boolean callSettings(Component component,
 Point point)

Description copied from class: OfflineTask

Call any task specific settings. This replaces the older function callSettings() which is now deprecated. Passes a reference to an awt component so that it's location can be used to open a popup dialog, etc, for more complex systems with many options.

Overrides:

callSettings in class OfflineTask

Parameters:

component - button or whatever called the settings.

Returns:

exportOptions

protected void exportOptions(Component component,
 Point point)

itisCodes

protected void itisCodes(Component component,
 Point point)

canRun

public boolean canRun()

Description copied from class: TethysTask

Check the Tethys server, reset the whyNot flag to null, return false is server not OK. Expect to override / extend in concrete export tasks.

Overrides:

canRun in class TethysTask

Returns:

true if it's possible to run the task.

whyNot

public String whyNot()

Description copied from class: OfflineTask

If a task can't run, try to return a string to say why not.

Overrides:

whyNot in class TethysTask

Returns:

text reason as to why task can't run (such as missing data).

runEntireTask

public void runEntireTask(OfflineTaskGroup.TaskGroupWorker taskGroupWorker,
 ExportDatablockGroup exportDatablockGroup)

Called back from modified offlinetaskgroup which will let the detectionshander do all the data load / management in it's own way

Parameters:

taskGroupWorker -

exportDatablockGroup -

update

public void update(DetectionExportProgress progress)

Description copied from interface: DetectionExportObserver

Update message and state of export

Specified by:

update in interface DetectionExportObserver

Parameters:

progress -

getSettingsProviders

public ArrayList<PamSettings> getSettingsProviders()

Overrides:

getSettingsProviders in class OfflineTask