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:

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

public class SampledField
extends AbstractSpatialNamedSBase

Since:

1.0

Author:

Alex Thomas, Andreas Dräger, Piero Dalle Pezze

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor and Description
SampledField()
SampledField(int level, int version)
SampledField(SampledField sf)
SampledField(java.lang.String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
boolean	append(java.lang.String data) Appends the variable data to samples.
SampledField	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
CompressionKind	getCompression() Returns the value of compression
XMLNode	getData() Returns the value of data
java.lang.String	getDataString() Returns the value of data
DataKind	getDataType() Returns the value of dataType
InterpolationKind	getInterpolation() Returns the value of interpolation type
InterpolationKind	getInterpolationType() Returns the value of interpolation type
int	getNumSamples1() Returns the value of numSamples1
int	getNumSamples2() Returns the value of numSamples2
int	getNumSamples3() Returns the value of numSamples3
java.lang.String	getSamples() Returns the value of samples.
int	getSamplesLength() Returns the value of samplesLength.
int	hashCode() Returns a hash code value for this SBase instance.
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 type is set
boolean	isSetInterpolationType() Returns whether interpolation type 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(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setCompression(CompressionKind compression) Sets the value of compression
void	setData(java.lang.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 type
void	setInterpolationType(InterpolationKind interpolation) Sets the value of interpolation type
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(java.lang.String samples) Sets the value of samples
void	setSamplesLength(int samplesLength) Sets the value of samplesLength
void	setSamplesLength(java.lang.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 type
boolean	unsetInterpolationType() Unsets the variable interpolation type
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.
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

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, 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, 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, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.NamedSBase

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

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, 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 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(java.lang.String id,
                    int level,
                    int version)

Parameters:

id -

level -

version -

Method Detail

clone

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

Returns:

a copy of this object

equals

public boolean equals(java.lang.Object object)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSpatialNamedSBase

Parameters:

object - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

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

getInterpolationType

public InterpolationKind getInterpolationType()

Returns the value of interpolation type

Returns:

the value of interpolation type

getInterpolation

public InterpolationKind getInterpolation()

Returns the value of interpolation type

Returns:

the value of interpolation type

See Also:

getInterpolationType()

isSetInterpolation

public boolean isSetInterpolation()

Returns whether interpolation type is set

Returns:

whether interpolation type is set

See Also:

isSetInterpolationType()

isSetInterpolationType

public boolean isSetInterpolationType()

Returns whether interpolation type is set

Returns:

whether interpolation type is set

setInterpolation

public void setInterpolation(InterpolationKind interpolation)

Sets the value of interpolation type

Parameters:

interpolation - the value of interpolation type

See Also:

setInterpolationType(InterpolationKind)

setInterpolationType

public void setInterpolationType(InterpolationKind interpolation)

Sets the value of interpolation type

Parameters:

interpolation - the value of interpolation type

unsetInterpolation

public boolean unsetInterpolation()

Unsets the variable interpolation type

Returns:

true, if interpolation type was set before, otherwise false

See Also:

unsetInterpolationType()

unsetInterpolationType

public boolean unsetInterpolationType()

Unsets the variable interpolation type

Returns:

true, if interpolation type was set before, otherwise false

getSamples

public java.lang.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(java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.String data)
             throws javax.xml.stream.XMLStreamException

Sets the value of data

Parameters:

data -

Throws:

javax.xml.stream.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 javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractSpatialNamedSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSpatialNamedSBase

getChildAt

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

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSpatialNamedSBase

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSpatialNamedSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

writeXMLAttributes

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

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSpatialNamedSBase

Returns:

a Map containing the XML attributes of this object.

readAttribute

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

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.