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

import java.util.HashSet;
import java.util.Set;
import java.util.UUID;

import javax.persistence.FetchType;
import javax.persistence.MappedSuperclass;
import javax.persistence.OneToMany;
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.XmlType;

import org.apache.log4j.Logger;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.CascadeType;

import eu.etaxonomy.cdm.strategy.merge.Merge;
import eu.etaxonomy.cdm.strategy.merge.MergeMode;

/**
 * Abstract superclass implementing human annotations and machine markers to be assigned to CDM objects.
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:10
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AnnotatableEntity", propOrder = {
    "markers",
    "annotations"
})
@MappedSuperclass
public abstract class AnnotatableEntity extends VersionableEntity implements IAnnotatableEntity {
        private static final long serialVersionUID = 9151211842542443102L;
        @SuppressWarnings("unused")
        private static final Logger logger = Logger.getLogger(AnnotatableEntity.class);

        @XmlElementWrapper(name = "Markers", nillable = true)
        @XmlElement(name = "Marker")
        @OneToMany(fetch=FetchType.LAZY)
        @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE, CascadeType.DELETE, CascadeType.DELETE_ORPHAN})
        @Merge(MergeMode.ADD_CLONE)
        protected Set<Marker> markers;
        
        @XmlElementWrapper(name = "Annotations", nillable = true)
        @XmlElement(name = "Annotation")
        @OneToMany(fetch=FetchType.LAZY)
        @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE, CascadeType.DELETE, CascadeType.DELETE_ORPHAN})
        @Merge(MergeMode.ADD_CLONE)
        protected Set<Annotation> annotations;
        
        protected AnnotatableEntity() {
                super();
        }

//*************** MARKER **********************************************
        
        
        public Set<Marker> getMarkers(){
                if(markers == null) {
                        this.markers = new HashSet<Marker>();
                }
                return this.markers;
        }
        public void addMarker(Marker marker){
                if (marker != null){
                        marker.setMarkedObj(this);
                        getMarkers().add(marker);
                }
        }
        public void removeMarker(Marker marker){
                if(getMarkers().contains(marker)) {
                        getMarkers().remove(marker);
                    marker.setMarkedObj(null);
                }
        }
        
        public boolean hasMarker(MarkerType type, boolean value){
                return hasMarker(type.getUuid(), value);
        }
        
        public boolean hasMarker(UUID uuidMarkerType, boolean value){
                for (Marker marker: getMarkers()){
                        if (marker.getMarkerType().getUuid().equals(uuidMarkerType)){
                                if (marker.getFlag() == value){
                                        return true;
                                }
                        }
                }
                return false;
        }

//*************** ANNOTATIONS **********************************************
        
        public Set<Annotation> getAnnotations(){
                if(annotations == null) {
                        this.annotations = new HashSet<Annotation>();
                }
                return this.annotations;
        }
        public void addAnnotation(Annotation annotation){
                if (annotation != null){
                        annotation.setAnnotatedObj(this);
                        getAnnotations().add(annotation);
                }
        }
        
        public void removeAnnotation(Annotation annotation){
                if(getAnnotations().contains(annotation)) {
                        getAnnotations().remove(annotation);
                    annotation.setAnnotatedObj(null);
                }
        }
        
//********************** CLONE *****************************************/

        /* (non-Javadoc)
         * @see eu.etaxonomy.cdm.model.common.VersionableEntity#clone()
         */
        @Override
        public Object clone() throws CloneNotSupportedException{
                AnnotatableEntity result = (AnnotatableEntity)super.clone();
                
                //Annotations
                result.annotations = new HashSet<Annotation>();
                for (Annotation annotation : getAnnotations()){
                        Annotation newAnnotation = (Annotation)annotation.clone();
                        result.addAnnotation(newAnnotation);
                }
                
                //Markers
                result.markers = new HashSet<Marker>();
                for (Marker marker : getMarkers()){
                        Marker newMarker = (Marker)marker.clone();
                        result.addMarker(newMarker);
                }
                
                //no changes to: -
                return result;
        }
}