T
- shared-state of naming
public class CopyFiles<T> extends Task<FileWithDirectoryInput,RecordingCounter<T>>
Unusually this task does not use the InputOutputContext
for each job, but rather for
the experiment as a whole when determining the destination path for files. Similarly the
message-log of the experiment is used for non-error messages.
The following outputs are produced:
Output Name | Default? | Description |
---|---|---|
yes | a copied file for each input file. | |
outputs from the RecordingCounter | ||
outputs from Task |
Constructor and Description |
---|
CopyFiles() |
Modifier and Type | Method and Description |
---|---|
void |
afterAllJobsAreExecuted(RecordingCounter<T> sharedState,
InputOutputContext context)
Called once after all calls to
Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>) . |
RecordingCounter<T> |
beforeAnyJobIsExecuted(Outputter outputter,
ConcurrencyPlan concurrencyPlan,
List<FileWithDirectoryInput> inputs,
ParametersExperiment parameters)
Called once before all calls to
Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>) . |
OutputEnabledMutable |
defaultOutputs()
If specified, default rules for determine which outputs are enabled or not.
|
void |
doJobOnInput(InputBound<FileWithDirectoryInput,RecordingCounter<T>> input)
Performs the task on a particular input.
|
CopyFilesMethod |
getMethod()
How the copying occurs from source to destination file.
|
CopyFilesNaming<T> |
getNaming()
How an output name (and path) is selected for an input file.
|
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.
|
void |
setMethod(CopyFilesMethod method)
How the copying occurs from source to destination file.
|
void |
setNaming(CopyFilesNaming<T> naming)
How an output name (and path) is selected for an input file.
|
executeJob, isInputCompatibleWith
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public boolean hasVeryQuickPerInputExecution()
Task
hasVeryQuickPerInputExecution
in class Task<FileWithDirectoryInput,RecordingCounter<T>>
public InputTypesExpected inputTypesExpected()
Task
This is usually the class of T (or sometimes the absolute base class InputFromManager).
inputTypesExpected
in class Task<FileWithDirectoryInput,RecordingCounter<T>>
public RecordingCounter<T> beforeAnyJobIsExecuted(Outputter outputter, ConcurrencyPlan concurrencyPlan, List<FileWithDirectoryInput> inputs, ParametersExperiment parameters) throws ExperimentExecutionException
Task
Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>)
.beforeAnyJobIsExecuted
in class Task<FileWithDirectoryInput,RecordingCounter<T>>
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.Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>)
and to Task.afterAllJobsAreExecuted(S, org.anchoranalysis.io.output.outputter.InputOutputContext)
.ExperimentExecutionException
- if a fatal error occurs executing this step of the
experiment.public void doJobOnInput(InputBound<FileWithDirectoryInput,RecordingCounter<T>> input) throws JobExecutionException
Task
doJobOnInput
in class Task<FileWithDirectoryInput,RecordingCounter<T>>
input
- the input for the job.JobExecutionException
- if an error occurs executing a particular job, that is not
otherwise suppressed.public void afterAllJobsAreExecuted(RecordingCounter<T> sharedState, InputOutputContext context) throws ExperimentExecutionException
Task
Task.executeJob(org.anchoranalysis.experiment.task.ParametersUnbound<T, S>)
.afterAllJobsAreExecuted
in class Task<FileWithDirectoryInput,RecordingCounter<T>>
sharedState
- the shared-statecontext
- IO-context for experiment (not for an individual job)ExperimentExecutionException
- if a fatal error occurs executing this step of the
experiment.public OutputEnabledMutable defaultOutputs()
Task
defaultOutputs
in class Task<FileWithDirectoryInput,RecordingCounter<T>>
public CopyFilesMethod getMethod()
e.g. with or without compression.
public void setMethod(CopyFilesMethod method)
e.g. with or without compression.
public CopyFilesNaming<T> getNaming()
public void setNaming(CopyFilesNaming<T> naming)
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.