// 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.referential.taxon;

/*
 * #%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 java.io.Serializable;
import java.sql.Timestamp;

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

    private VirtualComponentPK virtualComponentPk;

    /**
     * Get the composite primary key identifier class
     * @return virtualComponentPk
     */
    public VirtualComponentPK getVirtualComponentPk()
    {
        return this.virtualComponentPk;
    }

    /**
     * Set the composite primary key identifier class
     * @param virtualComponentPkIn
     */
    public void setVirtualComponentPk(VirtualComponentPK virtualComponentPkIn) {
        this.virtualComponentPk = virtualComponentPkIn;
    }

    // Generate 1 attributes
    private Timestamp updateDate;

    /**
     * 
     * @return this.updateDate Timestamp
     */
    public Timestamp getUpdateDate()
    {
        return this.updateDate;
    }

    /**
     * 
     * @param updateDateIn Timestamp
     */
    public void setUpdateDate(Timestamp updateDateIn)
    {
        this.updateDate = updateDateIn;
    }

    // Generate 2 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 TaxonName taxonName;

    /**
     * Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique,
     * un nom
     * de taxon, un code et éventuellement un auteur et une date.
     * Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes.
     * On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin
     * référent).
     * Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
     * @return this.taxonName TaxonName
     */
    public TaxonName getTaxonName()
    {
        return this.taxonName;
    }

    /**
     * Classe regroupant les taxons. Il s'agit en fait d'une combinaison entre un rang taxinomique,
     * un nom
     * de taxon, un code et éventuellement un auteur et une date.
     * Cette classe regroupe les taxons valides, provisoires, obsolètes, virtuels et les synonymes.
     * On garde l'historique du passage en taxon valide, puis du passage en synonyme (date de fin
     * référent).
     * Dans COST : "Use the FAO reference list ftp://ftp.fao.org/FI/stat/data/ASFIS_sp.zip"
     * @param taxonNameIn TaxonName
     */
    public void setTaxonName(TaxonName taxonNameIn)
    {
        this.taxonName = taxonNameIn;
    }

    /**
     * This entity does not have any identifiers
     * and is not extending any other entity,
     * so this method will only return <code>true</code> if the argument reference and <code>this</code>
     * refer to the same object.
     */
    @Override
    public boolean equals(Object object)
    {
        return super.equals(object);
    }

    /**
     * This entity does not have any identifiers
     * and is not extending any other entity,
     * so this method will only take the identifiers of this entity into account when calculating the hash code.
     */
    @Override
    public int hashCode()
    {
        return super.hashCode();
    }

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


        /**
         * Constructs a new instance of {@link VirtualComponent}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param updateDate Timestamp
         * @param referenceTaxon ReferenceTaxon
         * @param taxonName TaxonName
         * @return newInstance VirtualComponent
         */
        public static VirtualComponent newInstance(Timestamp updateDate, ReferenceTaxon referenceTaxon, TaxonName taxonName)
        {
            final VirtualComponent entity = new VirtualComponentImpl();
            entity.setUpdateDate(updateDate);
            entity.setReferenceTaxon(referenceTaxon);
            entity.setTaxonName(taxonName);
            return entity;
        }
    }

    /**
     * @see Comparable#compareTo
     */
    public int compareTo(VirtualComponent o)
    {
        int cmp = 0;
        if (this.getVirtualComponentPk() != null)
        {
            cmp = this.getVirtualComponentPk().compareTo(o.getVirtualComponentPk());
        }
            if (this.getUpdateDate() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getUpdateDate().compareTo(o.getUpdateDate()));
            }
        return cmp;
    }
// HibernateEntity.vsl merge-point
// VirtualComponent.java merge-point
}