org.sbml.jsbml

Interface NamedSBase

All Superinterfaces:

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

All Known Subinterfaces:

CallableSBase, NamedSBaseWithDerivedUnit, Quantity, UniqueNamedSBase, Variable

All Known Implementing Classes:

AbstractNamedSBase, AbstractNamedSBaseRef, AbstractNamedSBaseWithUnit, AbstractReferenceGlyph, BoundingBox, ChangedMath, ColorDefinition, Compartment, CompartmentGlyph, CompartmentType, Curve, Deletion, Dimension, Dimensions, Event, ExternalModelDefinition, FluxBound, FluxObjective, FunctionDefinition, GeneralGlyph, GlobalRenderInformation, GradientBase, GraphicalObject, Group, InitialSpeciesInstance, Input, Layout, LinearGradient, ListOfMemberConstraint, LocalParameter, LocalRenderInformation, LocalStyle, Member, MemberConstraint, Model, ModelDefinition, ModifierSpeciesReference, Objective, Output, Parameter, Point, Port, PossibleValue, ProductSpeciesReference, QualitativeSpecies, QuantityWithUnit, RadialGradient, Reaction, ReactionGlyph, ReactionRule, ReferenceGlyph, RenderGroup, RenderInformationBase, Selector, SimpleSpeciesReference, Species, SpeciesGlyph, SpeciesReference, SpeciesReferenceGlyph, SpeciesType, SpeciesType, SpeciesTypeInstance, SpeciesTypeRestriction, SpeciesTypeState, StateFeature, StateFeatureInstance, Style, Submodel, Symbol, TextGlyph, Transition, UnitDefinition

public interface NamedSBase
extends SBase

Base class for all the SBML components with an id and a name (optional or not).

Since:

0.8

Version:

$Rev: 1639 $

Author:

Andreas Dräger, marine

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId()
java.lang.String	getName()
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetId()
boolean	isSetName()
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, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, 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.

getName

java.lang.String getName()

Returns:

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

isIdMandatory

boolean isIdMandatory()

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

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.

isSetName

boolean isSetName()

Returns:

true if the name is not null.

setId

void setId(java.lang.String id)

sets the id value with 'id'

Parameters:

id -

setName

void setName(java.lang.String name)

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

Parameters:

name -

unsetId

void unsetId()

sets the id value to null.

unsetName

void unsetName()

sets the name value to null.