Package nz.org.riskscape.engine.task

Class IndexBuilderTask<T>

java.lang.Object

nz.org.riskscape.engine.task.WorkerTask

nz.org.riskscape.engine.task.IndexBuilderTask<T>

All Implemented Interfaces:

AutoCloseable

public class IndexBuilderTask<T>
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
IndexBuilderTask(TaskSpec spec)

Method Summary

Modifier and Type	Method	Description
T	getIndex()
String	getSpecNameBrief()
boolean	producesResult()
ReturnState	run()	Processes the work that the task has to do.

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

close, consumeProcessingResult, getContext, getFirstStep, getFirstStepRealizedResult, getLastStep, getName, getPageReader, getPageWriter, getSpec, 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

IndexBuilderTask

public IndexBuilderTask(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

producesResult

public boolean producesResult()

Specified by:

producesResult in class WorkerTask

getSpecNameBrief

public String getSpecNameBrief()

Overrides:

getSpecNameBrief in class WorkerTask

Returns:

a unique name for the worker's TaskSpec that is brief and user-friendly. This can be used as a simple way to represent the work that this task is doing to the user.

getIndex

public T getIndex()