Package nz.org.riskscape.engine.pipeline

Interface SinkConstructor

All Superinterfaces:
AutoCloseable, Realized
public interface SinkConstructor extends Realized

A SinkConstructor allows a Sink to be constructed from the set of execution time ExecutionOptions.

These can be returned from Step.realize(RealizationInput) to allow the pipeline to define various pipeline specific output options while still allowing some level of execution time customization.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SinkConstructor
    DEVNULL
    Constructor for a sink that throws tuples away.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Struct
    getProducedType()
    The type of tuple that come out of this realized thing, or Struct.EMPTY_STRUCT if nothing
    ResultOrProblems<Sink>
    newInstance(PipelineJobContext context)
    Create a new instance of the tuple consumer (T), returning a failed result if it couldn't be done because of the given execution options or some other environment issue As much as possible, other validation errors should have been surfaced during the realization of this SinkConstructor from the step.

    Methods inherited from interface nz.org.riskscape.engine.pipeline.Realized

    close

  • Field Details

    • DEVNULL

      static final SinkConstructor DEVNULL

      Constructor for a sink that throws tuples away.

  • Method Details

    • newInstance

      ResultOrProblems<Sink> newInstance(PipelineJobContext context)

      Create a new instance of the tuple consumer (T), returning a failed result if it couldn't be done because of the given execution options or some other environment issue As much as possible, other validation errors should have been surfaced during the realization of this SinkConstructor from the step.

    • getProducedType

      default Struct getProducedType()
      Description copied from interface: Realized

      The type of tuple that come out of this realized thing, or Struct.EMPTY_STRUCT if nothing

      Specified by:
      getProducedType in interface Realized