Package org.sbml.jsbml.ext.spatial

Class SpatialPoints

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.SpatialPoints

All Implemented Interfaces:

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

public class SpatialPoints
extends AbstractSpatialNamedSBase

Since:

1.0

Author:

Piero Dalle Pezze

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

Method Summary

Modifier and Type	Method	Description
boolean	append(java.lang.String data)	Appends the variable data to arrayData.
SpatialPoints	clone()	clones this class
boolean	equals(java.lang.Object object)
java.lang.String	getArrayData()	Returns the value of arrayData.
int	getArrayDataLength()	Returns the value of arrayDataLength.
CompressionKind	getCompression()	Returns the value of compression.
DataKind	getDataType()	Returns the value of dataType.
int	hashCode()
boolean	isSetArrayData()	Returns whether arrayData is set.
boolean	isSetArrayDataLength()	Returns whether arrayDataLength is set.
boolean	isSetCompression()	Returns whether compression is set.
boolean	isSetDataType()	Returns whether dataType is set.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
void	setArrayData(java.lang.String arrayData)	Sets the value of arrayData
void	setArrayDataLength(int arrayDataLength)	Sets the value of arrayDataLength
void	setCompression(java.lang.String compression)	Sets the value of compression
void	setCompression(CompressionKind compression)	Sets the value of compression
void	setDataType(java.lang.String dataType)	Sets the value of dataType
void	setDataType(DataKind dataType)	Sets the value of dataType
boolean	unsetArrayData()	Unsets the variable arrayData.
boolean	unsetArrayDataLength()	Unsets the variable arrayDataLength.
boolean	unsetCompression()	Unsets the variable compression.
boolean	unsetDataType()	Unsets the variable dataType.
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

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, getAnnotation, getAnnotationString, 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, isIdMandatory, 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.ext.spatial.AbstractSpatialNamedSBase

getAllowsChildren, getChildAt, getChildCount, getSpatialId, initDefaults, isSetSpatialId, setSpatialId, unsetSpatialId

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

SpatialPoints

public SpatialPoints()

Creates an SpatialPoints instance

SpatialPoints

public SpatialPoints(int level,
                     int version)

Creates a SpatialPoints instance with a level and version.

Parameters:

level - SBML Level

version - SBML Version

SpatialPoints

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

Creates a SpatialPoints instance with a level and version.

Parameters:

id -

level - SBML Level

version - SBML Version

SpatialPoints

public SpatialPoints(SpatialPoints sp)

Clone constructor

Method Detail

clone

public SpatialPoints clone()

clones this class

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSpatialNamedSBase

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSpatialNamedSBase

getCompression

public CompressionKind getCompression()

Returns the value of compression.

Returns:

the value of compression.

isSetCompression

public boolean isSetCompression()

Returns whether compression is set.

Returns:

whether compression is set.

setCompression

public void setCompression(java.lang.String compression)

Sets the value of compression

Parameters:

compression -

setCompression

public void setCompression(CompressionKind compression)

Sets the value of compression

Parameters:

compression - the value of compression to be set.

unsetCompression

public boolean unsetCompression()

Unsets the variable compression.

Returns:

true if compression was set before, otherwise false.

getArrayData

public java.lang.String getArrayData()

Returns the value of arrayData.

Returns:

the value of arrayData.

isSetArrayData

public boolean isSetArrayData()

Returns whether arrayData is set.

Returns:

whether arrayData is set.

setArrayData

public void setArrayData(java.lang.String arrayData)

Sets the value of arrayData

Parameters:

arrayData - the value of arrayData to be set.

unsetArrayData

public boolean unsetArrayData()

Unsets the variable arrayData.

Returns:

true if arrayData was set before, otherwise false.

append

public boolean append(java.lang.String data)

Appends the variable data to arrayData.

Returns:

true if data was appended to arrayData, otherwise false.

getArrayDataLength

public int getArrayDataLength()

Returns the value of arrayDataLength.

Returns:

the value of arrayDataLength.

isSetArrayDataLength

public boolean isSetArrayDataLength()

Returns whether arrayDataLength is set.

Returns:

whether arrayDataLength is set.

setArrayDataLength

public void setArrayDataLength(int arrayDataLength)

Sets the value of arrayDataLength

Parameters:

arrayDataLength - the value of arrayDataLength to be set.

unsetArrayDataLength

public boolean unsetArrayDataLength()

Unsets the variable arrayDataLength.

Returns:

true if arrayDataLength was set before, otherwise false.

getDataType

public DataKind getDataType()

Returns the value of dataType.

Returns:

the value of dataType.

isSetDataType

public boolean isSetDataType()

Returns whether dataType is set.

Returns:

whether dataType is set.

setDataType

public void setDataType(java.lang.String dataType)

Sets the value of dataType

Parameters:

dataType -

setDataType

public void setDataType(DataKind dataType)

Sets the value of dataType

Parameters:

dataType - the value of dataType to be set.

unsetDataType

public boolean unsetDataType()

Unsets the variable dataType.

Returns:

true if dataType was set before, otherwise false.

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSpatialNamedSBase

writeXMLAttributes

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

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSpatialNamedSBase

readAttribute

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

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase