Package tethys.tasks

Class TethysTask

java.lang.Object

offlineProcessing.OfflineTask

tethys.tasks.TethysTask

Direct Known Subclasses:

ExportCalibrationTask, ExportDataBlockTask, ExportDeploymentsTask

public abstract class TethysTask
extends OfflineTask

Base class for offline tasks in Tethys. These probably won't be made available as tasks in Tethys, but will be picked up by the batch processor which can then execute them across multiple datasets.

These will have to be set up with their own complete sets of parameters, i.e. all the information that was normally going into the export Wizards, so that they can be fully automated from the batch processor.

Author:

dg50

Field Summary

Fields

Modifier and Type	Field	Description
protected String	whyNot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	canRun()	Check the Tethys server, reset the whyNot flag to null, return false is server not OK.
TethysControl	getTethysControl()
TethysTaskManager	getTethysTaskManager()
String	whyNot()	If a task can't run, try to return a string to say why not.

Methods inherited from class offlineProcessing.OfflineTask

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

Methods inherited from class java.lang.Object

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

Field Details

whyNot

protected String whyNot

Constructor Details

TethysTask

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

Method Details

canRun

public boolean canRun()

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 OfflineTask

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 OfflineTask

Returns:

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

getTethysControl

public TethysControl getTethysControl()

Returns:

the tethysControl

getTethysTaskManager

public TethysTaskManager getTethysTaskManager()

Returns:

the tethysTaskManager