root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/Sex.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 java.util.HashMap;
import java.util.Map;
import java.util.UUID;

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 eu.etaxonomy.cdm.model.common.Language;
import eu.etaxonomy.cdm.model.common.TermVocabulary;
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

/**
 * The class representing the restriction concerning the sex for
 * the applicability of {@link TaxonDescription taxon descriptions}. The sex of a
 * {@link SpecimenOrObservationBase specimen or observation}
 * does not belong to a {@link SpecimenDescription specimen description} but is an attribute of
 * the specimen itself.
 * 
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:52
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Sex")
@XmlRootElement(name = "Sex")
@Entity
@Indexed(index = "eu.etaxonomy.cdm.model.common.DefinedTermBase")
@Audited
public class Sex extends Scope {
        private static final long serialVersionUID = 3463642992193419657L;
        @SuppressWarnings("unused")
        private static final Logger logger = Logger.getLogger(Sex.class);

        protected static Map<UUID, Sex> termMap = null;         

        private static final UUID uuidMale = UUID.fromString("600a5212-cc02-431d-8a80-2bf595bd1eab");
        private static final UUID uuidFemale = UUID.fromString("b4cfe0cb-b35c-4f97-9b6b-2b3c096ea2c0");
        private static final UUID uuidHermaphrodite = UUID.fromString("0deddc65-2505-4c77-91a7-17d0de24afcc");
        private static final UUID uuidUnknown = UUID.fromString("4f5e4c51-a664-48ad-8238-2e9f49eaf8dd");



        /** 
         * Creates a new empty sex instance.
         * 
         * @see #Sex(String, String, String)
         */
        public static Sex NewInstance(){
                return new Sex();
        }
        
        /** 
         * Creates a new sex instance with a description (in the {@link Language#DEFAULT() default language}),
         * a label and a label abbreviation.
         * 
         * @param       term             the string (in the default language) describing the
         *                                               new sex to be created 
         * @param       label            the string identifying the new sex to be created
         * @param       labelAbbrev  the string identifying (in abbreviated form) the
         *                                               new sex to be created
         * @see                                  #NewInstance()
         */
        public static Sex NewInstance(String term, String label, String labelAbbrev){
                return new Sex(term, label, labelAbbrev);
        }       
        
        /** 
         * Class constructor: creates a new empty sex instance.
         * 
         * @see #Sex(String, String, String)
         */
        public Sex() {
        }

        /** 
         * Class constructor: creates a new sex instance with a description
         * (in the {@link Language#DEFAULT() default language}), a label and a label abbreviation.
         * 
         * @param       term             the string (in the default language) describing the
         *                                               new sex to be created 
         * @param       label            the string identifying the new sex to be created
         * @param       labelAbbrev  the string identifying (in abbreviated form) the
         *                                               new sex to be created
         * @see                                  #Sex()
         */
        public Sex(String term, String label, String labelAbbrev) {
                super(term, label, labelAbbrev);
        }

        
//************************** METHODS ********************************
        
        /* (non-Javadoc)
         * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()
         */
        @Override
        public void resetTerms(){
                termMap = null;
        }

        
        protected static Sex getTermByUuid(UUID uuid){
                if (termMap == null){
                        return null;  //better return null then initialize the termMap in an unwanted way 
                }
                return (Sex)termMap.get(uuid);
        }
        

        public static Sex MALE(){
                return getTermByUuid(uuidMale);
        }

        public static Sex FEMALE(){
                return getTermByUuid(uuidFemale);
        }
        
        public static Sex HERMAPHRODITE(){
                return getTermByUuid(uuidHermaphrodite);
        }
        
        public static Sex UNKNOWN(){
                return getTermByUuid(uuidUnknown);
        }
        
        @Override
        protected void setDefaultTerms(TermVocabulary<Modifier> termVocabulary) {
                termMap = new HashMap<UUID, Sex>();
                for (Modifier term : termVocabulary.getTerms()){
                        termMap.put(term.getUuid(), (Sex)term);
                }       
        }

        
}