root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/SpecimenDescription.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.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;
import org.hibernate.envers.Audited;
import org.hibernate.search.annotations.Indexed;
import org.springframework.beans.factory.annotation.Configurable;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;
import eu.etaxonomy.cdm.strategy.cache.common.IdentifiableEntityDefaultCacheStrategy;

/**
 * This class represents descriptions for {@link SpecimenOrObservationBase specimens or observations}.
 * <P>
 * This class corresponds to DescriptionsBaseType with an "Object" element
 * according to the SDD schema.
 *  
 * @author a.mueller
 * @version 1.0
 * @created 08-Jul-2008
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SpecimenDescription")
@XmlRootElement(name = "SpecimenDescription")
@Entity
@Indexed(index = "eu.etaxonomy.cdm.model.description.DescriptionBase")
@Audited
@Configurable
public class SpecimenDescription extends DescriptionBase<IIdentifiableEntityCacheStrategy<SpecimenDescription>> implements Cloneable {
        private static final long serialVersionUID = -8506790426682192703L;
        private static final Logger logger = Logger.getLogger(SpecimenDescription.class);
        

        /**
         * Class constructor: creates a new empty specimen description instance.
         */
        public SpecimenDescription() {
                super();
                this.cacheStrategy = new IdentifiableEntityDefaultCacheStrategy<SpecimenDescription>();
        }
        

        /**
         * Creates a new empty specimen description instance.
         */
        public static SpecimenDescription NewInstance(){
                return new SpecimenDescription();
        }

        /**
         * Creates a new empty specimen description instance.
         */
        public static SpecimenDescription NewInstance(SpecimenOrObservationBase specimen){
                SpecimenDescription result =  new SpecimenDescription();
                result.addDescribedSpecimenOrObservation(specimen);
                return result;
        }
        
//*********************** CLONE ********************************************************/
        
        /** 
         * Clones <i>this</i> specimen description. This is a shortcut that enables to create
         * a new instance that differs only slightly from <i>this</i> specimen 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() {
                SpecimenDescription result;
                result = (SpecimenDescription)super.clone();
                //no changes to: taxonName
                return result;
        }       
        

}