org.sbml.jsbml.ext.groups

Class MemberConstraint

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.groups.MemberConstraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, SBase, UniqueNamedSBase, TreeNodeWithChangeSupport

public class MemberConstraint
extends AbstractNamedSBase
implements UniqueNamedSBase

Since:

1.0

Version:

$Rev: 1714 $

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	distinctAttribute
private java.lang.String	identicalAttribute
private static long	serialVersionUID Generated serial version identifier.

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
MemberConstraint() Creates an MemberConstraint instance
MemberConstraint(int level, int version) Creates a MemberConstraint instance with a level and version.
MemberConstraint(MemberConstraint obj) Clone constructor
MemberConstraint(java.lang.String id) Creates a MemberConstraint instance with an id.
MemberConstraint(java.lang.String id, int level, int version) Creates a MemberConstraint instance with an id, level, and version.
MemberConstraint(java.lang.String id, java.lang.String name, int level, int version) Creates a MemberConstraint instance with an id, name, level, and version.

Method Summary

Methods

Modifier and Type	Method and Description
MemberConstraint	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	getDistinctAttribute() Returns the value of distinctAttribute
java.lang.String	getIdenticalAttribute() Returns the value of identicalAttribute
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the namespace.
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	isSetDistinctAttribute() Returns whether distinctAttribute is set
boolean	isSetIdenticalAttribute() Returns whether identicalAttribute is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setDistinctAttribute(java.lang.String distinctAttribute) Sets the value of distinctAttribute
void	setIdenticalAttribute(java.lang.String identicalAttribute) Sets the value of identicalAttribute
boolean	unsetDistinctAttribute() Unsets the variable distinctAttribute
boolean	unsetIdenticalAttribute() Unsets the variable identicalAttribute
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.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, setId, setName, toString, unsetId, unsetName

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, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, 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.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

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

identicalAttribute

private java.lang.String identicalAttribute

distinctAttribute

private java.lang.String distinctAttribute

Constructor Detail

MemberConstraint

public MemberConstraint()

Creates an MemberConstraint instance

MemberConstraint

public MemberConstraint(java.lang.String id)

Creates a MemberConstraint instance with an id.

Parameters:

id -

MemberConstraint

public MemberConstraint(int level,
                int version)

Creates a MemberConstraint instance with a level and version.

Parameters:

level -

version -

MemberConstraint

public MemberConstraint(java.lang.String id,
                int level,
                int version)

Creates a MemberConstraint instance with an id, level, and version.

Parameters:

id -

level -

version -

MemberConstraint

public MemberConstraint(java.lang.String id,
                java.lang.String name,
                int level,
                int version)

Creates a MemberConstraint instance with an id, name, level, and version.

Parameters:

id -

name -

level -

version -

MemberConstraint

public MemberConstraint(MemberConstraint obj)

Clone constructor

Method Detail

clone

public MemberConstraint 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

Specified by:

clone in class AbstractSBase

Returns:

a copy of this object

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractNamedSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

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 SBase

Overrides:

equals in class AbstractNamedSBase

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.

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

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.

getIdenticalAttribute

public java.lang.String getIdenticalAttribute()

Returns the value of identicalAttribute

Returns:

the value of identicalAttribute

isSetIdenticalAttribute

public boolean isSetIdenticalAttribute()

Returns whether identicalAttribute is set

Returns:

whether identicalAttribute is set

setIdenticalAttribute

public void setIdenticalAttribute(java.lang.String identicalAttribute)

Sets the value of identicalAttribute

unsetIdenticalAttribute

public boolean unsetIdenticalAttribute()

Unsets the variable identicalAttribute

Returns:

true, if identicalAttribute was set before, otherwise false

getDistinctAttribute

public java.lang.String getDistinctAttribute()

Returns the value of distinctAttribute

Returns:

the value of distinctAttribute

isSetDistinctAttribute

public boolean isSetDistinctAttribute()

Returns whether distinctAttribute is set

Returns:

whether distinctAttribute is set

setDistinctAttribute

public void setDistinctAttribute(java.lang.String distinctAttribute)

Sets the value of distinctAttribute

unsetDistinctAttribute

public boolean unsetDistinctAttribute()

Unsets the variable distinctAttribute

Returns:

true, if distinctAttribute was set before, otherwise false

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 AbstractNamedSBase

Returns:

a Map containing the XML attributes of this object.

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 AbstractNamedSBase

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.