Package org.sbml.jsbml.ext.arrays

Class Dimension

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.arrays.Dimension

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, org.sbml.jsbml.CallableSBase, org.sbml.jsbml.NamedSBase, org.sbml.jsbml.NamedSBaseWithDerivedUnit, org.sbml.jsbml.SBase, org.sbml.jsbml.SBaseWithDerivedUnit, org.sbml.jsbml.util.TreeNodeWithChangeSupport

public class Dimension
extends org.sbml.jsbml.AbstractNamedSBase
implements org.sbml.jsbml.CallableSBase

The Dimension is used to indicate the parent SBase is arrayed.

Since:

1.0

Author:

Leandro Watanabe

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor	Description
Dimension()	Creates an Dimension instance
Dimension(int level, int version)	Creates a Dimension instance with a level and version.
Dimension(java.lang.String id)	Creates a Dimension instance with an id.
Dimension(java.lang.String id, int level, int version)	Creates a Dimension instance with an id, level, and version.
Dimension(java.lang.String id, java.lang.String name, int level, int version)	Creates a Dimension instance with an id, name, level, and version.
Dimension(Dimension obj)	Clone constructor

Method Summary

Modifier and Type	Method	Description
Dimension	clone()	clones this class
boolean	containsUndeclaredUnits()
boolean	equals(java.lang.Object obj)
int	getArrayDimension()	Returns the value of arrayDimension
org.sbml.jsbml.UnitDefinition	getDerivedUnitDefinition()
java.lang.String	getDerivedUnits()
java.lang.String	getSize()	Returns the value of size
int	hashCode()
void	initDefaults()	Initializes the default values using the namespace.
boolean	isIdMandatory()
boolean	isSetArrayDimension()	Returns whether arrayDimension is set
boolean	isSetSize()	Returns whether size is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
void	setArrayDimension(int arrayDimension)	Sets the value of arrayDimension
void	setSize(java.lang.String size)	Sets the value of size
boolean	unsetArrayDimension()	Unsets the variable arrayDimension
boolean	unsetSize()	Unsets the variable size
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, 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, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from interface org.sbml.jsbml.NamedSBase

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

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, 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

Methods inherited from interface javax.swing.tree.TreeNode

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

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

Constructor Detail

Dimension

public Dimension()

Creates an Dimension instance

Dimension

public Dimension(java.lang.String id)

Creates a Dimension instance with an id.

Parameters:

id - the id

Dimension

public Dimension(int level,
                 int version)

Creates a Dimension instance with a level and version.

Parameters:

level - the SBML level

version - the SBML version

Dimension

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

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

Parameters:

id - the id

level - the SBML level

version - the SBML version

Dimension

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

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

Parameters:

id - the id

name - the name

level - the SBML level

version - the SBML version

Dimension

public Dimension(Dimension obj)

Clone constructor

Parameters:

obj - the instance to clone

Method Detail

clone

public Dimension clone()

clones this class

Specified by:

clone in interface org.sbml.jsbml.SBase

Specified by:

clone in class org.sbml.jsbml.AbstractSBase

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface org.sbml.jsbml.NamedSBase

Specified by:

isIdMandatory in interface org.sbml.jsbml.SBase

Overrides:

isIdMandatory in class org.sbml.jsbml.AbstractSBase

getSize

public java.lang.String getSize()

Returns the value of size

Returns:

the value of size

isSetSize

public boolean isSetSize()

Returns whether size is set

Returns:

whether size is set

setSize

public void setSize(java.lang.String size)

Sets the value of size

Parameters:

size - the value of size

unsetSize

public boolean unsetSize()

Unsets the variable size

Returns:

true, if size was set before, otherwise false

getArrayDimension

public int getArrayDimension()

Returns the value of arrayDimension

Returns:

the value of arrayDimension

isSetArrayDimension

public boolean isSetArrayDimension()

Returns whether arrayDimension is set

Returns:

whether arrayDimension is set

setArrayDimension

public void setArrayDimension(int arrayDimension)

Sets the value of arrayDimension

Parameters:

arrayDimension - the value of arrayDimension

unsetArrayDimension

public boolean unsetArrayDimension()

Unsets the variable arrayDimension

Returns:

true, if arrayDimension was set before, otherwise false

readAttribute

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

Specified by:

readAttribute in interface org.sbml.jsbml.SBase

Overrides:

readAttribute in class org.sbml.jsbml.AbstractSBase

writeXMLAttributes

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

Specified by:

writeXMLAttributes in interface org.sbml.jsbml.SBase

Overrides:

writeXMLAttributes in class org.sbml.jsbml.AbstractSBase

hashCode

public int hashCode()

Specified by:

hashCode in interface org.sbml.jsbml.SBase

Overrides:

hashCode in class org.sbml.jsbml.AbstractSBase

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface org.sbml.jsbml.SBase

Overrides:

equals in class org.sbml.jsbml.AbstractSBase

containsUndeclaredUnits

public boolean containsUndeclaredUnits()

Specified by:

containsUndeclaredUnits in interface org.sbml.jsbml.SBaseWithDerivedUnit

getDerivedUnitDefinition

public org.sbml.jsbml.UnitDefinition getDerivedUnitDefinition()

Specified by:

getDerivedUnitDefinition in interface org.sbml.jsbml.SBaseWithDerivedUnit

getDerivedUnits

public java.lang.String getDerivedUnits()

Specified by:

getDerivedUnits in interface org.sbml.jsbml.SBaseWithDerivedUnit