org.sbml.jsbml

Interface NamedSBase

All Superinterfaces:

java.lang.Cloneable, SBase, java.io.Serializable, javax.swing.tree.TreeNode, TreeNodeWithChangeSupport

All Known Subinterfaces:

CallableSBase, CompartmentalizedSBase, NamedSBaseWithDerivedUnit, Quantity, UniqueNamedSBase, Variable

All Known Implementing Classes:

AbstractNamedSBase, AbstractNamedSBaseWithUnit, Compartment, CompartmentType, Event, FunctionDefinition, LocalParameter, Model, ModifierSpeciesReference, Parameter, QuantityWithUnit, Reaction, SimpleSpeciesReference, Species, SpeciesReference, SpeciesType, Symbol, UnitDefinition

public interface NamedSBase
extends SBase

Base class for all the SBML components with an id and a name (optional or not) in SBML Level 3 Version 1 or lower. Since SBML Level 3 Version 2, every SBase have an id an a name. This interface is kept as it is to be able to know which elements could have an id or name before SBML L3V2, not every SBase will be NamedSBase in jsbml. If you support L3V2 and want to manipulate id and name, prefer to use the SBase interface instead of NamedSBase.

Since:

0.8

Author:

Andreas Dräger, marine

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id of the element if it is set, an empty string otherwise.
java.lang.String	getName() Returns the name of the element if it is set, an empty string otherwise.
boolean	isIdMandatory() Returns true if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetId() Returns true if the id is not null.
boolean	isSetName() Returns true if the name is not null.
void	setId(java.lang.String id) Sets the id value with 'id'
void	setName(java.lang.String name) Sets the name value with 'name'.
void	unsetId() Sets the id value to null.
void	unsetName() Sets the name value to null.

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getId

java.lang.String getId()

Returns the id of the element if it is set, an empty string otherwise.

Specified by:

getId in interface SBase

Returns:

the id of the element if it is set, an empty string otherwise.

getName

java.lang.String getName()

Returns the name of the element if it is set, an empty string otherwise.

Specified by:

getName in interface SBase

Returns:

the name of the element if it is set, an empty string otherwise.

isIdMandatory

boolean isIdMandatory()

Returns true if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Specified by:

isIdMandatory in interface SBase

Returns:

true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.

isSetId

boolean isSetId()

Returns true if the id is not null.

Specified by:

isSetId in interface SBase

Returns:

true if the id is not null.

isSetName

boolean isSetName()

Returns true if the name is not null.

Specified by:

isSetName in interface SBase

Returns:

true if the name is not null.

setId

void setId(java.lang.String id)

Sets the id value with 'id'

Specified by:

setId in interface SBase

Parameters:

id - the id to set

setName

void setName(java.lang.String name)

Sets the name value with 'name'. If level is 1, sets automatically the id to 'name' as well.

Specified by:

setName in interface SBase

Parameters:

name - the name to set

unsetId

void unsetId()

Sets the id value to null.

Specified by:

unsetId in interface SBase

unsetName

void unsetName()

Sets the name value to null.

Specified by:

unsetName in interface SBase