java.io.Serializable
, java.lang.Cloneable
, javax.swing.tree.TreeNode
, SBase
, UniqueSId
, TreeNodeWithChangeSupport
public class ListOfObjectives extends ListOf<Objective>
ListOfObjectives
adds an additional required attribute: 'activeObjective'.ListOf.Type
JSBML_WRONG_SBO_TERM
Constructor | Description |
---|---|
ListOfObjectives() |
Creates a new
ListOfObjectives instance. |
ListOfObjectives(int level,
int version) |
Creates a new
ListOfObjectives instance. |
ListOfObjectives(ListOfObjectives listOf) |
Creates a new
ListOfObjectives instance. |
ListOfObjectives(ListOf<Objective> listOf) |
Creates a new
ListOfObjectives instance. |
Modifier and Type | Method | Description |
---|---|---|
ListOf<Objective> |
clone() |
Creates a deep copy of this object, i.e., a new
SBase with the same
properties
like this one. |
java.lang.String |
getActiveObjective() |
Returns the value of activeObjective
|
Objective |
getActiveObjectiveInstance() |
Returns the active
Objective . |
java.lang.String |
getElementName() |
Returns the XML element name of this object.
|
boolean |
isSetActiveObjective() |
Returns whether activeObjective is set
|
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value) |
Sets the given attribute in this
SBase . |
void |
setActiveObjective(java.lang.String activeObjective) |
Sets the active objective.
|
void |
setActiveObjective(Objective activeObjective) |
Sets the value of
activeObjective to the id of the given Objective . |
boolean |
unsetActiveObjective() |
Unsets the variable activeObjective
|
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. |
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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
hashCode, of, of, of, of, of, of, of, of, of, of, of, of, replaceAll, sort, spliterator
add, add, addAll, addAll, append, clear, contains, containsAll, equals, filterList, firstHit, get, get, getAllowsChildren, getChildAt, getChildCount, getFirst, getLast, getOtherListName, getSBaseListType, indexOf, initListOf, isDebugMode, isEmpty, iterator, lastIndexOf, listIterator, listIterator, newInstance, remove, remove, remove, remove, removeAll, removeAll, removeFirst, retainAll, set, setDebugMode, setListOf, setOtherListName, setPackageName, setSBaseListType, setSBaseListType, size, subList, toArray, toArray, unsetSBaseListType
getClass, hashCode, notify, notifyAll, wait, wait, wait
removeTreeNodeChangeListener
addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet
public ListOfObjectives()
ListOfObjectives
instance.public ListOfObjectives(int level, int version)
ListOfObjectives
instance.level
- the SBML levelversion
- the SBML versionpublic ListOfObjectives(ListOfObjectives listOf)
ListOfObjectives
instance.listOf
- the instance to clonepublic ListOfObjectives(ListOf<Objective> listOf)
ListOfObjectives
instance.listOf
- the instance to clonepublic ListOf<Objective> clone()
SBase
SBase
with the same
properties
like this one.public java.lang.String getActiveObjective()
public Objective getActiveObjectiveInstance()
Objective
.Objective
or null if none can be found.public java.lang.String getElementName()
SBase
getElementName
in interface SBase
getElementName
in class ListOf<Objective>
public boolean isSetActiveObjective()
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 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 setActiveObjective(java.lang.String activeObjective)
This attribute refers to an id of an existing Objective
. This attribute
exists so that if multiple objectives are defined in a single model, the model will
always be well-defined, i.e., there is a single objective function which defines
a single optimum.
activeObjective
- the value of activeObjective
public void setActiveObjective(Objective activeObjective)
activeObjective
to the id of the given Objective
.activeObjective
- an Objective
that will be set as the active objective.setActiveObjective(String)
public boolean unsetActiveObjective()
true
, if activeObjective 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 AbstractSBase
Map
containing the XML attributes of this object.