Package org.anchoranalysis.plugin.io.bean.task

Class SummarizeBase<T extends InputFromManager,S>

Object

AnchorBean<Task<T,Summarizer<S>>>

Task<T,Summarizer<S>>

SummarizeBase<T,S>

Direct Known Subclasses:

SummarizeInputs

public abstract class SummarizeBase<T extends InputFromManager,S>
extends Task<T,Summarizer<S>>

Constructor Summary

Constructors

Constructor	Description
SummarizeBase()

Method Summary

Modifier and Type	Method	Description
void	afterAllJobsAreExecuted(Summarizer<S> sharedState, InputOutputContext context)	Called once after all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).
Summarizer<S>	beforeAnyJobIsExecuted(Outputter outputter, ConcurrencyPlan concurrencyPlan, List<T> inputs, ParametersExperiment parameters)	Called once before all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).
void	doJobOnInput(InputBound<T,Summarizer<S>> input)	Performs the task on a particular input.
protected abstract S	extractObjectForSummary(T input)	Extract object for summary.
Summarizer<S>	getSummarizer()
boolean	hasVeryQuickPerInputExecution()	Is the execution-time of the task per-input expected to be very quick to execute?
void	setSummarizer(Summarizer<S> summarizer)

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

defaultOutputs, executeJob, inputTypesExpected, 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

SummarizeBase

public SummarizeBase()

Method Details

beforeAnyJobIsExecuted

public Summarizer<S> beforeAnyJobIsExecuted(Outputter outputter,
 ConcurrencyPlan concurrencyPlan,
 List<T> inputs,
 ParametersExperiment parameters)
                                     throws ExperimentExecutionException

Description copied from class: Task

Called once before all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).

Specified by:

beforeAnyJobIsExecuted in class Task<T extends InputFromManager,Summarizer<S>>

Parameters:

outputter - the output-manager for the experiment (not for an individual job)

concurrencyPlan - available numbers of processors that can call Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>)

inputs - a list of inputs, each will result in at least one call to Task.executeJob(ParametersUnbound).

parameters - the experiment-parameters.

Returns:

the shared-state that is passed to each call to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>) and to Task.afterAllJobsAreExecuted(S, org.anchoranalysis.io.output.outputter.InputOutputContext).

Throws:

ExperimentExecutionException - if a fatal error occurs executing this step of the experiment.

doJobOnInput

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

Description copied from class: Task

Performs the task on a particular input.

Specified by:

doJobOnInput in class Task<T extends InputFromManager,Summarizer<S>>

Parameters:

input - the input for the job.

Throws:

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

afterAllJobsAreExecuted

public void afterAllJobsAreExecuted(Summarizer<S> sharedState,
 InputOutputContext context)
                             throws ExperimentExecutionException

Description copied from class: Task

Called once after all calls to Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>).

Specified by:

afterAllJobsAreExecuted in class Task<T extends InputFromManager,Summarizer<S>>

Parameters:

sharedState - the shared-state

context - IO-context for experiment (not for an individual job)

Throws:

ExperimentExecutionException - if a fatal error occurs executing this step of the experiment.

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<T extends InputFromManager,Summarizer<S>>

Returns:

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

extractObjectForSummary

protected abstract S extractObjectForSummary(T input)

Extract object for summary.

getSummarizer

public Summarizer<S> getSummarizer()

setSummarizer

public void setSummarizer(Summarizer<S> summarizer)