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:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Objective>, java.util.Collection<Objective>, java.util.List<Objective>, javax.swing.tree.TreeNode, SBase, TreeNodeWithChangeSupport

public class ListOfObjectives
extends ListOf<Objective>

Unlike other SBML ListOf classes, ListOfObjectives adds an additional required attribute activeObjective.

Since:

1.0

Version:

$Rev: 1706 $

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

Modifier and Type	Field and Description
private java.lang.String	activeObjective
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.ListOf

listOf, listType

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
ListOfObjectives()
ListOfObjectives(int level, int version)
ListOfObjectives(ListOf<Objective> listOf)
ListOfObjectives(ListOfObjectives listOf)

Method Summary

Methods

Modifier and Type	Method and 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
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) This attribute refers to an id of an existing 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.

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, getSBaseListType, indexOf, initListOf, isDebugMode, isEmpty, iterator, lastIndexOf, listIterator, listIterator, newInstance, remove, remove, remove, remove, removeAll, removeAll, removeFirst, retainAll, set, setDebugMode, setListOf, setSBaseListType, setSBaseListType, size, subList, toArray, toArray, toString, unsetSBaseListType

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hashCode, 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

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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

hashCode

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

activeObjective

private java.lang.String activeObjective

Constructor Detail

ListOfObjectives

public ListOfObjectives()

ListOfObjectives

public ListOfObjectives(int level,
                int version)

Parameters:

level -

version -

ListOfObjectives

public ListOfObjectives(ListOfObjectives listOf)

Parameters:

listOf -

ListOfObjectives

public ListOfObjectives(ListOf<Objective> listOf)

Parameters:

listOf -

Method Detail

clone

public ListOf<Objective> clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Overrides:

clone in class ListOf<Objective>

Returns:

a copy of this object

getActiveObjective

public java.lang.String getActiveObjective()

Returns the value of activeObjective

Returns:

the value of activeObjective

getElementName

public java.lang.String getElementName()

Description copied from interface: SBase

Returns the XML element name of this object.

Specified by:

getElementName in interface SBase

Overrides:

getElementName in class ListOf<Objective>

Returns:

the XML element name of this object.

isSetActiveObjective

public boolean isSetActiveObjective()

Returns whether activeObjective is set

Returns:

whether activeObjective is set

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class ListOf<Objective>

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

setActiveObjective

public void setActiveObjective(java.lang.String activeObjective)

This attribute refers to an id of an existing Objective. This attribute exists so that 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. Sets the value of activeObjective

unsetActiveObjective

public boolean unsetActiveObjective()

Unsets the variable activeObjective

Returns:

true, if activeObjective was set before, otherwise false

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this 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.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

Returns:

a Map containing the XML attributes of this object.