org.sbml.jsbml.ext.spatial

Class SampledField

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.SampledField

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SpatialNamedSBase, SBase, TreeNodeWithChangeSupport

public class SampledField
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
SampledField()
SampledField(int level, int version)
SampledField(SampledField sf)
SampledField(String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
boolean	append(String data) Appends the variable data to samples.
SampledField	clone()
boolean	equals(Object object)
boolean	getAllowsChildren()
TreeNode	getChildAt(int index)
int	getChildCount()
CompressionKind	getCompression() Returns the value of compression
XMLNode	getData() Returns the value of data
String	getDataString() Returns the value of data
DataKind	getDataType() Returns the value of dataType
InterpolationKind	getInterpolation() Returns the value of interpolation
int	getNumSamples1() Returns the value of numSamples1
int	getNumSamples2() Returns the value of numSamples2
int	getNumSamples3() Returns the value of numSamples3
String	getSamples() Returns the value of samples.
int	getSamplesLength() Returns the value of samplesLength.
int	hashCode()
boolean	isSetCompression() Returns whether compression is set
boolean	isSetData() Returns whether data is set
boolean	isSetDataType() Returns whether dataType is set
boolean	isSetInterpolation() Returns whether interpolation is set
boolean	isSetNumSamples1() Returns whether numSamples1 is set
boolean	isSetNumSamples2() Returns whether numSamples2 is set
boolean	isSetNumSamples3() Returns whether numSamples3 is set
boolean	isSetSamples() Returns whether samples is set.
boolean	isSetSamplesLength() Returns whether samplesLength is set.
boolean	readAttribute(String attributeName, String prefix, String value)
void	setCompression(CompressionKind compression) Sets the value of compression
void	setData(String data) Sets the value of data
void	setData(XMLNode data) Sets the value of data
void	setDataType(DataKind dataType) Sets the value of dataType
void	setInterpolation(InterpolationKind interpolation) Sets the value of interpolation
void	setNumSamples1(int numSamples1) Sets the value of numSamples1
void	setNumSamples2(int numSamples2) Sets the value of numSamples2
void	setNumSamples3(int numSamples3) Sets the value of numSamples3
void	setSamples(String samples) Sets the value of samples
void	setSamplesLength(int samplesLength) Sets the value of samplesLength
void	setSamplesLength(String samplesLength) Sets the value of samplesLength
boolean	unsetCompression() Unsets the variable compression
boolean	unsetData() Unsets the variable data
boolean	unsetDataType() Unsets the variable dataType
boolean	unsetInterpolation() Unsets the variable interpolation
boolean	unsetNumSamples1() Unsets the variable numSamples1
boolean	unsetNumSamples2() Unsets the variable numSamples2
boolean	unsetNumSamples3() Unsets the variable numSamples3
boolean	unsetSamples() Unsets the variable samples.
boolean	unsetSamplesLength() Unsets the variable samplesLength.
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

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

SampledField

public SampledField()

SampledField

public SampledField(SampledField sf)

Parameters:

sf -

SampledField

public SampledField(int level,
                    int version)

Parameters:

level -

version -

SampledField

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

Parameters:

id -

level -

version -

Method Detail

clone

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

getNumSamples1

public int getNumSamples1()

Returns the value of numSamples1

Returns:

the value of numSamples1

isSetNumSamples1

public boolean isSetNumSamples1()

Returns whether numSamples1 is set

Returns:

whether numSamples1 is set

setNumSamples1

public void setNumSamples1(int numSamples1)

Sets the value of numSamples1

Parameters:

numSamples1 -

unsetNumSamples1

public boolean unsetNumSamples1()

Unsets the variable numSamples1

Returns:

true, if numSamples1 was set before, otherwise false

getNumSamples2

public int getNumSamples2()

Returns the value of numSamples2

Returns:

the value of numSamples2

isSetNumSamples2

public boolean isSetNumSamples2()

Returns whether numSamples2 is set

Returns:

whether numSamples2 is set

setNumSamples2

public void setNumSamples2(int numSamples2)

Sets the value of numSamples2

Parameters:

numSamples2 -

unsetNumSamples2

public boolean unsetNumSamples2()

Unsets the variable numSamples2

Returns:

true, if numSamples2 was set before, otherwise false

getNumSamples3

public int getNumSamples3()

Returns the value of numSamples3

Returns:

the value of numSamples3

isSetNumSamples3

public boolean isSetNumSamples3()

Returns whether numSamples3 is set

Returns:

whether numSamples3 is set

setNumSamples3

public void setNumSamples3(int numSamples3)

Sets the value of numSamples3

Parameters:

numSamples3 -

unsetNumSamples3

public boolean unsetNumSamples3()

Unsets the variable numSamples3

Returns:

true, if numSamples3 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(DataKind dataType)

Sets the value of dataType

Parameters:

dataType -

unsetDataType

public boolean unsetDataType()

Unsets the variable dataType

Returns:

true, if dataType 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(CompressionKind compression)

Sets the value of compression

Parameters:

compression -

unsetCompression

public boolean unsetCompression()

Unsets the variable compression

Returns:

true, if compression was set before, otherwise false

getInterpolation

public InterpolationKind getInterpolation()

Returns the value of interpolation

Returns:

the value of interpolation

isSetInterpolation

public boolean isSetInterpolation()

Returns whether interpolation is set

Returns:

whether interpolation is set

setInterpolation

public void setInterpolation(InterpolationKind interpolation)

Sets the value of interpolation

Parameters:

interpolation -

unsetInterpolation

public boolean unsetInterpolation()

Unsets the variable interpolation

Returns:

true, if interpolation was set before, otherwise false

getSamples

public String getSamples()

Returns the value of samples.

Returns:

the value of samples.

isSetSamples

public boolean isSetSamples()

Returns whether samples is set.

Returns:

whether samples is set.

setSamples

public void setSamples(String samples)

Sets the value of samples

Parameters:

samples - the value of samples to be set.

unsetSamples

public boolean unsetSamples()

Unsets the variable samples.

Returns:

true if samples was set before, otherwise false.

append

public boolean append(String data)

Appends the variable data to samples.

Returns:

true if data was appended to samples, otherwise false.

getSamplesLength

public int getSamplesLength()

Returns the value of samplesLength.

Returns:

the value of samplesLength.

isSetSamplesLength

public boolean isSetSamplesLength()

Returns whether samplesLength is set.

Returns:

whether samplesLength is set.

setSamplesLength

public void setSamplesLength(String samplesLength)

Sets the value of samplesLength

Parameters:

samplesLength - the value of samplesLength to be set.

setSamplesLength

public void setSamplesLength(int samplesLength)

Sets the value of samplesLength

Parameters:

samplesLength - the value of samplesLength to be set.

unsetSamplesLength

public boolean unsetSamplesLength()

Unsets the variable samplesLength.

Returns:

true if samplesLength was set before, otherwise false.

getDataString

public String getDataString()

Returns the value of data

Returns:

the value of data

getData

public XMLNode getData()

Returns the value of data

Returns:

the value of data

isSetData

public boolean isSetData()

Returns whether data is set

Returns:

whether data is set

setData

public void setData(String data)
             throws XMLStreamException

Sets the value of data

Parameters:

data -

Throws:

XMLStreamException

setData

public void setData(XMLNode data)

Sets the value of data

Parameters:

data -

unsetData

public boolean unsetData()

Unsets the variable data

Returns:

true, if data was set before, otherwise false

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSpatialNamedSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSpatialNamedSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSpatialNamedSBase

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