Package nz.org.riskscape.engine.cli.pipeline

Class CliPipelineRunner

java.lang.Object

nz.org.riskscape.engine.cli.pipeline.CliPipelineRunner

All Implemented Interfaces:

nz.org.riskscape.engine.cli.PipelineRenderer

public class CliPipelineRunner
extends Object
implements nz.org.riskscape.engine.cli.PipelineRenderer

Has code for running the execution of a realized pipeline and sending the output etc to the right place. Factored out here for reuse from other commands

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<LocalDateTime>	DEFAULT_TIME_FUNCTION
static final String	MONITOR_PROGRESS_DEFAULT
static final String	PARAMETERS_FILENAME	The filename of the parameters file that contains the parameters that were used in the model run.

Constructor Summary

Constructors

Constructor	Description
CliPipelineRunner(nz.org.riskscape.engine.pipeline.ExecutionContext executionContext, nz.org.riskscape.engine.cli.TerminalCommand command)
CliPipelineRunner(nz.org.riskscape.engine.pipeline.ExecutionContext executionContext, nz.org.riskscape.engine.i18n.Messages messages, nz.org.riskscape.cli.Terminal terminal, Supplier<LocalDateTime> currentTime)

Method Summary

Modifier and Type	Method	Description
static String	createDirFriendlyTimestamp(LocalDateTime dateTime)
Optional<nz.org.riskscape.engine.util.ProgressNotifier>	createProgressNotifier(CliPipelineRunnerOptions options, com.codahale.metrics.MetricRegistry metrics, nz.org.riskscape.engine.Project useProject)
Locale	getLocale()
nz.org.riskscape.engine.i18n.Messages	getMessages()
void	run(nz.org.riskscape.engine.pipeline.RealizedPipeline realized, CliPipelineRunnerOptions options)
void	run(nz.org.riskscape.engine.pipeline.RealizedPipeline realized, CliPipelineRunnerOptions options, Map<String,List<?>> parameters)

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.org.riskscape.engine.cli.PipelineRenderer

boundPipelineParameterToString, graph, printPipeline, printStep, printStruct

Field Details

DEFAULT_TIME_FUNCTION

public static final Supplier<LocalDateTime> DEFAULT_TIME_FUNCTION

PARAMETERS_FILENAME

public static final String PARAMETERS_FILENAME

The filename of the parameters file that contains the parameters that were used in the model run.

See Also:

• Constant Field Values

MONITOR_PROGRESS_DEFAULT

public static final String MONITOR_PROGRESS_DEFAULT

See Also:

• Constant Field Values

Constructor Details

CliPipelineRunner

public CliPipelineRunner(nz.org.riskscape.engine.pipeline.ExecutionContext executionContext,
 nz.org.riskscape.engine.cli.TerminalCommand command)

CliPipelineRunner

public CliPipelineRunner(nz.org.riskscape.engine.pipeline.ExecutionContext executionContext,
 nz.org.riskscape.engine.i18n.Messages messages,
 nz.org.riskscape.cli.Terminal terminal,
 Supplier<LocalDateTime> currentTime)

Method Details

createDirFriendlyTimestamp

public static String createDirFriendlyTimestamp(LocalDateTime dateTime)

Returns:

a file system path friendly string that represents the given datetime.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface nz.org.riskscape.engine.cli.PipelineRenderer

run

public void run(nz.org.riskscape.engine.pipeline.RealizedPipeline realized,
 CliPipelineRunnerOptions options)

run

public void run(nz.org.riskscape.engine.pipeline.RealizedPipeline realized,
 CliPipelineRunnerOptions options,
 Map<String,List<?>> parameters)

createProgressNotifier

public Optional<nz.org.riskscape.engine.util.ProgressNotifier> createProgressNotifier(CliPipelineRunnerOptions options,
 com.codahale.metrics.MetricRegistry metrics,
 nz.org.riskscape.engine.Project useProject)

getMessages

public nz.org.riskscape.engine.i18n.Messages getMessages()

Specified by:

getMessages in interface nz.org.riskscape.engine.cli.PipelineRenderer