Package nz.org.riskscape.engine.steps

Class RelationInputStep

java.lang.Object
nz.org.riskscape.engine.steps.BaseStep<RelationInputStep.Parameters>
nz.org.riskscape.engine.steps.RelationInputStep
All Implemented Interfaces:
nz.org.riskscape.engine.Identified, nz.org.riskscape.engine.pipeline.Step
public class RelationInputStep extends BaseStep<RelationInputStep.Parameters>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RelationInputStep.Parameters
     

  • Field Summary

    Fields inherited from interface nz.org.riskscape.engine.pipeline.Step

    FUNCTOR_INTERFACES

  • Constructor Summary

    Constructors
    Constructor
    Description
    RelationInputStep(nz.org.riskscape.engine.Engine engine)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static nz.org.riskscape.engine.pipeline.Step
    canned(nz.org.riskscape.engine.relation.Relation relation)
     
    String
    getId()
     
    nz.org.riskscape.problem.ResultOrProblems<? extends nz.org.riskscape.engine.pipeline.Realized>
    realize(RelationInputStep.Parameters parameters)
     
    static nz.org.riskscape.engine.pipeline.RealizedStep
    realized(nz.org.riskscape.engine.relation.Relation relation)
     
    static nz.org.riskscape.engine.pipeline.RealizedStep
    realized(nz.org.riskscape.engine.relation.Relation relation, String nestName)
     
    static void
    setInput(nz.org.riskscape.engine.relation.Relation relation, String stepName, Map<String,List<?>> pipelineParameters)
    Set a parameter for a step of this type to be a particular relation.

    Methods inherited from class nz.org.riskscape.engine.steps.BaseStep

    bindInputs, bindParameters, equals, findParameterClass, getDescription, getEngine, getInputArity, getInputNames, getParamContext, getParameterSet, hashCode, realize, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface nz.org.riskscape.engine.Identified

    getIdentifiedClass

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

    getDeclaredParameter, getDeclaredParameterNames, getDeclaredParameters, getDefaultInputName, hasNamedInput, named

  • Constructor Details

    • RelationInputStep

      public RelationInputStep(nz.org.riskscape.engine.Engine engine)

  • Method Details

    • canned

      public static nz.org.riskscape.engine.pipeline.Step canned(nz.org.riskscape.engine.relation.Relation relation)

    • realized

      public static nz.org.riskscape.engine.pipeline.RealizedStep realized(nz.org.riskscape.engine.relation.Relation relation)

    • realized

      public static nz.org.riskscape.engine.pipeline.RealizedStep realized(nz.org.riskscape.engine.relation.Relation relation, String nestName)

    • realize

      public nz.org.riskscape.problem.ResultOrProblems<? extends nz.org.riskscape.engine.pipeline.Realized> realize(RelationInputStep.Parameters parameters)
      Specified by:
      realize in class BaseStep<RelationInputStep.Parameters>

    • getId

      public String getId()
      Specified by:
      getId in interface nz.org.riskscape.engine.Identified
      Overrides:
      getId in class BaseStep<RelationInputStep.Parameters>

    • setInput

      public static void setInput(nz.org.riskscape.engine.relation.Relation relation, String stepName, Map<String,List<?>> pipelineParameters)

      Set a parameter for a step of this type to be a particular relation. This is a sort of safe/convenient way of pickling parameters in the case of something like nested pipelines where the input needs to be passed programmatically.