org.colomoto.biolqm.tool

Interface LogicalModelTool<R,S>

All Superinterfaces:

Service

All Known Implementing Classes:

AbstractTool, AttractorTool, StableJBDD, StableStateTool, TrapSpaceTool

public interface LogicalModelTool<R,S>
extends Service

Simple tool description interface. Implement this interface to integrate a tool in the command line interface.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
R	getResult(LogicalModel model) Get the analysis result.
R	getResult(LogicalModel model, S settings) Get the analysis result with a custom setting.
R	getResult(LogicalModel model, String... parameters) Get the analysis result.
R	getResult(LogicalModel model, String parameters) Get the analysis result.
S	getSettings() Construct a default setting object.
S	getSettings(String... parameters) Construct a default setting object.
S	getSettings(String parameters) Construct a default setting object.
void	run(LogicalModel model, String... parameters) Run the tool on a logical model.
boolean	supportsMultivalued() Does this tool handle multivalued models?

Methods inherited from interface org.colomoto.biolqm.Service

getID, getName

Method Detail

supportsMultivalued

boolean supportsMultivalued()

Does this tool handle multivalued models?

Returns:

true if it supports multivalued models, false for Boolean only

getSettings

S getSettings()

Construct a default setting object.

Returns:

the custom setting object

getSettings

S getSettings(String parameters)

Construct a default setting object.

Parameters:

parameters - optional command line settings

Returns:

the custom setting object

getSettings

S getSettings(String... parameters)

Construct a default setting object.

Parameters:

parameters - optional command line settings

Returns:

the custom setting object

getResult

R getResult(LogicalModel model,
            S settings)
     throws Exception

Get the analysis result with a custom setting.

Parameters:

model - the source model

settings - a custom setting object

Returns:

the result object

Throws:

Exception - when the analysis could not be performed

getResult

R getResult(LogicalModel model)
     throws Exception

Get the analysis result.

Parameters:

model - the source model

Returns:

the result object

Throws:

Exception - when the analysis could not be performed

getResult

R getResult(LogicalModel model,
            String parameters)
     throws Exception

Get the analysis result.

Parameters:

model - the source model

parameters - optional command line settings (space separated)

Returns:

the result object

Throws:

Exception - when the analysis could not be performed

getResult

R getResult(LogicalModel model,
            String... parameters)
     throws Exception

Get the analysis result.

Parameters:

model - the source model

parameters - optional list of command line settings

Returns:

the result object

Throws:

Exception - when the analysis could not be performed

run

void run(LogicalModel model,
         String... parameters)

Run the tool on a logical model.

Parameters:

model - the model to use

parameters - the raw command line parameters