GeneProduct (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.GeneProduct

```
public class GeneProduct
extends SBase
```
fbc Association of a gene product with a Reaction
In the SBML Level 3 Flux Balance Constraints (&ldquofbc&rdquo) representation format, a GeneProduct object represents a single gene or implied gene product. The gene or gene product is identified using the required attribute 'label', which is a text string. (This attribute is separate from the usual SBML 'id' attribute, which is used to cross-reference entities within an SBML model.) A GeneProduct object can also possess an optional 'associatedSpecies' attribute if this a attribute is defined, it should have a value of type SIdRef and be the identifier of a Species object defined in the enclosing Model. An 'associatedSpecies', if it exists, is interpreted to be a species associated with the gene or gene product that is represented by the GeneProduct object.

"Note:"

This class of objects was introduced in Version 2 of the SBML Level 3 Flux Balance Constraints (&ldquofbc&rdquo) specification. In Version 1 of &ldquofbc&rdquo, the information encoded by this class can be stored instead using the Association and GeneAssociation annotation classes. Please see the Version 1 and Version 2 &ldquofbc&rdquo specifications for more details.

Constructor Summary

Constructors
Constructor and Description
`GeneProduct()` Creates a new `GeneProduct` with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
`GeneProduct(FbcPkgNamespaces fbcns)` Creates a new `GeneProduct` with the given `FbcPkgNamespaces` object.
`GeneProduct(GeneProduct orig)` Copy constructor for `GeneProduct`.
`GeneProduct(long level)` Creates a new `GeneProduct` with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
`GeneProduct(long level, long version)` Creates a new `GeneProduct` with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
`GeneProduct(long level, long version, long pkgVersion)` Creates a new `GeneProduct` with the given SBML Level, Version, and &ldquofbc&rdquopackage version.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GeneProduct`	`cloneObject()` Creates and returns a deep copy of this `GeneProduct` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`java.lang.String`	`getAssociatedSpecies()` Returns the value of the 'associatedSpecies' attribute of this `GeneProduct`.
`java.lang.String`	`getElementName()` Returns the XML element name of this object.
`java.lang.String`	`getId()` Returns the value of the 'id' attribute of this `GeneProduct`.
`java.lang.String`	`getLabel()` Returns the value of the 'label' attribute of this `GeneProduct`.
`java.lang.String`	`getName()` Returns the value of the 'name' attribute of this `GeneProduct`.
`int`	`getTypeCode()` Returns the libSBML type code for this SBML object.
`boolean`	`hasRequiredAttributes()` Predicate returning `true` if all the required attributes for this `GeneProduct` object have been set.
`boolean`	`isSetAssociatedSpecies()` Predicate returning `true` if this `GeneProduct`'s 'associatedSpecies' attribute is set.
`boolean`	`isSetId()` Predicate returning `true` if this `GeneProduct`'s 'id' attribute is set.
`boolean`	`isSetLabel()` Predicate returning `true` if this `GeneProduct`'s 'label' attribute is set.
`boolean`	`isSetName()` Predicate returning `true` if this `GeneProduct`'s 'name' attribute is set.
`void`	`renameSIdRefs(java.lang.String oldid, java.lang.String newid)` Replaces all uses of a given `SIdRef` type attribute value with another value.
`int`	`setAssociatedSpecies(java.lang.String associatedSpecies)` Sets the value of the 'associatedSpecies' attribute of this `GeneProduct`.
`int`	`setId(java.lang.String id)` Sets the value of the 'id' attribute of this `GeneProduct`.
`int`	`setLabel(java.lang.String label)` Sets the value of the 'label' attribute of this `GeneProduct`.
`int`	`setName(java.lang.String name)` Sets the value of the 'name' attribute of this `GeneProduct`.
`int`	`unsetAssociatedSpecies()` Unsets the value of the 'associatedSpecies' attribute of this `GeneProduct`.
`int`	`unsetId()` Unsets the value of the 'id' attribute of this `GeneProduct`.
`int`	`unsetLabel()` Unsets the value of the 'label' attribute of this `GeneProduct`.
`int`	`unsetName()` Unsets the value of the 'name' attribute of this `GeneProduct`.

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GeneProduct
```
public GeneProduct(long level,
                   long version,
                   long pkgVersion)
            throws SBMLConstructorException
```
    Creates a new GeneProduct with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this GeneProduct
    
    version - a long integer, the SBML Version to assign to this GeneProduct
    
    pkgVersion - a long integer, the SBML Fbc Version to assign to this GeneProduct
    
    Throws:
    
    SBMLConstructorException
  - GeneProduct
```
public GeneProduct(long level,
                   long version)
            throws SBMLConstructorException
```
    Creates a new GeneProduct with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this GeneProduct
    
    version - a long integer, the SBML Version to assign to this GeneProduct
    
    pkgVersion - a long integer, the SBML Fbc Version to assign to this GeneProduct
    
    Throws:
    
    SBMLConstructorException
  - GeneProduct
```
public GeneProduct(long level)
            throws SBMLConstructorException
```
    Creates a new GeneProduct with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this GeneProduct
    
    version - a long integer, the SBML Version to assign to this GeneProduct
    
    pkgVersion - a long integer, the SBML Fbc Version to assign to this GeneProduct
    
    Throws:
    
    SBMLConstructorException
  - GeneProduct
```
public GeneProduct()
            throws SBMLConstructorException
```
    Creates a new GeneProduct with the given SBML Level, Version, and &ldquofbc&rdquopackage version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this GeneProduct
    
    version - a long integer, the SBML Version to assign to this GeneProduct
    
    pkgVersion - a long integer, the SBML Fbc Version to assign to this GeneProduct
    
    Throws:
    
    SBMLConstructorException
  - GeneProduct
```
public GeneProduct(FbcPkgNamespaces fbcns)
            throws SBMLConstructorException
```
    Creates a new GeneProduct with the given FbcPkgNamespaces object.
    
    Parameters:
    
    fbcns - the FbcPkgNamespaces object
    
    Throws:
    
    SBMLConstructorException
  - GeneProduct
```
public GeneProduct(GeneProduct orig)
            throws SBMLConstructorException
```
    Copy constructor for GeneProduct.
    
    Parameters:
    
    orig - the GeneProduct instance to copy.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    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 GeneProduct.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 GeneProduct.delete() themselves.
    
    Overrides:
    
    delete in class SBase
  - cloneObject
```
public GeneProduct cloneObject()
```
    Creates and returns a deep copy of this GeneProduct object.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this GeneProduct object.
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this GeneProduct.
    
    Overrides:
    
    getId in class SBase
    
    Returns:
    
    the value of the 'id' attribute of this GeneProduct as a string.
  - getName
```
public java.lang.String getName()
```
    Returns the value of the 'name' attribute of this GeneProduct.
    
    Overrides:
    
    getName in class SBase
    
    Returns:
    
    the value of the 'name' attribute of this GeneProduct as a string.
  - getLabel
```
public java.lang.String getLabel()
```
    Returns the value of the 'label' attribute of this GeneProduct.
    
    Returns:
    
    the value of the 'label' attribute of this GeneProduct as a string.
  - getAssociatedSpecies
```
public java.lang.String getAssociatedSpecies()
```
    Returns the value of the 'associatedSpecies' attribute of this GeneProduct.
    
    Returns:
    
    the value of the 'associatedSpecies' attribute of this GeneProduct as a string.
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true if this GeneProduct's 'id' attribute is set.
    
    Overrides:
    
    isSetId in class SBase
    
    Returns:
    
    true if this GeneProduct's 'id' attribute has been set, otherwise false is returned.
  - isSetName
```
public boolean isSetName()
```
    Predicate returning true if this GeneProduct's 'name' attribute is set.
    
    Overrides:
    
    isSetName in class SBase
    
    Returns:
    
    true if this GeneProduct's 'name' attribute has been set, otherwise false is returned.
  - isSetLabel
```
public boolean isSetLabel()
```
    Predicate returning true if this GeneProduct's 'label' attribute is set.
    
    Returns:
    
    true if this GeneProduct's 'label' attribute has been set, otherwise false is returned.
  - isSetAssociatedSpecies
```
public boolean isSetAssociatedSpecies()
```
    Predicate returning true if this GeneProduct's 'associatedSpecies' attribute is set.
    
    Returns:
    
    true if this GeneProduct's 'associatedSpecies' attribute has been set, otherwise false is returned.
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this GeneProduct.
    Overrides:
    
    setId in class SBase
    
    Parameters:
    
    id - String value of the 'id' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setName
```
public int setName(java.lang.String name)
```
    Sets the value of the 'name' attribute of this GeneProduct.
    Overrides:
    
    setName in class SBase
    
    Parameters:
    
    name - String value of the 'name' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setLabel
```
public int setLabel(java.lang.String label)
```
    Sets the value of the 'label' attribute of this GeneProduct.
    Parameters:
    
    label - String value of the 'label' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setAssociatedSpecies
```
public int setAssociatedSpecies(java.lang.String associatedSpecies)
```
    Sets the value of the 'associatedSpecies' attribute of this GeneProduct.
    Parameters:
    
    associatedSpecies - String value of the 'associatedSpecies' attribute to be set
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this GeneProduct.
    Overrides:
    
    unsetId in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetName
```
public int unsetName()
```
    Unsets the value of the 'name' attribute of this GeneProduct.
    Overrides:
    
    unsetName in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetLabel
```
public int unsetLabel()
```
    Unsets the value of the 'label' attribute of this GeneProduct.
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetAssociatedSpecies
```
public int unsetAssociatedSpecies()
```
    Unsets the value of the 'associatedSpecies' attribute of this GeneProduct.
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - renameSIdRefs
```
public void renameSIdRefs(java.lang.String oldid,
                          java.lang.String newid)
```
    Replaces all uses of a given SIdRef type attribute value with another value.
    
    In SBML, object identifiers are of a data type called SId. In SBML Level 3, an explicit data type called SIdRef was introduced for attribute values that refer to SId values in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to an identifier', but the effective data type was the same as SIdRefin Level 3. These and other methods of libSBML refer to the type SIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.
    This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.
    
    Overrides:
    
    renameSIdRefs in class SBase
    
    Parameters:
    
    oldid - the old identifier
    
    newid - the new identifier
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object.
    For GeneProduct, the XML element name is always 'geneProduct'.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the name of this element, i.e. 'geneProduct'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this SBML object.
    
    LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes to identify the package to which a given object belongs, call the getPackageName() method on the object.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object: SBML_FBC_GENEPRODUCT (default).
    
    See Also:
    
    GeneProduct.getElementName(), SBase.getPackageName()
    
    "Warning:"
    
    The specific integer values of the possible type codes may be reused by different Level 3 package plug-ins. Thus, to identifiy the correct code, it is necessary to invoke both getTypeCode() and getPackageName().
  - hasRequiredAttributes
```
public boolean hasRequiredAttributes()
```
    Predicate returning true if all the required attributes for this GeneProduct object have been set.
    Overrides:
    
    hasRequiredAttributes in class SBase
    
    Returns:
    
    a boolean value indicating whether all the required attributes for this object have been defined.
    
    "Note:"
    The required attributes for a GeneProduct object are:
    
    'id'
    'label'

Class GeneProduct

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

GeneProduct

GeneProduct

GeneProduct

GeneProduct

GeneProduct

GeneProduct

Method Detail

delete

cloneObject

getId

getName

getLabel

getAssociatedSpecies

isSetId

isSetName

isSetLabel

isSetAssociatedSpecies

setId

setName

setLabel

setAssociatedSpecies

unsetId

unsetName

unsetLabel

unsetAssociatedSpecies

renameSIdRefs

getElementName

getTypeCode

hasRequiredAttributes