Package org.anchoranalysis.launcher.run.tasks

Class HelloWorld<S extends InputFromManager>

Object

AnchorBean<Task<S,NoSharedState>>

Task<S,NoSharedState>

TaskWithoutSharedState<S>

HelloWorld<S>

Type Parameters:

S - the type of InputFromManager expected

public class HelloWorld<S extends InputFromManager>
extends TaskWithoutSharedState<S>

A dummy task that simply writes a message to all log files, specifically: 1. log file for experiment 2. log file for each input-object

The message is:

1. a line saying Hello World.
2. a recommendation to replace the task with a specific task.
3. a link to a page on the Anchor website showing predefined tasks.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
HelloWorld()

Method Summary

Modifier and Type	Method	Description
void	doJobOnInput(InputBound<S,NoSharedState> input)	Performs the task on a particular input.
boolean	hasVeryQuickPerInputExecution()	Is the execution-time of the task per-input expected to be very quick to execute?
InputTypesExpected	inputTypesExpected()	Highest class(es) that will function as a valid input.

Methods inherited from class org.anchoranalysis.experiment.bean.task.TaskWithoutSharedState

afterAllJobsAreExecuted, beforeAnyJobIsExecuted

Methods inherited from class org.anchoranalysis.experiment.bean.task.Task

defaultOutputs, executeJob, isInputCompatibleWith

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

HelloWorld

public HelloWorld()

Method Details

inputTypesExpected

public InputTypesExpected inputTypesExpected()

Description copied from class: Task

Highest class(es) that will function as a valid input.

This is usually the class of T (or sometimes the absolute base class InputFromManager).

Specified by:

inputTypesExpected in class Task<S extends InputFromManager,NoSharedState>

Returns:

the input-types that a task expects.

doJobOnInput

public void doJobOnInput(InputBound<S,NoSharedState> input)
                  throws JobExecutionException

Description copied from class: Task

Performs the task on a particular input.

Specified by:

doJobOnInput in class Task<S extends InputFromManager,NoSharedState>

Parameters:

input - the input for the job.

Throws:

JobExecutionException - if an error occurs executing a particular job, that is not otherwise suppressed.

hasVeryQuickPerInputExecution

public boolean hasVeryQuickPerInputExecution()

Description copied from class: Task

Is the execution-time of the task per-input expected to be very quick to execute?

Specified by:

hasVeryQuickPerInputExecution in class Task<S extends InputFromManager,NoSharedState>

Returns:

true iff the execution is expected to be very quick, false otherwise.