Package nz.org.riskscape.engine.pipeline

Class Subpipeline

java.lang.Object

nz.org.riskscape.engine.pipeline.Subpipeline

public class Subpipeline
extends Object

Constructor Summary

Constructors

Constructor	Description
Subpipeline(URI location, PipelineDeclaration ast, Map<String,Expression> parameters)	Creates a new Subpipeline instance.
Subpipeline(PipelineDeclaration subpipeline)

Method Summary

Modifier and Type	Method	Description
PipelineDeclaration	getAst()	The PipelineDeclaration (AST) of the subpipeline.
URI	getLocation()	Where this sub-pipeline was defined (might not be the ast's location, e.g.
Map<String,Expression>	getParameters()	Default parameter values defined for the subpipeline, to be used as a "back up" if the model or user doesn't otherwise define them.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Subpipeline

public Subpipeline(PipelineDeclaration subpipeline)

Subpipeline

public Subpipeline(URI location,
 PipelineDeclaration ast,
 Map<String,Expression> parameters)

Creates a new Subpipeline instance.

Parameters:

location - Where this sub-pipeline was defined (might not be the ast's location, e.g. ini file)

ast - The PipelineDeclaration (AST) of the subpipeline.

parameters - Default parameter values defined for the subpipeline, to be used as a "back up" if the model or user doesn't otherwise define them.

Implementation note: At the moment, it makes sense for this to just be a set of Expressions, but if we add support for things like param.foo.description, then we might want to make changes to the set of parameter classes ( ModelParameter, PipelineModelParameter, ParameterTemplate etc) to be API, maybe break the connection to Parameter (not sure this really matters any more?) and make them expression-first, rather than java-type first)

Method Details

getLocation

public URI getLocation()

Where this sub-pipeline was defined (might not be the ast's location, e.g. ini file)

getAst

public PipelineDeclaration getAst()

The PipelineDeclaration (AST) of the subpipeline.

getParameters

public Map<String,Expression> getParameters()

Default parameter values defined for the subpipeline, to be used as a "back up" if the model or user doesn't otherwise define them.

Implementation note: At the moment, it makes sense for this to just be a set of Expressions, but if we add support for things like param.foo.description, then we might want to make changes to the set of parameter classes ( ModelParameter, PipelineModelParameter, ParameterTemplate etc) to be API, maybe break the connection to Parameter (not sure this really matters any more?) and make them expression-first, rather than java-type first)