Package nz.org.riskscape.engine.pipeline

Class NamedStep

java.lang.Object

nz.org.riskscape.engine.pipeline.NamedStep

public final class NamedStep
extends Object

Constructor Summary

Constructors

Constructor	Description
NamedStep(@NonNull String name, @NonNull Step target, @NonNull StepDefinition ast)
NamedStep(String name, Step target)	Create a named step without specifying the source that defined it - some fake ast will be constructed and assigned as a place holder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
@NonNull StepDefinition	getAst()	The source that defined this step - might not be actual user specified source code in some instances.
@NonNull String	getName()	The name that the user assigned, or that the system generated, that identifies an instance of the step in the Pipeline.
List<Parameter>	getRenamedParameters()
@NonNull Step	getTarget()	The implementation of the step - this is the thing that can actually operate on the tuples that pass through this part of the pipeline
int	hashCode()
ResultOrProblems<? extends Realized>	realize(RealizationInput stepInput)
boolean	requiresNamedInputs()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

NamedStep

public NamedStep(String name,
 Step target)

Create a named step without specifying the source that defined it - some fake ast will be constructed and assigned as a place holder.

NamedStep

public NamedStep(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull Step target,
 @NonNull
 @NonNull StepDefinition ast)

Method Details

getRenamedParameters

public List<Parameter> getRenamedParameters()

realize

public ResultOrProblems<? extends Realized> realize(RealizationInput stepInput)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

requiresNamedInputs

public boolean requiresNamedInputs()

Returns:

true if the target defines input names - any edges to this named step will require that they address a particular input

getName

@NonNull
public @NonNull String getName()

The name that the user assigned, or that the system generated, that identifies an instance of the step in the Pipeline.

getTarget

@NonNull
public @NonNull Step getTarget()

The implementation of the step - this is the thing that can actually operate on the tuples that pass through this part of the pipeline

getAst

@NonNull
public @NonNull StepDefinition getAst()

The source that defined this step - might not be actual user specified source code in some instances.