org.colomoto.biolqm.io

Interface LogicalModelFormat

All Known Implementing Classes:

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

public interface LogicalModelFormat

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

Author:

Aurelien Naldi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LogicalModelFormat.MultivaluedSupport

Method Summary

Modifier and Type	Method and Description
boolean	canExport() Does this format supports export operation?
boolean	canImport() Does this format supports import operation?
void	export(LogicalModel model, OutputStreamProvider outputProvider) Export a logical model to this format.
String	getID() get the ID of the format.
LogicalModelFormat.MultivaluedSupport	getMultivaluedSupport() Precise type of support for multivalued models.
String	getName() Get a longer name for the format.
LogicalModel	importFile(File f) Import a file in this format and build a logical model for it.
boolean	supportsMultivalued() Deprecated.

Method Detail

getID

String getID()

get the ID of the format. It will be used to retrieve the format

Returns:

the format ID

getName

String getName()

Get a longer name for the format. This is descriptive only and has no real role.

Returns:

the format name

canExport

boolean canExport()

Does this format supports export operation?

Returns:

true if this format implements export.

canImport

boolean canImport()

Does this format supports import operation?

Returns:

true if this format implements import.

supportsMultivalued

@Deprecated
boolean supportsMultivalued()

Deprecated.

Does this format handle multivalued models?

Returns:

true if it supports multivalued models, false for Boolean formats

getMultivaluedSupport

LogicalModelFormat.MultivaluedSupport getMultivaluedSupport()

Precise type of support for multivalued models.

Returns:

the type of support: native, booleanized or none

export

void export(LogicalModel model,
            OutputStreamProvider outputProvider)
     throws IOException

Export a logical model to this format.

Parameters:

model - the model to export

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

Throws:

IOException - if writing failed

importFile

LogicalModel importFile(File f)
                 throws IOException

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

Parameters:

f - the file to import

Returns:

a new LogicalModel containing the imported data.

Throws:

IOException - if loading failed