Package nz.org.riskscape.engine.pipeline

Class ExecutionOptions

java.lang.Object
nz.org.riskscape.engine.pipeline.ExecutionOptions
public class ExecutionOptions extends Object

Various options that apply to PipelineExecutor#execute(RealizedPipeline, ExecutionOptions)

  • Field Details

    • SEND_IT_TO_HELL

      public static final Function<RealizedStep,SinkConstructor> SEND_IT_TO_HELL

      A 'useful' function for capping a pipeline with a black hole - results are thrown away.

  • Constructor Details

    • ExecutionOptions

      public ExecutionOptions()

  • Method Details

    • clone

      public ExecutionOptions clone()
      Overrides:
      clone in class Object

    • getDefaultCreationOptions

      public CreateRequest getDefaultCreationOptions()

      A URI to use for storing results, typically with ResourceFactory.create(nz.org.riskscape.engine.resource.CreateRequest)

    • getStepCapper

      public Function<RealizedStep,SinkConstructor> getStepCapper()

      A function to use for applying a Sink to any terminal steps that are not themselves sinks. The argument is the realized step that must be capped. If you really don't care about any uncapped outputs, then you can use {@link #SEND<em>IT</em>TO_HELL}

    • getSaveFormat

      public Format getSaveFormat()

      The preferred file format that pipeline results should be saved in

    • getProgressMetrics

      public com.codahale.metrics.MetricRegistry getProgressMetrics()

      A set of metrics that are useful to show progress to the user.

    • setDefaultCreationOptions

      public void setDefaultCreationOptions(CreateRequest defaultCreationOptions)

      A URI to use for storing results, typically with ResourceFactory.create(nz.org.riskscape.engine.resource.CreateRequest)

    • setStepCapper

      public void setStepCapper(Function<RealizedStep,SinkConstructor> stepCapper)

      A function to use for applying a Sink to any terminal steps that are not themselves sinks. The argument is the realized step that must be capped. If you really don't care about any uncapped outputs, then you can use {@link #SEND<em>IT</em>TO_HELL}

    • setSaveFormat

      public void setSaveFormat(Format saveFormat)

      The preferred file format that pipeline results should be saved in

    • setProgressMetrics

      public void setProgressMetrics(com.codahale.metrics.MetricRegistry progressMetrics)

      A set of metrics that are useful to show progress to the user.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object