Package org.anchoranalysis.experiment.arguments

Class ExecutionArguments

Object

org.anchoranalysis.experiment.arguments.ExecutionArguments

public class ExecutionArguments
extends Object

Arguments that can further specify an experiment's execution (in its entirety) in addition to its bean specification.

This is often used to insert further parameters from the command-line into bean plugins, that have otherwise been loaded from BeanXML.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ExecutionArguments()	Creates with neither a model-directory nor initial task-arguments.
ExecutionArguments(Path modelDirectory, TaskArguments task)	Creates with a model-directory and an image-size suggestion.

Method Summary

Modifier and Type	Method	Description
void	activateDebugMode(String debugContains)	Activates debug-mode.
PathPrefixerContext	derivePathPrefixerContext()	Derive a PathPrefixerContext from the arguments in this class.
InputArguments	input()	Arguments to help determine the input to the experiment.
InputContextParameters	inputContextParameters()	Additional parameters that offer context for many beans that provide input-functions.
boolean	isDebugModeEnabled()	Has debug mode been enabled when executing an experiment?
OutputArguments	output()	Arguments to help specify the outputs from the experiment.
TaskArguments	task()	Arguments to help specify the outputs from the experiment.

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutionArguments

public ExecutionArguments()

Creates with neither a model-directory nor initial task-arguments.

ExecutionArguments

public ExecutionArguments(Path modelDirectory, TaskArguments task)

Creates with a model-directory and an image-size suggestion.

Parameters:

modelDirectory - the model-directory.

task - arguments to help specify the outputs from the experiment.

Method Details

inputContextParameters

public InputContextParameters inputContextParameters()

Additional parameters that offer context for many beans that provide input-functions.

Returns:

the parameters, reusing the internal data-structure.

derivePathPrefixerContext

public PathPrefixerContext derivePathPrefixerContext() throws PathPrefixerException

Derive a PathPrefixerContext from the arguments in this class.

Returns:

a newly created PathPrefixerContext derived from this class.

Throws:

PathPrefixerException - if the the path in outputDirectory of PathPrefixerContext is relative instead of absolute.

activateDebugMode

public void activateDebugMode(String debugContains)

Activates debug-mode.

Parameters:

debugContains - maybe a string used for filtering inputs during debugging, or an empty-string if this isn't enabled.

isDebugModeEnabled

public boolean isDebugModeEnabled()

Has debug mode been enabled when executing an experiment?

Returns:

true iff debug mode has been enabled.

input

public InputArguments input()

Arguments to help determine the input to the experiment.

output

public OutputArguments output()

Arguments to help specify the outputs from the experiment.

task

public TaskArguments task()

Arguments to help specify the outputs from the experiment.