org.sbml.jsbml.ext.groups

Class ListOfMemberConstraint

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ListOf<MemberConstraint>

org.sbml.jsbml.ext.groups.ListOfMemberConstraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<MemberConstraint>, java.util.Collection<MemberConstraint>, java.util.List<MemberConstraint>, javax.swing.tree.TreeNode, NamedSBase, SBase, UniqueNamedSBase, TreeNodeWithChangeSupport

public class ListOfMemberConstraint
extends ListOf<MemberConstraint>
implements NamedSBase, UniqueNamedSBase

Since:

1.0

Version:

$Rev: 1808 $

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ListOf

ListOf.Type

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	id id of the SBML component (can be optional depending on the level and version).
private boolean	isSetMembersShareType
private boolean	membersShareType
private java.lang.String	name name of the SBML component (can be optional depending on the level and version).
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.ListOf

listOf, listType

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
ListOfMemberConstraint()
ListOfMemberConstraint(int level, int version)
ListOfMemberConstraint(ListOfMemberConstraint listOf)

Method Summary

Methods

Modifier and Type	Method and Description
(package private) boolean	checkIdentifier(java.lang.String sID) Checks if the sID is a valid identifier.
ListOfMemberConstraint	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object obj) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.lang.String	getId()
boolean	getMembersShareType() Returns the value of membersShareType
java.lang.String	getName()
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetId()
boolean	isSetMembersShareType() Returns whether membersShareType is set
boolean	isSetName()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setId(java.lang.String id) sets the id value with 'id'
void	setMembersShareType(boolean membersShareType) Sets the value of membersShareType
void	setName(java.lang.String name) sets the name value with 'name'.
void	unsetId() sets the id value to null.
boolean	unsetMembersShareType() Unsets the variable membersShareType
void	unsetName() sets the name value to null.
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.

Methods inherited from class org.sbml.jsbml.ListOf

add, add, addAll, addAll, append, clear, contains, containsAll, filterList, firstHit, get, get, getAllowsChildren, getChildAt, getChildCount, getElementName, getFirst, getLast, getSBaseListType, indexOf, initListOf, isDebugMode, isEmpty, iterator, lastIndexOf, listIterator, listIterator, newInstance, remove, remove, remove, remove, removeAll, removeAll, removeFirst, retainAll, set, setDebugMode, setListOf, setSBaseListType, setSBaseListType, size, subList, toArray, toArray, toString, unsetSBaseListType

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

id

private java.lang.String id

id of the SBML component (can be optional depending on the level and version). Matches the id attribute of an element in a SBML file.

name

private java.lang.String name

name of the SBML component (can be optional depending on the level and version). Matches the name attribute of an element in a SBML file.

membersShareType

private boolean membersShareType

isSetMembersShareType

private boolean isSetMembersShareType

Constructor Detail

ListOfMemberConstraint

public ListOfMemberConstraint()

ListOfMemberConstraint

public ListOfMemberConstraint(int level,
                      int version)

ListOfMemberConstraint

public ListOfMemberConstraint(ListOfMemberConstraint listOf)

Method Detail

clone

public ListOfMemberConstraint clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Overrides:

clone in class ListOf<MemberConstraint>

Returns:

a copy of this object

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface java.util.Collection<MemberConstraint>

Specified by:

equals in interface java.util.List<MemberConstraint>

Specified by:

equals in interface SBase

Overrides:

equals in class ListOf<MemberConstraint>

Parameters:

obj - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

getId

public java.lang.String getId()

Specified by:

getId in interface NamedSBase

Returns:

the id of the element if it is set, an empty string otherwise.

getName

public java.lang.String getName()

Specified by:

getName in interface NamedSBase

Returns:

the name of the element if it is set, an empty string otherwise.

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface java.util.Collection<MemberConstraint>

Specified by:

hashCode in interface java.util.List<MemberConstraint>

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

isSetId

public boolean isSetId()

Specified by:

isSetId in interface NamedSBase

Returns:

true if the id is not null.

isSetName

public boolean isSetName()

Specified by:

isSetName in interface NamedSBase

Returns:

true if the name is not null.

checkIdentifier

boolean checkIdentifier(java.lang.String sID)

Checks if the sID is a valid identifier.

Parameters:

sID - the identifier to be checked. If null or an invalid identifier, an exception will be thrown.

Returns:

true only if the sID is a valid identifier. Otherwise this method throws an IllegalArgumentException. This is an intended behavior.

Throws:

java.lang.IllegalArgumentException - if the given id is not valid in this model.

setId

public void setId(java.lang.String id)

Description copied from interface: NamedSBase

sets the id value with 'id'

Specified by:

setId in interface NamedSBase

setName

public void setName(java.lang.String name)

Description copied from interface: NamedSBase

sets the name value with 'name'. If level is 1, sets automatically the id to 'name'

Specified by:

setName in interface NamedSBase

unsetId

public void unsetId()

Description copied from interface: NamedSBase

sets the id value to null.

Specified by:

unsetId in interface NamedSBase

unsetName

public void unsetName()

Description copied from interface: NamedSBase

sets the name value to null.

Specified by:

unsetName in interface NamedSBase

getMembersShareType

public boolean getMembersShareType()

Returns the value of membersShareType

Returns:

the value of membersShareType

isSetMembersShareType

public boolean isSetMembersShareType()

Returns whether membersShareType is set

Returns:

whether membersShareType is set

setMembersShareType

public void setMembersShareType(boolean membersShareType)

Sets the value of membersShareType

unsetMembersShareType

public boolean unsetMembersShareType()

Unsets the variable membersShareType

Returns:

true, if membersShareType was set before, otherwise false

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class ListOf<MemberConstraint>

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this 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.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

Returns:

a Map containing the XML attributes of this object.

isIdMandatory

public boolean isIdMandatory()

Description copied from interface: NamedSBase

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Specified by:

isIdMandatory in interface NamedSBase

Returns:

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.