root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/TaxonNameDescription.java

/**
* 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.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.annotations.Cascade;
import org.hibernate.annotations.CascadeType;
import org.hibernate.envers.Audited;
import org.hibernate.search.annotations.Indexed;
import org.springframework.beans.factory.annotation.Configurable;

import eu.etaxonomy.cdm.model.name.NomenclaturalCode;
import eu.etaxonomy.cdm.model.name.TaxonNameBase;
import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;
import eu.etaxonomy.cdm.strategy.cache.common.IdentifiableEntityDefaultCacheStrategy;

/**
 * This class represents all piece of information (not ruled by a {@link NomenclaturalCode nomenclatural code})
 * concerning a {@link TaxonNameBase taxon name} like for instance the content of its first
 * publication (protolog) or a picture of this publication.
 *
 * @author a.mueller
 * @version 1.0
 * @created 08-Jul-2008
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "TaxonNameDescription", propOrder = {
        "taxonName"
})
@XmlRootElement(name = "TaxonNameDescription")
@Entity
@Indexed(index = "eu.etaxonomy.cdm.model.description.DescriptionBase")
@Audited
@Configurable
public class TaxonNameDescription extends DescriptionBase<IIdentifiableEntityCacheStrategy<TaxonNameDescription>> implements Cloneable{
    private static final long serialVersionUID = -7349160369642038687L;
    @SuppressWarnings("unused")
    private static final Logger logger = Logger.getLogger(TaxonNameDescription.class);

    @XmlElement(name="TaxonName")
    @XmlIDREF
    @XmlSchemaType(name="IDREF")
    @ManyToOne(fetch = FetchType.LAZY)
//      @JoinColumn(name="taxonName_id")
    @Cascade(CascadeType.SAVE_UPDATE)
    private TaxonNameBase<?,?> taxonName;

    /**
     * Creates a new taxon name description instance for the given {@link TaxonNameBase name}.
     * The new taxon name description will be also added to the {@link TaxonNameBase#getDescriptions() set of descriptions}
     * assigned to the given name.
     *
     * @see     #NewInstance()
     */
    public static TaxonNameDescription NewInstance(TaxonNameBase name){
        TaxonNameDescription description = new TaxonNameDescription();
        name.addDescription(description);
        return description;
    }

    /**
     * Class constructor: creates a new empty taxon name description instance.
     */
    public TaxonNameDescription() {
        super();
        this.cacheStrategy = new IdentifiableEntityDefaultCacheStrategy();
    }

    /**
     * Creates a new empty taxon name description instance.
     */
    public static TaxonNameDescription NewInstance(){
        return new TaxonNameDescription();
    }

    /**
     * Returns the {@link TaxonNameBase taxon name} to which <i>this</i> taxon name description
     * provides additional information not ruled by a {@link NomenclaturalCode nomenclatural code}.
     */
    public TaxonNameBase<?,?> getTaxonName() {
        return taxonName;
    }


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

    /**
     * Clones <i>this</i> taxon name description. This is a shortcut that enables to create
     * a new instance that differs only slightly from <i>this</i> taxon name description by
     * modifying only some of the attributes.
     *
     * @see eu.etaxonomy.cdm.model.description.DescriptionBase#clone()
     * @see java.lang.Object#clone()
     */
    @Override
    public Object clone() {
        TaxonNameDescription result;
        result = (TaxonNameDescription)super.clone();
        //no changes to: taxonName
        return result;
    }
}