jp.ac.keio.bio.fun.xitosbml.pane

Class SpeciesDialog

java.lang.Object

jp.ac.keio.bio.fun.xitosbml.pane.SpeciesDialog

public class SpeciesDialog
extends Object

The class SpeciesDialog, which generates a GUI for creating / editing Species. This class is used in SpeciesTable. Date Created: Jan 20, 2016

Author:

Kaito Ii <ii@fun.bio.keio.ac.jp>, Akira Funahashi <funa@bio.keio.ac.jp>

Constructor Summary

Constructors

Constructor and Description
SpeciesDialog(org.sbml.jsbml.Model model) Instantiates a new species dialog.

Method Summary

Modifier and Type	Method and Description
org.sbml.jsbml.Species	showDialog() Create and show a dialog for adding Species.
org.sbml.jsbml.Species	showDialog(org.sbml.jsbml.Species species) Create and show a dialog for adding Species with given JSBML Species object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeciesDialog

public SpeciesDialog(org.sbml.jsbml.Model model)

Instantiates a new species dialog.

Parameters:

model - the SBML model

Method Detail

showDialog

public org.sbml.jsbml.Species showDialog()
                                  throws IllegalArgumentException,
                                         org.sbml.jsbml.IdentifierException

Create and show a dialog for adding Species. If a user creates a species through this dialog, then a Species object will be returned. If not, null is returned.

Returns:

the JSBML Species object if a species is created

Throws:

IllegalArgumentException - the illegal argument exception

org.sbml.jsbml.IdentifierException - the identifier exception

showDialog

public org.sbml.jsbml.Species showDialog(org.sbml.jsbml.Species species)
                                  throws IllegalArgumentException,
                                         org.sbml.jsbml.IdentifierException

Create and show a dialog for adding Species with given JSBML Species object. If a user edits the species through this dialog, then a Species object will be returned. If not, null is returned.

Parameters:

species - the JSBML Species object

Returns:

the JSBML Species object if the parameter is edited

Throws:

IllegalArgumentException - the illegal argument exception

org.sbml.jsbml.IdentifierException - the identifier exception