java.io.Serializable
, java.lang.Cloneable
, javax.swing.tree.TreeNode
, NamedSBase
, SBase
, UniqueNamedSBase
, UniqueSId
, TreeNodeWithChangeSupport
public class Group extends AbstractNamedSBase implements UniqueNamedSBase
Modifier and Type | Class | Description |
---|---|---|
static class |
Group.Kind |
This is a collection of possible values for the
kind attribute within
a Group . |
JSBML_WRONG_SBO_TERM
Constructor | Description |
---|---|
Group() |
Creates a new
Group instance. |
Group(int level,
int version) |
Creates a new
Group instance. |
Group(Group group) |
Creates a new
Group instance from the given Group. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
addMember(Member member) |
Adds a new
Member to the listOfMembers . |
Group |
clone() |
Creates a deep copy of this object, i.e., a new
SBase with the same
properties
like this one. |
Member |
createMember() |
Creates a new Member element and adds it to the
listOfMembers list. |
Member |
createMember(java.lang.String id) |
Creates a new
Member element and adds it to the
listOfMembers list. |
Member |
createMember(java.lang.String id,
SBase sbase) |
|
Member |
createMemberWithIdRef(java.lang.String idRef) |
|
Member |
createMemberWithIdRef(java.lang.String id,
java.lang.String idRef) |
|
Member |
createMemberWithMetaIdRef(java.lang.String metaIdRef) |
|
Member |
createMemberWithMetaIdRef(java.lang.String id,
java.lang.String metaIdRef) |
|
Member |
creteMember(SBase sbase) |
|
boolean |
equals(java.lang.Object obj) |
|
boolean |
getAllowsChildren() |
|
javax.swing.tree.TreeNode |
getChildAt(int index) |
|
int |
getChildCount() |
|
Group.Kind |
getKind() |
|
ListOfMembers |
getListOfMembers() |
Returns the
listOfMembers . |
Member |
getMember(int i) |
Gets an element from the
listOfMembers at the given index. |
Member |
getMember(java.lang.String id) |
Gets an element from the listOfMembers, with the given id.
|
int |
getMemberCount() |
|
int |
getNumMembers() |
|
int |
hashCode() |
Returns a hash code value for this
SBase instance. |
boolean |
isIdMandatory() |
Returns
true if the identifier of this
SBase is required to be defined (i.e., not null )
in the definition of SBML. |
boolean |
isSetKind() |
|
boolean |
isSetListOfMembers() |
Returns
true if listOfMembers is not null. |
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value) |
Sets the given attribute in this
SBase . |
Member |
removeMember(int i) |
Removes an element from the
listOfMembers at the given index. |
Member |
removeMember(java.lang.String id) |
Removes an element from the
listOfMembers . |
boolean |
removeMember(Member member) |
Removes an element from the
listOfMembers . |
void |
setKind(Group.Kind kind) |
|
void |
setListOfMembers(ListOfMembers listOfMembers) |
Sets the given
ListOf<Member> . |
boolean |
unsetListOfMembers() |
|
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. |
isValidId
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm
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
getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm
addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet
public Group()
Group
instance.public Group(Group group)
Group
instance from the given Group.group
- the Group
to clonepublic Group(int level, int version)
Group
instance.level
- the SBML levelversion
- the SBML versionpublic Group clone()
SBase
SBase
with the same
properties
like this one.clone
in interface SBase
clone
in class AbstractSBase
public Member createMemberWithIdRef(java.lang.String idRef)
idRef
- the identifier of an object elsewhere in the Model.
An example value of idRef might be the identifier of a species in the model, or the identifier of another group.Member
instance.public Member createMemberWithMetaIdRef(java.lang.String metaIdRef)
metaIdRef
- Member
instance.public Member createMemberWithIdRef(java.lang.String id, java.lang.String idRef)
public Member createMemberWithMetaIdRef(java.lang.String id, java.lang.String metaIdRef)
public Member creteMember(SBase sbase)
sbase
- the element that should be referenced as a new member of this
Group
.Member
or null
if the given
SBase
neither has a metaId nor an id.createMember(String, SBase)
public javax.swing.tree.TreeNode getChildAt(int index)
getChildAt
in interface javax.swing.tree.TreeNode
getChildAt
in class AbstractSBase
public int getChildCount()
getChildCount
in interface javax.swing.tree.TreeNode
getChildCount
in class AbstractSBase
public Group.Kind getKind()
public ListOfMembers getListOfMembers()
listOfMembers
.
Creates it if it does not already exist.listOfMembers
.public boolean isSetListOfMembers()
true
if listOfMembers
is not null.true
if listOfMembers
is not null.public void setListOfMembers(ListOfMembers listOfMembers)
ListOf<Member>
.
If listOfMembers
was defined before and contains some
elements, they are all unset.listOfMembers
- public boolean unsetListOfMembers()
true
if listOfMembers
contains at least
one element, otherwise false
.public boolean addMember(Member member)
member
- the element to add to the listtrue
(as specified by Collection.add(E)
)Collection.add(Object)
public boolean removeMember(Member member)
listOfMembers
.member
- the element to be removed from the list.true
if the list contained the specified element and it was
removed.List.remove(Object)
public Member removeMember(java.lang.String id)
listOfMembers
.id
- the id of the element to be removed from the list.null
.public Member removeMember(int i)
listOfMembers
at the given index.i
- the index where to remove the Member
.java.lang.IndexOutOfBoundsException
- if the listOf is not set or if the index is
out of bound ((i < 0) || (i > listOfMembers)
).public Member createMember()
listOfMembers
list.listOfMembers
public Member createMember(java.lang.String id)
Member
element and adds it to the
listOfMembers
list.id
- the identifier that is to be applied to the new element.Member
element, which is the last
element in the listOfMembers
.public Member getMember(int i)
listOfMembers
at the given index.i
- the index of the Member
element to get.java.lang.IndexOutOfBoundsException
- if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size).public Member getMember(java.lang.String id)
id
- the id of the Member
element to get.null
.public int getNumMembers()
Member
s of this Group
.getMemberCount()
public boolean isIdMandatory()
SBase
true
if the identifier of this
SBase
is required to be defined (i.e., not null
)
in the definition of SBML.isIdMandatory
in interface NamedSBase
isIdMandatory
in interface SBase
isIdMandatory
in class AbstractSBase
true
if the identifier of this element must be set in
order to create a valid SBML representation. false
otherwise, i.e., if the identifier can be understood as an optional
attribute.public boolean isSetKind()
public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBase
SBase
.
If the given attribute name is not recognized, nothing is done and
false
is returned.
readAttribute
in interface SBase
readAttribute
in class AbstractSBase
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public void setKind(Group.Kind kind)
kind
- public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
SBase
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.
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class AbstractSBase
Map
containing the XML attributes of this object.public boolean getAllowsChildren()
getAllowsChildren
in interface javax.swing.tree.TreeNode
getAllowsChildren
in class AbstractSBase
public int hashCode()
SBase
SBase
instance.hashCode
in interface SBase
hashCode
in class AbstractSBase
SBase
instance.Object.hashCode()
public boolean equals(java.lang.Object obj)
SBase