org.sbml.jsbml.ext.fbc

Class ListOfObjectives

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ListOf<Objective>

org.sbml.jsbml.ext.fbc.ListOfObjectives

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Objective>, Collection<Objective>, List<Objective>, TreeNode, SBase, UniqueSId, TreeNodeWithChangeSupport

public class ListOfObjectives
extends ListOf<Objective>

ListOfObjectives adds an additional required attribute: 'activeObjective'.

Since:

1.0

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ListOf

ListOf.Type

Field Summary

Fields inherited from class org.sbml.jsbml.ListOf

listOf, listType, otherListName

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
ListOfObjectives() Creates a new ListOfObjectives instance.
ListOfObjectives(int level, int version) Creates a new ListOfObjectives instance.
ListOfObjectives(ListOf<Objective> listOf) Creates a new ListOfObjectives instance.
ListOfObjectives(ListOfObjectives listOf) Creates a new ListOfObjectives instance.

Method Summary

Modifier and Type	Method and Description
ListOf<Objective>	clone()
String	getActiveObjective() Returns the value of activeObjective
Objective	getActiveObjectiveInstance() Returns the active Objective.
String	getElementName()
boolean	isSetActiveObjective() Returns whether activeObjective is set
boolean	readAttribute(String attributeName, String prefix, String value)
void	setActiveObjective(Objective activeObjective) Sets the value of activeObjective to the id of the given Objective.
void	setActiveObjective(String activeObjective) Sets the active objective.
boolean	unsetActiveObjective() Unsets the variable activeObjective
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.ListOf

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

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, 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, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

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

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Constructor Detail

ListOfObjectives

public ListOfObjectives()

Creates a new ListOfObjectives instance.

ListOfObjectives

public ListOfObjectives(int level,
                        int version)

Creates a new ListOfObjectives instance.

Parameters:

level - the SBML level

version - the SBML version

ListOfObjectives

public ListOfObjectives(ListOfObjectives listOf)

Creates a new ListOfObjectives instance.

Parameters:

listOf - the instance to clone

ListOfObjectives

public ListOfObjectives(ListOf<Objective> listOf)

Creates a new ListOfObjectives instance.

Parameters:

listOf - the instance to clone

Method Detail

clone

public ListOf<Objective> clone()

Specified by:

clone in interface SBase

Overrides:

clone in class ListOf<Objective>

getActiveObjective

public String getActiveObjective()

Returns the value of activeObjective

Returns:

the value of activeObjective

getActiveObjectiveInstance

public Objective getActiveObjectiveInstance()

Returns the active Objective.

Returns:

the active Objective or null if none can be found.

getElementName

public String getElementName()

Specified by:

getElementName in interface SBase

Overrides:

getElementName in class ListOf<Objective>

isSetActiveObjective

public boolean isSetActiveObjective()

Returns whether activeObjective is set

Returns:

whether activeObjective is set

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase

setActiveObjective

public void setActiveObjective(String activeObjective)

Sets the active objective.

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.

Parameters:

activeObjective - the value of activeObjective

setActiveObjective

public void setActiveObjective(Objective activeObjective)

Sets the value of activeObjective to the id of the given Objective.

Parameters:

activeObjective - an Objective that will be set as the active objective.

See Also:

setActiveObjective(String)

unsetActiveObjective

public boolean unsetActiveObjective()

Unsets the variable activeObjective

Returns:

true, if activeObjective was set before, otherwise false

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase