cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/Language.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.common;
  11
  12
  13 import org.apache.log4j.Logger;
  14 import org.springframework.stereotype.Component;
  15 import au.com.bytecode.opencsv.CSVWriter;
  16
  17 import java.util.*;
  18
  19 import javax.persistence.*;
  20 import javax.xml.bind.annotation.XmlAccessType;
  21 import javax.xml.bind.annotation.XmlAccessorType;
  22 import javax.xml.bind.annotation.XmlAttribute;
  23 import javax.xml.bind.annotation.XmlType;
  24
  25 /**
  26  * list of languages according to current internet best practices as given by IANA
  27  * or ISO codes.  http://www.ietf.org/rfc/rfc4646.txt
  28  * http://www.loc.gov/standards/iso639-2/php/English_list.php
  29  * @author m.doering
  30  * @version 1.0
  31  * @created 08-Nov-2007 13:06:31
  32  */
  33 @XmlAccessorType(XmlAccessType.FIELD)
  34 @XmlType(name = "Language")
  35 @Entity
  36 @Component
  37 public class Language extends DefinedTermBase {
  38         static Logger logger = Logger.getLogger(Language.class);
  39
  40         private static final UUID uuidChinese = UUID.fromString("a9fc2782-5b2a-466f-b9c3-64d9ca6614c4");
  41         public static final UUID uuidEnglish = UUID.fromString("e9f8cdb7-6819-44e8-95d3-e2d0690c3523");
  42         private static final UUID uuidSpanish = UUID.fromString("511d8125-f5e6-445d-aee2-6327375238be");
  43         private static final UUID uuidHindi = UUID.fromString("0a1d9d1d-135d-4575-b172-669b51673c39");
  44         private static final UUID uuidArabic = UUID.fromString("4d3ec2eb-536f-4aab-81c5-34e37a3edbba");
  45         private static final UUID uuidRussian = UUID.fromString("64ea9354-cbf8-40de-9f6e-387d24896f50");
  46         private static final UUID uuidPortuguese = UUID.fromString("c2c08339-2405-4d7d-bd25-cbe01fb7ce09");
  47         private static final UUID uuidJapanese = UUID.fromString("6778c7fb-c195-4dc1-ae3f-164201314e51");
  48         private static final UUID uuidGerman = UUID.fromString("d1131746-e58b-4e80-a865-f5182c9c3073");
  49         private static final UUID uuidFrench = UUID.fromString("7759a1d8-a5ea-454a-8c93-1dcfaae8cc21");
  50         private static final UUID uuidItalian = UUID.fromString("fecbf0c7-fea9-465b-8a16-950517c5c0c4");
  51         private static final UUID uuidDutch = UUID.fromString("9965d79a-acf9-4921-a2c0-863b8c16c056");
  52         private static final UUID uuidPolish = UUID.fromString("3fdca387-f1b0-4ec1-808f-1bc3dc482194");
  53         private static final UUID uuidLatin = UUID.fromString("160a5b6c-87f5-4422-9bda-78cd404c179e");
  54
  55         public static Language NewInstance(){
  56                 return new Language();
  57         }
  58
  59         public static Language NewInstance(UUID uuid){
  60                 return new Language(uuid);
  61         }
  62
  63         @XmlAttribute(name = "iso639_1")
  64         private char[] iso639_1 = new char[2];
  65         @XmlAttribute(name = "iso639_2")
  66         private char[] iso639_2 = new char[3];
  67
  68         public Language() {
  69                 super();
  70         }
  71         public Language(UUID uuid) {
  72                 super();
  73                 this.setUuid(uuid);
  74         }
  75         public Language(char[] iso639_1, char[] iso639_2, String englishLabel, String frenchLabel) throws Exception {
  76                 super();
  77                 if(iso639_1.length > 2){
  78                         logger.warn("iso639_1 too long: "+iso639_1.toString());
  79                 }
  80                 if(iso639_2.length > 3){
  81                         logger.warn("iso639_2 too long: "+iso639_2.toString());
  82                 }
  83                 this.iso639_1=iso639_1;
  84                 this.iso639_2=iso639_2;
  85                 String textEnglish = englishLabel;
  86                 String textFrench = englishLabel;
  87                 String label = String.valueOf(iso639_2);
  88                 String labelAbbrev = null;
  89                 this.addRepresentation(new Representation(textEnglish, label, labelAbbrev, Language.ENGLISH()));
  90                 this.addRepresentation(new Representation(textFrench, label, labelAbbrev, Language.FRENCH()));
  91         }
  92         public Language(String text, String label, String labelAbbrev, Language lang) {
  93                 super();
  94                 this.addRepresentation(new Representation(text,label,labelAbbrev, lang));
  95         }
  96         public Language(String label, String text, String labelAbbrev) {
  97                 this(label,text,labelAbbrev, DEFAULT());
  98         }
  99
 100         public static final Language getByUuid(UUID uuid){
 101                 return (Language)findByUuid(uuid);
 102         }
 103
 104
 105         public static final Language DEFAULT(){
 106                 return ENGLISH();
 107         }
 108
 109
 110         public static final Language CHINESE(){
 111                 return getByUuid(uuidChinese);
 112         }
 113
 114         public static final Language ENGLISH(){
 115                 return getByUuid(uuidEnglish);
 116         }
 117
 118         public static final Language SPANISH(){
 119                 return getByUuid(uuidSpanish);
 120         }
 121
 122         public static final Language HINDI(){
 123                 return getByUuid(uuidHindi);
 124         }
 125
 126         public static final Language ARABIC(){
 127                 return getByUuid(uuidArabic);
 128         }
 129
 130         public static final Language RUSSIAN(){
 131                 return getByUuid(uuidRussian);
 132         }
 133
 134         public static final Language PORTUGUESE(){
 135                 return getByUuid(uuidPortuguese);
 136         }
 137
 138         public static final Language JAPANESE(){
 139                 return getByUuid(uuidJapanese);
 140         }
 141
 142         public static final Language GERMAN(){
 143                 return getByUuid(uuidGerman);
 144         }
 145
 146         public static final Language FRENCH(){
 147                 return getByUuid(uuidFrench);
 148         }
 149
 150         public static final Language ITALIAN(){
 151                 return getByUuid(uuidItalian);
 152         }
 153
 154         public static final Language DUTCH(){
 155                 return getByUuid(uuidDutch);
 156         }
 157
 158         public static final Language POLISH(){
 159                 return getByUuid(uuidPolish);
 160         }
 161
 162         public static final Language LATIN(){
 163                 return getByUuid(uuidLatin);
 164         }
 165
 166         /**
 167          * Get the according iso639-1 alpha-2 language code
 168          * http://www.loc.gov/standards/iso639-2/
 169          *
 170          * @return the iso639 alpha-2 language code or null if not available
 171          */
 172         //TODO create userDefinedType ?
 173         @Column(length=2)
 174         public String getIso639_1() {
 175
 176                 return String.valueOf(iso639_1);
 177         }
 178
 179         public void setIso639_1(String iso639_1) {
 180                 iso639_1 = iso639_1.trim();
 181                 if(iso639_1.length() > 2){
 182                         logger.warn("Iso639-1: "+iso639_1+" too long");
 183                 }
 184                 this.iso639_1 = iso639_1.toCharArray();
 185         }
 186
 187         /**
 188          * Get the according iso639-2 alpha-3 language code
 189          * http://www.loc.gov/standards/iso639-2/
 190          *
 191          * @return the iso639 alpha-3 language code or null if not available
 192          */
 193         //TODO create userDefinedType ?
 194         @Column(length=3)
 195         public String getIso639_2() {
 196                 return String.valueOf(iso639_2);
 197         }
 198
 199         public void setIso639_2(String iso639_2) {
 200                 iso639_2 = iso639_2.trim();
 201                 if(iso639_2.length() > 3 ){
 202                         logger.warn("Iso639-2: "+iso639_2+" too long");
 203                 }
 204                 this.iso639_2 = iso639_2.toCharArray();
 205         }
 206
 207         @Override
 208         public ILoadableTerm readCsvLine(List csvLine) {
 209                 ILoadableTerm result;
 210                 if ( UUID.fromString(csvLine.get(0).toString()).equals(DEFAULT().getUuid()) && this != DEFAULT() ){
 211                         result = DEFAULT();
 212                         result.readCsvLine(csvLine);
 213                 }else{
 214                         // read UUID, URI, english label+description
 215                         List<String> csvLineString = csvLine;
 216                         result = this;
 217                         super.readCsvLine(csvLine);
 218                         // iso codes extra
 219                         this.iso639_1=csvLineString.get(5).trim().toCharArray();
 220                         this.iso639_2=csvLineString.get(4).trim().toCharArray();
 221                         if(iso639_1.length > 2){
 222                                 logger.warn("Iso639-1: "+iso639_1.toString()+" from "+csvLine.get(3)+" ,"+csvLine.get(2)+" too long");
 223                         }
 224                         if(iso639_2.length > 3 ){
 225                                 logger.warn("Iso639-2: "+iso639_2.toString()+" from "+csvLine.get(3)+" ,"+csvLine.get(2)+" too long");
 226                         }
 227                 }
 228                 return result;
 229         }
 230
 231         @Override
 232         public void writeCsvLine(CSVWriter writer) {
 233                 String [] line = new String[6];
 234                 line[0] = getUuid().toString();
 235                 line[1] = getUri();
 236                 line[2] = getLabel(Language.ENGLISH());
 237                 line[3] = getDescription(Language.ENGLISH());
 238                 line[4] = String.valueOf(this.iso639_1);
 239                 line[5] = String.valueOf(this.iso639_2);
 240                 writer.writeNext(line);
 241         }
 242
 243         /* (non-Javadoc)
 244          * @see eu.etaxonomy.cdm.model.common.TermBase#toString()
 245          */
 246         @Override
 247         public String toString() {
 248                 if (this.getLabel() != null){
 249                         return this.getLabel();
 250                 }else{
 251                         return super.toString();
 252                 }
 253         }
 254
 255
 256
 257 }