org.colomoto.biolqm.modifier

Class AbstractModelModifierService

java.lang.Object

org.colomoto.biolqm.modifier.AbstractModelModifierService

All Implemented Interfaces:

ModelModifierService, Service

Direct Known Subclasses:

ModelBooleanizerService, ModelReductionService, ModelReverserService, PerturbationService, SubSpaceService

public abstract class AbstractModelModifierService
extends Object
implements ModelModifierService

A base class handling service discovery for model modifier services.

Author:

Aurelien Naldi

Constructor Summary

Constructors

Constructor and Description
AbstractModelModifierService(String id, String name, String descr) Shared constructor for model modifier.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Provide a brief description of parameters for the help message
String	getID() get the ID of the service.
LogicalModel	getModifiedModel(LogicalModel model, String parameters) Setup a modifier and directly retrieve the modified model.
String	getName() Get a longer name for the service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.colomoto.biolqm.modifier.ModelModifierService

getModifier

Constructor Detail

AbstractModelModifierService

public AbstractModelModifierService(String id,
                                    String name,
                                    String descr)

Shared constructor for model modifier.

Parameters:

id - the identifier used to retrieve the service instance

name - the human readable name of the service

descr - a longer description (for the help message)

Method Detail

getID

public String getID()

Description copied from interface: Service

get the ID of the service.

Specified by:

getID in interface Service

Returns:

the service ID

getName

public String getName()

Description copied from interface: Service

Get a longer name for the service. This is descriptive only and has no real role.

Specified by:

getName in interface Service

Returns:

the service name

getDescription

public String getDescription()

Description copied from interface: ModelModifierService

Provide a brief description of parameters for the help message

Specified by:

getDescription in interface ModelModifierService

Returns:

a short String describing the service parameters

getModifiedModel

public LogicalModel getModifiedModel(LogicalModel model,
                                     String parameters)

Description copied from interface: ModelModifierService

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

Specified by:

getModifiedModel in interface ModelModifierService

Parameters:

model - the model to be modified

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

Returns:

a new modified model