eu.etaxonomy.cdm.model.description
Class StatisticalMeasurementValue

java.lang.Object
  eu.etaxonomy.cdm.model.common.CdmBase
      eu.etaxonomy.cdm.model.common.VersionableEntity
          eu.etaxonomy.cdm.model.description.StatisticalMeasurementValue

All Implemented Interfaces:

ICdmBase, IVersionableEntity, IModifiable, Serializable, Cloneable

@Entity
@Indexed(index="eu.etaxonomy.cdm.model.description.DescriptionElementBase")
public class StatisticalMeasurementValue
extends VersionableEntity
implements IModifiable, Cloneable

This class represents the assignment of numerical values to features corresponding to quantitative data. A statistical measurement value instance constitutes an atomized part of an information piece (quantitative data) so that several statistical measurement value instances may belong to one quantitative data instance.

This class corresponds to CharacterMeasureDataType according to the SDD schema.

Version:

1.0

Author:

m.doering

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.etaxonomy.cdm.model.common.CdmBase

uuid

Constructor Summary

protected

StatisticalMeasurementValue() Class constructor: creates a new empty statistical measurement value instance.

Method Summary

void	addModifier(Modifier modifier) Adds a modifier to the set of modifiers used to qualify the validity of this statistical measurement value.
Object	clone() Clones this statistical measurement value.
Set<Modifier>	getModifiers() Returns the set of modifiers used to qualify the validity or probability of this statistical measurement value.
StatisticalMeasure	getType() Returns the type of statistical measure used in this statistical measurement value.
float	getValue() Returns the numerical value used to describe the feature corresponding to the quantitative data this statistical measurement value belongs to.
static StatisticalMeasurementValue	NewInstance() Creates a new empty statistical measurement value instance.
static StatisticalMeasurementValue	NewInstance(StatisticalMeasure type, float value) Creates a new empty statistical measurement value instance.
void	removeModifier(Modifier modifier) Removes one element from the set of modifiers used to qualify the validity of this statistical measurement value.
void	setType(StatisticalMeasure type)
void	setValue(float value)

Methods inherited from class eu.etaxonomy.cdm.model.common.VersionableEntity

equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from class eu.etaxonomy.cdm.model.common.CdmBase

addPropertyChangeListener, addPropertyChangeListener, clone, deproxy, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUuid, hashCode, hasListeners, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isInstanceOf, removePropertyChangeListener, removePropertyChangeListener, setCreated, setCreatedBy, setId, setUuid, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Constructor Detail

StatisticalMeasurementValue

protected StatisticalMeasurementValue()

Class constructor: creates a new empty statistical measurement value instance.

Method Detail

NewInstance

public static StatisticalMeasurementValue NewInstance()

Creates a new empty statistical measurement value instance.

NewInstance

public static StatisticalMeasurementValue NewInstance(StatisticalMeasure type,
                                                      float value)

Creates a new empty statistical measurement value instance.

getType

public StatisticalMeasure getType()

Returns the type of statistical measure used in this statistical measurement value.

setType

public void setType(StatisticalMeasure type)

See Also:

getType()

getValue

public float getValue()

Returns the numerical value used to describe the feature corresponding to the quantitative data this statistical measurement value belongs to.

setValue

public void setValue(float value)

See Also:

getValue()

getModifiers

public Set<Modifier> getModifiers()

Returns the set of modifiers used to qualify the validity or probability of this statistical measurement value. This is only metainformation.

Specified by:

getModifiers in interface IModifiable

addModifier

public void addModifier(Modifier modifier)

Adds a modifier to the set of modifiers used to qualify the validity of this statistical measurement value.

Specified by:

addModifier in interface IModifiable

Parameters:

modifier - the modifier to be added to this statistical measurement value

See Also:

getModifiers()

removeModifier

public void removeModifier(Modifier modifier)

Removes one element from the set of modifiers used to qualify the validity of this statistical measurement value.

Specified by:

removeModifier in interface IModifiable

Parameters:

modifier - the modifier which should be removed

See Also:

getModifiers(), addModifier(Modifier)

clone

public Object clone()

Clones this statistical measurement value. This is a shortcut that enables to create a new instance that differs only slightly from this statistical measurement value by modifying only some of the attributes.

Overrides:

clone in class VersionableEntity

See Also:

VersionableEntity.clone(), Object.clone()