org.colomoto.biolqm.service

Class LQMServiceManager

java.lang.Object

org.colomoto.biolqm.service.LQMServiceManager

public class LQMServiceManager
extends Object

Static service manager: list available "services" in LQM:

• formats
• modifiers

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
String[]	args

Constructor Summary

Constructors

Constructor and Description
LQMServiceManager(String[] args) Create an instance, storing command-line arguments

Method Summary

Modifier and Type	Method and Description
static FileWriter	fileWriter(String path) Open a file for writing.
static <T> T	get(Class<T> cl) Retrieve any service by class
static LogicalModelFormat	getFormat(String name) Get the format declaration for a given ID.
static Iterable<LogicalModelFormat>	getFormats() Get the available formats.
static ModelModifierService	getModifier(String name) Get the service for a given ID.
static Iterable<ModelModifierService>	getModifiers() Get the available model modifier services.
static ModelToolService	getTool(String name) Get the tool declaration for a given ID.
static Iterable<ModelToolService>	getTools() Get the available tools.
static LogicalModel	load(String filename) Load a model guessing the format.
static LogicalModel	load(String filename, String format) Load a model from file.
static LogicalModel	modify(LogicalModel model, String name) Construct a modified model.
static LogicalModel	modify(LogicalModel model, String name, String parameters) Construct a modified model.
static boolean	register(Service srv) Register a service after initial service discovery.
static boolean	save(LogicalModel model, String filename, String format) Save a model to 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

LQMServiceManager

public LQMServiceManager(String[] args)

Create an instance, storing command-line arguments

Parameters:

args - the list of command-line arguments for use in scripts

Method Detail

getFormat

public static LogicalModelFormat getFormat(String name)

Get the format declaration for a given ID.

Parameters:

name - ID of the format

Returns:

the format declaration instance or null if not found.

getFormats

public static Iterable<LogicalModelFormat> getFormats()

Get the available formats.

Returns:

all available formats

getTool

public static ModelToolService getTool(String name)

Get the tool declaration for a given ID.

Parameters:

name - ID of the tool

Returns:

the tool declaration instance or null if not found.

getTools

public static Iterable<ModelToolService> getTools()

Get the available tools.

Returns:

all available tools

getModifier

public static ModelModifierService getModifier(String name)

Get the service for a given ID.

Parameters:

name - ID of the service

Returns:

the service instance or null if not found.

get

public static <T> T get(Class<T> cl)

Retrieve any service by class

Type Parameters:

T - the type of the desired service

Parameters:

cl - the class of the desired service

Returns:

an instance of this service, or null if it does not exist

getModifiers

public static Iterable<ModelModifierService> getModifiers()

Get the available model modifier services.

Returns:

all available services for model modifiers

register

public static boolean register(Service srv)

Register a service after initial service discovery. When possible, service discovery should be used instead.

Parameters:

srv - the new service to register

Returns:

true is the service was added

load

public static LogicalModel load(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

modify

public static LogicalModel modify(LogicalModel model,
                                  String name)
                           throws Exception

Construct a modified model.

Parameters:

model - the original model

name - the name of a modifier

Returns:

a modified model

Throws:

Exception - in case of error (following the Task interfce)

See Also:

modify(LogicalModel,String,String)

modify

public static LogicalModel modify(LogicalModel model,
                                  String name,
                                  String parameters)
                           throws Exception

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

Throws:

Exception - in case of error (following the Task interfce)

See Also:

ModelModifierService.modify(LogicalModel,String)

fileWriter

public static 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 - if it could not be created

load

public static LogicalModel load(String filename,
                                String format)

Load a model from file.

Parameters:

filename - the path to the loaded file

format - the name of the import format

Returns:

the loaded model

save

public static boolean save(LogicalModel model,
                           String filename,
                           String format)

Save a model to file

Parameters:

model - the model to save

filename - the path of the output file

format - the name of the export format

Returns:

true if success