root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/occurrence/Specimen.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.occurrence;

import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.ManyToOne;
import javax.validation.constraints.Size;
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.Field;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.Indexed;
import org.springframework.beans.factory.annotation.Configurable;

import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;
import eu.etaxonomy.cdm.strategy.cache.common.IdentifiableEntityDefaultCacheStrategy;
import eu.etaxonomy.cdm.validation.annotation.NullOrNotEmpty;

/**
 * A specimen is regarded as derived from an field observation, 
 * so locality and gathering related information is captured as a separate FieldObservation object
 * related to a specimen via a derivation event
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:52
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Specimen", propOrder = {
                "preservation",
                "exsiccatum"
})
@XmlRootElement(name = "Specimen")
@Entity
@Indexed(index = "eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase")
@Audited
@Configurable
public class Specimen extends DerivedUnitBase<IIdentifiableEntityCacheStrategy<Specimen>> implements Cloneable {
        private static final long serialVersionUID = -504050482700773061L;
        private static final Logger logger = Logger.getLogger(Specimen.class);
        
        @XmlElement(name = "Preservation")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        private PreservationMethod preservation;
        
        
        @XmlElement(name = "Exsiccatum")
        @NullOrNotEmpty
        @Field(index=Index.TOKENIZED)
        @Size(max = 255)
    private String exsiccatum;
        
        
        /**
         * Factory method
         * @return
         */
        public static Specimen NewInstance(){
                return new Specimen();
        }
        
        /**
         * Constructor
         */
        protected Specimen() {
                super();
                this.cacheStrategy = new IdentifiableEntityDefaultCacheStrategy<Specimen>();
        }

//***************************** GETTER / SETTER **************************************  
        
        public PreservationMethod getPreservation(){
                return this.preservation;
        }
        
        public void setPreservation(PreservationMethod preservation){
                this.preservation = preservation;
        }


        public void setExsiccatum(String exsiccatum) {
                this.exsiccatum = exsiccatum;
        }

        public String getExsiccatum() {
                return exsiccatum;
        }
        
        
//*********** CLONE **********************************/ 
        
        /** 
         * Clones <i>this</i> specimen. This is a shortcut that enables to
         * create a new instance that differs only slightly from <i>this</i> specimen
         * by modifying only some of the attributes.<BR>
         * This method overrides the clone method from {@link DerivedUnitBase DerivedUnitBase}.
         * 
         * @see DerivedUnitBase#clone()
         * @see eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity#clone()
         * @see java.lang.Object#clone()
         */
        @Override
        public Object clone(){
                try{
                        Specimen result = (Specimen)super.clone();
                        result.setPreservation(this.preservation);
                        //no changes to: -
                        return result;
                } catch (CloneNotSupportedException e) {
                        logger.warn("Object does not implement cloneable");
                        e.printStackTrace();
                        return null;
                }
        }

        

}