EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.model.description;

import javax.persistence.Entity;

import javax.persistence.FetchType;

import javax.persistence.ManyToOne;

import javax.validation.constraints.NotNull;

import javax.xml.bind.annotation.XmlAccessType;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlElement;

import javax.xml.bind.annotation.XmlIDREF;

import javax.xml.bind.annotation.XmlRootElement;

import javax.xml.bind.annotation.XmlSchemaType;

import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;

import org.hibernate.envers.Audited;

import org.hibernate.search.annotations.Indexed;

import org.hibernate.search.annotations.IndexedEmbedded;

import eu.etaxonomy.cdm.model.location.NamedArea;

import eu.etaxonomy.cdm.model.taxon.Taxon;

import eu.etaxonomy.cdm.validation.Level2;

/**

 * This class represents elementary distribution data for a {@link Taxon taxon}.

 * Only {@link TaxonDescription taxon descriptions} may contain distributions.

 * A distribution instance consist of a {@link NamedArea named area} and of a {@link PresenceAbsenceTermBase status}

 * describing the absence or the presence of a taxon (like "extinct"

 * or "introduced") in this named area.

 * <P>

 * This class corresponds partially to: <ul>

 * <li> CodedDescriptionType according to the the SDD schema

 * <li> Distribution according to the TDWG ontology

 * </ul>

 *

 * @author m.doering

 * @version 1.0

 * @created 08-Nov-2007 13:06:21

 */

@XmlAccessorType(XmlAccessType.FIELD)

@XmlType(name = "Distribution", propOrder = {

    "area",

    "status"

})

@XmlRootElement(name = "Distribution")

@Entity

@Audited

@Indexed(index = "eu.etaxonomy.cdm.model.description.DescriptionElementBase")

public class Distribution extends DescriptionElementBase implements Cloneable {

    private static final long serialVersionUID = 8366462435651559730L;

    private static final Logger logger = Logger.getLogger(Distribution.class);

    @XmlElement(name = "NamedArea")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

    @ManyToOne(fetch = FetchType.LAZY)

    @NotNull(groups = Level2.class)

    @IndexedEmbedded(depth=1)

    private NamedArea area;

    @XmlElement(name = "PresenceAbsenceStatus")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

    @ManyToOne(fetch = FetchType.LAZY)

    @NotNull(groups = Level2.class)

    @IndexedEmbedded(depth=1)

    private PresenceAbsenceTerm status;

    /**

     * Class constructor: creates a new empty distribution instance.

     * The corresponding {@link Feature feature} is set to {@link Feature#DISTRIBUTION() DISTRIBUTION}.

     */

    protected Distribution(){

        super();

    }

    /**

     * Creates an empty distribution instance. The corresponding {@link Feature feature}

     * is set to {@link Feature#DISTRIBUTION() DISTRIBUTION}.

     *

     * @see		#NewInstance(NamedArea, PresenceAbsenceTermBase)

     */

    public static Distribution NewInstance(){

        Distribution result = new Distribution();

        result.setFeature(Feature.DISTRIBUTION());

        return result;

    }

    /**

     * Creates a distribution instance with the given {@link NamedArea named area} and {@link PresenceAbsenceTermBase status}.

     * The corresponding {@link Feature feature} is set to {@link Feature#DISTRIBUTION() DISTRIBUTION}.

     *

     * @param	area	the named area for the new distribution

     * @param	status	the presence or absence term for the new distribution

     * @see				#NewInstance()

     */

    public static Distribution NewInstance(NamedArea area, PresenceAbsenceTerm status){

        Distribution result = NewInstance();

        result.setArea(area);

        result.setStatus(status);

        return result;

    }

    /**

     * @deprecated Deprecated because {@link Feature feature} should always be {@link Feature#DISTRIBUTION() DISTRIBUTION}

     * for all distribution instances and therefore it should not be changed.

     */

    /* (non-Javadoc)

     * @see eu.etaxonomy.cdm.model.description.DescriptionElementBase#setFeature(eu.etaxonomy.cdm.model.description.Feature)

     */

    @Override

    @Deprecated

    public void setFeature(Feature feature) {

        super.setFeature(feature);

    }

    /**

     * Returns the {@link NamedArea named area} <i>this</i> distribution applies to.

     */

    public NamedArea getArea(){

        return this.area;

    }

    /**

     * @see	#getArea()

     */

    public void setArea(NamedArea area){

        this.area = area;

    }

    /**

     * Returns the {@link PresenceAbsenceTerm presence or absence term} for <i>this</i> distribution.

     */

    public PresenceAbsenceTerm getStatus(){

        return this.status;

    }

    /**

     * @see	#getStatus()

     */

    public void setStatus(PresenceAbsenceTerm status){

        this.status = status;

    }

    /**

     * Special function for building the sorted distribution tree. The function returns true

     * if the sources of the two different objects are different

     * @param dist

     * @return

     */

    public boolean isDifferentSources(Distribution dist){

        boolean result = false;

        if(this.getSources().equals(dist.getSources())){

            result = true;

        }

        return result;

    }

//*********************************** CLONE *****************************************/

    /**

     * Clones <i>this</i> distribution. This is a shortcut that enables to create

     * a new instance that differs only slightly from <i>this</i> distribution by

     * modifying only some of the attributes.

     *

     * @see eu.etaxonomy.cdm.model.description.DescriptionElementBase#clone()

     * @see java.lang.Object#clone()

     */

    @Override

    public Object clone() {

        try {

            Distribution result = (Distribution)super.clone();

            return result;

            //no changes to: area, status

        } catch (CloneNotSupportedException e) {

            logger.warn("Object does not implement cloneable");

            e.printStackTrace();

            return null;

        }

    }

// ************************* to String ***************************************************/

    /**

     * Implementation of the toString() function

     */

    @Override

    public String toString(){

        String result = "null";

        if (this.area != null){

            result = area.getTitleCache();

        }

        return result;

    }

}