org.colomoto.biolqm.tool

Class AbstractTool<R,S>

java.lang.Object

org.colomoto.biolqm.tool.AbstractTool<R,S>

All Implemented Interfaces:

Service, LogicalModelTool<R,S>

Direct Known Subclasses:

AttractorTool, StableJBDD, StableStateTool, TrapSpaceTool

public abstract class AbstractTool<R,S>
extends Object
implements LogicalModelTool<R,S>

Base class for the boring parts of tool declaration classes.

Author:

Aurelien Naldi

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTool(String id, String name)
protected	AbstractTool(String id, String name, String helpMessage, boolean supportsMultivalued)

Method Summary

Modifier and Type	Method and Description
String	getHelp()
String	getID() get the ID of the service.
String	getName() Get a longer name for the service.
R	getResult(LogicalModel model) Get the analysis result.
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 s) Construct a default setting object.
boolean	supportsMultivalued() Does this tool handle multivalued models?
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.colomoto.biolqm.tool.LogicalModelTool

getResult, run

Constructor Detail

AbstractTool

protected AbstractTool(String id,
                       String name)

AbstractTool

protected AbstractTool(String id,
                       String name,
                       String helpMessage,
                       boolean supportsMultivalued)

Method Detail

getSettings

public S getSettings()

Description copied from interface: LogicalModelTool

Construct a default setting object.

Specified by:

getSettings in interface LogicalModelTool<R,S>

Returns:

the custom setting object

getSettings

public S getSettings(String s)

Description copied from interface: LogicalModelTool

Construct a default setting object.

Specified by:

getSettings in interface LogicalModelTool<R,S>

Parameters:

s - optional command line settings

Returns:

the custom setting object

getSettings

public S getSettings(String... parameters)

Description copied from interface: LogicalModelTool

Construct a default setting object.

Specified by:

getSettings in interface LogicalModelTool<R,S>

Parameters:

parameters - optional command line settings

Returns:

the custom setting object

getResult

public R getResult(LogicalModel model)
            throws Exception

Description copied from interface: LogicalModelTool

Get the analysis result.

Specified by:

getResult in interface LogicalModelTool<R,S>

Parameters:

model - the source model

Returns:

the result object

Throws:

Exception - when the analysis could not be performed

getResult

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

Description copied from interface: LogicalModelTool

Get the analysis result.

Specified by:

getResult in interface LogicalModelTool<R,S>

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

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

Description copied from interface: LogicalModelTool

Get the analysis result.

Specified by:

getResult in interface LogicalModelTool<R,S>

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

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

getHelp

public String getHelp()

supportsMultivalued

public boolean supportsMultivalued()

Description copied from interface: LogicalModelTool

Does this tool handle multivalued models?

Specified by:

supportsMultivalued in interface LogicalModelTool<R,S>

Returns:

true if it supports multivalued models, false for Boolean only

toString

public String toString()

Overrides:

toString in class Object