root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/occurrence/Collection.java

// $Id$
/**
* 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.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.annotations.Index;
import org.hibernate.annotations.Table;
import org.hibernate.envers.Audited;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.Indexed;
import org.hibernate.search.annotations.IndexedEmbedded;
import org.hibernate.validator.constraints.Length;
import org.springframework.beans.factory.annotation.Configurable;

import eu.etaxonomy.cdm.model.agent.Institution;
import eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity;
import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;
import eu.etaxonomy.cdm.strategy.cache.common.IdentifiableEntityDefaultCacheStrategy;
import eu.etaxonomy.cdm.strategy.cache.occurrence.CollectionDefaultCacheStrategy;
import eu.etaxonomy.cdm.validation.annotation.NullOrNotEmpty;

/**
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:16
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Collection", propOrder = {
        "name",
    "code",
    "codeStandard",
    "townOrLocation",
    "institute",
    "superCollection"
})
@XmlRootElement(name = "Collection")
@Entity
@Indexed(index = "eu.etaxonomy.cdm.model.occurrence.Collection")
@Audited
@Configurable
@Table(appliesTo="Collection", indexes = { @Index(name = "collectionTitleCacheIndex", columnNames = { "titleCache" }) })
public class Collection extends IdentifiableMediaEntity<IIdentifiableEntityCacheStrategy<Collection>> implements Cloneable{
        private static final long serialVersionUID = -7833674897174732255L;
        private static final Logger logger = Logger.getLogger(Collection.class);
        
        @XmlElement(name = "Code")
        @Field(index=org.hibernate.search.annotations.Index.UN_TOKENIZED)
        @NullOrNotEmpty
        @Length(max = 255)
        private String code;
        
        @XmlElement(name = "CodeStandard")
        @Field(index=org.hibernate.search.annotations.Index.UN_TOKENIZED)
        @NullOrNotEmpty
        @Length(max = 255)
        private String codeStandard;
        
        @XmlElement(name = "Name")
        @Field(index=org.hibernate.search.annotations.Index.TOKENIZED)
        @NullOrNotEmpty
        @Length(max = 255)
        private String name;

        @XmlElement(name = "TownOrLocation")
        @Field(index=org.hibernate.search.annotations.Index.TOKENIZED)
        @NullOrNotEmpty
        @Length(max = 255)
        private String townOrLocation;
        
        @XmlElement(name = "Institution")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        @Cascade(CascadeType.SAVE_UPDATE)
        @IndexedEmbedded
        private Institution institute;
        
        @XmlElement(name = "SuperCollection")
        @XmlIDREF
        @XmlSchemaType(name = "IDREF")
        @ManyToOne(fetch = FetchType.LAZY)
        @Cascade(CascadeType.SAVE_UPDATE)
        private Collection superCollection;
        
        
        /**
         * Factory method
         * @return
         */
        public static Collection NewInstance(){
                return new Collection();
        }
        
        /**
         * Constructor
         */
        protected Collection() {
                super();
                this.cacheStrategy = new CollectionDefaultCacheStrategy();
        }

        public Institution getInstitute(){
                return this.institute;
        }

        /**
         * 
         * @param institute    institute
         */
        public void setInstitute(Institution institute){
                this.institute = institute;
        }

        public String getCode(){
                return this.code;
        }

        /**
         * 
         * @param code    code
         */
        public void setCode(String code){
                this.code = code;
        }

        public String getCodeStandard(){
                return this.codeStandard;
        }

        /**
         * 
         * @param codeStandard    codeStandard
         */
        public void setCodeStandard(String codeStandard){
                this.codeStandard = codeStandard;
        }

        public String getName(){
                return this.name;
        }

        /**
         * 
         * @param name    name
         */
        public void setName(String name){
                this.name = name;
        }

        public String getTownOrLocation(){
                return this.townOrLocation;
        }

        /**
         * 
         * @param townOrLocation    townOrLocation
         */
        public void setTownOrLocation(String townOrLocation){
                this.townOrLocation = townOrLocation;
        }

//      @Override
//      public String generateTitle(){
//              return "";
//      }

        public Collection getSuperCollection() {
                return superCollection;
        }

        public void setSuperCollection(Collection superCollection) {
                this.superCollection = superCollection;
        }

        
//*********** CLONE **********************************/ 
        
        /** 
         * Clones <i>this</i> collection. This is a shortcut that enables to
         * create a new instance that differs only slightly from <i>this</i> collection
         * by modifying only some of the attributes.<BR>
         * This method overrides the clone method from {@link IdentifiableMediaEntity IdentifiableMediaEntity}.
         * 
         * @see eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity#clone()
         * @see java.lang.Object#clone()
         */
        @Override
        public Collection clone(){
                try{
                        Collection result = (Collection)super.clone();
                        //superCollection
                        result.setSuperCollection(this.superCollection);
                        //institute
                        result.setInstitute(this.institute);
                        //no changes to: code, codeStandard, name, townOrLocation
                        return result;
                } catch (CloneNotSupportedException e) {
                        logger.warn("Object does not implement cloneable");
                        e.printStackTrace();
                        return null;
                }
        }
}