org.colomoto.biolqm.tool.trapspaces

Class TrapSpaceTool

java.lang.Object

org.colomoto.biolqm.tool.AbstractTool<TrapSpaceList,TrapSpaceSettings>

org.colomoto.biolqm.tool.trapspaces.TrapSpaceTool

All Implemented Interfaces:

Service, LogicalModelTool<TrapSpaceList,TrapSpaceSettings>

@ProviderFor(value=LogicalModelTool.class)
public class TrapSpaceTool
extends AbstractTool<TrapSpaceList,TrapSpaceSettings>

Field Summary

Fields

Modifier and Type	Field and Description
static String	HELP_LINE
static String	HELP_MESSAGE

Constructor Summary

Constructors

Constructor and Description
TrapSpaceTool()

Method Summary

Modifier and Type	Method and Description
TrapSpaceList	getResult(LogicalModel model, TrapSpaceSettings settings) Get the analysis result with a custom setting.
TrapSpaceSettings	getSettings(String[] parameters) Construct a default setting object.
Task<TrapSpaceList>	getTask(LogicalModel model, TrapSpaceSettings settings)
void	run(LogicalModel model, String... parameters) Run the tool on a logical model.

Methods inherited from class org.colomoto.biolqm.tool.AbstractTool

getHelp, getID, getName, getResult, getResult, getResult, getSettings, getSettings, supportsMultivalued, toString

Methods inherited from class java.lang.Object

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

Field Detail

HELP_LINE

public static final String HELP_LINE

See Also:

Constant Field Values

HELP_MESSAGE

public static final String HELP_MESSAGE

See Also:

Constant Field Values

Constructor Detail

TrapSpaceTool

public TrapSpaceTool()

Method Detail

run

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

Description copied from interface: LogicalModelTool

Run the tool on a logical model.

Parameters:

model - the model to use

parameters - the raw command line parameters

getSettings

public TrapSpaceSettings getSettings(String[] parameters)

Description copied from interface: LogicalModelTool

Construct a default setting object.

Specified by:

getSettings in interface LogicalModelTool<TrapSpaceList,TrapSpaceSettings>

Overrides:

getSettings in class AbstractTool<TrapSpaceList,TrapSpaceSettings>

Parameters:

parameters - optional command line settings

Returns:

the custom setting object

getResult

public TrapSpaceList getResult(LogicalModel model,
                               TrapSpaceSettings settings)
                        throws Exception

Description copied from interface: LogicalModelTool

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

getTask

public Task<TrapSpaceList> getTask(LogicalModel model,
                                   TrapSpaceSettings settings)