Package nz.org.riskscape.engine.task

Class RelationTask

java.lang.Object

nz.org.riskscape.engine.task.WorkerTask

nz.org.riskscape.engine.task.RelationTask

All Implemented Interfaces:

AutoCloseable

public class RelationTask
extends WorkerTask

Field Summary

Fields inherited from class nz.org.riskscape.engine.task.WorkerTask

id, in, out, pageReader, pageWriter, processingResult, runtime, runtimeAverage, spec

Constructor Summary

Constructors

Constructor	Description
RelationTask(TaskSpec spec)

Method Summary

Modifier and Type	Method	Description
void	close()	Override this method to clean up any resources that were allocated/created by this task for use during execution.
boolean	producesResult()
ReturnState	run()	Processes the work that the task has to do.

Methods inherited from class nz.org.riskscape.engine.task.WorkerTask

consumeProcessingResult, getContext, getFirstStep, getFirstStepRealizedResult, getLastStep, getName, getPageReader, getPageWriter, getSpec, getSpecNameBrief, hasInputPage, hasOutputPage, hasPageInProgress, isComplete, isCreated, isInputReady, isOutputReady, isReadyToRun, isStarted, markComplete, markStarted, runPublic, taskComplete, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RelationTask

public RelationTask(TaskSpec spec)

Method Details

run

public ReturnState run()

Description copied from class: WorkerTask

Processes the work that the task has to do. The task doesn't necessarily run to completion in one go - it's likely that the task will run out of input or output first, so it'll need to keep coming back and chipping away at the work.

Specified by:

run in class WorkerTask

close

public void close()

Description copied from class: WorkerTask

Override this method to clean up any resources that were allocated/created by this task for use during execution. Will be called from the scheduler once the task has signaled it is complete, but it may also get called if a job that this task was part of has failed.

Thread safety should be ensured by requiring the scheduler to only call close on a task that is not currently being run.

Implementations shouldn't need to do any buffer management in this method, it's meant for closing things like TupleIterators or other sorts of resources that follow the Closeable pattern.

Specified by:

close in interface AutoCloseable

Overrides:

close in class WorkerTask

producesResult

public boolean producesResult()

Specified by:

producesResult in class WorkerTask