Package nz.org.riskscape.engine.steps

Class BaseStep<T>

java.lang.Object
nz.org.riskscape.engine.steps.BaseStep<T>
All Implemented Interfaces:
nz.org.riskscape.engine.Identified, nz.org.riskscape.engine.pipeline.Step
Direct Known Subclasses:
AsyncSelectStep, EnlargeStep, FilterStep, GroupByStep, JoinStep, ProjectionStep, RelationInputStep, SaveStep, SegmentStep, SelectStep, SortStep, SubpipelineStep, UnionStep, UnnestStep
public abstract class BaseStep<T> extends Object implements nz.org.riskscape.engine.pipeline.Step

  • Field Summary

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

    FUNCTOR_INTERFACES

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseStep(nz.org.riskscape.engine.Engine engine)
     
    BaseStep(nz.org.riskscape.engine.Engine engine, com.google.common.collect.Range<Integer> inputArity, List<String> inputNames)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected nz.org.riskscape.problem.ResultOrProblems<T>
    bindInputs(nz.org.riskscape.engine.pipeline.RealizationInput input, T parameters)
     
    protected nz.org.riskscape.problem.ResultOrProblems<T>
    bindParameters(nz.org.riskscape.engine.pipeline.RealizationInput input)
     
    protected nz.org.riskscape.problem.ResultOrProblems<T>
    buildParametersObject(nz.org.riskscape.engine.pipeline.RealizationInput input)
     
    boolean
    equals(Object obj)
     
    protected Class<T>
    findParameterClass(Class<?> modelClass)
     
    nz.org.riskscape.engine.i18n.RiskscapeMessage
    getDescription()
     
    nz.org.riskscape.engine.Engine
    getEngine()
     
    String
    getId()
     
    com.google.common.collect.Range<Integer>
    getInputArity()
     
    List<String>
    getInputNames()
     
    protected Object
    getParamContext(String name)
    Finds a Parameter for a Step based on name.
    nz.org.riskscape.engine.bind.JavaParameterSet<T>
    getParameterSet()
     
    int
    hashCode()
     
    nz.org.riskscape.engine.pipeline.RealizedPipeline
    realize(nz.org.riskscape.engine.pipeline.RealizationInput input)
     
    abstract nz.org.riskscape.problem.ResultOrProblems<? extends nz.org.riskscape.engine.pipeline.Realized>
    realize(T parameters)
     
    nz.org.riskscape.problem.ResultOrProblems<? extends nz.org.riskscape.engine.pipeline.Realized>
    realizeSimple(nz.org.riskscape.engine.pipeline.RealizationInput input)
    Test friendly version of realize that returns just the realized result from the step, rather than a new pipeline
    protected nz.org.riskscape.problem.ResultOrProblems<Map<String,List<?>>>
    resolvePipelineParameters(nz.org.riskscape.engine.pipeline.RealizationInput input, Map<String,List<?>> paramMap)
    Attempts to resolve any pipeline parameters in our parameter input so they simplify binding.
    String
    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

  • Constructor Details

    • BaseStep

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

    • BaseStep

      public BaseStep(nz.org.riskscape.engine.Engine engine, com.google.common.collect.Range<Integer> inputArity, List<String> inputNames)

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface nz.org.riskscape.engine.Identified

    • getDescription

      public nz.org.riskscape.engine.i18n.RiskscapeMessage getDescription()
      Specified by:
      getDescription in interface nz.org.riskscape.engine.pipeline.Step
      Returns:
      A human digestible description for this step.

    • getInputArity

      public com.google.common.collect.Range<Integer> getInputArity()
      Specified by:
      getInputArity in interface nz.org.riskscape.engine.pipeline.Step

    • realize

      public nz.org.riskscape.engine.pipeline.RealizedPipeline realize(nz.org.riskscape.engine.pipeline.RealizationInput input)
      Specified by:
      realize in interface nz.org.riskscape.engine.pipeline.Step

    • buildParametersObject

      protected nz.org.riskscape.problem.ResultOrProblems<T> buildParametersObject(nz.org.riskscape.engine.pipeline.RealizationInput input)

    • realizeSimple

      public nz.org.riskscape.problem.ResultOrProblems<? extends nz.org.riskscape.engine.pipeline.Realized> realizeSimple(nz.org.riskscape.engine.pipeline.RealizationInput input)

      Test friendly version of realize that returns just the realized result from the step, rather than a new pipeline

    • realize

      public abstract nz.org.riskscape.problem.ResultOrProblems<? extends nz.org.riskscape.engine.pipeline.Realized> realize(T parameters)

    • bindInputs

      protected nz.org.riskscape.problem.ResultOrProblems<T> bindInputs(nz.org.riskscape.engine.pipeline.RealizationInput input, T parameters)

    • findParameterClass

      protected Class<T> findParameterClass(Class<?> modelClass)

    • equals

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

    • bindParameters

      protected nz.org.riskscape.problem.ResultOrProblems<T> bindParameters(nz.org.riskscape.engine.pipeline.RealizationInput input)

    • resolvePipelineParameters

      protected nz.org.riskscape.problem.ResultOrProblems<Map<String,List<?>>> resolvePipelineParameters(nz.org.riskscape.engine.pipeline.RealizationInput input, Map<String,List<?>> paramMap)

      Attempts to resolve any pipeline parameters in our parameter input so they simplify binding. Doing this up front handles cases like: - a step parameter wanting a struct, but being given a parameter, so binding fails (no such binder) - a step parameter switching logic depending on the type of expression, and so that logic gets confused by the parameter token (without resolving it itself)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getParamContext

      protected Object getParamContext(String name)

      Finds a Parameter for a Step based on name. This is a helper intended for Step sub-classes to report a Problem for a given parameter.

      Returns:
      the Parameter matching the name given, or null if no match was found

    • getParameterSet

      public nz.org.riskscape.engine.bind.JavaParameterSet<T> getParameterSet()
      Specified by:
      getParameterSet in interface nz.org.riskscape.engine.pipeline.Step

    • getEngine

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

    • getInputNames

      public List<String> getInputNames()
      Specified by:
      getInputNames in interface nz.org.riskscape.engine.pipeline.Step