Constructor and Description |
---|
Objective()   |
Objective(FbcPkgNamespaces fbcns)   |
Objective(long level)   |
Objective(long level,
long version)   |
Objective(long level,
long version,
long pkgVersion)   |
Objective(Objective source)   |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFbc(SWIGTYPE_p_FbcVisitor v)   |
int |
addFluxObjective(FluxObjective member)   |
Objective |
cloneObject()
Creates and returns a deep copy of this
SBase object. |
FluxObjective |
createFluxObjective()   |
void |
delete()
Explicitly deletes the underlying native object.
|
SBase |
getElementByMetaId(String metaid)
Returns the first child element it can find with a specific 'metaid'
attribute value, or
null if no such object is found. |
SBase |
getElementBySId(String id)
Returns the first child element found that has the given
id in the
model-wide SId namespace, or null if no such object is found. |
String |
getElementName()
Returns the XML element name of this object.
|
FluxObjective |
getFluxObjective(long n)   |
FluxObjective |
getFluxObjective(String symbol)   |
boolean |
getIsSetListOfFluxObjectives()   |
ListOfFluxObjectives |
getListOfFluxObjectives()   |
long |
getNumFluxObjectives()   |
int |
getObjectiveType()   |
String |
getType()   |
int |
getTypeCode()
Returns the libSBML type code for this object.
|
boolean |
isSetType()   |
FluxObjective |
removeFluxObjective(long index)   |
FluxObjective |
removeFluxObjective(String symbol)   |
int |
setType(int type)   |
int |
setType(String type)   |
int |
unsetId()
Unsets the value of the 'id' attribute of this SBML object.
|
int |
unsetName()
Unsets the value of the 'name' attribute of this SBML object.
|
int |
unsetType()   |
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getLevel, getLine, getListOfAllElements, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm
public Objective() throws SBMLConstructorException
SBMLConstructorException
public Objective(FbcPkgNamespaces fbcns) throws SBMLConstructorException
SBMLConstructorException
public Objective(long level) throws SBMLConstructorException
SBMLConstructorException
public Objective(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public Objective(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public Objective(Objective source) throws SBMLConstructorException
SBMLConstructorException
public boolean acceptFbc(SWIGTYPE_p_FbcVisitor v)
public int addFluxObjective(FluxObjective member)
public Objective cloneObject()
SBase
object.
cloneObject
 in class SBase
SBase
object.public FluxObjective createFluxObjective()
public void delete()
In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize()
methods for the objects. The finalize()
methods in turn call the Objective.delete()
method on the libSBML object.
This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke Objective.delete()
themselves.
public SBase getElementByMetaId(String metaid)
null
if no such object is found.
getElementByMetaId
 in class SBase
metaid
- string representing the 'metaid' attribute value of the
object to find.
public SBase getElementBySId(String id)
id
in the
model-wide SId
namespace, or null
if no such object is found.
getElementBySId
 in class SBase
id
- string representing the 'id' attribute value of the object
to find.
public String getElementName()
This is overridden by subclasses to return a string appropriate to the
SBML component. For example, Model
defines it as returning
'model'
, CompartmentType
defines it as returning 'compartmentType'
,
and so on.
getElementName
 in class SBase
public FluxObjective getFluxObjective(long n)
public FluxObjective getFluxObjective(String symbol)
public boolean getIsSetListOfFluxObjectives()
public ListOfFluxObjectives getListOfFluxObjectives()
public long getNumFluxObjectives()
public int getObjectiveType()
public int getTypeCode()
This method may return the type code of this SBML object, or it may
return SBML_UNKNOWN
. This
is because subclasses of SBase
are not required to implement this
method to return a type code. This method is meant primarily for the
LibSBML C interface, in which class and subclass information is not
readily available.
getTypeCode
 in class SBase
SBML_UNKNOWN
(the default).
Objective.getElementName()
,
SBase.getPackageName()
public boolean isSetType()
public FluxObjective removeFluxObjective(long index)
public FluxObjective removeFluxObjective(String symbol)
public int setType(int type)
public int unsetId()
Most (but not all) objects in SBML include two common attributes: 'id'
and 'name'. The identifier given by an object's 'id' attribute value
is used to identify the object within the SBML model definition.
Other objects can refer to the component using this identifier. The
data type of 'id' is always either Sid
or
UnitSId
, depending on the object in question. Both
data types are defined as follows:
letter .= 'a'..'z','A'..'Z' digit .= '0'..'9' idChar .= letter | digit | '_' SId .= ( letter | '_' ) idChar*
The equality of SId
and UnitSId
type values
in SBML is determined by an exact character sequence match i.e.,
comparisons of these identifiers must be performed in a case-sensitive
manner. This applies to all uses of SId
and
UnitSId
.
public int unsetName()
Most (but not all) objects in SBML include two common attributes: 'id'
and 'name'. In contrast to the 'id' attribute, the 'name' attribute is
optional and is not intended to be used for cross-referencing purposes
within a model. Its purpose instead is to provide a human-readable
label for the component. The data type of 'name' is the type
string
defined in XML Schema. SBML imposes no
restrictions as to the content of 'name' attributes beyond those
restrictions defined by the string
type in XML Schema.
The recommended practice for handling 'name' is as follows. If a software tool has the capability for displaying the content of 'name' attributes, it should display this content to the user as a component's label instead of the component's 'id'. If the user interface does not have this capability (e.g., because it cannot display or use special characters in symbol names), or if the 'name' attribute is missing on a given component, then the user interface should display the value of the 'id' attribute instead. (Script language interpreters are especially likely to display 'id' instead of 'name'.)
As a consequence of the above, authors of systems that automatically generate the values of 'id' attributes should be aware some systems may display the 'id''s to the user. Authors therefore may wish to take some care to have their software create 'id' values that are: (a) reasonably easy for humans to type and read and (b) likely to be meaningful, for example by making the 'id' attribute be an abbreviated form of the name attribute value.
An additional point worth mentioning is although there are restrictions on the uniqueness of 'id' values, there are no restrictions on the uniqueness of 'name' values in a model. This allows software applications leeway in assigning component identifiers.
public int unsetType()