// 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.adagio.core.dao.administration.programStrategy;

/*
 * #%L
 * SIH-Adagio :: Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2012 - 2014 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.adagio.core.dao.referential.PrecisionType;
import fr.ifremer.adagio.core.dao.referential.gear.Gear;
import fr.ifremer.adagio.core.dao.referential.metier.Metier;
import fr.ifremer.adagio.core.dao.referential.pmfm.Pmfm;
import fr.ifremer.adagio.core.dao.referential.taxon.ReferenceTaxon;
import java.io.Serializable;

/**
 * 
 */
// HibernateEntity.vsl annotations merge-point
public abstract class PmfmStrategy
    implements Serializable, Comparable<PmfmStrategy>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = 301800090645795415L;

    // Generate 6 attributes
    private Integer id;

    /**
     * Identifiant interne. généré par le système.
     * @return this.id Integer
     */
    public Integer getId()
    {
        return this.id;
    }

    /**
     * Identifiant interne. généré par le système.
     * @param idIn Integer
     */
    public void setId(Integer idIn)
    {
        this.id = idIn;
    }

    private Integer acquisitionNumber = Integer.valueOf("1");

    /**
     * 
     * @return this.acquisitionNumber Integer
     */
    public Integer getAcquisitionNumber()
    {
        return this.acquisitionNumber;
    }

    /**
     * 
     * @param acquisitionNumberIn Integer
     */
    public void setAcquisitionNumber(Integer acquisitionNumberIn)
    {
        this.acquisitionNumber = acquisitionNumberIn;
    }

    private Integer rankOrder;

    /**
     * 
     * @return this.rankOrder Integer
     */
    public Integer getRankOrder()
    {
        return this.rankOrder;
    }

    /**
     * 
     * @param rankOrderIn Integer
     */
    public void setRankOrder(Integer rankOrderIn)
    {
        this.rankOrder = rankOrderIn;
    }

    private Boolean isMandatory;

    /**
     * 
     * @return this.isMandatory Boolean
     */
    public Boolean isIsMandatory()
    {
        return this.isMandatory;
    }

    /**
     * 
     * @param isMandatoryIn Boolean
     */
    public void setIsMandatory(Boolean isMandatoryIn)
    {
        this.isMandatory = isMandatoryIn;
    }

    private Float minValue;

    /**
     * 
     * @return this.minValue Float
     */
    public Float getMinValue()
    {
        return this.minValue;
    }

    /**
     * 
     * @param minValueIn Float
     */
    public void setMinValue(Float minValueIn)
    {
        this.minValue = minValueIn;
    }

    private Float maxValue;

    /**
     * 
     * @return this.maxValue Float
     */
    public Float getMaxValue()
    {
        return this.maxValue;
    }

    /**
     * 
     * @param maxValueIn Float
     */
    public void setMaxValue(Float maxValueIn)
    {
        this.maxValue = maxValueIn;
    }

    // Generate 7 associations
    private ReferenceTaxon referenceTaxon;

    /**
     * 
     * @return this.referenceTaxon ReferenceTaxon
     */
    public ReferenceTaxon getReferenceTaxon()
    {
        return this.referenceTaxon;
    }

    /**
     * 
     * @param referenceTaxonIn ReferenceTaxon
     */
    public void setReferenceTaxon(ReferenceTaxon referenceTaxonIn)
    {
        this.referenceTaxon = referenceTaxonIn;
    }

    private Gear gear;

    /**
     * <html>
     * <head>
     * </head>
     * <body>
     * <p>
     * D&#233;fini un engin, non pas engin physique, mais au sens &quot;classe d'engin&quot;.
     * </p>
     * <p>
     * Il est possible de d&#233;finir un arboresence d'engin, au sein d'une meme
     * classification, via les liens d'engin parents/enfants.
     * </p>
     * <p>
     * <br>
     * </p>
     * <p>
     * Exemple, pour la classification 'Engin EU corpus' :
     * </p>
     * <p>
     * * 'corpus effort de p&#234;che'<br>- PAL Palangre de surface (Longliner)<br>
     * </p>
     * <p>
     * - EP1 Engins petits p&#233;lagiques - corpus r&#233;glementaire 685/95
     * </p>
     * <p>
     * * corpus 2 (...)<br>- ...
     * </p>
     * <p>
     * <br>
     * </p>
     * <p>
     * Exemple, pour la classification 'FAO/CISTEP' :<br>* 'chaluts' (code
     * '03.0.0')<br>
     * </p>
     * <p>
     * - 'OTB' 'chalut de fond'<br>
     * </p>
     * <p>
     * - chalut p&#233;lagique
     * </p>
     * <p>
     * - ...<br>* 'Filets'
     * </p>
     * </body>
     * </html>
     * @return this.gear Gear
     */
    public Gear getGear()
    {
        return this.gear;
    }

    /**
     * <html>
     * <head>
     * </head>
     * <body>
     * <p>
     * D&#233;fini un engin, non pas engin physique, mais au sens &quot;classe d'engin&quot;.
     * </p>
     * <p>
     * Il est possible de d&#233;finir un arboresence d'engin, au sein d'une meme
     * classification, via les liens d'engin parents/enfants.
     * </p>
     * <p>
     * <br>
     * </p>
     * <p>
     * Exemple, pour la classification 'Engin EU corpus' :
     * </p>
     * <p>
     * * 'corpus effort de p&#234;che'<br>- PAL Palangre de surface (Longliner)<br>
     * </p>
     * <p>
     * - EP1 Engins petits p&#233;lagiques - corpus r&#233;glementaire 685/95
     * </p>
     * <p>
     * * corpus 2 (...)<br>- ...
     * </p>
     * <p>
     * <br>
     * </p>
     * <p>
     * Exemple, pour la classification 'FAO/CISTEP' :<br>* 'chaluts' (code
     * '03.0.0')<br>
     * </p>
     * <p>
     * - 'OTB' 'chalut de fond'<br>
     * </p>
     * <p>
     * - chalut p&#233;lagique
     * </p>
     * <p>
     * - ...<br>* 'Filets'
     * </p>
     * </body>
     * </html>
     * @param gearIn Gear
     */
    public void setGear(Gear gearIn)
    {
        this.gear = gearIn;
    }

    private PrecisionType precisionType;

    /**
     * Type d'incertitude, par exemple intervalle de confiance ou % d'incertitude
     * @return this.precisionType PrecisionType
     */
    public PrecisionType getPrecisionType()
    {
        return this.precisionType;
    }

    /**
     * Type d'incertitude, par exemple intervalle de confiance ou % d'incertitude
     * @param precisionTypeIn PrecisionType
     */
    public void setPrecisionType(PrecisionType precisionTypeIn)
    {
        this.precisionType = precisionTypeIn;
    }

    private Strategy strategy;

    /**
     * La stratégie définit a priori ce que devront être les données présentes dans le système de
     * l'origine
     * de la collecte des données. Il s'agit de la liste des paramètres à mesurer, ainsi que des
     * méthodes
     * préconisées pour chacun de ces paramètres. La stratégie permet ainsi d'aider à la saisie des
     * données, en personnalisant les écrans, et facilite la consultation rapide du contenu
     * théorique de la
     * base.
     * Par exemple, on pourra avoir les stratégies suivantes :
     * - stratégie "échantillonnage pendant les marées observées"
     * - stratégie "échantillonnage pendant les campagne à la mer"
     * @return this.strategy Strategy
     */
    public Strategy getStrategy()
    {
        return this.strategy;
    }

    /**
     * La stratégie définit a priori ce que devront être les données présentes dans le système de
     * l'origine
     * de la collecte des données. Il s'agit de la liste des paramètres à mesurer, ainsi que des
     * méthodes
     * préconisées pour chacun de ces paramètres. La stratégie permet ainsi d'aider à la saisie des
     * données, en personnalisant les écrans, et facilite la consultation rapide du contenu
     * théorique de la
     * base.
     * Par exemple, on pourra avoir les stratégies suivantes :
     * - stratégie "échantillonnage pendant les marées observées"
     * - stratégie "échantillonnage pendant les campagne à la mer"
     * @param strategyIn Strategy
     */
    public void setStrategy(Strategy strategyIn)
    {
        this.strategy = strategyIn;
    }

    private AcquisitionLevel acquisitionLevel;

    /**
     * Niveau de saisie sur lequel un quadruplet PSFM peut avoir des résultats. Ce niveau de saisie
     * est
     * défini via les stratégies.
     * Exemple :
     * • Opération
     * • Opération de prélèvement
     * • Lot (Quantification de lot ou Classement de lot)
     * • Echantillon
     * Typiquement, le PSFM "mesure par Ichtyomètre de la taille d'un poisson entier" pourra être
     * saisit
     * sur un lot (comme critère de classement) et sur les résultats de mesure sur un échantillon
     * (effectuée en laboratoire). Ce PSFM pourra donc avoir les deux niveaus de saisie suivants :
     * "Lot" et
     * "Echantillon"
     * @return this.acquisitionLevel AcquisitionLevel
     */
    public AcquisitionLevel getAcquisitionLevel()
    {
        return this.acquisitionLevel;
    }

    /**
     * Niveau de saisie sur lequel un quadruplet PSFM peut avoir des résultats. Ce niveau de saisie
     * est
     * défini via les stratégies.
     * Exemple :
     * • Opération
     * • Opération de prélèvement
     * • Lot (Quantification de lot ou Classement de lot)
     * • Echantillon
     * Typiquement, le PSFM "mesure par Ichtyomètre de la taille d'un poisson entier" pourra être
     * saisit
     * sur un lot (comme critère de classement) et sur les résultats de mesure sur un échantillon
     * (effectuée en laboratoire). Ce PSFM pourra donc avoir les deux niveaus de saisie suivants :
     * "Lot" et
     * "Echantillon"
     * @param acquisitionLevelIn AcquisitionLevel
     */
    public void setAcquisitionLevel(AcquisitionLevel acquisitionLevelIn)
    {
        this.acquisitionLevel = acquisitionLevelIn;
    }

    private Metier metier;

    /**
     * <html>
     * <head>
     * </head>
     * <body>
     * <p>
     * M&#233;tier, qui peut etre un m&#233;tier de peche ou non.<br><br>Un
     * m&#233;tier de peche a obligatoirement une esp&#232;ce cible (TaxonGroup) de
     * d&#233;fini, et &#233;ventuellement un engin (Gear).
     * </p>
     * <p>
     * Dans ce cas, le nom (name) et le mn&#233;monique (label) pourront etre
     * d&#233;termin&#233; par la concat&#233;nation de l'engin et de l'esp&#232;ce cible.
     * </p>
     * <p>
     * <br>
     * <br>
     * </p>
     * <p>
     * <u>V2.1 </u>: modification de la gestion des m&#233;tiers : suppression des
     * classes FishingMetierGearType et MetierSpecies : un m&#233;tier est
     * maintenant d&#233;fini directement par Gear et TaxonGroup.<br><br>=&gt; Le
     * r&#233;f&#233;rentiel des engin du m&#233;tier (FishingMetierGearType) est maintenent
     * int&#233;gr&#233; au r&#233;f&#233;rentiel g&#233;n&#233;rique des engins<br>
     * </p>
     * <p>
     * </p>
     * <p>
     * =&gt; Le r&#233;f&#233;rentiel des esp&#232;ces m&#233;tier (MetierSpecies) est maintenent
     * int&#233;gr&#233; au r&#233;f&#233;rentiel g&#233;n&#233;rique des groupes de taxon<br><br>
     * </p>
     * <p>
     * <u>V3 </u>:<br>- Le m&#233;tier de peche n'a pas forc&#233;ment d'engin
     * (optionnel) Ex : AQUNEP
     * </p>
     * <p>
     * (Aquaculture)<br>- le mn&#233;monique et le libell&#233; ne sont plus calcul&#233;s &#224;
     * la vol&#233;e par concat&#233;nation, pour permettre l'utilisation de libell&#233; plus
     * court..
     * </p>
     * </body>
     * </html>
     * @return this.metier Metier
     */
    public Metier getMetier()
    {
        return this.metier;
    }

    /**
     * <html>
     * <head>
     * </head>
     * <body>
     * <p>
     * M&#233;tier, qui peut etre un m&#233;tier de peche ou non.<br><br>Un
     * m&#233;tier de peche a obligatoirement une esp&#232;ce cible (TaxonGroup) de
     * d&#233;fini, et &#233;ventuellement un engin (Gear).
     * </p>
     * <p>
     * Dans ce cas, le nom (name) et le mn&#233;monique (label) pourront etre
     * d&#233;termin&#233; par la concat&#233;nation de l'engin et de l'esp&#232;ce cible.
     * </p>
     * <p>
     * <br>
     * <br>
     * </p>
     * <p>
     * <u>V2.1 </u>: modification de la gestion des m&#233;tiers : suppression des
     * classes FishingMetierGearType et MetierSpecies : un m&#233;tier est
     * maintenant d&#233;fini directement par Gear et TaxonGroup.<br><br>=&gt; Le
     * r&#233;f&#233;rentiel des engin du m&#233;tier (FishingMetierGearType) est maintenent
     * int&#233;gr&#233; au r&#233;f&#233;rentiel g&#233;n&#233;rique des engins<br>
     * </p>
     * <p>
     * </p>
     * <p>
     * =&gt; Le r&#233;f&#233;rentiel des esp&#232;ces m&#233;tier (MetierSpecies) est maintenent
     * int&#233;gr&#233; au r&#233;f&#233;rentiel g&#233;n&#233;rique des groupes de taxon<br><br>
     * </p>
     * <p>
     * <u>V3 </u>:<br>- Le m&#233;tier de peche n'a pas forc&#233;ment d'engin
     * (optionnel) Ex : AQUNEP
     * </p>
     * <p>
     * (Aquaculture)<br>- le mn&#233;monique et le libell&#233; ne sont plus calcul&#233;s &#224;
     * la vol&#233;e par concat&#233;nation, pour permettre l'utilisation de libell&#233; plus
     * court..
     * </p>
     * </body>
     * </html>
     * @param metierIn Metier
     */
    public void setMetier(Metier metierIn)
    {
        this.metier = metierIn;
    }

    private Pmfm 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.
     * @return this.pmfm Pmfm
     */
    public Pmfm getPmfm()
    {
        return this.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.
     * @param pmfmIn Pmfm
     */
    public void setPmfm(Pmfm pmfmIn)
    {
        this.pmfm = pmfmIn;
    }

    /**
     * Returns <code>true</code> if the argument is an PmfmStrategy 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 PmfmStrategy))
        {
            return false;
        }
        final PmfmStrategy that = (PmfmStrategy)object;
        if (this.id == null || that.getId() == null || !this.id.equals(that.getId()))
        {
            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.id == null ? 0 : this.id.hashCode());

        return hashCode;
    }

    /**
     * Constructs new instances of {@link PmfmStrategy}.
     */
    public static final class Factory
    {
        /**
         * Constructs a new instance of {@link PmfmStrategy}.
         * @return new PmfmStrategyImpl()
         */
        public static PmfmStrategy newInstance()
        {
            return new PmfmStrategyImpl();
        }

        /**
         * Constructs a new instance of {@link PmfmStrategy}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param acquisitionNumber Integer
         * @param rankOrder Integer
         * @param isMandatory Boolean
         * @param strategy Strategy
         * @param acquisitionLevel AcquisitionLevel
         * @param pmfm Pmfm
         * @return newInstance
         */
        public static PmfmStrategy newInstance(Integer acquisitionNumber, Integer rankOrder, Boolean isMandatory, Strategy strategy, AcquisitionLevel acquisitionLevel, Pmfm pmfm)
        {
            final PmfmStrategy entity = new PmfmStrategyImpl();
            entity.setAcquisitionNumber(acquisitionNumber);
            entity.setRankOrder(rankOrder);
            entity.setIsMandatory(isMandatory);
            entity.setStrategy(strategy);
            entity.setAcquisitionLevel(acquisitionLevel);
            entity.setPmfm(pmfm);
            return entity;
        }

        /**
         * Constructs a new instance of {@link PmfmStrategy}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param acquisitionNumber Integer
         * @param rankOrder Integer
         * @param isMandatory Boolean
         * @param minValue Float
         * @param maxValue Float
         * @param referenceTaxon ReferenceTaxon
         * @param gear Gear
         * @param precisionType PrecisionType
         * @param strategy Strategy
         * @param acquisitionLevel AcquisitionLevel
         * @param metier Metier
         * @param pmfm Pmfm
         * @return newInstance PmfmStrategy
         */
        public static PmfmStrategy newInstance(Integer acquisitionNumber, Integer rankOrder, Boolean isMandatory, Float minValue, Float maxValue, ReferenceTaxon referenceTaxon, Gear gear, PrecisionType precisionType, Strategy strategy, AcquisitionLevel acquisitionLevel, Metier metier, Pmfm pmfm)
        {
            final PmfmStrategy entity = new PmfmStrategyImpl();
            entity.setAcquisitionNumber(acquisitionNumber);
            entity.setRankOrder(rankOrder);
            entity.setIsMandatory(isMandatory);
            entity.setMinValue(minValue);
            entity.setMaxValue(maxValue);
            entity.setReferenceTaxon(referenceTaxon);
            entity.setGear(gear);
            entity.setPrecisionType(precisionType);
            entity.setStrategy(strategy);
            entity.setAcquisitionLevel(acquisitionLevel);
            entity.setMetier(metier);
            entity.setPmfm(pmfm);
            return entity;
        }
    }

    /**
     * @see Comparable#compareTo
     */
    public int compareTo(PmfmStrategy o)
    {
        int cmp = 0;
        if (this.getId() != null)
        {
            cmp = this.getId().compareTo(o.getId());
        }
        else
        {
            if (this.getAcquisitionNumber() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getAcquisitionNumber().compareTo(o.getAcquisitionNumber()));
            }
            if (this.getRankOrder() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getRankOrder().compareTo(o.getRankOrder()));
            }
            if (this.isIsMandatory() != null)
            {
                cmp = (cmp != 0 ? cmp : this.isIsMandatory().compareTo(o.isIsMandatory()));
            }
            if (this.getMinValue() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getMinValue().compareTo(o.getMinValue()));
            }
            if (this.getMaxValue() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getMaxValue().compareTo(o.getMaxValue()));
            }
        }
        return cmp;
    }
// HibernateEntity.vsl merge-point
// PmfmStrategy.java merge-point
}