Package org.anchoranalysis.experiment.task

Class InputOutputContextStateful

Object

InputOutputContextStateful

All Implemented Interfaces:

InputOutputContext

public class InputOutputContextStateful
extends Object
implements InputOutputContext

This exists as an implementation of InputOutputContext that exposes a StatefulMessageLogger.

As StatefulMessageLogger exists only in this package, and not in the package where InputOutputContext is defined, the interface and class are deliberately separated.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
InputOutputContextStateful(ExecutionArguments executionArguments, Outputter outputter, ExecutionTimeRecorder executionTimeRecorder, StatefulMessageLogger logger, ErrorReporter errorReporter)	Creates with initialization arguments.

Method Summary

Modifier and Type	Method	Description
ExecutionArguments	getExecutionArguments()	User-supplied arguments that can further specify an experiment's execution.
ExecutionTimeRecorder	getExecutionTimeRecorder()	Allows execution-times to be recorded for particular operations.
Logger	getLogger()	The associated logger.
StatefulMessageLogger	getMessageLogger()	Exposed as StatefulMessageLogger rather than as MessageLogger that is found in Logger
Path	getModelDirectory()	An input-directory in which models are stored.
Outputter	getOutputter()	An outputter that writes to the particular output-directory.
boolean	isDebugEnabled()	Is debug-mode enabled?

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.io.output.outputter.InputOutputContext

common, getErrorReporter, getMessageReporter, maybeSubdirectory, operationContext, subdirectory

Constructor Details

InputOutputContextStateful

public InputOutputContextStateful(ExecutionArguments executionArguments,
 Outputter outputter,
 ExecutionTimeRecorder executionTimeRecorder,
 StatefulMessageLogger logger,
 ErrorReporter errorReporter)

Creates with initialization arguments.

Parameters:

executionArguments - user-supplied arguments that can further specify an experiment's execution.

outputter - where files are outputted to, and how that output occurs.

executionTimeRecorder - records how long different aspects of an experiment take to execute.

logger - where log messages written to.

errorReporter - where errors are written to.

Method Details

getModelDirectory

public Path getModelDirectory()

Description copied from interface: InputOutputContext

An input-directory in which models are stored.

Specified by:

getModelDirectory in interface InputOutputContext

Returns:

a path to the model-directory.

isDebugEnabled

public boolean isDebugEnabled()

Description copied from interface: InputOutputContext

Is debug-mode enabled?

Specified by:

isDebugEnabled in interface InputOutputContext

Returns:

true iff debug-mode is enabled

getOutputter

public Outputter getOutputter()

Description copied from interface: InputOutputContext

An outputter that writes to the particular output-directory.

Specified by:

getOutputter in interface InputOutputContext

Returns:

the outputter.

getLogger

public Logger getLogger()

Description copied from interface: InputOutputContext

The associated logger.

Specified by:

getLogger in interface InputOutputContext

Returns:

the logger associated with input-output operations.

getMessageLogger

public StatefulMessageLogger getMessageLogger()

Exposed as StatefulMessageLogger rather than as MessageLogger that is found in Logger

Returns:

the logger.

getExecutionTimeRecorder

public ExecutionTimeRecorder getExecutionTimeRecorder()

Description copied from interface: InputOutputContext

Allows execution-times to be recorded for particular operations.

Specified by:

getExecutionTimeRecorder in interface InputOutputContext

Returns:

the recorder.

getExecutionArguments

public ExecutionArguments getExecutionArguments()

User-supplied arguments that can further specify an experiment's execution.