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.TermVocabulary;
  30
  31 /**
  32  * Reference systems for coordinates also according to OGC (Open Geographical
  33  * Consortium) The list should be extensible at runtime through configuration.
  34  * This needs to be investigated.
  35  * @author m.doering
  36  * @version 1.0
  37  * @created 08-Nov-2007 13:06:49
  38  */
  39 @XmlAccessorType(XmlAccessType.FIELD)
  40 @XmlType(name = "ReferenceSystem")
  41 @XmlRootElement(name = "ReferenceSystem")
  42 @Entity
  43 @Indexed(index = "eu.etaxonomy.cdm.model.common.DefinedTermBase")
  44 @Audited
  45 public class ReferenceSystem extends DefinedTermBase<ReferenceSystem> {
  46         private static final long serialVersionUID = -9060720949197749047L;
  47
  48         @SuppressWarnings("unused")
  49         private static final Logger logger = Logger.getLogger(ReferenceSystem.class);
  50
  51         protected static Map<UUID, ReferenceSystem> termMap = null;
  52
  53         private static final UUID uuidWGS84 = UUID.fromString("63f4dd55-00fa-49e7-96fd-2b7059a1c1ee");
  54         private static final UUID uuidGoogleEarth = UUID.fromString("1bb67042-2814-4b09-9e76-c8c1e68aa281");
  55         private static final UUID uuidGazetteer = UUID.fromString("e35f1d1c-9347-4190-bd47-a3b00632fcf3");
  56
  57
  58         /**
  59          * Factory method
  60          * @return
  61          */
  62         public static ReferenceSystem NewInstance(){
  63                 return new ReferenceSystem();
  64         }
  65
  66         /**
  67          * Factory method
  68          * @return
  69          */
  70         public static ReferenceSystem NewInstance(String term, String label, String labelAbbrev){
  71                 return new ReferenceSystem(term, label, labelAbbrev);
  72         }
  73
  74         /**
  75          * Constructor
  76          */
  77         public ReferenceSystem() {
  78         }
  79
  80         /**
  81          * Constructor
  82          */
  83         private ReferenceSystem(String term, String label, String labelAbbrev) {
  84                 super(term, label, labelAbbrev);
  85         }
  86
  87 // ************************************* MTEHODS ***************************************************/
  88
  89         /* (non-Javadoc)
  90          * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()
  91          */
  92         @Override
  93         public void resetTerms(){
  94                 termMap = null;
  95         }
  96
  97
  98
  99         protected static ReferenceSystem getTermByUuid(UUID uuid){
 100                 if (termMap == null){
 101                         DefaultTermInitializer vocabularyStore = new DefaultTermInitializer();
 102                         vocabularyStore.initialize();
 103                 }
 104                 return (ReferenceSystem)termMap.get(uuid);
 105         }
 106
 107         public static final ReferenceSystem WGS84(){
 108                 return getTermByUuid(uuidWGS84);
 109         }
 110
 111         public static final ReferenceSystem GOOGLE_EARTH(){
 112                 return getTermByUuid(uuidGoogleEarth);
 113         }
 114
 115         public static final ReferenceSystem GAZETTEER(){
 116                 return getTermByUuid(uuidGazetteer);
 117         }
 118
 119         @Override
 120         protected void setDefaultTerms(TermVocabulary<ReferenceSystem> termVocabulary){
 121                 termMap = new HashMap<UUID, ReferenceSystem>();
 122                 for (ReferenceSystem term : termVocabulary.getTerms()){
 123                         termMap.put(term.getUuid(), term);
 124                 }
 125         }
 126
 127 }