root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/occurrence/DeterminationEvent.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 java.util.HashSet;
import java.util.Set;

import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.ManyToMany;
import javax.persistence.ManyToOne;
import javax.persistence.Transient;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
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.hibernate.search.annotations.IndexedEmbedded;
import org.joda.time.Partial;

import eu.etaxonomy.cdm.model.agent.AgentBase;
import eu.etaxonomy.cdm.model.common.EventBase;
import eu.etaxonomy.cdm.model.reference.Reference;
import eu.etaxonomy.cdm.model.taxon.TaxonBase;

/**
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:21
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "DeterminationEvent", propOrder = {
    "identifiedUnit",
    "taxon",
    "modifier",
    "preferredFlag",
    "setOfReferences"
})
@XmlRootElement(name = "DeterminationEvent")
@Entity
@Indexed
@Audited
public class DeterminationEvent extends EventBase {
        private static final Logger logger = Logger.getLogger(DeterminationEvent.class);

        @XmlElement(name = "IdentifiedUnit")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        @Cascade(CascadeType.SAVE_UPDATE)
        private SpecimenOrObservationBase identifiedUnit;
        
        @XmlElement(name = "Taxon")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        @IndexedEmbedded
    @Cascade(CascadeType.SAVE_UPDATE)
    private TaxonBase taxon;
        
        @XmlElement(name = "Modifier")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        private DeterminationModifier modifier;
        
        @XmlElement(name = "PreferredFlag")
        private boolean preferredFlag;
        
        @XmlElementWrapper(name = "SetOfReferences")
        @XmlElement(name = "Reference")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToMany(fetch = FetchType.LAZY)
        private Set<Reference> setOfReferences = new HashSet<Reference>();

        
        
        /**
         * Factory method
         * @return
         */
        public static DeterminationEvent NewInstance(){
                return new DeterminationEvent();
        }
        
        /**
         * Constructor
         */
        protected DeterminationEvent() {
                super();
        }
        
        public DeterminationModifier getModifier() {
                return modifier;
        }

        public void setModifier(DeterminationModifier modifier) {
                this.modifier = modifier;
        }

        public TaxonBase getTaxon(){
                return this.taxon;
        }

        /**
         * 
         * @param taxon    taxon
         */
        public void setTaxon(TaxonBase taxon){
                this.taxon = taxon;
        }

        @Transient
        public Partial getIdentificationDate(){
                return this.getTimeperiod().getStart();
        }

        /**
         * 
         * @param identificationDate    identificationDate
         */
        public void setIdentificationDate(Partial identificationDate){
                this.getTimeperiod().setStart(identificationDate);
        }

        @Transient
        public AgentBase getDeterminer() {
                return this.getActor();
        }
        
        public void setDeterminer(AgentBase determiner) {
                this.setActor(determiner);
        }

        public SpecimenOrObservationBase getIdentifiedUnit() {
                return identifiedUnit;
        }

        public void setIdentifiedUnit(SpecimenOrObservationBase identifiedUnit) {
                this.identifiedUnit = identifiedUnit;
        }
        
        public boolean getPreferredFlag() {
                return preferredFlag;
        }

        public void setPreferredFlag(boolean preferredFlag) {
                this.preferredFlag = preferredFlag;
        }
        
        public Set<Reference> getReferences() {
                return setOfReferences;
        }

        public void setReferences(Set<Reference> references) {
                this.setOfReferences = references;
        }
        
        public void addReference(Reference reference) {
                this.setOfReferences.add(reference);
        }
        
//*********** CLONE **********************************/ 
        
        /** 
         * Clones <i>this</i> determination event. This is a shortcut that enables to
         * create a new instance that differs only slightly from <i>this</i> determination event
         * by modifying only some of the attributes.<BR>
         * This method overrides the clone method from {@link EventBase EventBase}.
         * 
         * @see EventBase#clone()
         * @see java.lang.Object#clone()
         */
        @Override
        public DeterminationEvent clone(){
                try{
                        DeterminationEvent result = (DeterminationEvent)super.clone();
                        //type
                        result.setIdentifiedUnit(this.getIdentifiedUnit());
                        //modifier
                        result.setModifier(this.getModifier());
                        //taxon
                        result.setTaxon(this.getTaxon()); //TODO
                        //no changes to: preferredFlag
                        return result;
                } catch (CloneNotSupportedException e) {
                        logger.warn("Object does not implement cloneable");
                        e.printStackTrace();
                        return null;
                }
        }
        
        

}