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

import java.util.UUID;

import eu.etaxonomy.cdm.model.agent.InstitutionType;
import eu.etaxonomy.cdm.model.description.AbsenceTerm;
import eu.etaxonomy.cdm.model.description.Feature;
import eu.etaxonomy.cdm.model.description.MeasurementUnit;
import eu.etaxonomy.cdm.model.description.Modifier;
import eu.etaxonomy.cdm.model.description.NaturalLanguageTerm;
import eu.etaxonomy.cdm.model.description.PresenceTerm;
import eu.etaxonomy.cdm.model.description.Scope;
import eu.etaxonomy.cdm.model.description.Sex;
import eu.etaxonomy.cdm.model.description.Stage;
import eu.etaxonomy.cdm.model.description.State;
import eu.etaxonomy.cdm.model.description.StatisticalMeasure;
import eu.etaxonomy.cdm.model.description.TextFormat;
import eu.etaxonomy.cdm.model.location.Continent;
import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
import eu.etaxonomy.cdm.model.location.NamedAreaType;
import eu.etaxonomy.cdm.model.location.ReferenceSystem;
import eu.etaxonomy.cdm.model.location.TdwgArea;
import eu.etaxonomy.cdm.model.location.WaterbodyOrCountry;
import eu.etaxonomy.cdm.model.media.RightsTerm;
import eu.etaxonomy.cdm.model.name.HybridRelationshipType;
import eu.etaxonomy.cdm.model.name.NameRelationshipType;
import eu.etaxonomy.cdm.model.name.NameTypeDesignationStatus;
import eu.etaxonomy.cdm.model.name.NomenclaturalStatusType;
import eu.etaxonomy.cdm.model.name.Rank;
import eu.etaxonomy.cdm.model.name.SpecimenTypeDesignationStatus;
import eu.etaxonomy.cdm.model.occurrence.DerivationEventType;
import eu.etaxonomy.cdm.model.occurrence.DeterminationModifier;
import eu.etaxonomy.cdm.model.occurrence.PreservationMethod;
import eu.etaxonomy.cdm.model.taxon.SynonymRelationshipType;
import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;

/**
 * @author n.hoffmann
 * @created 03.06.2009
 * @version 1.0
 * 
 * @deprecated
 * A static list of vocabularies is not the right way to do this.
 * We will use a service method that will return vocabularies by term type (once that is implemented)
 */
@Deprecated 
public enum VocabularyEnum {

        Language("45ac7043-7f5e-4f37-92f2-3874aaaef2de", Language.class),
        UndefinedLanguage("7fd1e6d0-2e76-4dfa-bad9-2673dd042c28", Language.class),
        Continent("e72cbcb6-58f8-4201-9774-15d0c6abc128", Continent.class),
        WaterbodyOrCountry("006b1870-7347-4624-990f-e5ed78484a1a", WaterbodyOrCountry.class),
        Rank("ef0d1ce1-26e3-4e83-b47b-ca74eed40b1b", Rank.class),
        SpecimenTypeDesignationStatus("ab177bd7-d3c8-4e58-a388-226fff6ba3c2", SpecimenTypeDesignationStatus.class),
        NomenclaturalStatusType("bb28cdca-2f8a-4f11-9c21-517e9ae87f1f", NomenclaturalStatusType.class),
        SynonymRelationshipType("48917fde-d083-4659-b07d-413db843bd50", SynonymRelationshipType.class),
        HybridRelationshipType("fc4abe52-9c25-4cfa-a682-8615bf4bbf07", HybridRelationshipType.class),
        NameRelationshipType("6878cb82-c1a4-4613-b012-7e73b413c8cd", NameRelationshipType.class),
        TaxonRelationshipType("15db0cf7-7afc-4a86-a7d4-221c73b0c9ac", TaxonRelationshipType.class),
        MarkerType("19dffff7-e142-429c-a420-5d28e4ebe305", MarkerType.class),
        AnnotationType("ca04609b-1ba0-4d31-9c2e-aa8eb2f4e62d", AnnotationType.class),
        NamedAreaType("e51d52d6-965b-4f7d-900f-4ba9c6f5dd33", NamedAreaType.class),
        NamedAreaLevel("49034253-27c8-4219-97e8-f8d987d3d122", NamedAreaLevel.class),
        Feature("b187d555-f06f-4d65-9e53-da7c93f8eaa8", Feature.class),
        NameFeature("a7ca3eef-4092-49e1-beec-ed5096193e5e", Feature.class),
        TdwgArea("1fb40504-d1d7-44b0-9731-374fbe6cac77", TdwgArea.class),
        PresenceTerm("adbbbe15-c4d3-47b7-80a8-c7d104e53a05", PresenceTerm.class),
        AbsenceTerm("5cd438c8-a8a1-4958-842e-169e83e2ceee", AbsenceTerm.class),
        Sex("9718b7dd-8bc0-4cad-be57-3c54d4d432fe", Sex.class),
        DerivationEventType("398b50bb-348e-4fe0-a7f5-a75afd846d1f", DerivationEventType.class),
        PreservationMethod("a7dc20c9-e6b3-459e-8f05-8d6d8fceb465", PreservationMethod.class),
        DeterminationModifier("fe87ea8d-6e0a-4e5d-b0da-0ab8ea67ca77", DeterminationModifier.class),
        StatisticalMeasure("066cc62e-7213-495e-a020-97a1233bc037", StatisticalMeasure.class),
        RightsTerm("8627c526-73af-44d9-902c-11c1f11b60b4", RightsTerm.class),
        NameTypeDesignationStatus("ab60e738-4d09-4c24-a1b3-9466b01f9f55", NameTypeDesignationStatus.class),
        ExtensionType("117cc307-5bd4-4b10-9b2f-2e14051b3b20",ExtensionType.class),
        ReferenceSystem("ec6376e5-0c9c-4f5c-848b-b288e6c17a86",ReferenceSystem.class),
        InstitutionType("29ad808b-3126-4274-be81-4561e7afc76f", InstitutionType.class),
        MeasurementUnit("3b82c375-66bb-4636-be74-dc9cd087292a", MeasurementUnit.class),
        Scope("109bf76d-6f55-43d5-9ec5-6115d9490faa", Scope.class),
        Stage("4d475bea-c3ae-4494-be16-6796f22fabac", Stage.class),
        State("ceb65a53-c6cf-42bb-862f-daca7f2fc11d", State.class),
        TextFormat("ac3926d2-5f6b-45a5-9cf9-be2a5a43f9b3", TextFormat.class),
//      NamedArea("57c25420-ae94-4848-9513-2aff9bdb502c", NamedArea.class),
        NaturalLanguageTerm("fdaba4b0-5c14-11df-a08a-0800200c9a66", NaturalLanguageTerm.class),
        Modifier("b9434774-4931-4f1e-99cb-40a3ecd61777", Modifier.class)
        ;
        
        
        private UUID uuid;
        private Class<? extends DefinedTermBase<?>> clazz;
        
        private VocabularyEnum(String uuidString, Class<? extends DefinedTermBase<?>> clazz){
                this.uuid = UUID.fromString(uuidString);
                this.clazz = clazz;
        }
        
        /** 
         * @return the <code>UUID</code> this vocabulary is uniquely identified with
         */
        public UUID getUuid(){
                return uuid;
        }
        
        /**
         * @return the Class of a specific term vocabulary
         */
        public Class<? extends DefinedTermBase<?>> getClazz(){
                return clazz;
        }
        
        public static VocabularyEnum getVocabularyEnum(Class clazz){
                
                for(VocabularyEnum vocabulary : VocabularyEnum.values()){
                        if(vocabulary.getClazz().equals(clazz)){
                                return vocabulary;
                        }
                }
                
                return null;
        }
}