public class Group extends SBase
The Group
class is the first and most central class in the SBML
Level 3 Groups package. This class represents a group of
entities: a simple mechanism for indicating that particular
components of an SBML model are related in some way. The nature of the
relationship is left up to the modeler, and can be clarified by means of
annotations on model components. Groups may contain either the same or
different types of SBML objects, and groups may be nested if desired.
There are no predefined modeling or mathematical semantics associated with
groups.
The Groups class has one required attribute, 'kind' two optional
attributes, 'id' and 'name' and a single child element, ListOfMembers
.
The membership of a group is determined by the contents of the list of
members stored in Member
objects within the ListOfMembers
child of a Group
object. Since the Group
class of objects is derived from SBase
, and SBase
provides the ability to attach SBO
terms as well as MIRIAM annotations,
the semantics of a given group in a model can be made more precise using
references to external controlled vocabularies and ontologies.
The attribute 'kind' on Group
is used to indicate the nature of the group
defined by a Group
instance. The 'kind' attribute must always have
one of the following three possible values:
'classification':
The group represents a class, and its members
have an is-a relationship to the group. For example, the group
could represent a type of molecule such as ATP, and the members could be
species located in different compartments, thereby establishing that the
species are pools of the same molecule in different locations.
'partonomy':
The group represents a collection of parts, and its
members have a part-of relationship to the group. For example, the
group could represent a cellular structure, and individual compartments
could be made members of the group to indicate they represent subparts of
that cellular structure.
'collection':
The grouping is merely a collection for convenience,
without an implied relationship between the members. For example, the
group could be used to collect together multiple disparate components of a
model&mdashspecies, reactions, events&mdashinvolved in a particular
phenotype, and apply a common annotation rather than having to copy the
same annotation to each component individually.
In the libSBML API for Groups, these possible values for the 'kind' attribute are programmatically represented as constants so that callers will not normally need to deal with text string values. The following are the constants defined for the three values of 'kind' (plus an additional constant to represent unrecognized values):
If an SBML element is referenced by a Group
's child Member
(directly or
indirectly), it is considered to be a member of that Group
. If the same
element is referenced by multiple Member
objects, this is equivalent to
including it just once. (It is considered best practice to avoid this,
but does not make for an invalid SBML document.)
Children of referenced elements are not considered to be members of the
Group: a KineticLaw
of a referenced Reaction
is not itself a Group
member. Even the membership of so-called SBML container classes (e.g.,
ListOfSpecies
, ListOfCompartments
, etc.) does not imply inclusion of
children as members of the Group
. The sole exception to this rule is the
handling of ListOfMembers
class, described below.
If a Member
object within a Group
object's ListOfMembers
references
another Group
object, it is the referenced Group
itself that is
considered to be a member of the parent Group
, not the corresponding
referenced model component(s). This is true regardless of whether those
components themselves happen to point to other components using some
mechanism defined by another SBML Level 3 package (as happens, for
example, in the SBML Level 3 Hierarchical Model Composition package
and its use of SBaseRef
). However, if instead a Member
object references
a ListOfMembers
object (using the 'id' attribute permitted on
ListOfMembers
objects), it is the components of that ListOfMembers
that
are considered to be part of the parent Group
. In other words: if in some
Group
G, a Member
M references another Group
, that Group
is the
member of G if M references a ListOfMembers
, it is the entities
referenced by the Member
objects within the ListOfMembers
that are
the members of G and not the ListOfMembers
object itself.
The implication of this is that any rule that applies to members of a
group (such the meaning of the 'kind' attribute, or the restrictions on
the application of 'sboTerm' attributes on a ListOfMembers
) applies to the
child group when referenced by the Group
'id', and to the members of the
child group when referenced by the ListOfMembers
'id'. In an example
situation where a parent group includes two Species
plus a Group
which
itself contains three other Species
, if the parent group's ListOfMembers
is given an 'sboTerm' attribute value, that SBO
term applies to the two
species and the group, not to the three child species members of the
second group. (Note also that in such a case, the parent group's 'kind'
attribute value would almost certainly be 'collection'
or
'partonomy'
, and not 'classification'
, as two species and a group are
very unlikely to be classified as the same thing.) In contrast, in the
situation where a parent group includes two Species
plus a ListOfMembers
which contains three other Species
, the parent group's ListOfMembers
'sboTerm' would apply to the five Species
, and could be more reasonably
marked as a 'classification'.
In a future version of this SBML Level 3 Groups specification, it may be possible to perform set operations on groups, but for now, this type of union is the only set operation that is possible.
Groups are not permitted to be circular: no Member
may reference itself,
its parent ListOfMembers
, nor its parent Group
. If a Member
references a
Group
, the same restrictions apply to that subgroup's children: they may
not reference the Member
, its parent ListOfMembers
, nor its parent Group
,
and if any of those children reference a Group
, the same restrictions apply
to them, etc.
If a Member
has a 'idRef' or 'metaIdRef' attribute which references an
object from a namespace that is not understood by the interpreter of the
SBML model, that Member
must be ignored. The referenced object will not be
understood by the interpreter, and therefore has no need to become a
member of the group. If an interpreter cannot tell whether a referenced
object does not exist or if exists in an unparsed namespace, it may choose
to produce a warning.
Member
,
ListOfMembers
,
ListOfGroups
Constructor and Description |
---|
Group()
Creates a new
Group using the given SBML Level, Version and
&ldquogroups&rdquo package version. |
Group(Group orig)
Copy constructor for
Group . |
Group(GroupsPkgNamespaces groupsns)
Creates a new
Group using the given GroupsPkgNamespaces object. |
Group(long level)
Creates a new
Group using the given SBML Level, Version and
&ldquogroups&rdquo package version. |
Group(long level,
long version)
Creates a new
Group using the given SBML Level, Version and
&ldquogroups&rdquo package version. |
Group(long level,
long version,
long pkgVersion)
Creates a new
Group using the given SBML Level, Version and
&ldquogroups&rdquo package version. |
Modifier and Type | Method and Description |
---|---|
int |
addMember(Member m)
|
Group |
cloneObject()
Creates and returns a deep copy of this
Group object. |
Member |
createMember()
|
void |
delete()
Explicitly deletes the underlying native object.
|
SBase |
getElementByMetaId(java.lang.String metaid)
Returns the first child element that has the given
metaid , or null
if no such object is found. |
SBase |
getElementBySId(java.lang.String id)
Returns the first child element that has the given
id in the model-wide
SId namespace, or null if no such object is found. |
java.lang.String |
getElementName()
Returns the XML element name of this
Group object. |
java.lang.String |
getId()
Returns the value of the 'id' attribute of this
Group . |
int |
getKind()
Returns the value of the 'kind' attribute of this
Group . |
java.lang.String |
getKindAsString()
Returns the value of the 'kind' attribute of this
Group . |
ListOfMembers |
getListOfMembers()
Returns the
ListOfMembers from this Group . |
Member |
getMember(long n)
|
Member |
getMember(java.lang.String sid)
|
Member |
getMemberByIdRef(java.lang.String sid)
|
java.lang.String |
getName()
Returns the value of the 'name' attribute of this
Group . |
long |
getNumMembers()
|
int |
getTypeCode()
Returns the libSBML type code for this
Group object. |
boolean |
hasRequiredAttributes()
Predicate returning
true if all the required attributes for this Group
object have been set. |
boolean |
isSetId()
Predicate returning
true if this Group 's 'id' attribute is set. |
boolean |
isSetKind()
Predicate returning
true if this Group 's 'kind' attribute is set. |
boolean |
isSetName()
Predicate returning
true if this Group 's 'name' attribute is set. |
Member |
removeMember(long n)
|
Member |
removeMember(java.lang.String sid)
|
int |
setId(java.lang.String id)
Sets the value of the 'id' attribute of this
Group . |
int |
setKind(int kind)
Sets the value of the 'kind' attribute of this
Group . |
int |
setKind(java.lang.String kind)
Sets the value of the 'kind' attribute of this
Group . |
int |
setName(java.lang.String name)
Sets the value of the 'name' attribute of this
Group . |
int |
unsetId()
Unsets the value of the 'id' attribute of this
Group . |
int |
unsetKind()
Unsets the value of the 'kind' attribute of this
Group . |
int |
unsetName()
Unsets the value of the 'name' attribute of this
Group . |
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getObjectVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData
public Group(long level, long version, long pkgVersion) throws SBMLConstructorException
Group
using the given SBML Level, Version and
&ldquogroups&rdquo package version.
level
- a long integer, the SBML Level to assign to this Group
.
version
- a long integer, the SBML Version to assign to this Group
.
pkgVersion
- a long integer, the SBML Groups Version to assign to
this Group
.
SBMLConstructorException
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.public Group(long level, long version) throws SBMLConstructorException
Group
using the given SBML Level, Version and
&ldquogroups&rdquo package version.
level
- a long integer, the SBML Level to assign to this Group
.
version
- a long integer, the SBML Version to assign to this Group
.
pkgVersion
- a long integer, the SBML Groups Version to assign to
this Group
.
SBMLConstructorException
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.public Group(long level) throws SBMLConstructorException
Group
using the given SBML Level, Version and
&ldquogroups&rdquo package version.
level
- a long integer, the SBML Level to assign to this Group
.
version
- a long integer, the SBML Version to assign to this Group
.
pkgVersion
- a long integer, the SBML Groups Version to assign to
this Group
.
SBMLConstructorException
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.public Group() throws SBMLConstructorException
Group
using the given SBML Level, Version and
&ldquogroups&rdquo package version.
level
- a long integer, the SBML Level to assign to this Group
.
version
- a long integer, the SBML Version to assign to this Group
.
pkgVersion
- a long integer, the SBML Groups Version to assign to
this Group
.
SBMLConstructorException
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.public Group(GroupsPkgNamespaces groupsns) throws SBMLConstructorException
Group
using the given GroupsPkgNamespaces
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.
groupsns
- the GroupsPkgNamespaces
object.
SBMLConstructorException
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.public Group(Group orig) throws SBMLConstructorException
Group
.
orig
- the Group
instance to copy.SBMLConstructorException
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 Group.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 Group.delete()
themselves.
public Group cloneObject()
Group
object.
cloneObject
 in class SBase
Group
object.public java.lang.String getId()
Group
.
getId
 in class SBase
Group
as a string.SBase.getIdAttribute()
,
SBase.setIdAttribute(String sid)
,
SBase.isSetIdAttribute()
,
SBase.unsetIdAttribute()
public java.lang.String getName()
Group
.
getName
 in class SBase
Group
as a string.SBase.getIdAttribute()
,
SBase.isSetName()
,
SBase.setName(String sid)
,
SBase.unsetName()
public int getKind()
Group
.
The attribute 'kind' on a Group
object is used to indicate the nature of
the group defined by a particular Group
instance. In the SBML
Level 3 Version 1 Group
specification, there are only three
allowable values for 'kind':
'classification'
, to indicate that the group represents a class,
and its members have an is-a relationship to the group.
'partonomy'
, to indicate that the group represents a collection of
parts, and its members have a part-of relationship to the group.
'collection'
, to indicate that the grouping is merely a collection
for convenience, without an implied relationship between the members.
Group
.
.
The possible values returned by this method are:
public java.lang.String getKindAsString()
Group
.
The attribute 'kind' on a Group
object is used to indicate the nature of
the group defined by a particular Group
instance. In the SBML
Level 3 Version 1 Group
specification, there are only three
allowable values for 'kind':
'classification'
, to indicate that the group represents a class,
and its members have an is-a relationship to the group.
'partonomy'
, to indicate that the group represents a collection of
parts, and its members have a part-of relationship to the group.
'collection'
, to indicate that the grouping is merely a collection
for convenience, without an implied relationship between the members.
Group
as a string.
The possible values returned by this method are:
'classification'
'partonomy'
'collection'
'unknown'
public boolean isSetId()
true
if this Group
's 'id' attribute is set.
isSetId
 in class SBase
true
if this Group
's 'id' attribute has been set, otherwise @c
false is returned.SBase.getIdAttribute()
,
SBase.setIdAttribute(String sid)
,
SBase.unsetIdAttribute()
,
SBase.isSetIdAttribute()
public boolean isSetName()
true
if this Group
's 'name' attribute is set.
isSetName
 in class SBase
true
if this Group
's 'name' attribute has been set, otherwise
false
is returned.SBase.getName()
,
SBase.setName(String sid)
,
SBase.unsetName()
public boolean isSetKind()
true
if this Group
's 'kind' attribute is set.
The attribute 'kind' on a Group
object is used to indicate the nature of
the group defined by a particular Group
instance. In the SBML
Level 3 Version 1 Group
specification, there are only three
allowable values for 'kind':
'classification'
, to indicate that the group represents a class,
and its members have an is-a relationship to the group.
'partonomy'
, to indicate that the group represents a collection of
parts, and its members have a part-of relationship to the group.
'collection'
, to indicate that the grouping is merely a collection
for convenience, without an implied relationship between the members.
true
if this Group
's 'kind' attribute has been set, otherwise
false
is returned.public int setId(java.lang.String id)
Group
.
setId
 in class SBase
id
- String& value of the 'id' attribute to be set.
SBase.getIdAttribute()
,
SBase.setIdAttribute(String sid)
,
SBase.isSetIdAttribute()
,
SBase.unsetIdAttribute()
public int setName(java.lang.String name)
Group
.
public int setKind(int kind)
Group
.
The attribute 'kind' on a Group
object is used to indicate the nature of
the group defined by a particular Group
instance. In the SBML
Level 3 Version 1 Group
specification, there are only three
allowable values for 'kind':
'classification'
, to indicate that the group represents a class,
and its members have an is-a relationship to the group.
'partonomy'
, to indicate that the group represents a collection of
parts, and its members have a part-of relationship to the group.
'collection'
, to indicate that the grouping is merely a collection
for convenience, without an implied relationship between the members.
kind
- int value of the
'kind' attribute to be set.
The value must be one of the predefined constants that represent
valid SBML Level 3 Version 1 Group
'kind' names, which
means it must be one of the following values:
public int setKind(java.lang.String kind)
Group
.
The attribute 'kind' on a Group
object is used to indicate the nature of
the group defined by a particular Group
instance. In the SBML
Level 3 Version 1 Group
specification, there are only three
allowable values for 'kind':
'classification'
, to indicate that the group represents a class,
and its members have an is-a relationship to the group.
'partonomy'
, to indicate that the group represents a collection of
parts, and its members have a part-of relationship to the group.
'collection'
, to indicate that the grouping is merely a collection
for convenience, without an implied relationship between the members.
kind
- String& of the 'kind' attribute to be set. The value
must be one of the following possible strings:
public int unsetId()
Group
.
unsetId
 in class SBase
SBase.getIdAttribute()
,
SBase.setIdAttribute(String sid)
,
SBase.isSetIdAttribute()
,
SBase.unsetIdAttribute()
public int unsetName()
Group
.
unsetName
 in class SBase
SBase.getName()
,
SBase.setName(String sid)
,
SBase.isSetName()
public int unsetKind()
Group
.
public ListOfMembers getListOfMembers()
ListOfMembers
from this Group
.
Using the SBML Level 3 Groups package, the membership of a group
is determined by the contents of the list of members stored in Member
objects within the ListOfMembers
child of a Group
object.
ListOfMembers
from this Group
.public Member getMember(long n)
n
- a long integer representing the index of the Member
to
retrieve.
Member
in the ListOfMembers
within this Group
.
Group.addMember(Member m)
,
Group.createMember()
,
Group.getMember(String sid)
,
Group.getNumMembers()
,
Group.removeMember(String sid)
,
Group.removeMember(long n)
public Member getMember(java.lang.String sid)
sid
- a string representing the identifier of the Member
to retrieve.
Member
in the ListOfMembers
within this Group
with the given
id or null if no such Member
exists.
Group.addMember(Member m)
,
Group.createMember()
,
Group.getMember(long n)
,
Group.getNumMembers()
,
Group.removeMember(String sid)
,
Group.removeMember(long n)
public Member getMemberByIdRef(java.lang.String sid)
public int addMember(Member m)
m
- the Member
object to add.
LIBSBML_OPERATION_SUCCESS
LIBSBML_OPERATION_FAILED
LIBSBML_INVALID_OBJECT
LIBSBML_LEVEL_MISMATCH
LIBSBML_VERSION_MISMATCH
LIBSBML_NAMESPACES_MISMATCH
LIBSBML_DUPLICATE_OBJECT_ID
Group.createMember()
,
Group.getMember(String sid)
,
Group.getMember(long n)
,
Group.getNumMembers()
,
Group.removeMember(String sid)
,
Group.removeMember(long n)
create
)
for alternatives that do not lead to these issues.
public long getNumMembers()
Member
objects in this Group
.
Group.addMember(Member m)
,
Group.createMember()
,
Group.getMember(String sid)
,
Group.getMember(long n)
,
Group.removeMember(String sid)
,
Group.removeMember(long n)
public Member createMember()
Member
object instance.
Group.addMember(Member m)
,
Group.getMember(String sid)
,
Group.getMember(long n)
,
Group.getNumMembers()
,
Group.removeMember(String sid)
,
Group.removeMember(long n)
public Member removeMember(long n)
n
- a long integer representing the index of the Member
to remove.
Member
in this Group
.
Group.addMember(Member m)
,
Group.createMember()
,
Group.getMember(String sid)
,
Group.getMember(long n)
,
Group.getNumMembers()
,
Group.removeMember(String sid)
public Member removeMember(java.lang.String sid)
sid
- a string representing the identifier of the Member
to remove.
Member
in this Group
based on the identifier or null if no
such Member
exists.
Group.addMember(Member m)
,
Group.createMember()
,
Group.getMember(String sid)
,
Group.getMember(long n)
,
Group.getNumMembers()
,
Group.removeMember(long n)
public java.lang.String getElementName()
Group
object.
For Group
, the XML element name is always 'group'.
getElementName
 in class SBase
'group'.
public int getTypeCode()
Group
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.
getTypeCode
 in class SBase
SBML_GROUPS_GROUP
.
Group.getElementName()
,
SBase.getPackageName()
public boolean hasRequiredAttributes()
true
if all the required attributes for this Group
object have been set.
hasRequiredAttributes
 in class SBase
true
to indicate that all the required attributes of this Group
have been set, otherwise false
is returned.
Group
object are:
public SBase getElementBySId(java.lang.String id)
id
in the model-wide
SId namespace, or null
if no such object is found.
getElementBySId
 in class SBase
id
- a string representing the id attribute of the object to
retrieve.
SBase
element with the given id
.public SBase getElementByMetaId(java.lang.String metaid)
metaid
, or null
if no such object is found.
getElementByMetaId
 in class SBase
metaid
- a string representing the metaid attribute of the object to
retrieve.
SBase
element with the given metaid
.