org.colomoto.biolqm.io

Class AbstractFormat

java.lang.Object

org.colomoto.biolqm.io.AbstractFormat

All Implemented Interfaces:

LogicalModelFormat

Direct Known Subclasses:

BNetFormat, BooleanFunctionFormat, BooleanNetFormat, BoolSimFormat, CNetFormat, GINMLFormat, GNAFormat, MaBoSSFormat, PintFormat, PNFormat, SBMLFormat, TruthTableFormat

public abstract class AbstractFormat
extends Object
implements LogicalModelFormat

Simple helper to fill in the boring parts of format declaration classes.

Author:

Aurelien Naldi

Nested Class Summary

Nested classes/interfaces inherited from interface org.colomoto.biolqm.io.LogicalModelFormat

LogicalModelFormat.MultivaluedSupport

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFormat(String id, String name)
protected	AbstractFormat(String id, String name, boolean supportsMultivalued) Deprecated.
protected	AbstractFormat(String id, String name, LogicalModelFormat.MultivaluedSupport modelType)

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, OutputStream out)
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() Does this format handle multivalued models?
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFormat

protected AbstractFormat(String id,
                         String name)

AbstractFormat

@Deprecated
protected AbstractFormat(String id,
                                     String name,
                                     boolean supportsMultivalued)

Deprecated.

AbstractFormat

protected AbstractFormat(String id,
                         String name,
                         LogicalModelFormat.MultivaluedSupport modelType)

Method Detail

getID

public String getID()

Description copied from interface: LogicalModelFormat

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

Specified by:

getID in interface LogicalModelFormat

Returns:

the format ID

getName

public String getName()

Description copied from interface: LogicalModelFormat

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

Specified by:

getName in interface LogicalModelFormat

Returns:

the format name

canExport

public boolean canExport()

Description copied from interface: LogicalModelFormat

Does this format supports export operation?

Specified by:

canExport in interface LogicalModelFormat

Returns:

true if this format implements export.

canImport

public boolean canImport()

Description copied from interface: LogicalModelFormat

Does this format supports import operation?

Specified by:

canImport in interface LogicalModelFormat

Returns:

true if this format implements import.

supportsMultivalued

public boolean supportsMultivalued()

Description copied from interface: LogicalModelFormat

Does this format handle multivalued models?

Specified by:

supportsMultivalued in interface LogicalModelFormat

Returns:

true if it supports multivalued models, false for Boolean formats

getMultivaluedSupport

public LogicalModelFormat.MultivaluedSupport getMultivaluedSupport()

Description copied from interface: LogicalModelFormat

Precise type of support for multivalued models.

Specified by:

getMultivaluedSupport in interface LogicalModelFormat

Returns:

the type of support: native, booleanized or none

importFile

public LogicalModel importFile(File f)
                        throws IOException

Description copied from interface: LogicalModelFormat

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

Specified by:

importFile in interface LogicalModelFormat

Parameters:

f - the file to import

Returns:

a new LogicalModel containing the imported data.

Throws:

IOException - if loading failed

export

public void export(LogicalModel model,
                   OutputStreamProvider outputProvider)
            throws IOException

Description copied from interface: LogicalModelFormat

Export a logical model to this format.

Specified by:

export in interface LogicalModelFormat

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

export

public void export(LogicalModel model,
                   OutputStream out)
            throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object