org.colomoto.biolqm.io

Interface LogicalModelFormat

All Superinterfaces:

Service

All Known Implementing Classes:

AbstractFormat, APNNFormat, BNetFormat, BooleanFunctionFormat, BooleanNetFormat, BoolSimFormat, CNetFormat, GINMLFormat, GNAFormat, ImplicantTableFormat, INAFormat, MaBoSSFormat, MNetFormat, PetriNetFormat, PintFormat, PNMLFormat, SBMLFormat, TruthTableFormat

public interface LogicalModelFormat
extends Service

Description of an available file format. Implement this interface to integrate new formats in the conversion tool.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
boolean	canExport() Does this format supports export operation?
boolean	canLoad() Does this format supports loading models?
default void	export(LogicalModel model, File destination) Export a logical model to this format.
default void	export(LogicalModel model, StreamProvider streams) Export a logical model to this format.
default void	export(LogicalModel model, String filename) Export a logical model to this format.
default ModelExporter	getExporter(LogicalModel model) Get a new model exporter to this format.
default ModelLoader	getLoader() Get a new model loader from this format.
default LogicalModel	load(File source) Load a file in this format and build a logical model for it.
default LogicalModel	load(StreamProvider streams) Load a file in this format and build a logical model for it.
default LogicalModel	load(String filename) Load a file in this format and build a logical model for it.

Methods inherited from interface org.colomoto.biolqm.service.Service

getAliases, getDescription, getID, getMultivaluedSupport, getName

Method Detail

canExport

boolean canExport()

Does this format supports export operation?

Returns:

true if this format implements export.

canLoad

boolean canLoad()

Does this format supports loading models?

Returns:

true if this model loading is implemented.

getLoader

default ModelLoader getLoader()

Get a new model loader from this format.

Returns:

a new model loader

Throws:

UnsupportedOperationException - if this format does not support loading

getExporter

default ModelExporter getExporter(LogicalModel model)

Get a new model exporter to this format.

Parameters:

model - the model to export

Returns:

a new model exporter

Throws:

UnsupportedOperationException - if this format does not support export

export

default void export(LogicalModel model,
                    StreamProvider streams)
             throws Exception

Export a logical model to this format.

Parameters:

model - the model to export

streams - an object providing output streams on demand for saving to one or multiple files

Throws:

UnsupportedOperationException - if this format does not support export

Exception - if writing failed

export

default void export(LogicalModel model,
                    File destination)
             throws Exception

Export a logical model to this format.

Parameters:

model - the model to export

destination - the destination file. Some formats may generate multiple output files based on it's path

Throws:

UnsupportedOperationException - if this format does not support export

Exception - if writing failed

export

default void export(LogicalModel model,
                    String filename)
             throws Exception

Export a logical model to this format.

Parameters:

model - the model to export

filename - the destination file. Some formats may generate multiple output files based on it's path

Throws:

UnsupportedOperationException - if this format does not support export

Exception - if writing failed

load

default LogicalModel load(StreamProvider streams)
                   throws Exception

Load a file in this format and build a logical model for it.

Parameters:

streams - an object providing input streams on demand, allowing to load from one or multiple files

Returns:

a new LogicalModel containing the imported data.

Throws:

UnsupportedOperationException - if this format does not support loading

Exception - if loading failed

load

default LogicalModel load(File source)
                   throws Exception

Load a file in this format and build a logical model for it.

Parameters:

source - the source file. Some formats may read multiple files

Returns:

a new LogicalModel containing the imported data.

Throws:

UnsupportedOperationException - if this format does not support loading

Exception - if loading failed

load

default LogicalModel load(String filename)
                   throws Exception

Load a file in this format and build a logical model for it.

Parameters:

filename - the source file name. Some formats may read multiple files

Returns:

a new LogicalModel containing the imported data.

Throws:

UnsupportedOperationException - if this format does not support loading

Exception - if loading failed