Package nz.org.riskscape.engine.output

Interface PipelineOutputStore

All Superinterfaces:
Identified
public interface PipelineOutputStore extends Identified

Defines an output store that is able to store the results of pipeline execution, aka a pipeline job.

  • Field Details

  • Method Details

    • newOutputOptions

      default PipelineOutputOptions newOutputOptions(String reference)
      Returns:
      a new PipelineOutputOptions object suitable for use with this store. May contain defaults or extra settings specific to this store, or just be a default PipelineOutputOptions object.

    • isApplicable

      int isApplicable(URI outputLocation)

      Returns a score indicating if this store is able to create a PipelineOutputContainer for the given URI.

      Note that this method need only check that the URI can be handled by the store, i.e. it has a recognized scheme. By the same token , returning a value greater than zero does not mean #create(URI, RealizedPipeline, MetricRegistry, PipelineOutputOptions) is guaranteed to return a successful result for the same URI.

      Parameters:
      outputLocation - a non-null user specified output location
      Returns:
      a value greater than zero if a this store can handle the given URI.

    • create

      ResultOrProblems<PipelineOutputContainer> create(URI outputLocation, RealizedPipeline pipeline, PipelineOutputOptions options)

      Creates a PipelineOutputContainer to store outputs from executing the given pipeline.

      Parameters:
      outputLocation - URI indicating where outputs should be stored
      pipeline - the pipeline whose outputs are to be stored
      options - user-defined, pipeline-global options to customize how output is stored
      Returns:
      a PipelineOutputContainer or problems describing why it couldn't be created