org.sbml.jsbml.ext.spatial

Class ParametricObject

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.ParametricObject

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SpatialNamedSBase, SBase, TreeNodeWithChangeSupport

public class ParametricObject
extends AbstractSpatialNamedSBase

Since:

1.0

Version:

$Rev$

Author:

Alex Thomas, Andreas Dräger, 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 and Description
ParametricObject()
ParametricObject(int level, int version)
ParametricObject(ParametricObject po)
ParametricObject(String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
boolean	append(String data) Appends the variable data to pointIndex.
ParametricObject	clone()
boolean	equals(Object object)
CompressionKind	getCompression() Returns the value of compression.
DataKind	getDataType() Returns the value of dataType.
String	getDomainType() Returns the value of domain
String	getPointIndex() Returns the value of pointIndex.
int	getPointIndexLength() Returns the value of pointIndexLength.
PolygonKind	getPolygonType() Returns the value of polygonType
int	hashCode()
boolean	isSetCompression() Returns whether compression is set.
boolean	isSetDataType() Returns whether dataType is set.
boolean	isSetDomainType() Returns whether domain is set
boolean	isSetPointIndex() Returns whether pointIndex is set.
boolean	isSetPointIndexLength() Returns whether pointIndexLength is set.
boolean	isSetPolygonType() Returns whether polygonType is set
boolean	readAttribute(String attributeName, String prefix, String value)
void	setCompression(CompressionKind compression) Sets the value of compression
void	setCompression(String compression) Sets the value of compression
void	setDataType(DataKind dataType) Sets the value of dataType
void	setDataType(String dataType) Sets the value of dataType
void	setDomainType(String domain) Sets the value of domain
void	setPointIndex(String pointIndex) Sets the value of pointIndex
void	setPointIndexLength(int pointIndexLength) Sets the value of pointIndexLength
void	setPolygonType(PolygonKind polygonType) Sets the value of polygonType
void	setPolygonType(String polygonType) Sets the value of polygonType
boolean	unsetCompression() Unsets the variable compression.
boolean	unsetDataType() Unsets the variable dataType.
boolean	unsetDomain() Unsets the variable domain
boolean	unsetPointIndex() Unsets the variable pointIndex.
boolean	unsetPointIndexLength() Unsets the variable pointIndexLength.
boolean	unsetPolygonType() Unsets the variable polygonType
Map<String,String>	writeXMLAttributes()

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.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, 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, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, 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, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, 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, 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, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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, getIndex, getParent, isLeaf

Constructor Detail

ParametricObject

public ParametricObject()

ParametricObject

public ParametricObject(ParametricObject po)

Parameters:

po -

ParametricObject

public ParametricObject(int level,
                        int version)

Parameters:

level -

version -

ParametricObject

public ParametricObject(String id,
                        int level,
                        int version)

Parameters:

id -

level -

version -

Method Detail

clone

public ParametricObject clone()

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSpatialNamedSBase

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSpatialNamedSBase

getPolygonType

public PolygonKind getPolygonType()

Returns the value of polygonType

Returns:

the value of polygonType

isSetPolygonType

public boolean isSetPolygonType()

Returns whether polygonType is set

Returns:

whether polygonType is set

setPolygonType

public void setPolygonType(String polygonType)

Sets the value of polygonType

Parameters:

polygonType -

setPolygonType

public void setPolygonType(PolygonKind polygonType)

Sets the value of polygonType

Parameters:

polygonType -

unsetPolygonType

public boolean unsetPolygonType()

Unsets the variable polygonType

Returns:

true, if polygonType was set before, otherwise false

getDomainType

public String getDomainType()

Returns the value of domain

Returns:

the value of domain

isSetDomainType

public boolean isSetDomainType()

Returns whether domain is set

Returns:

whether domain is set

setDomainType

public void setDomainType(String domain)

Sets the value of domain

Parameters:

domain -

unsetDomain

public boolean unsetDomain()

Unsets the variable domain

Returns:

true, if domain was set before, otherwise false

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(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.

getPointIndex

public String getPointIndex()

Returns the value of pointIndex.

Returns:

the value of pointIndex.

isSetPointIndex

public boolean isSetPointIndex()

Returns whether pointIndex is set.

Returns:

whether pointIndex is set.

setPointIndex

public void setPointIndex(String pointIndex)

Sets the value of pointIndex

Parameters:

pointIndex - the value of pointIndex to be set.

unsetPointIndex

public boolean unsetPointIndex()

Unsets the variable pointIndex.

Returns:

true if pointIndex was set before, otherwise false.

append

public boolean append(String data)

Appends the variable data to pointIndex.

Returns:

true if data was appended to pointIndex, otherwise false.

getPointIndexLength

public int getPointIndexLength()

Returns the value of pointIndexLength.

Returns:

the value of pointIndexLength.

isSetPointIndexLength

public boolean isSetPointIndexLength()

Returns whether pointIndexLength is set.

Returns:

whether pointIndexLength is set.

setPointIndexLength

public void setPointIndexLength(int pointIndexLength)

Sets the value of pointIndexLength

Parameters:

pointIndexLength - the value of pointIndexLength to be set.

unsetPointIndexLength

public boolean unsetPointIndexLength()

Unsets the variable pointIndexLength.

Returns:

true if pointIndexLength 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(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 Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSpatialNamedSBase

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSpatialNamedSBase