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
|
import java.io.Serializable;
|
13
|
import java.util.Set;
|
14
|
import java.util.UUID;
|
15
|
|
16
|
import javax.xml.bind.annotation.XmlEnum;
|
17
|
import javax.xml.bind.annotation.XmlEnumValue;
|
18
|
|
19
|
import org.apache.log4j.Logger;
|
20
|
|
21
|
import eu.etaxonomy.cdm.model.name.TaxonName;
|
22
|
import eu.etaxonomy.cdm.model.term.EnumeratedTermVoc;
|
23
|
import eu.etaxonomy.cdm.model.term.IEnumTerm;
|
24
|
|
25
|
|
26
|
|
27
|
/**
|
28
|
* The original source type is used to define the type of an {@link OriginalSourceBase original source}.<BR>
|
29
|
* It is used to distinguish e.g. data lineage when importing data from one database to another from e.g. content oriented
|
30
|
* sources such as the citation in a book.
|
31
|
* In future they may come further source types.
|
32
|
* @author a.mueller
|
33
|
* @since 15.05.2013
|
34
|
*/
|
35
|
@XmlEnum
|
36
|
public enum OriginalSourceType implements IEnumTerm<OriginalSourceType>, Serializable{
|
37
|
|
38
|
//0
|
39
|
/**
|
40
|
* Unknown provenance is the type to be used if no information is available about the type
|
41
|
* of activity that happened.
|
42
|
*
|
43
|
*/
|
44
|
@XmlEnumValue("Unknown")
|
45
|
Unknown(UUID.fromString("b48a443c-05f2-47ff-b885-1d3bd31118e1"), "Unknown Provenance", "UNK", null),
|
46
|
|
47
|
//1
|
48
|
/**
|
49
|
* Primary Taxonomic Source describes the sources a taxonomist uses to gather certain information.
|
50
|
* E.g. a taxonomist may have used three books/articles/other references to gather information
|
51
|
* about the distribution status of a taxon.
|
52
|
* He/she will store these references as original source of type Primary Taxonomic Source.
|
53
|
* This is a specialization of PROV-O Primary Source
|
54
|
* ({@link http://www.w3.org/TR/2013/REC-prov-o-20130430/#PrimarySource})
|
55
|
*
|
56
|
*/
|
57
|
@XmlEnumValue("Primary Taxonomic Source")
|
58
|
PrimaryTaxonomicSource(UUID.fromString("c990beb3-3bc9-4dad-bbdf-9c11683493da"), "Primary Taxonomic Source", "PTS", null),
|
59
|
|
60
|
//2
|
61
|
/**
|
62
|
* Data Lineage describes the data life cycle of electronically available data. A typical
|
63
|
* use-case for data lineage is a data import from one database to another. Sources of
|
64
|
* type data lineage will store information about the original database and the identifier
|
65
|
* and table (->namespace) used in the original database.
|
66
|
* There are multiple types of data lineage: Blackbox, Dispatcher, Aggregator
|
67
|
* ({@link http://de.wikipedia.org/wiki/Data-Lineage})
|
68
|
*/
|
69
|
@XmlEnumValue("Data Lineage")
|
70
|
Lineage(UUID.fromString("4f9fdf9a-f3b5-490c-96f0-90e050599b0e"), "Data Lineage", "DLI", null),
|
71
|
|
72
|
//3
|
73
|
/**
|
74
|
* Database Import is a specialization of {@value #Lineage}. It describes the electronic
|
75
|
* import of data from an external datasource into the given datasource. This step may
|
76
|
* include data transformations also but the primary process is the import of data.
|
77
|
*/
|
78
|
@XmlEnumValue("Database Import")
|
79
|
Import(UUID.fromString("2a3902ff-06a7-4307-b542-c743e664b8f2"), "Database Import", "DIM", Lineage),
|
80
|
|
81
|
//4
|
82
|
/**
|
83
|
* Data Transformation is a specialization of {@value #Lineage} and describes a data
|
84
|
* transformation process that happens primarily on the given dataset but may also
|
85
|
* include external data.
|
86
|
*/
|
87
|
@XmlEnumValue("Data Transformation")
|
88
|
Transformation(UUID.fromString("d59e80e5-cbb7-4658-b74d-0626bbb0da7f"), "Data Transformation", "TRA", Lineage),
|
89
|
|
90
|
|
91
|
//5
|
92
|
/**
|
93
|
* Data aggregation is a specification of {@value #Lineage} and describes the
|
94
|
* data transformation process that primarily includes data aggregation processes
|
95
|
* but may also include data imports and transformations.
|
96
|
*/
|
97
|
@XmlEnumValue("Data Aggregation")
|
98
|
Aggregation(UUID.fromString("944f2f40-5144-4c81-80d9-f61aa10507b8"), "Data Aggregation", "DAG", Lineage),
|
99
|
|
100
|
//6
|
101
|
/**
|
102
|
* Primary Media Source describes the original source for any media file.
|
103
|
* E.g. a media may be copy of figure in book. The book itself will then be the primary media source.
|
104
|
*
|
105
|
* This is a specialization of PROV-O Primary Source
|
106
|
* ({@link http://www.w3.org/TR/2013/REC-prov-o-20130430/#PrimarySource})
|
107
|
*
|
108
|
*/
|
109
|
@XmlEnumValue("Primary Media Source")
|
110
|
PrimaryMediaSource(UUID.fromString("72be3615-a6da-4728-948a-b3c5797fa4bc"), "Primary Media Source", "PMS", null),
|
111
|
|
112
|
//6
|
113
|
/**
|
114
|
* Nomenclatural reference as used for {@link TaxonName taxon names} and
|
115
|
* type designations.
|
116
|
* E.g. a media may be copy of figure in book. The book itself will then be the primary media source.
|
117
|
*
|
118
|
*/
|
119
|
@XmlEnumValue("Nomenclatural Reference")
|
120
|
NomenclaturalReference(UUID.fromString("67650daf-d4aa-48da-aa41-18d2763383aa"), "Nomenclatural Reference", "NOR", null),
|
121
|
|
122
|
|
123
|
//7
|
124
|
/**
|
125
|
* <code>Other</code> is the type to be used if none of the other types is applicable.
|
126
|
*/
|
127
|
@XmlEnumValue("Other")
|
128
|
Other(UUID.fromString("b7c4b7fe-0aef-428a-bb7b-9153a11bf845"), "Other", "OTH", null),
|
129
|
|
130
|
;
|
131
|
|
132
|
|
133
|
@SuppressWarnings("unused")
|
134
|
private static final Logger logger = Logger.getLogger(OriginalSourceType.class);
|
135
|
|
136
|
|
137
|
@SuppressWarnings("unchecked")
|
138
|
private OriginalSourceType(UUID uuid, String defaultString, String key, OriginalSourceType parent){
|
139
|
delegateVocTerm = EnumeratedTermVoc.addTerm(getClass(), this, uuid, defaultString, key, parent);
|
140
|
}
|
141
|
|
142
|
|
143
|
|
144
|
// *************************** DELEGATE **************************************/
|
145
|
|
146
|
private static EnumeratedTermVoc<OriginalSourceType> delegateVoc;
|
147
|
private IEnumTerm<OriginalSourceType> delegateVocTerm;
|
148
|
|
149
|
static {
|
150
|
delegateVoc = EnumeratedTermVoc.getVoc(OriginalSourceType.class);
|
151
|
}
|
152
|
|
153
|
@Override
|
154
|
public String getKey(){return delegateVocTerm.getKey();}
|
155
|
|
156
|
@Override
|
157
|
public String getMessage(){return delegateVocTerm.getMessage();}
|
158
|
|
159
|
@Override
|
160
|
public String getMessage(Language language){return delegateVocTerm.getMessage(language);}
|
161
|
|
162
|
@Override
|
163
|
public UUID getUuid() {return delegateVocTerm.getUuid();}
|
164
|
|
165
|
@Override
|
166
|
public OriginalSourceType getKindOf() {return delegateVocTerm.getKindOf();}
|
167
|
|
168
|
@Override
|
169
|
public Set<OriginalSourceType> getGeneralizationOf() {return delegateVocTerm.getGeneralizationOf();}
|
170
|
|
171
|
@Override
|
172
|
public boolean isKindOf(OriginalSourceType ancestor) {return delegateVocTerm.isKindOf(ancestor); }
|
173
|
|
174
|
@Override
|
175
|
public Set<OriginalSourceType> getGeneralizationOf(boolean recursive) {return delegateVocTerm.getGeneralizationOf(recursive);}
|
176
|
|
177
|
|
178
|
public static OriginalSourceType getByKey(String key){return delegateVoc.getByKey(key);}
|
179
|
public static OriginalSourceType getByUuid(UUID uuid) {return delegateVoc.getByUuid(uuid);}
|
180
|
|
181
|
}
|