Package nz.org.riskscape.engine.steps

Class ChildPipelineBuilder

java.lang.Object
nz.org.riskscape.engine.steps.ChildPipelineBuilder
public class ChildPipelineBuilder extends Object

Helper class for realizing a child pipeline that gets 'smooshed' back in to a parent as part of realizing a step

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChildPipelineBuilder(nz.org.riskscape.engine.pipeline.RealizationInput input, nz.org.riskscape.rl.ast.InputChain inputChain)
     
    ChildPipelineBuilder(nz.org.riskscape.engine.pipeline.RealizationInput input, nz.org.riskscape.rl.ast.PipelineDeclaration childAst)
    Constructs a new ChildPipelineBuilder for realizing and integrating a child pipeline into a parent pipeline.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addInputStep(nz.org.riskscape.engine.pipeline.RealizedStep stepFromParent)
    Adds an input step from the parent pipeline into the child pipeline (named in) by creating a stub step.
    void
    addInputStep(nz.org.riskscape.engine.pipeline.RealizedStep stepFromParent, String stubName)
    Adds an input step from the parent pipeline into the child pipeline by creating a stub step.
    void
    addParameter(String key, nz.org.riskscape.rl.ast.Expression value)
     
    ChildPipelineBuilder
    addParameters(Map<String,nz.org.riskscape.rl.ast.Expression> parameters)
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    addWellKnownOutput(nz.org.riskscape.engine.pipeline.RealizedStep outputStep, List<nz.org.riskscape.problem.Problem> warnings)
    Adds a step to the combined pipeline named after the input's prototype step (so will have the expected name) for any dependencies that are chained to this step.
    protected boolean
    canEqual(Object other)
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    combine()
    Combines the realized child pipeline back into the parent pipeline.
    ChildPipelineBuilder
    combineWith(nz.org.riskscape.engine.pipeline.RealizedPipeline newParent)
    Update this builder to realize against a different parent RealizedPipeline to the one that was provided in the RealizationInput.
    void
    drainWarningsFromChild(Consumer<nz.org.riskscape.problem.Problem> sink)
    Updates the realized child to remove any warnings (and sends them to the sink, e.g.
    boolean
    equals(Object o)
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    getBuilding()
     
    nz.org.riskscape.rl.ast.PipelineDeclaration
    getChildAst()
     
    nz.org.riskscape.engine.pipeline.RealizedStep
    getChildInputStep(nz.org.riskscape.engine.pipeline.RealizedStep originalInputStep)
    Retrieves the stub step that was created in the child pipeline for a given parent input step.
    Object
    getChildPipelineFrom()
    Used to customize any error message that results from realizing the child ast, defaults to the AST's location
    String
    getChildStepPrefix()
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    getCombined()
     
    nz.org.riskscape.engine.pipeline.RealizationInput
    getInput()
     
    Map<nz.org.riskscape.engine.pipeline.RealizedStep,nz.org.riskscape.engine.pipeline.RealizedStep>
    getInputSteps()
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    getParent()
     
    Map<String,nz.org.riskscape.rl.ast.Expression>
    getPipelineParameters()
     
    Map<nz.org.riskscape.engine.pipeline.RealizedStep,nz.org.riskscape.engine.pipeline.RealizedStep>
    getRebuilt()
     
    nz.org.riskscape.engine.pipeline.RealizedStep
    getRebuiltEndStep(nz.org.riskscape.rl.ast.InputChain rhs)
    While an input chain AST has only one end step (because it is a single branch), if any of the steps in that branch realize a subpipeline, then there's potential for there to be more than one end step in the child.
    nz.org.riskscape.engine.pipeline.RealizedStep
    getRebuiltStep(nz.org.riskscape.engine.pipeline.RealizedStep childStep)
     
    nz.org.riskscape.engine.steps.ChildPipelineBuilder.State
    getState()
     
    int
    hashCode()
     
    boolean
    isChildFailed()
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    realizeChild()
    Realizes the child pipeline using the configured AST and input steps.
    void
    setBuilding(nz.org.riskscape.engine.pipeline.RealizedPipeline building)
     
    ChildPipelineBuilder
    setChildPipelineFrom(Object pipelineSource)
    Customize errors resulting from combine to use a non-stanard 'failed to realize child pipeline' error.
    void
    setChildStepPrefix(String childStepPrefix)
     
    void
    setCombined(nz.org.riskscape.engine.pipeline.RealizedPipeline combined)
     
    void
    setParent(nz.org.riskscape.engine.pipeline.RealizedPipeline parent)
     
    void
    setRebuilt(Map<nz.org.riskscape.engine.pipeline.RealizedStep,nz.org.riskscape.engine.pipeline.RealizedStep> rebuilt)
     
    void
    setState(nz.org.riskscape.engine.steps.ChildPipelineBuilder.State state)
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ChildPipelineBuilder

      public ChildPipelineBuilder(nz.org.riskscape.engine.pipeline.RealizationInput input, nz.org.riskscape.rl.ast.InputChain inputChain)

    • ChildPipelineBuilder

      public ChildPipelineBuilder(nz.org.riskscape.engine.pipeline.RealizationInput input, nz.org.riskscape.rl.ast.PipelineDeclaration childAst)

      Constructs a new ChildPipelineBuilder for realizing and integrating a child pipeline into a parent pipeline.

      Parameters:
      input - the realization input containing the parent pipeline and context
      childAst - the AST declaration of the child pipeline to be realized

  • Method Details

    • combineWith

      public ChildPipelineBuilder combineWith(nz.org.riskscape.engine.pipeline.RealizedPipeline newParent)

      Update this builder to realize against a different parent RealizedPipeline to the one that was provided in the RealizationInput. This must be done before any input steps are set.

    • addInputStep

      public void addInputStep(nz.org.riskscape.engine.pipeline.RealizedStep stepFromParent)

      Adds an input step from the parent pipeline into the child pipeline (named in) by creating a stub step. The stub step mirrors the parent step's output schema but won't be executed during child pipeline realization.

      Parameters:
      stepFromParent - the realized step from the parent pipeline to use as input

    • addInputStep

      public void addInputStep(nz.org.riskscape.engine.pipeline.RealizedStep stepFromParent, String stubName)

      Adds an input step from the parent pipeline into the child pipeline by creating a stub step. The stub step mirrors the parent step's output schema but won't be executed during child pipeline realization.

      Parameters:
      stepFromParent - the realized step from the parent pipeline to use as input
      stubName - the name to give the stub step in the child pipeline - this is how the child pipeline will refer to it

    • setChildPipelineFrom

      public ChildPipelineBuilder setChildPipelineFrom(Object pipelineSource)

      Customize errors resulting from combine to use a non-stanard 'failed to realize child pipeline' error. Added to support specifying a sub-pipeline, instead of a URI, as the source of problems.

    • getChildInputStep

      public nz.org.riskscape.engine.pipeline.RealizedStep getChildInputStep(nz.org.riskscape.engine.pipeline.RealizedStep originalInputStep)

      Retrieves the stub step that was created in the child pipeline for a given parent input step.

      Parameters:
      originalInputStep - the original step from the parent pipeline
      Returns:
      the corresponding stub step in the child pipeline, or null if not found

    • realizeChild

      public nz.org.riskscape.engine.pipeline.RealizedPipeline realizeChild()

      Realizes the child pipeline using the configured AST and input steps. This method must be called after all input steps have been added via addInputStep(nz.org.riskscape.engine.pipeline.RealizedStep).

      Returns:
      the realized child pipeline, which may contain failures if realization encountered problems

    • drainWarningsFromChild

      public void drainWarningsFromChild(Consumer<nz.org.riskscape.problem.Problem> sink)

      Updates the realized child to remove any warnings (and sends them to the sink, e.g. List::add)

    • combine

      public nz.org.riskscape.engine.pipeline.RealizedPipeline combine()

      Combines the realized child pipeline back into the parent pipeline.

      If the child pipeline failed to realize, a failure step is added to the resulting pipeline to represent those errors

      All child steps are prefixed with the parent step name to ensure unique naming.

      Returns:
      the combined pipeline containing both parent and child steps

    • addWellKnownOutput

      public nz.org.riskscape.engine.pipeline.RealizedPipeline addWellKnownOutput(nz.org.riskscape.engine.pipeline.RealizedStep outputStep, List<nz.org.riskscape.problem.Problem> warnings)

      Adds a step to the combined pipeline named after the input's prototype step (so will have the expected name) for any dependencies that are chained to this step.

      # Future clean up idea

      Not really needed right now, but it might be good to make this an argument or optional version of the combine method, and so make it easier to move the problems from child realization somewhere so that it's handled consistently. I think we probably always want a well known step, it's just a question of whether it's the output step or some other arbitrary step from the pipeline (if it doesn't produce output). The well-known step should always be the one that receives any realization problems that weren't specific to a step.

    • getCombined

      public nz.org.riskscape.engine.pipeline.RealizedPipeline getCombined()

    • isChildFailed

      public boolean isChildFailed()
      Returns:
      true if the child pipeline has failures.

    • getRebuiltStep

      public nz.org.riskscape.engine.pipeline.RealizedStep getRebuiltStep(nz.org.riskscape.engine.pipeline.RealizedStep childStep)
      Returns:
      the step in combined pipeline that was rebuilt for the child step, i.e. it is the child step, but renamed and in the combined pipeline

    • addParameters

      public ChildPipelineBuilder addParameters(Map<String,nz.org.riskscape.rl.ast.Expression> parameters)

    • addParameter

      public void addParameter(String key, nz.org.riskscape.rl.ast.Expression value)

    • getRebuiltEndStep

      public nz.org.riskscape.engine.pipeline.RealizedStep getRebuiltEndStep(nz.org.riskscape.rl.ast.InputChain rhs)

      While an input chain AST has only one end step (because it is a single branch), if any of the steps in that branch realize a subpipeline, then there's potential for there to be more than one end step in the child. This means we must look for the step that corresponds to the last step definition in our AST (because that's what ChildPipelineBuilder#addWellKnownOutput does).

    • getState

      public nz.org.riskscape.engine.steps.ChildPipelineBuilder.State getState()

    • getInput

      public nz.org.riskscape.engine.pipeline.RealizationInput getInput()

    • getParent

      public nz.org.riskscape.engine.pipeline.RealizedPipeline getParent()

    • getChildAst

      public nz.org.riskscape.rl.ast.PipelineDeclaration getChildAst()

    • getInputSteps

      public Map<nz.org.riskscape.engine.pipeline.RealizedStep,nz.org.riskscape.engine.pipeline.RealizedStep> getInputSteps()

    • getPipelineParameters

      public Map<String,nz.org.riskscape.rl.ast.Expression> getPipelineParameters()

    • getRebuilt

      public Map<nz.org.riskscape.engine.pipeline.RealizedStep,nz.org.riskscape.engine.pipeline.RealizedStep> getRebuilt()

    • getBuilding

      public nz.org.riskscape.engine.pipeline.RealizedPipeline getBuilding()

    • getChildPipelineFrom

      public Object getChildPipelineFrom()

      Used to customize any error message that results from realizing the child ast, defaults to the AST's location

    • setState

      public void setState(nz.org.riskscape.engine.steps.ChildPipelineBuilder.State state)

    • setParent

      public void setParent(nz.org.riskscape.engine.pipeline.RealizedPipeline parent)

    • setRebuilt

      public void setRebuilt(Map<nz.org.riskscape.engine.pipeline.RealizedStep,nz.org.riskscape.engine.pipeline.RealizedStep> rebuilt)

    • setBuilding

      public void setBuilding(nz.org.riskscape.engine.pipeline.RealizedPipeline building)

    • setCombined

      public void setCombined(nz.org.riskscape.engine.pipeline.RealizedPipeline combined)

    • setChildStepPrefix

      public void setChildStepPrefix(String childStepPrefix)

    • 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

    • getChildStepPrefix

      public String getChildStepPrefix()