@Entity @Indexed(index="eu.etaxonomy.cdm.model.description.DescriptionElementBase") public class QuantitativeData extends DescriptionElementBase implements java.lang.Cloneable
categorical data
on one side and to literal data on
the other side). Only taxon descriptions
and
specimen descriptions
may contain quantitative data.feature
for instance can be measured in inches.
If the length of leaves of a particular tree is described as
"typically between 3 and 5 inches" and "at the utmost 8 inches" then three
statistical measurement value
instances
must be assigned to an instance of the present class
(with the measurement unit
set to "inch"):statistical measure
"typical lower boundary",
This class corresponds partially to CodedDescriptionType according to the SDD schema.
annotations, markers
CLOB_LENGTH, uuid
Modifier | Constructor and Description |
---|---|
protected |
QuantitativeData()
Class constructor: creates a new empty quantitative data instance.
|
protected |
QuantitativeData(Feature feature)
Class constructor: creates a new empty quantitative data instance.
|
Modifier and Type | Method and Description |
---|---|
void |
addStatisticalValue(StatisticalMeasurementValue statisticalValue)
Adds a
statistical measurement value to the set of
statistical measurement values describing
the feature corresponding to this quantitative data. |
java.lang.Object |
clone()
Clones this quantitative data.
|
java.lang.Float |
getAverage()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure
"average" and belonging to this quantitative data. |
java.util.Set<java.lang.Float> |
getExactValues() |
java.lang.Float |
getMax()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure "maximum" and
belonging to this quantitative data. |
java.lang.Float |
getMin()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure "minimum" and
belonging to this quantitative data. |
java.lang.Float |
getOverallMax() |
java.lang.Float |
getOverallMin() |
java.lang.Float |
getSampleSize()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure
"sample size" and belonging to this quantitative data. |
java.lang.Float |
getSpecificStatisticalValue(StatisticalMeasure type)
Returns the statistical value of type
type . |
java.util.Set<java.lang.Float> |
getSpecificStatisticalValues(StatisticalMeasure type) |
java.lang.Float |
getStandardDeviation()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure
"standard deviation" and belonging to this quantitative data. |
java.util.Set<StatisticalMeasurementValue> |
getStatisticalValues()
Returns the set of
statistical measurement values describing
the feature corresponding to this quantitative data. |
java.lang.Float |
getTypicalLowerBoundary()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure
"typical lower boundary" and belonging to this quantitative data. |
java.lang.Float |
getTypicalUpperBoundary()
Returns the numerical value of the one
statistical measurement value
with the corresponding statistical measure
"typical upper boundary" and belonging to this quantitative data. |
MeasurementUnit |
getUnit()
Returns the
measurement unit used in this
quantitative data. |
java.lang.Boolean |
getUnknownData() |
boolean |
isCharacterData()
Is this description item of a class type which is considered to
represent character data? These classes are
QuantitativeData
and CategoricalData . |
static QuantitativeData |
NewExactValueInstance(Feature feature,
float... exactValues)
Creates a new quantitative data instance of type feature with defined exact value.
|
static QuantitativeData |
NewInstance()
Creates a new empty quantitative data instance.
|
static QuantitativeData |
NewInstance(Feature feature)
Creates a new quantitative data instance of type feature.
|
static QuantitativeData |
NewMinMaxInstance(Feature feature,
float min,
float max)
Creates a new quantitative data instance of type feature with defined min and may value.
|
void |
removeStatisticalValue(StatisticalMeasurementValue statisticalValue)
Removes one element from the set of
statistical measurement values
describing the feature corresponding to this quantitative data. |
StatisticalMeasurementValue |
setAverage(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the average.
|
StatisticalMeasurementValue |
setMaximum(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the maximum.
|
StatisticalMeasurementValue |
setMinimum(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the minimum.
|
StatisticalMeasurementValue |
setSampleSize(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the sample size.
|
StatisticalMeasurementValue |
setSpecificStatisticalValue(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers,
StatisticalMeasure type)
Sets the statistical value of type
type . |
StatisticalMeasurementValue |
setStandardDeviation(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the standard deviation.
|
protected void |
setStatisticalValues(java.util.Set<StatisticalMeasurementValue> statisticalValues)
Deprecated.
|
StatisticalMeasurementValue |
setTypicalLowerBoundary(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the typical lower boundary.
|
StatisticalMeasurementValue |
setTypicalUpperBoundary(java.lang.Float value,
java.util.Set<DefinedTerm> modifiers)
Sets the statistical value for the typical upper boundary.
|
void |
setUnit(MeasurementUnit unit) |
void |
setUnknownData(java.lang.Boolean unknownData) |
java.lang.String |
toString()
Overrides
Object.toString() . |
addAggregationSource, addImportSource, addMedia, addModifier, addModifyingText, addModifyingText, addPrimaryTaxonomicSource, addPrimaryTaxonomicSource, addSource, addSource, addSource, addSource, addSources, clone, getFeature, getInDescription, getMedia, getModifiers, getModifiers, getModifyingText, getSortIndex, getSources, getTimeperiod, makeModifierMap, putModifyingText, putModifyingText, removeMedia, removeModifier, removeModifyingText, removeSource, setFeature, setInDescription, setSortIndex, setTimeperiod
addAnnotation, addMarker, addMarker, getAnnotations, getAnnotations, getMarkers, getMarkers, hasMarker, hasMarker, markerValue, removeAnnotation, removeMarker, removeMarker, setAnnotations
cloneLanguageString, equals, getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
addPropertyChangeListener, addPropertyChangeListener, addToSetWithChangeEvent, deproxy, deproxy, fireOnCreateEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCreated, getCreatedBy, getId, getUserFriendlyDescription, getUserFriendlyFieldName, getUserFriendlyTypeName, getUuid, hashCode, hasListeners, initListener, instanceToString, invokeSetMethod, invokeSetMethodWithNull, isBlank, isInstanceOf, isNotBlank, isPersited, removeFromSetWithChangeEvent, removePropertyChangeListener, removePropertyChangeListener, replaceInList, setCreated, setCreatedBy, setId, setNewEntityListener, setUuid
finalize, getClass, notify, notifyAll, wait, wait, wait
getUpdated, getUpdatedBy, setUpdated, setUpdatedBy
getCreated, getCreatedBy, getId, getUuid, isInstanceOf, isPersited, setCreated, setCreatedBy, setId, setUuid
protected QuantitativeData()
protected QuantitativeData(Feature feature)
public static QuantitativeData NewInstance()
public static QuantitativeData NewInstance(Feature feature)
public static QuantitativeData NewMinMaxInstance(Feature feature, float min, float max)
public static QuantitativeData NewExactValueInstance(Feature feature, float... exactValues)
public java.util.Set<StatisticalMeasurementValue> getStatisticalValues()
statistical measurement values
describing
the feature
corresponding to this quantitative data.@Deprecated protected void setStatisticalValues(java.util.Set<StatisticalMeasurementValue> statisticalValues)
public void addStatisticalValue(StatisticalMeasurementValue statisticalValue)
statistical measurement value
to the set of
statistical measurement values
describing
the feature
corresponding to this quantitative data.statisticalValue
- the statistical measurement value to be added to
this quantitative datagetStatisticalValues()
public void removeStatisticalValue(StatisticalMeasurementValue statisticalValue)
statistical measurement values
describing the feature
corresponding to this quantitative data.statisticalValue
- the statistical measurement value which should be removedgetStatisticalValues()
,
addStatisticalValue(StatisticalMeasurementValue)
public MeasurementUnit getUnit()
measurement unit
used in this
quantitative data.public void setUnit(MeasurementUnit unit)
getUnit()
public java.lang.Float getOverallMin()
public java.lang.Float getOverallMax()
public java.lang.Float getMin()
statistical measurement value
with the corresponding statistical measure
"minimum" and
belonging to this quantitative data. Returns null
if no such
statistical measurement value instance exists.public java.lang.Float getMax()
statistical measurement value
with the corresponding statistical measure
"maximum" and
belonging to this quantitative data. Returns null
if no such
statistical measurement value instance exists.public java.lang.Float getTypicalLowerBoundary()
statistical measurement value
with the corresponding statistical measure
"typical lower boundary" and belonging to this quantitative data.
Returns null
if no such statistical measurement value instance exists.public java.util.Set<java.lang.Float> getExactValues()
public java.lang.Float getAverage()
statistical measurement value
with the corresponding statistical measure
"average" and belonging to this quantitative data.
Returns null
if no such statistical measurement value instance exists.public java.lang.Float getStandardDeviation()
statistical measurement value
with the corresponding statistical measure
"standard deviation" and belonging to this quantitative data.
Returns null
if no such statistical measurement value instance exists.public java.lang.Float getSampleSize()
statistical measurement value
with the corresponding statistical measure
"sample size" and belonging to this quantitative data.
Returns null
if no such statistical measurement value instance exists.public java.lang.Float getTypicalUpperBoundary()
statistical measurement value
with the corresponding statistical measure
"typical upper boundary" and belonging to this quantitative data.
Returns null
if no such statistical measurement value instance exists.public java.lang.Float getSpecificStatisticalValue(StatisticalMeasure type)
type
.
If no such value exists null
is returned. If multiple such
values exist an arbitrary one is returned.type
- public java.util.Set<java.lang.Float> getSpecificStatisticalValues(StatisticalMeasure type)
public StatisticalMeasurementValue setMinimum(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setMaximum(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setAverage(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setStandardDeviation(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setSampleSize(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setTypicalLowerBoundary(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setTypicalUpperBoundary(java.lang.Float value, java.util.Set<DefinedTerm> modifiers)
type
- value
- public StatisticalMeasurementValue setSpecificStatisticalValue(java.lang.Float value, java.util.Set<DefinedTerm> modifiers, StatisticalMeasure type)
type
.
If such value exists the old value is replaced by the new value.
The new value is returned.type
- value
- public java.lang.Boolean getUnknownData()
public void setUnknownData(java.lang.Boolean unknownData)
public boolean isCharacterData()
DescriptionElementBase
QuantitativeData
and CategoricalData
.
To be overridden by these classes.isCharacterData
in class DescriptionElementBase
public java.lang.Object clone()
clone
in class DescriptionElementBase
DescriptionElementBase.clone()
,
Object.clone()
public java.lang.String toString()
CdmBase
Object.toString()
.
This returns an String that identifies the object well without being necessarily unique. Internally the method is delegating the
call to {link CdmBase.instanceToString()
.Note: If overriding this method's javadoc always copy or link the above requirement. If not overwritten by a subclass method returns the class, id and uuid as a string for any CDM object.
For example: Taxon#13<b5938a98-c1de-4dda-b040-d5cc5bfb3bc0>
Copyright © 2007-2020 EDIT. All Rights Reserved.