Package nz.org.riskscape.engine.model

Class BaseModel2

java.lang.Object

nz.org.riskscape.engine.model.BaseModel2

All Implemented Interfaces:

Model

public abstract class BaseModel2
extends Object
implements Model

The base Model2 implementation. (This is basically just some lombok boilerplate that all models need, but it reduces clutter in the sub-class implementations)

Constructor Summary

Constructors

Constructor	Description
BaseModel2(ModelFramework framework, BoundParameters frameworkParameters, BoundParameters boundParameters, List<? extends ModelParameter> modelParameters)

Method Summary

Modifier and Type	Method	Description
BoundParameters	getBoundParameters()
ModelFramework	getFramework()
BoundParameters	getFrameworkParameters()	Returns the parameters used by the ModelFramework to build this model (e.g.
List<? extends ModelParameter>	getModelParameters()	Returns a view the model's bound parameters (e.g.
abstract ResultOrProblems<RealizedPipeline>	realize(ExecutionContext context)	Produces an executable pipeline that will 'run' the model and produce results.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.org.riskscape.engine.model.Model

getModelParameter

Constructor Details

BaseModel2

public BaseModel2(ModelFramework framework,
 BoundParameters frameworkParameters,
 BoundParameters boundParameters,
 List<? extends ModelParameter> modelParameters)

Method Details

realize

public abstract ResultOrProblems<RealizedPipeline> realize(ExecutionContext context)

Description copied from interface: Model

Produces an executable pipeline that will 'run' the model and produce results.

Specified by:

realize in interface Model

Returns:

a RealizedPipeline that can be executed, or a list of Problems that occurred during realization.

getFramework

public ModelFramework getFramework()

Specified by:

getFramework in interface Model

Returns:

what sort of ModelFramework was used to build this model.

getFrameworkParameters

public BoundParameters getFrameworkParameters()

Description copied from interface: Model

Returns the parameters used by the ModelFramework to build this model (e.g. "template = default"). These parameters are so central to the model that it doesn't really make sense to override them at all, once the user has defined them.

Specified by:

getFrameworkParameters in interface Model

getBoundParameters

public BoundParameters getBoundParameters()

Specified by:

getBoundParameters in interface Model

Returns:

the configurable parameters that will be applied to the model when it is run. Note these parameters are subservient to the framework parameters that were used to create the model - change the framework parameters will likely result in a totally different set of model parameters.

getModelParameters

public List<? extends ModelParameter> getModelParameters()

Description copied from interface: Model

Returns a view the model's bound parameters (e.g. the data in Model.getBoundParameters()), but as ModelParameters, which contains more detailed metadata.

This view of the data is typically used for building user interfaces and validation, whereas the boundParameters version is there as reference for what was bound, but they should both contain the same set of parameter names.

Thinking ahead, I suspect we might want to introduce a RealizedModel class, that is returned from Model.realize(ExecutionContext), and that version can return the model's parameters.

Specified by:

getModelParameters in interface Model