org.colomoto.biolqm

Class LQMScriptLauncher

java.lang.Object

org.colomoto.biolqm.LQMScriptLauncher

public class LQMScriptLauncher
extends Object

Wrap common API to provide convenient access in scripts.

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
String[]	args

Constructor Summary

Constructors

Constructor and Description
LQMScriptLauncher(String[] args) Create a scripting environment with access to the command line arguments

Method Summary

Modifier and Type	Method and Description
FileWriter	fileWriter(String path) Open a file for writing.
LogicalModelFormat	getFormat(String name) Retrieve a format descriptor.
ModelModifierService	getModifier(String name) Retrieve a modifier service.
LogicalModelTool	getTool(String name) Retrieve a tool service.
static ScriptEngine	loadEngine(String scriptname) Detect and load script engines
LogicalModel	loadModel(String filename) Load a model guessing the format.
LogicalModel	loadModel(String filename, String format) Load a model from a file.
LogicalModel	modifyModel(LogicalModel model, String name) Construct a modified model.
LogicalModel	modifyModel(LogicalModel model, String name, String parameters) Construct a modified model.
boolean	saveModel(LogicalModel model, String filename, String format) Save a model to a file.

Methods inherited from class java.lang.Object

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

Field Detail

args

public final String[] args

Constructor Detail

LQMScriptLauncher

public LQMScriptLauncher(String[] args)

Create a scripting environment with access to the command line arguments

Parameters:

args - the command line arguments

Method Detail

loadEngine

public static ScriptEngine loadEngine(String scriptname)
                               throws Exception

Detect and load script engines

Parameters:

scriptname - path to the script file

Returns:

the associated engine

Throws:

Exception - if no engine was found or loading failed

loadModel

public LogicalModel loadModel(String filename)

Load a model guessing the format.

Parameters:

filename - the path to the file to load (extension gives the format)

Returns:

the loaded model

loadModel

public LogicalModel loadModel(String filename,
                              String format)

Load a model from a file. If a format is provided, enforce its use, otherwise use the file extension as format name.

Parameters:

filename - the path to the file to load (extension gives the format)

format - enforced format or null to guess from file extension

Returns:

the loaded model

See Also:

LQMLauncher.loadModel(String,String)

saveModel

public boolean saveModel(LogicalModel model,
                         String filename,
                         String format)

Save a model to a file.

Parameters:

model - the model to save

filename - the path to the output file

format - enforced format or null to guess from file extension

Returns:

true if success

See Also:

LQMLauncher.saveModel(LogicalModel,String,String)

modifyModel

public LogicalModel modifyModel(LogicalModel model,
                                String name)

Construct a modified model.

Parameters:

model - the original model

name - the name of a modifier

Returns:

a modified model

See Also:

modifyModel(LogicalModel,String,String)

modifyModel

public LogicalModel modifyModel(LogicalModel model,
                                String name,
                                String parameters)

Construct a modified model.

Parameters:

model - the original model

name - the name of a modifier

parameters - parameters for the model modifier

Returns:

a modified model

See Also:

ModelModifierService.getModifiedModel(LogicalModel,String)

getFormat

public LogicalModelFormat getFormat(String name)

Retrieve a format descriptor.

Parameters:

name - the ID of the format

Returns:

the format descriptor

See Also:

LQMServiceManager.getFormat(String)

getModifier

public ModelModifierService getModifier(String name)

Retrieve a modifier service.

Parameters:

name - the ID of the modifier service

Returns:

the corresponding modifier service

See Also:

LQMServiceManager.getModifier(String)

getTool

public LogicalModelTool getTool(String name)

Retrieve a tool service.

Parameters:

name - the ID of the tool

Returns:

the corresponding tool service

See Also:

LQMServiceManager.getTool(String)

fileWriter

public FileWriter fileWriter(String path)
                      throws IOException

Open a file for writing. A simple wrapper for FileWrapper constructor, to be used in scripts

Parameters:

path - the path to the file to open

Returns:

a FileWriter object

Throws:

IOException