org.sbml.jsbml

Class Constraint

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractMathContainer

org.sbml.jsbml.Constraint

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, MathContainer, SBase, SBaseWithDerivedUnit, TreeNodeWithChangeSupport

public class Constraint
extends AbstractMathContainer

Represents the constraint XML element of a SBML file.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Andreas Dräger, Marine Dumousseau, Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private XMLNode	message Represents the subnode message of a constraint element.
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, lv

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
Constraint() Creates a Constraint instance.
Constraint(ASTNode math, int level, int version) Creates a Constraint instance from an ASTNode, a level and a version.
Constraint(Constraint sb) Creates a Constraint instance from a given Constraint.
Constraint(int level, int version) Creates a Constraint instance from a level and a version.

Method Summary

Methods

Modifier and Type	Method and Description
Constraint	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
XMLNode	getMessage() Returns the message of this Constraint.
java.lang.String	getMessageString() Returns the message of this Constraint as an XML String.
ListOf<Constraint>	getParent() This is equivalent to calling AbstractSBase.getParentSBMLObject(), but this method is needed for TreeNode.
boolean	isSetMessage() Returns true if the message of this Constraint is not null.
void	setMessage(java.lang.String message) Sets the message of this Constraint to 'message'.
void	setMessage(XMLNode message) Sets the message of this Constraint to 'message'.
void	unsetMessage() Sets the message of this Constraint to null.

Methods inherited from class org.sbml.jsbml.AbstractMathContainer

containsUndeclaredUnits, getAllowsChildren, getDerivedUnitDefinition, getDerivedUnits, getFormula, getMath, getMathMLString, isSetMath, readAttribute, setFormula, setMath, toString, unsetFormula, unsetMath, writeXMLAttributes

Methods inherited from class org.sbml.jsbml.AbstractSBase

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

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, firePropertyChange, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, 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, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregister, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

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

addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

message

private XMLNode message

Represents the subnode message of a constraint element.

Constructor Detail

Constraint

public Constraint()

Creates a Constraint instance. By default, the message is null.

Constraint

public Constraint(ASTNode math,
          int level,
          int version)

Creates a Constraint instance from an ASTNode, a level and a version. By default, the message is null.

Parameters:

math -

level -

version -

Constraint

public Constraint(Constraint sb)

Creates a Constraint instance from a given Constraint.

Parameters:

sb -

Constraint

public Constraint(int level,
          int version)

Creates a Constraint instance from a level and a version. By default, the message is null.

Parameters:

level -

version -

Method Detail

clone

public Constraint 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 AbstractMathContainer

Returns:

a copy of this object

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractMathContainer

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractMathContainer

getMessage

public XMLNode getMessage()

Returns the message of this Constraint. Returns null if the message is not set.

Returns:

the message of this Constraint. Returns null if the message is not set.

getMessageString

public java.lang.String getMessageString()
                                  throws javax.xml.stream.XMLStreamException

Returns the message of this Constraint as an XML String.

Returns:

the message of this Constraint as an XML String.

Throws:

javax.xml.stream.XMLStreamException

getParent

public ListOf<Constraint> getParent()

Description copied from class: AbstractSBase

This is equivalent to calling AbstractSBase.getParentSBMLObject(), but this method is needed for TreeNode.

Specified by:

getParent in interface javax.swing.tree.TreeNode

Overrides:

getParent in class AbstractSBase

Returns:

the parent element of this element.

See Also:

AbstractSBase.getParentSBMLObject()

isSetMessage

public boolean isSetMessage()

Returns true if the message of this Constraint is not null.

Returns:

true if the message of this Constraint is not null.

setMessage

public void setMessage(java.lang.String message)
                throws javax.xml.stream.XMLStreamException

Sets the message of this Constraint to 'message'.

Parameters:

message - the message to set

Throws:

javax.xml.stream.XMLStreamException

setMessage

public void setMessage(XMLNode message)

Sets the message of this Constraint to 'message'.

Parameters:

message - the message to set

unsetMessage

public void unsetMessage()

Sets the message of this Constraint to null.