|
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.description;
|
|
11
|
|
|
12
|
import java.util.HashMap;
|
|
13
|
import java.util.Map;
|
|
14
|
import java.util.UUID;
|
|
15
|
|
|
16
|
import javax.persistence.Entity;
|
|
17
|
import javax.xml.bind.annotation.XmlAccessType;
|
|
18
|
import javax.xml.bind.annotation.XmlAccessorType;
|
|
19
|
import javax.xml.bind.annotation.XmlRootElement;
|
|
20
|
import javax.xml.bind.annotation.XmlType;
|
|
21
|
|
|
22
|
import org.apache.log4j.Logger;
|
|
23
|
import org.hibernate.envers.Audited;
|
|
24
|
import org.hibernate.search.annotations.Indexed;
|
|
25
|
|
|
26
|
import eu.etaxonomy.cdm.model.common.Language;
|
|
27
|
import eu.etaxonomy.cdm.model.common.TermVocabulary;
|
|
28
|
import eu.etaxonomy.cdm.model.location.NamedArea;
|
|
29
|
import eu.etaxonomy.cdm.model.taxon.Taxon;
|
|
30
|
|
|
31
|
/**
|
|
32
|
* This class represents terms describing different types of presence
|
|
33
|
* (like "native" or "introduced") of a {@link Taxon taxon} in a {@link NamedArea particular area}.
|
|
34
|
*
|
|
35
|
* @author m.doering
|
|
36
|
* @version 1.0
|
|
37
|
* @created 08-Nov-2007 13:06:44
|
|
38
|
*/
|
|
39
|
@XmlAccessorType(XmlAccessType.FIELD)
|
|
40
|
@XmlType(name = "PresenceTerm")
|
|
41
|
@XmlRootElement(name = "PresenceTerm")
|
|
42
|
@Entity
|
|
43
|
@Indexed(index = "eu.etaxonomy.cdm.model.common.DefinedTermBase")
|
|
44
|
@Audited
|
|
45
|
public class PresenceTerm extends PresenceAbsenceTermBase<PresenceTerm> {
|
|
46
|
private static final long serialVersionUID = -2876981902335193596L;
|
|
47
|
private static final Logger logger = Logger.getLogger(PresenceTerm.class);
|
|
48
|
|
|
49
|
protected static Map<UUID, PresenceTerm> termMap = null;
|
|
50
|
|
|
51
|
private static final UUID uuidP=UUID.fromString("cef81d25-501c-48d8-bbea-542ec50de2c2");
|
|
52
|
private static final UUID uuidPD=UUID.fromString("75a60279-a4c2-4f53-bc57-466028a4b3db");
|
|
53
|
|
|
54
|
private static final UUID uuidN=UUID.fromString("ddeac4f2-d8fa-43b8-ad7e-ca13abdd32c7");
|
|
55
|
private static final UUID uuidNQ=UUID.fromString("925662c1-bb10-459a-8c53-da5a738ac770");
|
|
56
|
private static final UUID uuidND=UUID.fromString("310373bf-7df4-4d02-8cb3-bcc7448805fc");
|
|
57
|
private static final UUID uuidC=UUID.fromString("9eb99fe6-59e2-4445-8e6a-478365bd0fa9");
|
|
58
|
private static final UUID uuidI=UUID.fromString("643cf9d1-a5f1-4622-9837-82ef961e880b");
|
|
59
|
private static final UUID uuidIQ=UUID.fromString("83eb0aa0-1a45-495a-a3ca-bf6958b74366");
|
|
60
|
private static final UUID uuidID=UUID.fromString("0c54761e-4887-4788-9dfa-7190c88746e3");
|
|
61
|
private static final UUID uuidIP=UUID.fromString("da159544-b0dd-4599-a9c9-640826af8c17");
|
|
62
|
private static final UUID uuidIA=UUID.fromString("42946bd6-9c22-45ad-a910-7427e8f60bfd");
|
|
63
|
private static final UUID uuidIN=UUID.fromString("e191e89a-a751-4b0c-b883-7f1de70915c9");
|
|
64
|
private static final UUID uuidIC=UUID.fromString("fac8c347-8262-44a1-b0a4-db4de451c021");
|
|
65
|
private static final UUID uuidE=UUID.fromString("c3ee7048-15b7-4be1-b687-9ce9c1a669d6");
|
|
66
|
private static final UUID uuidNA=UUID.fromString("4e04990a-66fe-4fdf-856c-f40772fbcf0a");
|
|
67
|
private static final UUID uuidIV=UUID.fromString("dc536e3d-a753-4bbe-a386-dd8aff35c234");
|
|
68
|
|
|
69
|
|
|
70
|
//********* METHODS **************************************/
|
|
71
|
/**
|
|
72
|
* Creates a new empty presence term.
|
|
73
|
*
|
|
74
|
* @see #NewInstance(String, String, String)
|
|
75
|
*/
|
|
76
|
public static PresenceTerm NewInstance(){
|
|
77
|
return new PresenceTerm();
|
|
78
|
}
|
|
79
|
|
|
80
|
/**
|
|
81
|
* Creates a new presence term with a description (in the {@link Language#DEFAULT() default language}),
|
|
82
|
* a label and a label abbreviation.
|
|
83
|
*
|
|
84
|
* @param term the string (in the default language) describing the
|
|
85
|
* new presence term to be created
|
|
86
|
* @param label the string identifying the new presence term to be created
|
|
87
|
* @param labelAbbrev the string identifying (in abbreviated form) the
|
|
88
|
* new presence term to be created
|
|
89
|
* @see #NewInstance()
|
|
90
|
*/
|
|
91
|
public static PresenceTerm NewInstance(String term, String label, String labelAbbrev){
|
|
92
|
return new PresenceTerm(term, label, labelAbbrev);
|
|
93
|
}
|
|
94
|
|
|
95
|
// ************* CONSTRUCTORS *************/
|
|
96
|
/**
|
|
97
|
* Class constructor: creates a new empty presence term.
|
|
98
|
*
|
|
99
|
* @see #PresenceTerm(String, String, String)
|
|
100
|
*/
|
|
101
|
public PresenceTerm() {
|
|
102
|
}
|
|
103
|
|
|
104
|
/**
|
|
105
|
* Class constructor: creates a new presence term with a description (in the {@link Language#DEFAULT() default language}),
|
|
106
|
* a label and a label abbreviation.
|
|
107
|
*
|
|
108
|
* @param term the string (in the default language) describing the
|
|
109
|
* new presence term to be created
|
|
110
|
* @param label the string identifying the new presence term to be created
|
|
111
|
* @param labelAbbrev the string identifying (in abbreviated form) the
|
|
112
|
* new presence term to be created
|
|
113
|
* @see #PresenceTerm()
|
|
114
|
*/
|
|
115
|
public PresenceTerm(String term, String label, String labelAbbrev) {
|
|
116
|
super(term, label, labelAbbrev);
|
|
117
|
}
|
|
118
|
|
|
119
|
|
|
120
|
|
|
121
|
//******************************* STATIC METHODS *****************************************
|
|
122
|
|
|
123
|
protected static PresenceTerm getTermByUuid(UUID uuid){
|
|
124
|
if (termMap == null){
|
|
125
|
return null;
|
|
126
|
}else{
|
|
127
|
return (PresenceTerm)termMap.get(uuid);
|
|
128
|
}
|
|
129
|
}
|
|
130
|
|
|
131
|
|
|
132
|
public static final PresenceTerm PRESENT(){
|
|
133
|
return getTermByUuid(uuidP);
|
|
134
|
}
|
|
135
|
public static final PresenceTerm PRESENT_DOUBTFULLY(){
|
|
136
|
return getTermByUuid(uuidPD);
|
|
137
|
}
|
|
138
|
public static final PresenceTerm CULTIVATED(){
|
|
139
|
return getTermByUuid(uuidC);
|
|
140
|
}
|
|
141
|
public static final PresenceTerm ENDEMIC_FOR_THE_RELEVANT_AREA(){
|
|
142
|
return getTermByUuid(uuidE);
|
|
143
|
}
|
|
144
|
public static final PresenceTerm INTRODUCED(){
|
|
145
|
return getTermByUuid(uuidI);
|
|
146
|
}
|
|
147
|
public static final PresenceTerm INTRODUCED_ADVENTITIOUS(){
|
|
148
|
return getTermByUuid(uuidIA);
|
|
149
|
}
|
|
150
|
|
|
151
|
public static final PresenceTerm INTRODUCED_CULTIVATED(){
|
|
152
|
return getTermByUuid(uuidIC);
|
|
153
|
}
|
|
154
|
|
|
155
|
public static final PresenceTerm INTRODUCED_DOUBTFULLY_INTRODUCED(){
|
|
156
|
return getTermByUuid(uuidID);
|
|
157
|
}
|
|
158
|
|
|
159
|
public static final PresenceTerm INTRODUCED_NATURALIZED(){
|
|
160
|
return getTermByUuid(uuidIN);
|
|
161
|
}
|
|
162
|
|
|
163
|
public static final PresenceTerm INTRODUCED_PRESENCE_QUESTIONABLE(){
|
|
164
|
return getTermByUuid(uuidIQ);
|
|
165
|
}
|
|
166
|
|
|
167
|
public static final PresenceTerm INTRODUCED_UNCERTAIN_DEGREE_OF_NATURALISATION(){
|
|
168
|
return getTermByUuid(uuidIP);
|
|
169
|
}
|
|
170
|
|
|
171
|
public static final PresenceTerm NATIVE(){
|
|
172
|
return getTermByUuid(uuidN);
|
|
173
|
}
|
|
174
|
|
|
175
|
public static final PresenceTerm NATIVE_DOUBTFULLY_NATIVE(){
|
|
176
|
return getTermByUuid(uuidND);
|
|
177
|
}
|
|
178
|
|
|
179
|
public static final PresenceTerm NATIVE_PRESENCE_QUESTIONABLE(){
|
|
180
|
return getTermByUuid(uuidNQ);
|
|
181
|
}
|
|
182
|
|
|
183
|
public static final PresenceTerm INVASIVE(){
|
|
184
|
return getTermByUuid(uuidIV);
|
|
185
|
}
|
|
186
|
|
|
187
|
public static final PresenceTerm NATURALISED(){
|
|
188
|
return getTermByUuid(uuidNA);
|
|
189
|
}
|
|
190
|
|
|
191
|
//TODO read from label(abbrevs) like in TDWGArea
|
|
192
|
public static PresenceTerm getPresenceTermByAbbreviation(String abbrev) {
|
|
193
|
if (abbrev == null) { throw new NullPointerException("abbrev is 'null' in getPresenceTermByAbbreviation");
|
|
194
|
} else if (abbrev.equalsIgnoreCase("c")) { return PresenceTerm.CULTIVATED();
|
|
195
|
} else if (abbrev.equalsIgnoreCase("e")) { return PresenceTerm.ENDEMIC_FOR_THE_RELEVANT_AREA();
|
|
196
|
} else if (abbrev.equalsIgnoreCase("i")) { return PresenceTerm.INTRODUCED();
|
|
197
|
} else if (abbrev.equalsIgnoreCase("ia")) { return PresenceTerm.INTRODUCED_ADVENTITIOUS();
|
|
198
|
} else if (abbrev.equalsIgnoreCase("ic")) { return PresenceTerm.INTRODUCED_CULTIVATED();
|
|
199
|
} else if (abbrev.equalsIgnoreCase("id")) { return PresenceTerm.INTRODUCED_DOUBTFULLY_INTRODUCED();
|
|
200
|
} else if (abbrev.equalsIgnoreCase("in")) { return PresenceTerm.INTRODUCED_NATURALIZED();
|
|
201
|
} else if (abbrev.equalsIgnoreCase("ip")) { return PresenceTerm.INTRODUCED_UNCERTAIN_DEGREE_OF_NATURALISATION();
|
|
202
|
} else if (abbrev.equalsIgnoreCase("iq")) { return PresenceTerm.INTRODUCED_PRESENCE_QUESTIONABLE();
|
|
203
|
} else if (abbrev.equalsIgnoreCase("n")) { return PresenceTerm.NATIVE();
|
|
204
|
} else if (abbrev.equalsIgnoreCase("nd")) { return PresenceTerm.NATIVE_DOUBTFULLY_NATIVE();
|
|
205
|
} else if (abbrev.equalsIgnoreCase("nq")) { return PresenceTerm.NATIVE_PRESENCE_QUESTIONABLE();
|
|
206
|
} else if (abbrev.equalsIgnoreCase("p")) { return PresenceTerm.PRESENT();
|
|
207
|
} else if (abbrev.equalsIgnoreCase("na")) { return PresenceTerm.NATURALISED();
|
|
208
|
} else if (abbrev.equalsIgnoreCase("iv")) { return PresenceTerm.INVASIVE();
|
|
209
|
} else {
|
|
210
|
logger.warn("Unknown presence status term: " + abbrev);
|
|
211
|
return null;
|
|
212
|
}
|
|
213
|
}
|
|
214
|
|
|
215
|
//************************** METHODS ********************************
|
|
216
|
|
|
217
|
/* (non-Javadoc)
|
|
218
|
* @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()
|
|
219
|
*/
|
|
220
|
@Override
|
|
221
|
public void resetTerms(){
|
|
222
|
termMap = null;
|
|
223
|
}
|
|
224
|
|
|
225
|
/* (non-Javadoc)
|
|
226
|
* @see eu.etaxonomy.cdm.model.common.DefinedTermBase#setDefaultTerms(eu.etaxonomy.cdm.model.common.TermVocabulary)
|
|
227
|
*/
|
|
228
|
@Override
|
|
229
|
protected void setDefaultTerms(TermVocabulary<PresenceTerm> termVocabulary) {
|
|
230
|
termMap = new HashMap<UUID, PresenceTerm>();
|
|
231
|
for (PresenceTerm term : termVocabulary.getTerms()){
|
|
232
|
termMap.put(term.getUuid(), (PresenceTerm)term); //TODO casting
|
|
233
|
}
|
|
234
|
}
|
|
235
|
}
|