// license-header java merge-point
   //
   // Attention: Generated code! Do not modify by hand!
   // Generated by: hibernate/HibernateEntity.vsl in andromda-hibernate-cartridge.
   //
   package fr.ifremer.quadrige2.core.dao.data.sample;
   
   /*-
    * #%L
   * Quadrige2 Core :: Server API
   * %%
   * Copyright (C) 2017 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import fr.ifremer.quadrige2.core.dao.administration.program.Program;
  import fr.ifremer.quadrige2.core.dao.administration.user.Department;
  import fr.ifremer.quadrige2.core.dao.data.samplingoperation.SamplingOperation;
  import fr.ifremer.quadrige2.core.dao.referential.QualityFlag;
  import fr.ifremer.quadrige2.core.dao.referential.Unit;
  import fr.ifremer.quadrige2.core.dao.referential.pmfm.Matrix;
  import fr.ifremer.quadrige2.core.dao.referential.taxon.ReferenceTaxon;
  import fr.ifremer.quadrige2.core.dao.referential.taxon.TaxonGroup;
  import java.io.Serializable;
  import java.sql.Timestamp;
  import java.util.Collection;
  import java.util.Date;
  import java.util.HashSet;
  
  /**
   * Liste les échantillons prélevés lors d'un passage sur un lieu de surveillance.
   */
  // HibernateEntity.vsl annotations merge-point
  public abstract class Sample
      implements Serializable, Comparable<Sample>
  {
      /**
       * The serial version UID of this class. Needed for serialization.
       */
      private static final long serialVersionUID = 8025414281931891516L;
  
      // Generate 12 attributes
      private Integer sampleId;
  
      /**
       * Identifiant interne de l'échantillon
       * @return this.sampleId Integer
       */
      public Integer getSampleId()
      {
          return this.sampleId;
      }
  
      /**
       * Identifiant interne de l'échantillon
       * @param sampleIdIn Integer
       */
      public void setSampleId(Integer sampleIdIn)
      {
          this.sampleId = sampleIdIn;
      }
  
      private String sampleLb;
  
      /**
       * Mmnémonique de l'échantillon
       * @return this.sampleLb String
       */
      public String getSampleLb()
      {
          return this.sampleLb;
      }
  
      /**
       * Mmnémonique de l'échantillon
       * @param sampleLbIn String
       */
      public void setSampleLb(String sampleLbIn)
      {
          this.sampleLb = sampleLbIn;
      }
  
      private Double sampleNumberIndiv;
  
      /**
       * Nombre d'individus constituant l'échantillon. Ce nombre permet de connaître le nombre
      * d'individus constituant la grille de saisie.
      * @return this.sampleNumberIndiv Double
      */
     public Double getSampleNumberIndiv()
     {
         return this.sampleNumberIndiv;
     }
 
     /**
      * Nombre d'individus constituant l'échantillon. Ce nombre permet de connaître le nombre
      * d'individus constituant la grille de saisie.
      * @param sampleNumberIndivIn Double
      */
     public void setSampleNumberIndiv(Double sampleNumberIndivIn)
     {
         this.sampleNumberIndiv = sampleNumberIndivIn;
     }
 
     private Float sampleSize;
 
     /**
      * 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.
      * @return this.sampleSize Float
      */
     public Float getSampleSize()
     {
         return this.sampleSize;
     }
 
     /**
      * 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.
      * @param sampleSizeIn Float
      */
     public void setSampleSize(Float sampleSizeIn)
     {
         this.sampleSize = sampleSizeIn;
     }
 
     private String sampleCm;
 
     /**
      * Commentaire de l'échantillon
      * @return this.sampleCm String
      */
     public String getSampleCm()
     {
         return this.sampleCm;
     }
 
     /**
      * Commentaire de l'échantillon
      * @param sampleCmIn String
      */
     public void setSampleCm(String sampleCmIn)
     {
         this.sampleCm = sampleCmIn;
     }
 
     private Date sampleControlDt;
 
     /**
      * Date de contrôle de l'échantillon
      * @return this.sampleControlDt Date
      */
     public Date getSampleControlDt()
     {
         return this.sampleControlDt;
     }
 
     /**
      * Date de contrôle de l'échantillon
      * @param sampleControlDtIn Date
      */
     public void setSampleControlDt(Date sampleControlDtIn)
     {
         this.sampleControlDt = sampleControlDtIn;
     }
 
     private Date sampleValidDt;
 
     /**
      * Date de validation de l'échantillon
      * @return this.sampleValidDt Date
      */
     public Date getSampleValidDt()
     {
         return this.sampleValidDt;
     }
 
     /**
      * Date de validation de l'échantillon
      * @param sampleValidDtIn Date
      */
     public void setSampleValidDt(Date sampleValidDtIn)
     {
         this.sampleValidDt = sampleValidDtIn;
     }
 
     private Date sampleQualifDt;
 
     /**
      * Date de qualification de l'échantillon
      * @return this.sampleQualifDt Date
      */
     public Date getSampleQualifDt()
     {
         return this.sampleQualifDt;
     }
 
     /**
      * Date de qualification de l'échantillon
      * @param sampleQualifDtIn Date
      */
     public void setSampleQualifDt(Date sampleQualifDtIn)
     {
         this.sampleQualifDt = sampleQualifDtIn;
     }
 
     private String sampleQualifCm;
 
     /**
      * Commentaire de qualification
      * @return this.sampleQualifCm String
      */
     public String getSampleQualifCm()
     {
         return this.sampleQualifCm;
     }
 
     /**
      * Commentaire de qualification
      * @param sampleQualifCmIn String
      */
     public void setSampleQualifCm(String sampleQualifCmIn)
     {
         this.sampleQualifCm = sampleQualifCmIn;
     }
 
     private String sampleScope;
 
     /**
      * Vrai si l'étape de qualification est globale, faux si des éléments fils ou résultats n'ont
      * pas la même étape
      * @return this.sampleScope String
      */
     public String getSampleScope()
     {
         return this.sampleScope;
     }
 
     /**
      * Vrai si l'étape de qualification est globale, faux si des éléments fils ou résultats n'ont
      * pas la même étape
      * @param sampleScopeIn String
      */
     public void setSampleScope(String sampleScopeIn)
     {
         this.sampleScope = sampleScopeIn;
     }
 
     private String sampleHasMeas;
 
     /**
      * Vrai si l'élément a des résultats de mesure, dénombrement ou fichier
      * @return this.sampleHasMeas String
      */
     public String getSampleHasMeas()
     {
         return this.sampleHasMeas;
     }
 
     /**
      * Vrai si l'élément a des résultats de mesure, dénombrement ou fichier
      * @param sampleHasMeasIn String
      */
     public void setSampleHasMeas(String sampleHasMeasIn)
     {
         this.sampleHasMeas = sampleHasMeasIn;
     }
 
     private Timestamp updateDt;
 
     /**
      * Date de modification de l'objet, mise à jour par le système
      * @return this.updateDt Timestamp
      */
     public Timestamp getUpdateDt()
     {
         return this.updateDt;
     }
 
     /**
      * Date de modification de l'objet, mise à jour par le système
      * @param updateDtIn Timestamp
      */
     public void setUpdateDt(Timestamp updateDtIn)
     {
         this.updateDt = updateDtIn;
     }
 
     // Generate 11 associations
     private QualityFlag qualityFlag;
 
     /**
      * Liste des niveaux de qualification.
      * @return this.qualityFlag QualityFlag
      */
     public QualityFlag getQualityFlag()
     {
         return this.qualityFlag;
     }
 
     /**
      * Liste des niveaux de qualification.
      * @param qualityFlagIn QualityFlag
      */
     public void setQualityFlag(QualityFlag qualityFlagIn)
     {
         this.qualityFlag = qualityFlagIn;
     }
 
     private TaxonGroup taxonGroup;
 
     /**
      * Liste l'ensemble de taxons ayant les mêmes caractéristiques pour le critère pris en compte.
      * @return this.taxonGroup TaxonGroup
      */
     public TaxonGroup getTaxonGroup()
     {
         return this.taxonGroup;
     }
 
     /**
      * Liste l'ensemble de taxons ayant les mêmes caractéristiques pour le critère pris en compte.
      * @param taxonGroupIn TaxonGroup
      */
     public void setTaxonGroup(TaxonGroup taxonGroupIn)
     {
         this.taxonGroup = taxonGroupIn;
     }
 
     private Unit sizeUnit;
 
     /**
      * Liste l'ensemble des unités de mesure.
      * @return this.sizeUnit Unit
      */
     public Unit getSizeUnit()
     {
         return this.sizeUnit;
     }
 
     /**
      * Liste l'ensemble des unités de mesure.
      * @param sizeUnitIn Unit
      */
     public void setSizeUnit(Unit sizeUnitIn)
     {
         this.sizeUnit = sizeUnitIn;
     }
 
     private Collection<Program> programs = new HashSet<Program>();
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @return this.programs Collection<Program>
      */
     public Collection<Program> getPrograms()
     {
         return this.programs;
     }
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @param programsIn Collection<Program>
      */
     public void setPrograms(Collection<Program> programsIn)
     {
         this.programs = programsIn;
     }
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @param elementToAdd Program
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addPrograms(Program elementToAdd)
     {
         return this.programs.add(elementToAdd);
     }
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @param elementToRemove Program
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removePrograms(Program elementToRemove)
     {
         return this.programs.remove(elementToRemove);
     }
 
     private Department recorderDepartment;
 
     /**
      * Liste les départements ou services auxquels sont rattachés les agents
      * @return this.recorderDepartment Department
      */
     public Department getRecorderDepartment()
     {
         return this.recorderDepartment;
     }
 
     /**
      * Liste les départements ou services auxquels sont rattachés les agents
      * @param recorderDepartmentIn Department
      */
     public void setRecorderDepartment(Department recorderDepartmentIn)
     {
         this.recorderDepartment = recorderDepartmentIn;
     }
 
     private SamplingOperation samplingOperation;
 
     /**
      * Liste les prélévements effectués lors d'un passage.
      * @return this.samplingOperation SamplingOperation
      */
     public SamplingOperation getSamplingOperation()
     {
         return this.samplingOperation;
     }
 
     /**
      * Liste les prélévements effectués lors d'un passage.
      * @param samplingOperationIn SamplingOperation
      */
     public void setSamplingOperation(SamplingOperation samplingOperationIn)
     {
         this.samplingOperation = samplingOperationIn;
     }
 
     private Matrix matrix;
 
     /**
      * Support utilisé pour mesurer un paramètre.
      * @return this.matrix Matrix
      */
     public Matrix getMatrix()
     {
         return this.matrix;
     }
 
     /**
      * Support utilisé pour mesurer un paramètre.
      * @param matrixIn Matrix
      */
     public void setMatrix(Matrix matrixIn)
     {
         this.matrix = matrixIn;
     }
 
     private ReferenceTaxon referenceTaxon;
 
     /**
      * Liste des taxons qui sont la référence.
      * l'ID référent est indépendant des ID taxon car les taxons peuvent être référents à un moment
      * et ne
      * plus l'être par la suite.
      * Toutes les données du système doivent donc être reliées au référent et non au taxon qui sont
      * référents à un moment mais ne peuvent plus l'être par la suite.
      * Le fonctionnement dans la table TAXON_NAME est le suivant :
      * - REF_TAXON_ID est toujours renseigné
      * - si TAXON_NAME_IS_REFER est à vrai, il s'agit d'un taxon référent (toujours le cas s'il
      * s'agit d'un
      * taxon virtuel)
      * - sinon c'est un synonyme
      * Un taxon référent qui devient synonyme voit donc son statut TAXON_NAME_IS_REFER changer et le
      * nouveau taxon référent qui le remplace récupère l'information REF_TAXON_ID
      * NB : c'était le comportement initialement prévu.
      * En réalité, lorsqu'un taxon référent T1-R1 devient synonyme d'un nouveau taxon référent T2,
      * le taxon
      * T2 prend un nouveau code référent R2 et donc le taxon T1 est lié à R2 (et tous les synonymes
      * et les
      * résultats qu'il pouvait avoir).
      * Ce mécanisme a été adopté car il fallait distinguer 2 cas :
      * 1- cas d'un taxon référent T1-R1 qui devient synonyme d'un référent qu'on crée T2 : on aurait
      * alors
      * pu utiliser le même REF_TAXON_ID R1 au lieu d'en créer un et ne pas mettre à jour les autres
      * synonymes, résultats...
      * 2- cas d'un taxon référent T1-R1 qui devient synonyme d'un référent qui existe déjà T2-R2 (et
      * qui
      * aurait déjà d'autres synonymes, résultats...), dans ce cas le remplacement de la référence R1
      * pour
      * R2 est nécessaire
      * La modélisation pourrait être revue car la table REFENCE_TAXON ne se justifie alors plus, on
      * pourrait directement utiliser une référence à la colonne TAXON_NAME_ID pour désigner les
      * référents
      * @return this.referenceTaxon ReferenceTaxon
      */
     public ReferenceTaxon getReferenceTaxon()
     {
         return this.referenceTaxon;
     }
 
     /**
      * Liste des taxons qui sont la référence.
      * l'ID référent est indépendant des ID taxon car les taxons peuvent être référents à un moment
      * et ne
      * plus l'être par la suite.
      * Toutes les données du système doivent donc être reliées au référent et non au taxon qui sont
      * référents à un moment mais ne peuvent plus l'être par la suite.
      * Le fonctionnement dans la table TAXON_NAME est le suivant :
      * - REF_TAXON_ID est toujours renseigné
      * - si TAXON_NAME_IS_REFER est à vrai, il s'agit d'un taxon référent (toujours le cas s'il
      * s'agit d'un
      * taxon virtuel)
      * - sinon c'est un synonyme
      * Un taxon référent qui devient synonyme voit donc son statut TAXON_NAME_IS_REFER changer et le
      * nouveau taxon référent qui le remplace récupère l'information REF_TAXON_ID
      * NB : c'était le comportement initialement prévu.
      * En réalité, lorsqu'un taxon référent T1-R1 devient synonyme d'un nouveau taxon référent T2,
      * le taxon
      * T2 prend un nouveau code référent R2 et donc le taxon T1 est lié à R2 (et tous les synonymes
      * et les
      * résultats qu'il pouvait avoir).
      * Ce mécanisme a été adopté car il fallait distinguer 2 cas :
      * 1- cas d'un taxon référent T1-R1 qui devient synonyme d'un référent qu'on crée T2 : on aurait
      * alors
      * pu utiliser le même REF_TAXON_ID R1 au lieu d'en créer un et ne pas mettre à jour les autres
      * synonymes, résultats...
      * 2- cas d'un taxon référent T1-R1 qui devient synonyme d'un référent qui existe déjà T2-R2 (et
      * qui
      * aurait déjà d'autres synonymes, résultats...), dans ce cas le remplacement de la référence R1
      * pour
      * R2 est nécessaire
      * La modélisation pourrait être revue car la table REFENCE_TAXON ne se justifie alors plus, on
      * pourrait directement utiliser une référence à la colonne TAXON_NAME_ID pour désigner les
      * référents
      * @param referenceTaxonIn ReferenceTaxon
      */
     public void setReferenceTaxon(ReferenceTaxon referenceTaxonIn)
     {
         this.referenceTaxon = referenceTaxonIn;
     }
 
     /**
      * Returns <code>true</code> if the argument is an Sample instance and all identifiers for this entity
      * equal the identifiers of the argument entity. Returns <code>false</code> otherwise.
      */
     @Override
     public boolean equals(Object object)
     {
         if (this == object)
         {
             return true;
         }
         if (!(object instanceof Sample))
         {
             return false;
         }
         final Sample that = (Sample)object;
         if (this.sampleId == null || that.getSampleId() == null || !this.sampleId.equals(that.getSampleId()))
         {
             return false;
         }
         return true;
     }
 
     /**
      * Returns a hash code based on this entity's identifiers.
      */
     @Override
     public int hashCode()
     {
         int hashCode = 0;
         hashCode = 29 * hashCode + (this.sampleId == null ? 0 : this.sampleId.hashCode());
 
         return hashCode;
     }
 
     /**
      * Constructs new instances of {@link Sample}.
      */
     public static final class Factory
     {
         /**
          * Constructs a new instance of {@link Sample}.
          * @return new SampleImpl()
          */
         public static Sample newInstance()
         {
             return new SampleImpl();
         }
 
         /**
          * Constructs a new instance of {@link Sample}, taking all required and/or
          * read-only properties as arguments, except for identifiers.
          * @param updateDt Timestamp
          * @param qualityFlag QualityFlag
          * @param recorderDepartment Department
          * @param samplingOperation SamplingOperation
          * @param matrix Matrix
          * @return newInstance
          */
         public static Sample newInstance(Timestamp updateDt, QualityFlag qualityFlag, Department recorderDepartment, SamplingOperation samplingOperation, Matrix matrix)
         {
             final Sample entity = new SampleImpl();
             entity.setUpdateDt(updateDt);
             entity.setQualityFlag(qualityFlag);
             entity.setRecorderDepartment(recorderDepartment);
             entity.setSamplingOperation(samplingOperation);
             entity.setMatrix(matrix);
             return entity;
         }
 
         /**
          * Constructs a new instance of {@link Sample}, taking all possible properties
          * (except the identifier(s))as arguments.
          * @param sampleLb String
          * @param sampleNumberIndiv Double
          * @param sampleSize Float
          * @param sampleCm String
          * @param sampleControlDt Date
          * @param sampleValidDt Date
          * @param sampleQualifDt Date
          * @param sampleQualifCm String
          * @param sampleScope String
          * @param sampleHasMeas String
          * @param updateDt Timestamp
          * @param qualityFlag QualityFlag
          * @param taxonGroup TaxonGroup
          * @param sizeUnit Unit
          * @param programs Collection<Program>
          * @param recorderDepartment Department
          * @param samplingOperation SamplingOperation
          * @param matrix Matrix
          * @param referenceTaxon ReferenceTaxon
          * @return newInstance Sample
          */
         public static Sample newInstance(String sampleLb, Double sampleNumberIndiv, Float sampleSize, String sampleCm, Date sampleControlDt, Date sampleValidDt, Date sampleQualifDt, String sampleQualifCm, String sampleScope, String sampleHasMeas, Timestamp updateDt, QualityFlag qualityFlag, TaxonGroup taxonGroup, Unit sizeUnit, Collection<Program> programs, Department recorderDepartment, SamplingOperation samplingOperation, Matrix matrix, ReferenceTaxon referenceTaxon)
         {
             final Sample entity = new SampleImpl();
             entity.setSampleLb(sampleLb);
             entity.setSampleNumberIndiv(sampleNumberIndiv);
             entity.setSampleSize(sampleSize);
             entity.setSampleCm(sampleCm);
             entity.setSampleControlDt(sampleControlDt);
             entity.setSampleValidDt(sampleValidDt);
             entity.setSampleQualifDt(sampleQualifDt);
             entity.setSampleQualifCm(sampleQualifCm);
             entity.setSampleScope(sampleScope);
             entity.setSampleHasMeas(sampleHasMeas);
             entity.setUpdateDt(updateDt);
             entity.setQualityFlag(qualityFlag);
             entity.setTaxonGroup(taxonGroup);
             entity.setSizeUnit(sizeUnit);
             entity.setPrograms(programs);
             entity.setRecorderDepartment(recorderDepartment);
             entity.setSamplingOperation(samplingOperation);
             entity.setMatrix(matrix);
             entity.setReferenceTaxon(referenceTaxon);
             return entity;
         }
     }
 
     /**
      * @see Comparable#compareTo
      */
     public int compareTo(Sample o)
     {
         int cmp = 0;
         if (this.getSampleId() != null)
         {
             cmp = this.getSampleId().compareTo(o.getSampleId());
         }
         else
         {
             if (this.getSampleLb() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleLb().compareTo(o.getSampleLb()));
             }
             if (this.getSampleNumberIndiv() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleNumberIndiv().compareTo(o.getSampleNumberIndiv()));
             }
             if (this.getSampleSize() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleSize().compareTo(o.getSampleSize()));
             }
             if (this.getSampleCm() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleCm().compareTo(o.getSampleCm()));
             }
             if (this.getSampleControlDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleControlDt().compareTo(o.getSampleControlDt()));
             }
             if (this.getSampleValidDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleValidDt().compareTo(o.getSampleValidDt()));
             }
             if (this.getSampleQualifDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleQualifDt().compareTo(o.getSampleQualifDt()));
             }
             if (this.getSampleQualifCm() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleQualifCm().compareTo(o.getSampleQualifCm()));
             }
             if (this.getSampleScope() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleScope().compareTo(o.getSampleScope()));
             }
             if (this.getSampleHasMeas() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getSampleHasMeas().compareTo(o.getSampleHasMeas()));
             }
             if (this.getUpdateDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getUpdateDt().compareTo(o.getUpdateDt()));
             }
         }
         return cmp;
     }
 // HibernateEntity.vsl merge-point
 // Sample.java merge-point
 }