Sample (SIH-Adagio Core 3.3.1-rev-401 API)

java.lang.Object
- fr.ifremer.adagio.core.dao.data.sample.Sample

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SampleImpl
```
public abstract class Sample
extends Object
implements Serializable
```
Un prélèvement représente un (et un seul) support, prélevé au cours d'une opération de peche, d'un échantillonnage au débarquement ou d'une vente. Il s'agit de la partie qui est recueillie pour analyse ou dénombrement.

Un prélèvement est rattaché à une opération de peche ou un groupe d'opérations, un débarquement ou à une vente. Il peut être en plus rattaché à un des lots échantillonnés (le lot de provenance).

Dans le cas des marées observées en mer, un prlèvement correspond à un individu, dont le support est, par exemple :

- crustacé (crevette...)

- poisson (merlu, sardine...)

- gastéropode (bigorneau, littorine...)

- echinoderme (oursin...)

- etc.

Le nombre d'individu, généralement égal à 1, permet de constituer des prélèvement de plusieurs individu (dès lors qu'il sont ne meme anture). Chaque résultat de mesure (SampleMeasurement) pourra identifié l'individu concerné par la mesure, par une numéro din'dividu.

Un mnémonique, représentant généralement l'étiquette collée sur le sachet contenant le prélèvement, permet d"identifier le prélèvement de manière simple, notamment en laboratoire pour la saisie des lectures d'age, etc..

Par exemple de prélèvement :

- un poisson, d'une espèce donnée, sur lequel est prélevé un otholithe, et/ou des écailes afin de réaliser une lecture d'age.

- un cétacé, issu d'un lot, sur lesquels doit être effectué des analyses d'age, de taille,

- etc.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Sample.Factory
Constructs new instances of Sample.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Sample.Factory` Constructs new instances of `Sample`.

Constructor Summary

Constructors
Constructor and Description

Sample()

Constructors
Constructor and Description
`Sample()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` This entity does not have any identifiers and is not extending any other entity, so this method will only return `true` if the argument reference and `this` refer to the same object.
`Batch`	`getBatch()` Lot auquel appartient l'échantillon analysé (optionnel).
`Collection<Sample>`	`getChildSamples()`
`String`	`getComments()` Commentaire libre concernant l'échantillon.
`Date`	`getControlDate()`
`Date`	`getCreationDate()`
`Collection<FishingArea>`	`getFishingAreas()` Zone de peche du prélèvement (utilisé surtout dans le cas d'un prélèvement hors marée/débarquement ou vente - exemple : prélèvement en poissonnerie)
`FishingOperation`	`getFishingOperation()` Opération de prélèvement à laquelle est rattaché l'échantillon analysé.
`Integer`	`getId()` Identifiant de l'échantillon.
`Short`	`getIndividualCount()` Nombre d'individus constituant l'échantillon.
`String`	`getLabel()` Mnémonique du prélèvement.
`Matrix`	`getMatrix()` Support de l'échantillon.
`Sample`	`getParentSample()` Parent sample.
`Program`	`getProgram()`
`String`	`getQualificationComments()`
`Date`	`getQualificationDate()`
`QualityFlag`	`getQualityFlag()` Niveau de qualité de la donnée.
`Department`	`getRecorderDepartment()`
`Person`	`getRecorderPerson()`
`ReferenceTaxon`	`getReferenceTaxon()` Taxon (espèce scientifique) caractéristant l'échantillon (optionnel)
`Date`	`getSampleDate()` Jour du prélèvement (heure optionnelle).
`Collection<SampleMeasurement>`	`getSampleMeasurements()`
`Float`	`getSize()` La taille de l'échantillon peut représenter une surface ou un volume suivant les cas.
`Unit`	`getSizeUnit()` Unité associée à la valeur de la taille du prélèvement.
`String`	`getSynchronizationStatus()` Etat de synchronisation (en cours, terminé, en attente de synchro, supprimé).
`TaxonGroup`	`getTaxonGroup()` Groupe de taxon (généralement espèce commerciale) caractéristant l'échantillon (optionnel)
`Timestamp`	`getUpdateDate()`
`Date`	`getValidationDate()`
`int`	`hashCode()` Returns a hash code based on this entity's identifiers.
`void`	`setBatch(Batch batch)`
`void`	`setChildSamples(Collection<Sample> childSamples)`
`void`	`setComments(String comments)`
`void`	`setControlDate(Date controlDate)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setFishingAreas(Collection<FishingArea> fishingAreas)`
`void`	`setFishingOperation(FishingOperation fishingOperation)`
`void`	`setId(Integer id)`
`void`	`setIndividualCount(Short individualCount)`
`void`	`setLabel(String label)`
`void`	`setMatrix(Matrix matrix)`
`void`	`setParentSample(Sample parentSample)`
`void`	`setProgram(Program program)`
`void`	`setQualificationComments(String qualificationComments)`
`void`	`setQualificationDate(Date qualificationDate)`
`void`	`setQualityFlag(QualityFlag qualityFlag)`
`void`	`setRecorderDepartment(Department recorderDepartment)`
`void`	`setRecorderPerson(Person recorderPerson)`
`void`	`setReferenceTaxon(ReferenceTaxon referenceTaxon)`
`void`	`setSampleDate(Date sampleDate)`
`void`	`setSampleMeasurements(Collection<SampleMeasurement> sampleMeasurements)`
`void`	`setSize(Float size)`
`void`	`setSizeUnit(Unit sizeUnit)`
`void`	`setSynchronizationStatus(String synchronizationStatus)`
`void`	`setTaxonGroup(TaxonGroup taxonGroup)`
`void`	`setUpdateDate(Timestamp updateDate)`
`void`	`setValidationDate(Date validationDate)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Sample
```
public Sample()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Identifiant de l'échantillon. Généré par le système.
  - setId
```
public void setId(Integer id)
```
  - getLabel
```
public String getLabel()
```
    Mnémonique du prélèvement. Par exemple, il peut s'agir d'un code propre à chaque programme : pour les marées observée, par exemple, il s'agira d'une étiquette permettant d'identifier l'échantillon sur le terrain puis en laboratoire.
    
    Autant que possible, le mnémonique devra etre unique pour tous le système, ou à défaut unique au sein de la marée, du débarquement, de la vente ou de la campagne.
    
    Nomenclature retenue à l'issu des spécifications Allegro V3 : ____
    
    Avec :
    
    - : date de l’observation au format AAAMMJJ. La date est issue (suivant la donnée mère rattachée) :
    
    * de la date de début de l’opération de pêche ou du groupe d’opérations (si période du groupe d’opération n’a pas été renseigné : prendre la date de début de la marée)
    
    * ou de la date de débarquement,
    
    * ou de la date de la vente.
    
    - : il s’agit des initiales déjà saisit par l’utilisateur (cf variante précédente).
    
    - : mnémonique du lieu d’observation, si présent, ou libellé sinon. Le lieu d’observation est issu (suivant la donnée mère rattachée) :
    
    * pour une opération de pêche ou un groupe d’opérations, il s’agit du port de départ de la marée,
    
    * pour un débarquement, du lieu de débarquement
    
    * pour une vente, du lieu de la vente
    
    - : suivant la donnée mère rattachée :
    
    * ‘G’ (=Ground) si donnée mère rattachée est un débarquement ou une vente ;
    
    * ‘S’ (=Sea) si donnée mère rattachée est une opération de pêche ou à une groupe d’opérations.
    
    - : Il s’agit d’un numéro au format NNN (sur trois caractère. Exemple : « 001 »), auto-incrémentée (valeur maximale connue + 1) de manière à être unique au sein de (suivant la donnée mère rattachée) :
    
    * la marée, si la donnée mère rattachée est une opération de pêche ou un groupe d’opérations
    
    * ou du débarquement,
    
    * ou de la vente
  - setLabel
```
public void setLabel(String label)
```
  - getSampleDate
```
public Date getSampleDate()
```
    Jour du prélèvement (heure optionnelle).
  - setSampleDate
```
public void setSampleDate(Date sampleDate)
```
  - getIndividualCount
```
public Short getIndividualCount()
```
    Nombre d'individus constituant l'échantillon.
  - setIndividualCount
```
public void setIndividualCount(Short individualCount)
```
  - getSize
```
public Float getSize()
```
    La taille de l'échantillon peut représenter une surface ou un volume suivant les cas. Il peut aussi s'agir du nombre d'individus entrant dans l'homogénat.
  - setSize
```
public void setSize(Float size)
```
  - getSynchronizationStatus
```
public String getSynchronizationStatus()
```
    Etat de synchronisation (en cours, terminé, en attente de synchro, supprimé). Seulement visible dans la base locale.
  - setSynchronizationStatus
```
public void setSynchronizationStatus(String synchronizationStatus)
```
  - getComments
```
public String getComments()
```
    Commentaire libre concernant l'échantillon.
  - setComments
```
public void setComments(String comments)
```
  - getCreationDate
```
public Date getCreationDate()
```
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
  - getControlDate
```
public Date getControlDate()
```
  - setControlDate
```
public void setControlDate(Date controlDate)
```
  - getValidationDate
```
public Date getValidationDate()
```
  - setValidationDate
```
public void setValidationDate(Date validationDate)
```
  - getQualificationDate
```
public Date getQualificationDate()
```
  - setQualificationDate
```
public void setQualificationDate(Date qualificationDate)
```
  - getQualificationComments
```
public String getQualificationComments()
```
  - setQualificationComments
```
public void setQualificationComments(String qualificationComments)
```
  - getUpdateDate
```
public Timestamp getUpdateDate()
```
  - setUpdateDate
```
public void setUpdateDate(Timestamp updateDate)
```
  - getFishingAreas
```
public Collection<FishingArea> getFishingAreas()
```
    Zone de peche du prélèvement (utilisé surtout dans le cas d'un prélèvement hors marée/débarquement ou vente - exemple : prélèvement en poissonnerie)
  - setFishingAreas
```
public void setFishingAreas(Collection<FishingArea> fishingAreas)
```
  - getFishingOperation
```
public FishingOperation getFishingOperation()
```
    Opération de prélèvement à laquelle est rattaché l'échantillon analysé.
  - setFishingOperation
```
public void setFishingOperation(FishingOperation fishingOperation)
```
  - getMatrix
```
public Matrix getMatrix()
```
    Support de l'échantillon.
  - setMatrix
```
public void setMatrix(Matrix matrix)
```
  - getRecorderDepartment
```
public Department getRecorderDepartment()
```
  - setRecorderDepartment
```
public void setRecorderDepartment(Department recorderDepartment)
```
  - getProgram
```
public Program getProgram()
```
  - setProgram
```
public void setProgram(Program program)
```
  - getParentSample
```
public Sample getParentSample()
```
    Parent sample. Use in MerluMed.
    
    Ex : un poisson peut avoir dans sont estomac plusieurs autres poissons.
  - setParentSample
```
public void setParentSample(Sample parentSample)
```
  - getChildSamples
```
public Collection<Sample> getChildSamples()
```
  - setChildSamples
```
public void setChildSamples(Collection<Sample> childSamples)
```
  - getReferenceTaxon
```
public ReferenceTaxon getReferenceTaxon()
```
    Taxon (espèce scientifique) caractéristant l'échantillon (optionnel)
  - setReferenceTaxon
```
public void setReferenceTaxon(ReferenceTaxon referenceTaxon)
```
  - getTaxonGroup
```
public TaxonGroup getTaxonGroup()
```
    Groupe de taxon (généralement espèce commerciale) caractéristant l'échantillon (optionnel)
  - setTaxonGroup
```
public void setTaxonGroup(TaxonGroup taxonGroup)
```
  - getQualityFlag
```
public QualityFlag getQualityFlag()
```
    Niveau de qualité de la donnée.
    
    "Non qualifiée" par défaut
  - setQualityFlag
```
public void setQualityFlag(QualityFlag qualityFlag)
```
  - getRecorderPerson
```
public Person getRecorderPerson()
```
  - setRecorderPerson
```
public void setRecorderPerson(Person recorderPerson)
```
  - getSizeUnit
```
public Unit getSizeUnit()
```
    Unité associée à la valeur de la taille du prélèvement.
  - setSizeUnit
```
public void setSizeUnit(Unit sizeUnit)
```
  - getBatch
```
public Batch getBatch()
```
    Lot auquel appartient l'échantillon analysé (optionnel).
  - setBatch
```
public void setBatch(Batch batch)
```
  - getSampleMeasurements
```
public Collection<SampleMeasurement> getSampleMeasurements()
```
  - setSampleMeasurements
```
public void setSampleMeasurements(Collection<SampleMeasurement> sampleMeasurements)
```
  - equals
```
public boolean equals(Object object)
```
    This entity does not have any identifiers and is not extending any other entity, so this method will only return true if the argument reference and this refer to the same object.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Returns a hash code based on this entity's identifiers.
    
    Overrides:
    
    hashCode in class Object

Class Sample

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Sample

Method Detail

getId

setId

getLabel

setLabel

getSampleDate

setSampleDate

getIndividualCount

setIndividualCount

getSize

setSize

getSynchronizationStatus

setSynchronizationStatus

getComments

setComments

getCreationDate

setCreationDate

getControlDate

setControlDate

getValidationDate

setValidationDate

getQualificationDate

setQualificationDate

getQualificationComments

setQualificationComments

getUpdateDate

setUpdateDate

getFishingAreas

setFishingAreas

getFishingOperation

setFishingOperation

getMatrix

setMatrix

getRecorderDepartment

setRecorderDepartment

getProgram

setProgram

getParentSample

setParentSample

getChildSamples

setChildSamples

getReferenceTaxon

setReferenceTaxon

getTaxonGroup

setTaxonGroup

getQualityFlag

setQualityFlag

getRecorderPerson

setRecorderPerson

getSizeUnit

setSizeUnit

getBatch

setBatch

getSampleMeasurements

setSampleMeasurements

equals

hashCode