org.sbml.jsbml

Interface SBMLInputConverter<T>

Type Parameters:

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

public interface SBMLInputConverter<T>

This interface allows the implementing class to create a JSBML model based on some other data structure. Possible examples are CellDesigner plug-in data structures or Objects from libSBML. Other data structures can also be considered, such as a conversion of BioPax or CellML into JSBML data structures.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Andreas Dräger

Method Summary

Methods

Modifier and Type	Method and Description
Model	convertModel(T model) Takes a model in an arbitrary (but type-secure) format and delivers a corresponding JSBML-compliant model.
SBMLDocument	convertSBMLDocument(java.io.File sbmlFile)
SBMLDocument	convertSBMLDocument(java.lang.String fileName)
T	getOriginalModel()
java.util.List<SBMLException>	getWarnings() Creates an SBML error report and returns the list of errors.
void	setListener(ProgressListener listener)

Method Detail

convertModel

Model convertModel(T model)
                   throws java.lang.Exception

Takes a model in an arbitrary (but type-secure) format and delivers a corresponding JSBML-compliant model.

Parameters:

model -

Returns:

Throws:

java.lang.Exception

convertSBMLDocument

SBMLDocument convertSBMLDocument(java.io.File sbmlFile)
                                 throws java.lang.Exception

Parameters:

sbmlFile -

Returns:

Throws:

java.lang.Exception

convertSBMLDocument

SBMLDocument convertSBMLDocument(java.lang.String fileName)
                                 throws java.lang.Exception

Parameters:

fileName -

Returns:

Throws:

java.lang.Exception

getOriginalModel

T getOriginalModel()

Returns:

The original model that has been converted by this class in the method convertModel(Object). Typically, the identical result can also be obtained by calling AbstractTreeNode.getUserObject(Object) with #ORIGINAL_MODEL_KEY as parameter.

getWarnings

java.util.List<SBMLException> getWarnings()

Creates an SBML error report and returns the list of errors.

Returns:

Warnings that occur during the conversion of the model.

setListener

void setListener(ProgressListener listener)

Parameters:

listener - the listener to set