org.sbml.jsbml
public abstract class AbstractNamedSBase extends AbstractSBase implements NamedSBase
UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
Constructor and Description |
---|
AbstractNamedSBase()
Creates an
AbstractNamedSBase . |
AbstractNamedSBase(AbstractNamedSBase nsb)
Creates an
AbstractNamedSBase from a given AbstractNamedSBase . |
AbstractNamedSBase(int level,
int version)
Creates an
AbstractNamedSBase from a level and version. |
AbstractNamedSBase(String id)
Creates an
AbstractNamedSBase with the given identifier. |
AbstractNamedSBase(String id,
int level,
int version)
Creates an
AbstractNamedSBase from an id, level and version. |
AbstractNamedSBase(String id,
String name,
int level,
int version)
Creates an AbctractNamedSBase from an id, name, level and version.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object object)
|
String |
getId() |
String |
getName() |
int |
hashCode()
Returns a hash code value for this
SBase instance. |
boolean |
isSetId() |
boolean |
isSetName() |
static boolean |
isValidId(String idCandidate,
int level,
int version)
Deprecated.
|
boolean |
readAttribute(String attributeName,
String prefix,
String value)
Sets the given attribute in this
SBase . |
void |
setId(String id)
sets the id value with 'id'
|
void |
setName(String name)
sets the name value with 'name'.
|
String |
toString()
Returns the name of the component, if it is available.
|
void |
unsetId()
sets the id value to
null . |
void |
unsetName()
sets the name value to
null . |
Map<String,String> |
writeXMLAttributes()
Returns a map with all the attributes of this
SBase that
need to be written out in XML. |
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, clone, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm
addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet
isIdMandatory
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, 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
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
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf
public AbstractNamedSBase()
AbstractNamedSBase
. By default, id and name are null
.public AbstractNamedSBase(AbstractNamedSBase nsb)
AbstractNamedSBase
from a given AbstractNamedSBase
.nsb
- an AbstractNamedSBase
object to clonepublic AbstractNamedSBase(int level, int version)
AbstractNamedSBase
from a level and version. By default, id
and name are null
.level
- the SBML levelversion
- the SBML versionpublic AbstractNamedSBase(String id)
AbstractNamedSBase
with the given identifier. Note
that with this constructor the level and version of the element are not
specified. These elements are however required to ensure the validity of
the SBML data structure. Without level and version, it may not be
possible to serialize this class to SBML.id
- the id of this AbstractNamedSBase
public AbstractNamedSBase(String id, int level, int version)
AbstractNamedSBase
from an id, level and version.id
- the id of this AbstractNamedSBase
level
- the SBML levelversion
- the SBML version@Deprecated public static final boolean isValidId(String idCandidate, int level, int version)
SyntaxChecker.isValidId(String, int, int)
idCandidate
- The String
to be tested.level
- Level of the SBML to be used.version
- Version of the SBML to be used.public String getId()
getId
in interface NamedSBase
public String getName()
getName
in interface NamedSBase
public int hashCode()
SBase
SBase
instance.hashCode
in interface SBase
hashCode
in class AbstractSBase
SBase
instance.Object.hashCode()
public boolean isSetId()
isSetId
in interface NamedSBase
true
if the id is not null
.public boolean isSetName()
isSetName
in interface NamedSBase
true
if the name is not null
.public boolean readAttribute(String attributeName, String prefix, String value)
SBase
SBase
.
If the given attribute name is not recognized, nothing is done and
false
is returned.
readAttribute
in interface SBase
readAttribute
in class AbstractSBase
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public void setId(String id)
NamedSBase
setId
in interface NamedSBase
public void setName(String name)
NamedSBase
setName
in interface NamedSBase
public String toString()
toString
in class AbstractSBase
public void unsetId()
NamedSBase
null
.unsetId
in interface NamedSBase
public void unsetName()
NamedSBase
null
.unsetName
in interface NamedSBase
public Map<String,String> writeXMLAttributes()
SBase
SBase
that
need to be written out in XML.
The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class AbstractSBase
Map
containing the XML attributes of this object.