jp.sbi.celldesigner.plugin.sbgnml

Class PluginSBGNML

java.lang.Object

jp.sbi.celldesigner.plugin.sbgnml.PluginSBGNML

public class PluginSBGNML
extends java.lang.Object

Plugin class for exporting Graphical Notation to SBGN-ML. For example, you can export graphical network on CellDesigner's canvas as SBGN-ML with following lines of code.

 
 PluginModel m = plugin.getSelectedModel();
 PluginSBGNML plugsbgn = new PluginSBGNML(m);
 plugsbgn.export();
 
 

While there is no output file (SBGN-ML file) specified in the above example code, CellDesigner will launch FileDialog to ask users where to store the exported SBGN-ML. If you want to specify where to store SBGN-ML, then use the following code.

 
 PluginModel m = plugin.getSelectedModel();
 File sbgnFile = new File("foo.sbgn");
 PluginSBGNML plugsbgn = new PluginSBGNML(m, sbgnFile);
 plugsbgn.export();
 
 

Author:

Akira Funahashi Akira Funahashi

Constructor Summary

Constructors

Constructor and Description
PluginSBGNML(PluginModel pluginModel) Class constructor specifying pluginModel
PluginSBGNML(PluginModel pluginModel, java.io.File sbgnFile) Class constructor specifying pluginModel and sbgnFile

Method Summary

Modifier and Type	Method and Description
void	export() Convert PluginModel which has CelLDesigner annotation to SBGN object model and then export as SBGN-ML.
java.io.File	getSbgnFile() Returns sbgnFile object.
void	setSbgnFile(java.io.File sbgnFile) Sets sbgnFile

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginSBGNML

public PluginSBGNML(PluginModel pluginModel)

Class constructor specifying pluginModel

Parameters:

pluginModel - the model which will be exported to SBGN-ML.

PluginSBGNML

public PluginSBGNML(PluginModel pluginModel,
                    java.io.File sbgnFile)

Class constructor specifying pluginModel and sbgnFile

Parameters:

pluginModel - the model which will be exported to SBGN-ML.

sbgnFile - output file (SBGN-ML file)

Method Detail

export

public void export()

Convert PluginModel which has CelLDesigner annotation to SBGN object model and then export as SBGN-ML. If sbgnFile (output SBGN-ML file) is not specified, this plugin will launch FileDialog to ask users where to store the SBGN-ML.

getSbgnFile

public java.io.File getSbgnFile()

Returns sbgnFile object.

Returns:

sbgnFile if exists, otherwise null.

setSbgnFile

public void setSbgnFile(java.io.File sbgnFile)

Sets sbgnFile

Parameters:

sbgnFile - File