fr.ifremer.adagio.core.dao.referential.pmfm

Class Pmfm

Object

Pmfm

All Implemented Interfaces:

Serializable, Comparable<Pmfm>

Direct Known Subclasses:

PmfmImpl

public abstract class Pmfm
extends Object
implements Serializable, Comparable<Pmfm>

Quadruplet paramètre/support/méthode/fraction. Ce quadruplet est systématiquement associé aux résultats et décrit précisemment les conditions de mesure/d'analyse de ceux-ci.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pmfm.Factory Constructs new instances of Pmfm.

Constructor Summary

Constructors

Constructor and Description
Pmfm()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addQualitativeValues(QualitativeValue elementToAdd) Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.
int	compareTo(Pmfm o)
boolean	equals(Object object) Returns true if the argument is an Pmfm instance and all identifiers for this entity equal the identifiers of the argument entity.
AggregationLevel	getAggregationLevel() Niveau (ou période) d'agrégation de la donnée.
String	getComments()
Date	getCreationDate()
Float	getDefaultValue() Précision de la mesure associé pour le PSFM.Typiquement, cette précision est utile lors de la saisie de plusieursinstruments et de la méthode associée.
String	getDescription()
Float	getDetectionThreshold() Seuil de détection des instruments de mesure et de la méthode associée.
Fraction	getFraction() Une fraction analysée est un composant du support sur lequel porte l'analyse.
Integer	getId() Idenfiant interne.
Matrix	getMatrix() Le support est un composant du milieu sur lequel porte l'investigation.
Integer	getMaximumNumberDecimals() Nombre de décimales significatives pour le résultat mesuré/analysé suivant le quadruplet lié.
Float	getMaxValue() Valeur maximale autorisée par défaut (peut etre redéfini dans les stratégies).
Method	getMethod() Les méthodes sont rassemblées dans une liste qui couvre tous les domaines pour lesquels il existe un paramètre.
Float	getMinValue() Valeur mimimale autorisée par défaut (peut etre redéfini dans les stratégies).
Parameter	getParameter() Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en apprécier les caractéristiques et/ou la qualité et/ou l'aptitude à des usages.
Float	getPrecision()
Collection<QualitativeValue>	getQualitativeValues() Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.
Integer	getSignifFiguresNumber() Nombre de chiffres significatifs en tout du résultat pour le quadruplet concerné.
Status	getStatus() Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire
Unit	getUnit() Unité d'une mesure.
Timestamp	getUpdateDate()
ValidityStatus	getValidityStatus() Etat de validation d'une donnée du référentiel.
int	hashCode() Returns a hash code based on this entity's identifiers.
boolean	removeQualitativeValues(QualitativeValue elementToRemove) Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.
void	setAggregationLevel(AggregationLevel aggregationLevelIn) Niveau (ou période) d'agrégation de la donnée.
void	setComments(String commentsIn)
void	setCreationDate(Date creationDateIn)
void	setDefaultValue(Float defaultValueIn) Précision de la mesure associé pour le PSFM.Typiquement, cette précision est utile lors de la saisie de plusieursinstruments et de la méthode associée.
void	setDescription(String descriptionIn)
void	setDetectionThreshold(Float detectionThresholdIn) Seuil de détection des instruments de mesure et de la méthode associée.
void	setFraction(Fraction fractionIn) Une fraction analysée est un composant du support sur lequel porte l'analyse.
void	setId(Integer idIn) Idenfiant interne.
void	setMatrix(Matrix matrixIn) Le support est un composant du milieu sur lequel porte l'investigation.
void	setMaximumNumberDecimals(Integer maximumNumberDecimalsIn) Nombre de décimales significatives pour le résultat mesuré/analysé suivant le quadruplet lié.
void	setMaxValue(Float maxValueIn) Valeur maximale autorisée par défaut (peut etre redéfini dans les stratégies).
void	setMethod(Method methodIn) Les méthodes sont rassemblées dans une liste qui couvre tous les domaines pour lesquels il existe un paramètre.
void	setMinValue(Float minValueIn) Valeur mimimale autorisée par défaut (peut etre redéfini dans les stratégies).
void	setParameter(Parameter parameterIn) Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en apprécier les caractéristiques et/ou la qualité et/ou l'aptitude à des usages.
void	setPrecision(Float precisionIn)
void	setQualitativeValues(Collection<QualitativeValue> qualitativeValuesIn) Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.
void	setSignifFiguresNumber(Integer signifFiguresNumberIn) Nombre de chiffres significatifs en tout du résultat pour le quadruplet concerné.
void	setStatus(Status statusIn) Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire
void	setUnit(Unit unitIn) Unité d'une mesure.
void	setUpdateDate(Timestamp updateDateIn)
void	setValidityStatus(ValidityStatus validityStatusIn) Etat de validation d'une donnée du référentiel.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pmfm

public Pmfm()

Method Detail

getId

public Integer getId()

Idenfiant interne. Généré par le système.

Returns:

this.id Integer

setId

public void setId(Integer idIn)

Idenfiant interne. Généré par le système.

Parameters:

idIn - Integer

getSignifFiguresNumber

public Integer getSignifFiguresNumber()

Nombre de chiffres significatifs en tout du résultat pour le quadruplet concerné.

Returns:

this.signifFiguresNumber Integer

setSignifFiguresNumber

public void setSignifFiguresNumber(Integer signifFiguresNumberIn)

Nombre de chiffres significatifs en tout du résultat pour le quadruplet concerné.

Parameters:

signifFiguresNumberIn - Integer

getMaximumNumberDecimals

public Integer getMaximumNumberDecimals()

Nombre de décimales significatives pour le résultat mesuré/analysé suivant le quadruplet lié.

Returns:

this.maximumNumberDecimals Integer

setMaximumNumberDecimals

public void setMaximumNumberDecimals(Integer maximumNumberDecimalsIn)

Nombre de décimales significatives pour le résultat mesuré/analysé suivant le quadruplet lié.

Parameters:

maximumNumberDecimalsIn - Integer

getDetectionThreshold

public Float getDetectionThreshold()

Seuil de détection des instruments de mesure et de la méthode associée.

Returns:

this.detectionThreshold Float

setDetectionThreshold

public void setDetectionThreshold(Float detectionThresholdIn)

Seuil de détection des instruments de mesure et de la méthode associée.

Parameters:

detectionThresholdIn - Float

getMinValue

public Float getMinValue()

Valeur mimimale autorisée par défaut (peut etre redéfini dans les stratégies).

Returns:

this.minValue Float

setMinValue

public void setMinValue(Float minValueIn)

Valeur mimimale autorisée par défaut (peut etre redéfini dans les stratégies).

Parameters:

minValueIn - Float

getMaxValue

public Float getMaxValue()

Valeur maximale autorisée par défaut (peut etre redéfini dans les stratégies).

Returns:

this.maxValue Float

setMaxValue

public void setMaxValue(Float maxValueIn)

Valeur maximale autorisée par défaut (peut etre redéfini dans les stratégies).

Parameters:

maxValueIn - Float

getPrecision

public Float getPrecision()

Returns:

this.precision Float

setPrecision

public void setPrecision(Float precisionIn)

Parameters:

precisionIn - Float

getDefaultValue

public Float getDefaultValue()

Précision de la mesure associé pour le PSFM.Typiquement, cette précision est utile lors de la saisie de plusieursinstruments et de la méthode associée.

Returns:

this.defaultValue Float

setDefaultValue

public void setDefaultValue(Float defaultValueIn)

Précision de la mesure associé pour le PSFM.Typiquement, cette précision est utile lors de la saisie de plusieursinstruments et de la méthode associée.

Parameters:

defaultValueIn - Float

getCreationDate

public Date getCreationDate()

Returns:

this.creationDate Date

setCreationDate

public void setCreationDate(Date creationDateIn)

Parameters:

creationDateIn - Date

getDescription

public String getDescription()

Returns:

this.description String

setDescription

public void setDescription(String descriptionIn)

Parameters:

descriptionIn - String

getComments

public String getComments()

Returns:

this.comments String

setComments

public void setComments(String commentsIn)

Parameters:

commentsIn - String

getUpdateDate

public Timestamp getUpdateDate()

Returns:

this.updateDate Timestamp

setUpdateDate

public void setUpdateDate(Timestamp updateDateIn)

Parameters:

updateDateIn - Timestamp

getValidityStatus

public ValidityStatus getValidityStatus()

Etat de validation d'une donnée du référentiel. Utile pour les responsables de référentiel. Validity status of a referential data.

Returns:

this.validityStatus ValidityStatus

setValidityStatus

public void setValidityStatus(ValidityStatus validityStatusIn)

Etat de validation d'une donnée du référentiel. Utile pour les responsables de référentiel. Validity status of a referential data.

Parameters:

validityStatusIn - ValidityStatus

getMatrix

public Matrix getMatrix()

Le support est un composant du milieu sur lequel porte l'investigation. Les supports sont, par exemple : - un engin, - la mer (ou autre environnement), - bivalve (moule, huître, coque...) - crustacé (crevette...) - poisson (merlu, sardine...) - gastéropode (bigorneau, littorine...) - echinoderme (oursin...) - masse d'eau, eau brute - eau filtrée - ... Le support ne correspond pas au support réellement analysé. En effet, il peut s'agir d'une analyse sur une fraction du support (par exemple, pour le poisson, l'otolite,… ou pour un engin, le bras). Nombre de lignes : 20

Returns:

this.matrix Matrix

setMatrix

public void setMatrix(Matrix matrixIn)

Le support est un composant du milieu sur lequel porte l'investigation. Les supports sont, par exemple : - un engin, - la mer (ou autre environnement), - bivalve (moule, huître, coque...) - crustacé (crevette...) - poisson (merlu, sardine...) - gastéropode (bigorneau, littorine...) - echinoderme (oursin...) - masse d'eau, eau brute - eau filtrée - ... Le support ne correspond pas au support réellement analysé. En effet, il peut s'agir d'une analyse sur une fraction du support (par exemple, pour le poisson, l'otolite,… ou pour un engin, le bras). Nombre de lignes : 20

Parameters:

matrixIn - Matrix

getMethod

public Method getMethod()

Les méthodes sont rassemblées dans une liste qui couvre tous les domaines pour lesquels il existe un paramètre. La liste des méthodes est générique et porte sur toutes les phases du processus de mesure des paramètres. Chaque méthode n'est pas non plus systématiquement spécifique à l'une de ces phases ou à une nature particulière de paramètre. En effet, une méthode peut couvrir tout le cycle du processus et/ou être utilisable pour une phase quelle que soit la nature du paramètre. Les méthodes peuvent être référencées par les paramètres à différentes phases de leur processus de mesure que sont : pour les paramètres biologique : - le prélèvement et l'échantillonnage ; - la conservation et le transport ; - le fractionnement ; - l'analyse ; pour les paramètres environnementaux : - l'observation ;

Returns:

this.method Method

setMethod

public void setMethod(Method methodIn)

Les méthodes sont rassemblées dans une liste qui couvre tous les domaines pour lesquels il existe un paramètre. La liste des méthodes est générique et porte sur toutes les phases du processus de mesure des paramètres. Chaque méthode n'est pas non plus systématiquement spécifique à l'une de ces phases ou à une nature particulière de paramètre. En effet, une méthode peut couvrir tout le cycle du processus et/ou être utilisable pour une phase quelle que soit la nature du paramètre. Les méthodes peuvent être référencées par les paramètres à différentes phases de leur processus de mesure que sont : pour les paramètres biologique : - le prélèvement et l'échantillonnage ; - la conservation et le transport ; - le fractionnement ; - l'analyse ; pour les paramètres environnementaux : - l'observation ;

Parameters:

methodIn - Method

getQualitativeValues

public Collection<QualitativeValue> getQualitativeValues()

Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.

Returns:

this.qualitativeValues Collection

setQualitativeValues

public void setQualitativeValues(Collection<QualitativeValue> qualitativeValuesIn)

Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.

Parameters:

qualitativeValuesIn - Collection

addQualitativeValues

public boolean addQualitativeValues(QualitativeValue elementToAdd)

Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.

Parameters:

elementToAdd - QualitativeValue

Returns:

true if this collection changed as a result of the call

removeQualitativeValues

public boolean removeQualitativeValues(QualitativeValue elementToRemove)

Liste des valeurs qualitatives pour un PSFM.Il s'agit d’une sous-liste des valeurs qualitatives du paramètre.

Parameters:

elementToRemove - QualitativeValue

Returns:

true if this collection changed as a result of the call

getFraction

public Fraction getFraction()

Une fraction analysée est un composant du support sur lequel porte l'analyse. Les fractions analysées sont généralement des fractions "organiques", au sens d'une classification par partie d'un même organisme, ex : foie, écaille, reins, dents, otolithe... Elles peuvent aussi être un sous ensemble quelconque du support. Par exemple, dans le cas des engins : le bras, … Les fractions dites "systématiques", au sens d'une classification systématique (ex : poisson : Cyprinidae / Cyprinus / Cyprinus carpio...) ne sont pas considérées comme des fractions au sens de l'entité, mais comme une précision apportée sur l'individu. Représentées par les entités "taxon" et "groupe de taxon", elles ne font pas partie de la liste des fractions analysées. Etant une liste de référence, une procédure stricte pour la création de nouvelles fractions analysées pourra être mise en place (On pourra s'inspirer des procédures utilisées dans Quadrige2, qui utilisent le référentiel national du SANDRE). Nombre de lignes : 10

Returns:

this.fraction Fraction

setFraction

public void setFraction(Fraction fractionIn)

Une fraction analysée est un composant du support sur lequel porte l'analyse. Les fractions analysées sont généralement des fractions "organiques", au sens d'une classification par partie d'un même organisme, ex : foie, écaille, reins, dents, otolithe... Elles peuvent aussi être un sous ensemble quelconque du support. Par exemple, dans le cas des engins : le bras, … Les fractions dites "systématiques", au sens d'une classification systématique (ex : poisson : Cyprinidae / Cyprinus / Cyprinus carpio...) ne sont pas considérées comme des fractions au sens de l'entité, mais comme une précision apportée sur l'individu. Représentées par les entités "taxon" et "groupe de taxon", elles ne font pas partie de la liste des fractions analysées. Etant une liste de référence, une procédure stricte pour la création de nouvelles fractions analysées pourra être mise en place (On pourra s'inspirer des procédures utilisées dans Quadrige2, qui utilisent le référentiel national du SANDRE). Nombre de lignes : 10

Parameters:

fractionIn - Fraction

getParameter

public Parameter getParameter()

Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en apprécier les caractéristiques et/ou la qualité et/ou l'aptitude à des usages. Le paramètre se décline en trois types : quantitatif, qualitatif ou libre. Le type quantitatif se rapporte aux paramètres qui ont une infinité de résultats numériques. Le type qualitatif se rapporte aux paramètres qui ne prennent qu'un nombre limité de valeurs prédéfinies pour chacun d'eux. Le type libre, ou alphanumérique, correspond aux paramètres de valeurs alphanumériques, sans limite de valeurs possibles (hormis la longueur de la chaine : 40 max). Ces trois types sont mutuellement exclusifs. Exemple de paramètre : • Taille (numérique) • Age (numérique) • Sexe (qualitatif) • Catégorie commerciale (qualitatif) • Présentation commerciale (qualitatif) • Vrac / Hors Vrac (qualitatif) • Rejet / Débarquement (qualitatif) (Discard/Landing) • Stade de maturité (qualitatif) (Maturity stage) • Numéro de contrat (libre - alphanumérique) Cette liste n’est pas exhaustive. Nombre de lignes : 130

Returns:

this.parameter Parameter

setParameter

public void setParameter(Parameter parameterIn)

Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en apprécier les caractéristiques et/ou la qualité et/ou l'aptitude à des usages. Le paramètre se décline en trois types : quantitatif, qualitatif ou libre. Le type quantitatif se rapporte aux paramètres qui ont une infinité de résultats numériques. Le type qualitatif se rapporte aux paramètres qui ne prennent qu'un nombre limité de valeurs prédéfinies pour chacun d'eux. Le type libre, ou alphanumérique, correspond aux paramètres de valeurs alphanumériques, sans limite de valeurs possibles (hormis la longueur de la chaine : 40 max). Ces trois types sont mutuellement exclusifs. Exemple de paramètre : • Taille (numérique) • Age (numérique) • Sexe (qualitatif) • Catégorie commerciale (qualitatif) • Présentation commerciale (qualitatif) • Vrac / Hors Vrac (qualitatif) • Rejet / Débarquement (qualitatif) (Discard/Landing) • Stade de maturité (qualitatif) (Maturity stage) • Numéro de contrat (libre - alphanumérique) Cette liste n’est pas exhaustive. Nombre de lignes : 130

Parameters:

parameterIn - Parameter

getAggregationLevel

public AggregationLevel getAggregationLevel()

Niveau (ou période) d'agrégation de la donnée. Par exemple : - aucune (pas d'agrégation) - jour, - mois, - année - marée - opération - zone de peche (cas des séquences de peche ?) Utiliser une période d'agrégation permet de définir des valeurs moyennes sur une période d'agrégation (par exemple : le mois) indépendamment de la période concernée (par exemple : une année). Exemple : - moyenne mensuelle sur l'année, du nombre d'engin levé par jour : - paramètre : nombre d'engin levé - niveau d'agrégation du PSFM : jour - période concerné : 01/01/XX au 31/12/XX : définie au niveau de l'entité à laquelle est rattachée la mesure (exemple : la marée, l'opération, les caractéristiques d'utilisation, etc.). - période d'agrégation sur la mesure (xxxMeasurement) : mois

Returns:

this.aggregationLevel AggregationLevel

setAggregationLevel

public void setAggregationLevel(AggregationLevel aggregationLevelIn)

Niveau (ou période) d'agrégation de la donnée. Par exemple : - aucune (pas d'agrégation) - jour, - mois, - année - marée - opération - zone de peche (cas des séquences de peche ?) Utiliser une période d'agrégation permet de définir des valeurs moyennes sur une période d'agrégation (par exemple : le mois) indépendamment de la période concernée (par exemple : une année). Exemple : - moyenne mensuelle sur l'année, du nombre d'engin levé par jour : - paramètre : nombre d'engin levé - niveau d'agrégation du PSFM : jour - période concerné : 01/01/XX au 31/12/XX : définie au niveau de l'entité à laquelle est rattachée la mesure (exemple : la marée, l'opération, les caractéristiques d'utilisation, etc.). - période d'agrégation sur la mesure (xxxMeasurement) : mois

Parameters:

aggregationLevelIn - AggregationLevel

getStatus

public Status getStatus()

Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire. - obsolète (=inactif) : '0' - valide (=actif) : '1' - temporaire : '2' - en cours de suppression : '3' - : '4' note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas confondre avec par exemple l'activité d'un navire sur un mois.

Returns:

this.status Status

setStatus

public void setStatus(Status statusIn)

Pour les données du référentiel, information permettant de déterminer si une donnée est valide, obsolète ou temporaire. - obsolète (=inactif) : '0' - valide (=actif) : '1' - temporaire : '2' - en cours de suppression : '3' - : '4' note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas confondre avec par exemple l'activité d'un navire sur un mois.

Parameters:

statusIn - Status

getUnit

public Unit getUnit()

Unité d'une mesure. Nombre de lignes : 30

Returns:

this.unit Unit

setUnit

public void setUnit(Unit unitIn)

Unité d'une mesure. Nombre de lignes : 30

Parameters:

unitIn - Unit

equals

public boolean equals(Object object)

Returns true if the argument is an Pmfm instance and all identifiers for this entity equal the identifiers of the argument entity. Returns false otherwise.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code based on this entity's identifiers.

Overrides:

hashCode in class Object

compareTo

public int compareTo(Pmfm o)

Specified by:

compareTo in interface Comparable<Pmfm>

See Also:

Comparable.compareTo(T)