org.sbml.jsbml

Interface SBMLOutputConverter<T>

Type Parameters:

T - The type of output model that can be treated by this converter.

public interface SBMLOutputConverter<T>

This interface allows the implementing class to convert a JSBML model into another data structure. Possible examples are a conversion into libSBML or CellDesigner plug-in data structures. Other formats can also be implemented, for instance, a BioPax or CellML converter could be implemented.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

Method Summary

Modifier and Type	Method and Description
java.util.List<SBMLException>	getWriteWarnings(T model)
boolean	writeSBML(T model, java.lang.String filename) This method is identical to the method writeSBML(Object, String, String, String), but without the option to pass the program's name or version to the writer.
boolean	writeSBML(T model, java.lang.String filename, java.lang.String programName, java.lang.String versionNumber) Writes the given model (in which format it might be given) to an SBML file as specified by the given filename and returns true if this operation could be successfully executed, false otherwise.

Method Detail

getWriteWarnings

java.util.List<SBMLException> getWriteWarnings(T model)

Parameters:

model -

Returns:

writeSBML

boolean writeSBML(T model,
                  java.lang.String filename)
           throws SBMLException,
                  java.io.IOException

This method is identical to the method writeSBML(Object, String, String, String), but without the option to pass the program's name or version to the writer.

Parameters:

model -

filename -

Returns:

Throws:

SBMLException

java.io.IOException

See Also:

writeSBML(Object, String, String, String)

writeSBML

boolean writeSBML(T model,
                  java.lang.String filename,
                  java.lang.String programName,
                  java.lang.String versionNumber)
           throws SBMLException,
                  java.io.IOException

Writes the given model (in which format it might be given) to an SBML file as specified by the given filename and returns true if this operation could be successfully executed, false otherwise.

Parameters:

model - the model (in whatever format, but with respect to the type of this generic class).

filename - the file's absolute or relative path to which the SBML code should be serialized.

programName - the name of the program that uses this method.

versionNumber - the version number of the program that accesses this method.

Returns:

true if this operation could be successfully executed, false otherwise.

Throws:

SBMLException

java.io.IOException

See Also:

writeSBML(Object, String)