org.colomoto.biolqm.modifier

Interface ModelModifierService

All Superinterfaces:

Service

All Known Implementing Classes:

AbstractModelModifierService, ModelBooleanizerService, ModelReductionService, ModelReverserService, PerturbationService, 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
String	getDescription() Provide a brief description of parameters for the help message
LogicalModel	getModifiedModel(LogicalModel model, String parameters) Setup a modifier and directly retrieve the modified model.
ModelModifier	getModifier(LogicalModel model, String parameters) Setup a new modifier object.

Methods inherited from interface org.colomoto.biolqm.Service

getID, getName

Method Detail

getDescription

String getDescription()

Provide a brief description of parameters for the help message

Returns:

a short String describing the service parameters

getModifier

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

getModifiedModel

LogicalModel getModifiedModel(LogicalModel model,
                              String parameters)

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