org.sbml.libsbml

Class ListOfPossibleSpeciesFeatureValues

java.lang.Object

org.sbml.libsbml.SBase

org.sbml.libsbml.ListOf

org.sbml.libsbml.ListOfPossibleSpeciesFeatureValues

public class ListOfPossibleSpeciesFeatureValues
extends ListOf

multi A list of PossibleSpeciesFeatureValue objects.

The ListOfPossibleSpeciesFeatureValues is a container for PossibleSpeciesFeatureValue objects.

The various ListOf___ classes in SBML are merely containers used for organizing the main components of an SBML model. In libSBML's implementation, ListOf___ classes are derived from the intermediate utility class ListOf, which is not defined by the SBML specifications but serves as a useful programmatic construct. ListOf is itself is in turn derived from SBase, which provides all of the various ListOf___ classes with common features defined by the SBML specification, such as 'metaid' attributes and annotations.

The relationship between the lists and the rest of an SBML model is illustrated by the following (for SBML Level 2 Version 4):

SBML Level 3 Version 1 has essentially the same structure as Level 2 Version 4, depicted above, but SBML Level 3 Version 2 allows containers to contain zero or more of the relevant object, instead of requiring at least one. As such, libsbml will write out an otherwise-empty ListOf___ element that has any optional attribute set (such as 'id' or 'metaid'), that has an optional child (such as a 'notes' or 'annotation'), or that has attributes or children set from any SBML Level 3 package, whether or not the ListOf___ has any other children.

Readers may wonder about the motivations for using the ListOf___ containers in SBML. A simpler approach in XML might be to place the components all directly at the top level of the model definition. The choice made in SBML is to group them within XML elements named after ListOfClassname, in part because it helps organize the components. More importantly, the fact that the container classes are derived from SBase means that software tools can add information about the lists themselves into each list container's 'annotation'.

See Also:

ListOfFunctionDefinitions, ListOfUnitDefinitions, ListOfCompartmentTypes, ListOfSpeciesTypes, ListOfCompartments, ListOfSpecies, ListOfParameters, ListOfInitialAssignments, ListOfRules, ListOfConstraints, ListOfReactions,

, PossibleSpeciesFeatureValue

Constructor Summary

Constructors

Constructor and Description
ListOfPossibleSpeciesFeatureValues() Creates a new ListOfPossibleSpeciesFeatureValues object.
ListOfPossibleSpeciesFeatureValues(long level) Creates a new ListOfPossibleSpeciesFeatureValues object.
ListOfPossibleSpeciesFeatureValues(long level, long version) Creates a new ListOfPossibleSpeciesFeatureValues object.
ListOfPossibleSpeciesFeatureValues(long level, long version, long pkgVersion) Creates a new ListOfPossibleSpeciesFeatureValues object.
ListOfPossibleSpeciesFeatureValues(MultiPkgNamespaces multins) Creates a new ListOfPossibleSpeciesFeatureValues with the given MultiPkgNamespaces object.

Method Summary

Modifier and Type	Method and Description
ListOfPossibleSpeciesFeatureValues	cloneObject() Creates and returns a deep copy of this ListOfPossibleSpeciesFeatureValues object.
void	delete() Explicitly deletes the underlying native object.
PossibleSpeciesFeatureValue	get(long n) Get the nth PossibleSpeciesFeatureValue object from the ListOfPossibleSpeciesFeatureValues.
PossibleSpeciesFeatureValue	get(java.lang.String sid) Get the PossibleSpeciesFeatureValue with the given identifier sid.
java.lang.String	getElementName() Returns the XML element name of this object.
int	getItemTypeCode() Returns the libSBML type code for the objects contained in this ListOf (i.e., Compartment objects, if the list is non-empty).
int	getTypeCode() Returns the libSBML type code for this SBML object.
PossibleSpeciesFeatureValue	remove(long n) Removes the nth PossibleSpeciesFeatureValue object from the ListOfPossibleSpeciesFeatureValues.
PossibleSpeciesFeatureValue	remove(java.lang.String sid) Removes the PossibleSpeciesFeatureValue with the given identifier sid.

Methods inherited from class org.sbml.libsbml.ListOf

append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, insert, insertAndOwn, removeFromParentAndDelete, size

Methods inherited from class org.sbml.libsbml.SBase

addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getName, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetId, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetName, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setId, setIdAttribute, setMetaId, setModelHistory, setName, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListOfPossibleSpeciesFeatureValues

public ListOfPossibleSpeciesFeatureValues(long level,
                                          long version,
                                          long pkgVersion)
                                   throws SBMLConstructorException

Creates a new ListOfPossibleSpeciesFeatureValues object.

Parameters:

level - the SBML Level.

version - the Version within the SBML Level.

pkgVersion - the version of the package.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

ListOfPossibleSpeciesFeatureValues

public ListOfPossibleSpeciesFeatureValues(long level,
                                          long version)
                                   throws SBMLConstructorException

Creates a new ListOfPossibleSpeciesFeatureValues object.

Parameters:

level - the SBML Level.

version - the Version within the SBML Level.

pkgVersion - the version of the package.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

ListOfPossibleSpeciesFeatureValues

public ListOfPossibleSpeciesFeatureValues(long level)
                                   throws SBMLConstructorException

Creates a new ListOfPossibleSpeciesFeatureValues object.

Parameters:

level - the SBML Level.

version - the Version within the SBML Level.

pkgVersion - the version of the package.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

ListOfPossibleSpeciesFeatureValues

public ListOfPossibleSpeciesFeatureValues()
                                   throws SBMLConstructorException

Creates a new ListOfPossibleSpeciesFeatureValues object.

Parameters:

level - the SBML Level.

version - the Version within the SBML Level.

pkgVersion - the version of the package.

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

ListOfPossibleSpeciesFeatureValues

public ListOfPossibleSpeciesFeatureValues(MultiPkgNamespaces multins)
                                   throws SBMLConstructorException

Creates a new ListOfPossibleSpeciesFeatureValues with the given MultiPkgNamespaces object.

The package namespaces object used in this constructor is derived from a SBMLNamespaces object, which encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and package version and name information used in addition to SBML Level 3 Core. A common approach to using libSBML's SBMLNamespaces facilities is to create an package namespace object somewhere in a program once, then hand that object as needed to object constructors of that package that accept it as and argument, such as this one.

Parameters:

multins - the MultiPkgNamespaces object

Throws:

SBMLConstructorException

Note:

Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

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 ListOfPossibleSpeciesFeatureValues.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 ListOfPossibleSpeciesFeatureValues.delete() themselves.

Overrides:

delete in class ListOf

cloneObject

public ListOfPossibleSpeciesFeatureValues cloneObject()

Creates and returns a deep copy of this ListOfPossibleSpeciesFeatureValues object.

Overrides:

cloneObject in class ListOf

Returns:

a (deep) copy of this ListOfPossibleSpeciesFeatureValues object.

get

public PossibleSpeciesFeatureValue get(long n)

Get the nth PossibleSpeciesFeatureValue object from the ListOfPossibleSpeciesFeatureValues.

Overrides:

get in class ListOf

Parameters:

n - the index number of the PossibleSpeciesFeatureValue to get.

Returns:

the nth object, or null if the index is out of range.

See Also:

ListOf.size()

get

public PossibleSpeciesFeatureValue get(java.lang.String sid)

Get the PossibleSpeciesFeatureValue with the given identifier sid.

Parameters:

sid - a string representing the identifier of the PossibleSpeciesFeatureValue to get.

Returns:

the object with the given id, or null if no such object exists.

See Also:

*, ListOf.size()

remove

public PossibleSpeciesFeatureValue remove(long n)

Removes the nth PossibleSpeciesFeatureValue object from the ListOfPossibleSpeciesFeatureValues.

Overrides:

remove in class ListOf

Parameters:

n - the index of the PossibleSpeciesFeatureValue to remove.

Returns:

the object removed, or null if no such object exists. Note that the caller owns the returned object and is responsible for deleting it.

See Also:

ListOf.size()

remove

public PossibleSpeciesFeatureValue remove(java.lang.String sid)

Removes the PossibleSpeciesFeatureValue with the given identifier sid.

Parameters:

sid - the identifier of the PossibleSpeciesFeatureValue to remove.

Returns:

the object removed, or null if no such object exists. Note that the caller owns the returned object and is responsible for deleting it.

getElementName

public java.lang.String getElementName()

Returns the XML element name of this object.

Overrides:

getElementName in class ListOf

Returns:

the name of this element, i.e. 'listOfPossibleSpeciesFeatureValues'.

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 SBase.getPackageName() method on the object.

The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.

Overrides:

getTypeCode in class ListOf

Returns:

the SBML type code for this object: SBML_MULTI_BINDING_SITE_SPECIES_TYPE.

See Also:

ListOfPossibleSpeciesFeatureValues.getElementName(), SBase.getPackageName()

Warning:

The specific integer values of the possible type codes may be reused by different libSBML plug-ins for SBML Level 3. packages, To fully identify the correct code, it is necessary to invoke both getPackageName() and getTypeCode() (or ListOf.getItemTypeCode()).

getItemTypeCode

public int getItemTypeCode()

Returns the libSBML type code for the objects contained in this ListOf (i.e., Compartment objects, if the list is non-empty).

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 SBase.getPackageName() method on the object.

The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.

Overrides:

getItemTypeCode in class ListOf

Returns:

the SBML type code for the objects contained in this ListOf instance: SBML_COMPARTMENT (default).

See Also:

ListOfPossibleSpeciesFeatureValues.getElementName(), SBase.getPackageName()