org.colomoto.biolqm.modifier

Interface ModelModifierService

All Superinterfaces:

Service

All Known Implementing Classes:

BooleanizeService, BufferingService, PerturbationService, ReductionService, ReverseService, SanitizeService, SubmodelService, SubSpaceService

public interface ModelModifierService
extends Service

A service providing modifiers for logical models. Such services should be registered for service discovery. To provide a generic interface, the services can construct new modifiers by parsing a String (provided by the user on the command-line or in a script). Implementors can provide additional methods with specialised API to setup the modifiers.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
ModelModifier	getModifier(LogicalModel model) Get a new modifier object.
default ModelModifier	getModifier(LogicalModel model, String parameters) Setup a new modifier object.
default LogicalModel	modify(LogicalModel model) Apply a modifier with the default parameters.
default LogicalModel	modify(LogicalModel model, String parameters) Setup a modifier and directly retrieve the modified model.

Methods inherited from interface org.colomoto.biolqm.service.Service

getAliases, getDescription, getID, getMultivaluedSupport, getName

Method Detail

getModifier

default ModelModifier getModifier(LogicalModel model,
                                  String parameters)

Setup a new modifier object.

Parameters:

model - the model to modify

parameters - a string to setup the modifier if applicable

Returns:

a configured modifier instance

getModifier

ModelModifier getModifier(LogicalModel model)

Get a new modifier object.

Parameters:

model - the model to modify

Returns:

a modifier instance using the default parameters

modify

default LogicalModel modify(LogicalModel model,
                            String parameters)
                     throws Exception

Setup a modifier and directly retrieve the modified model. This is a shorthand for getModifier(model,parameters).getModifiedModel()

Parameters:

model - the model to be modified

parameters - the setting String (can be empty for some modifiers)

Returns:

a new modified model

Throws:

Exception - in case of error (following the Task interface)

modify

default LogicalModel modify(LogicalModel model)
                     throws Exception

Apply a modifier with the default parameters.

Parameters:

model - the original model

Returns:

the modified model

Throws:

Exception - in case of error (following the Task interface)