cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/location/ReferenceSystem.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.model.location;
  11
  12
  13 import java.util.HashMap;
  14 import java.util.Map;
  15 import java.util.UUID;
  16
  17 import javax.persistence.Entity;
  18 import javax.xml.bind.annotation.XmlAccessType;
  19 import javax.xml.bind.annotation.XmlAccessorType;
  20 import javax.xml.bind.annotation.XmlRootElement;
  21 import javax.xml.bind.annotation.XmlType;
  22
  23 import org.apache.log4j.Logger;
  24 import org.hibernate.envers.Audited;
  25 import org.hibernate.search.annotations.Indexed;
  26
  27 import eu.etaxonomy.cdm.model.common.DefaultTermInitializer;
  28 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
  29 import eu.etaxonomy.cdm.model.common.TermType;
  30 import eu.etaxonomy.cdm.model.common.TermVocabulary;
  31
  32 /**
  33  * Reference systems for coordinates also according to OGC (Open Geographical
  34  * Consortium) The list should be extensible at runtime through configuration.
  35  * This needs to be investigated.
  36  * @author m.doering
  37  * @version 1.0
  38  * @created 08-Nov-2007 13:06:49
  39  */
  40 @XmlAccessorType(XmlAccessType.FIELD)
  41 @XmlType(name = "ReferenceSystem")
  42 @XmlRootElement(name = "ReferenceSystem")
  43 @Entity
  44 @Indexed(index = "eu.etaxonomy.cdm.model.common.DefinedTermBase")
  45 @Audited
  46 public class ReferenceSystem extends DefinedTermBase<ReferenceSystem> {
  47         private static final long serialVersionUID = -9060720949197749047L;
  48
  49         @SuppressWarnings("unused")
  50         private static final Logger logger = Logger.getLogger(ReferenceSystem.class);
  51
  52         protected static Map<UUID, ReferenceSystem> termMap = null;
  53
  54         private static final UUID uuidWGS84 = UUID.fromString("63f4dd55-00fa-49e7-96fd-2b7059a1c1ee");
  55         private static final UUID uuidGoogleEarth = UUID.fromString("1bb67042-2814-4b09-9e76-c8c1e68aa281");
  56         private static final UUID uuidGazetteer = UUID.fromString("e35f1d1c-9347-4190-bd47-a3b00632fcf3");
  57
  58
  59         /**
  60          * Factory method
  61          * @return
  62          */
  63         public static ReferenceSystem NewInstance(){
  64                 return new ReferenceSystem();
  65         }
  66
  67         /**
  68          * Factory method
  69          * @return
  70          */
  71         public static ReferenceSystem NewInstance(String term, String label, String labelAbbrev){
  72                 return new ReferenceSystem(term, label, labelAbbrev);
  73         }
  74
  75 //********************************** Constructor *******************************************************************/
  76
  77         //for hibernate use only
  78         @Deprecated
  79         protected ReferenceSystem() {
  80                 super(TermType.ReferenceSystem);
  81         }
  82
  83         /**
  84          * Constructor
  85          */
  86         private ReferenceSystem(String term, String label, String labelAbbrev) {
  87                 super(TermType.ReferenceSystem, term, label, labelAbbrev);
  88         }
  89
  90 // ************************************* MTEHODS ***************************************************/
  91
  92         /* (non-Javadoc)
  93          * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()
  94          */
  95         @Override
  96         public void resetTerms(){
  97                 termMap = null;
  98         }
  99
 100
 101
 102         protected static ReferenceSystem getTermByUuid(UUID uuid){
 103                 if (termMap == null){
 104                         DefaultTermInitializer vocabularyStore = new DefaultTermInitializer();
 105                         vocabularyStore.initialize();
 106                 }
 107                 return (ReferenceSystem)termMap.get(uuid);
 108         }
 109
 110         public static final ReferenceSystem WGS84(){
 111                 return getTermByUuid(uuidWGS84);
 112         }
 113
 114         public static final ReferenceSystem GOOGLE_EARTH(){
 115                 return getTermByUuid(uuidGoogleEarth);
 116         }
 117
 118         public static final ReferenceSystem GAZETTEER(){
 119                 return getTermByUuid(uuidGazetteer);
 120         }
 121
 122         @Override
 123         protected void setDefaultTerms(TermVocabulary<ReferenceSystem> termVocabulary){
 124                 termMap = new HashMap<UUID, ReferenceSystem>();
 125                 for (ReferenceSystem term : termVocabulary.getTerms()){
 126                         termMap.put(term.getUuid(), term);
 127                 }
 128         }
 129
 130 }