// 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.spatial;

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

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

    private SpatialItem2LocationPK spatialItem2LocationPk;

    /**
     * Get the composite primary key identifier class
     * @return spatialItem2LocationPk
     */
    public SpatialItem2LocationPK getSpatialItem2LocationPk()
    {
        return this.spatialItem2LocationPk;
    }

    /**
     * Set the composite primary key identifier class
     * @param spatialItem2LocationPkIn
     */
    public void setSpatialItem2LocationPk(SpatialItem2LocationPK spatialItem2LocationPkIn) {
        this.spatialItem2LocationPk = spatialItem2LocationPkIn;
    }

    // Generate 1 attributes
    private String localizedName;

    /**
     * 
     * @return this.localizedName String
     */
    public String getLocalizedName()
    {
        return this.localizedName;
    }

    /**
     * 
     * @param localizedNameIn String
     */
    public void setLocalizedName(String localizedNameIn)
    {
        this.localizedName = localizedNameIn;
    }

    // Generate 2 associations
    private Location location;

    /**
     * Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou
     * surfacique.
     * Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche,
     * un
     * quartier maritime, une criée, etc.
     * Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités :
     * 200
     * @return this.location Location
     */
    public Location getLocation()
    {
        return this.location;
    }

    /**
     * Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou
     * surfacique.
     * Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche,
     * un
     * quartier maritime, une criée, etc.
     * Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités :
     * 200
     * @param locationIn Location
     */
    public void setLocation(Location locationIn)
    {
        this.location = locationIn;
    }

    private SpatialItem spatialItem;

    /**
     * Présence d'un élément d'une liste du référentiel sur une ou plusieurs zones géographiques.
     * Une ou plusieurs géométrie (ponctuelle, linéraire ou polygonale) peuvent etre définies afin
     * de
     * géolocaliser un des éléments d'une liste.
     * Une procédure stockée sous Oracle permet la mise à jour d'un lien vers le référentiel des
     * lieux
     * (table SPATIAL_ITEM2LOCATION) à partir des géométries définies.
     * @return this.spatialItem SpatialItem
     */
    public SpatialItem getSpatialItem()
    {
        return this.spatialItem;
    }

    /**
     * Présence d'un élément d'une liste du référentiel sur une ou plusieurs zones géographiques.
     * Une ou plusieurs géométrie (ponctuelle, linéraire ou polygonale) peuvent etre définies afin
     * de
     * géolocaliser un des éléments d'une liste.
     * Une procédure stockée sous Oracle permet la mise à jour d'un lien vers le référentiel des
     * lieux
     * (table SPATIAL_ITEM2LOCATION) à partir des géométries définies.
     * @param spatialItemIn SpatialItem
     */
    public void setSpatialItem(SpatialItem spatialItemIn)
    {
        this.spatialItem = spatialItemIn;
    }

    /**
     * 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 SpatialItem2Location}.
     */
    public static final class Factory
    {
        /**
         * Constructs a new instance of {@link SpatialItem2Location}.
         * @return new SpatialItem2LocationImpl()
         */
        public static SpatialItem2Location newInstance()
        {
            return new SpatialItem2LocationImpl();
        }

        /**
         * Constructs a new instance of {@link SpatialItem2Location}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param location Location
         * @param spatialItem SpatialItem
         * @return newInstance
         */
        public static SpatialItem2Location newInstance(Location location, SpatialItem spatialItem)
        {
            final SpatialItem2Location entity = new SpatialItem2LocationImpl();
            entity.setLocation(location);
            entity.setSpatialItem(spatialItem);
            return entity;
        }

        /**
         * Constructs a new instance of {@link SpatialItem2Location}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param localizedName String
         * @param location Location
         * @param spatialItem SpatialItem
         * @return newInstance SpatialItem2Location
         */
        public static SpatialItem2Location newInstance(String localizedName, Location location, SpatialItem spatialItem)
        {
            final SpatialItem2Location entity = new SpatialItem2LocationImpl();
            entity.setLocalizedName(localizedName);
            entity.setLocation(location);
            entity.setSpatialItem(spatialItem);
            return entity;
        }
    }

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