org.sbml.jsbml.ext.comp
public class ExternalModelDefinition extends AbstractNamedSBase implements UniqueNamedSBase
ExternalModelDefinition
objects are model definitions - in and of themselves,
they are definitions of the models but not uses of those models. The class provides a way
to declare and identify them so that Model
objects in the present SBMLDocument
can use them in SubModel
objects.Modifier and Type | Field and Description |
---|---|
private java.lang.String |
md5 |
private java.lang.String |
modelRef |
private static long |
serialVersionUID
Generated serial version identifier.
|
private java.lang.String |
source |
ignoredExtensions, ignoredXMLElements
listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
Constructor and Description |
---|
ExternalModelDefinition()
Creates an ExternalModelDefinition instance
|
ExternalModelDefinition(ExternalModelDefinition obj)
Clone constructor
|
ExternalModelDefinition(java.lang.String id)
Creates a ExternalModelDefinition instance with an id.
|
ExternalModelDefinition(java.lang.String id,
int level,
int version)
Creates a ExternalModelDefinition instance with an id, level, and version.
|
ExternalModelDefinition(java.lang.String id,
java.lang.String name,
int level,
int version)
Creates a ExternalModelDefinition instance with an id, name, level, and version.
|
Modifier and Type | Method and Description |
---|---|
ExternalModelDefinition |
clone()
clones this class
|
java.lang.String |
getMd5()
Returns the value of md5 or an empty
String if it is not set. |
java.lang.String |
getModelRef()
Returns the value of modelRef or an empty
String if it is not set. |
java.lang.String |
getSource()
Returns the value of source or an empty
String if it is not set. |
void |
initDefaults()
Initializes the default values using the namespace.
|
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 |
isSetMd5()
Returns whether md5 is set
|
boolean |
isSetModelRef()
Returns whether modelRef is set
|
boolean |
isSetSource()
Returns whether source is set
|
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value)
Sets the given attribute in this
SBase . |
void |
setMd5(java.lang.String md5)
Sets the value of the optional md5 attribute.
|
void |
setModelRef(java.lang.String modelRef)
Sets the value of the optional modelRef attribute.
|
void |
setSource(java.lang.String source)
Sets the value of the required source attribute.
|
boolean |
unsetMd5()
Unsets the variable md5
|
boolean |
unsetModelRef()
Unsets the variable modelRef
|
boolean |
unsetSource()
Unsets the variable source
|
java.util.Map<java.lang.String,java.lang.String> |
writeXMLAttributes()
Returns a map with all the attributes of this
SBase that
need to be written out in XML. |
equals, getId, getName, hashCode, isSetId, isSetName, isValidId, setId, setName, toString, unsetId, unsetName
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, 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, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, 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
finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, 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, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, 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
private static final long serialVersionUID
private java.lang.String source
private java.lang.String modelRef
private java.lang.String md5
public ExternalModelDefinition()
public ExternalModelDefinition(java.lang.String id)
id
- public ExternalModelDefinition(java.lang.String id, int level, int version)
id
- level
- version
- public ExternalModelDefinition(java.lang.String id, java.lang.String name, int level, int version)
id
- name
- level
- version
- public ExternalModelDefinition(ExternalModelDefinition obj)
public ExternalModelDefinition clone()
clone
in interface SBase
clone
in class AbstractSBase
public void initDefaults()
public java.lang.String getSource()
String
if it is not set.String
if it is not set.public boolean isSetSource()
public void setSource(java.lang.String source)
ExternalModelDefinition
. The value of the attribute must
be a URI, which includes URLs, URNs, or relative/absolute file locations.
The source attribute must refer specifically to an SBML Level 3 Version 1
document. The entire file at the given location is referenced. The source
attribute must have a value for every ExternalModelDefinition
.public boolean unsetSource()
true
, if source was set before,
otherwise false
public java.lang.String getModelRef()
String
if it is not set.String
if it is not set.public boolean isSetModelRef()
public void setModelRef(java.lang.String modelRef)
Model
or ExternalModelDefinition
object within the SBML document located at source. The object referenced may be
the main model in the document, or it may be a model definition contained in the
SBML document's listOfModelDefinitions or listOfExternalModelDefinitions. Loops
are not allowed: it must be possible to follow a chain of
ExternalModelDefinition
objects to its end in a Model
object.
In core SBML, the id on Model
is an optional attribute, and therefore, it
is possible that the Model
object in a given SBML document does not have
an identifier. In that case, there is no value to give to the modelRef attribute
in ExternalModelDefinition
. If modelRef does not have a value, then the
main model (i.e., the model element within the sbml element) in the referenced
file is interpreted as being the model referenced by this ExternalModelDefinition
instance.public boolean unsetModelRef()
true
, if modelRef was set before,
otherwise false
public java.lang.String getMd5()
String
if it is not set.String
if it is not set.public boolean isSetMd5()
public void setMd5(java.lang.String md5)
ExternalModelDefinition
reference was constructed.public boolean unsetMd5()
true
, if md5 was set before,
otherwise false
public java.util.Map<java.lang.String,java.lang.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 AbstractNamedSBase
Map
containing the XML attributes of this object.public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.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 AbstractNamedSBase
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public boolean isIdMandatory()
NamedSBase
NamedSBase
is required to be defined (i.e., not null
)
in the definition of SBML.isIdMandatory
in interface NamedSBase
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.