Project

General

Profile

CommonDataModel » History » Version 52

Andreas Kohlbecker, 04/06/2009 09:56 AM

1 32 Markus Döring
2 1
{{>toc}}
3
4
5
6
7 13 Markus Döring
# Common Data Model
8 1
9 31 Markus Döring
The Common Data Model (CDM) is the domain model for the core EDIT components. The CDM is primarily based on the [TDWG Ontology](http://rs.tdwg.org/ontology/voc/.) But other models and standards (see [[TaxonomicDataStandards]], [[BibliographicalDataStandards]], [[SpecimenOrObservationStandards]]) have influenced the modelling too.
10 2 Markus Döring
11 1
12 30 Markus Döring
13 1
## Scope
14 30 Markus Döring
15 49 Markus Döring
Basically the CDM covers all the data exchanged in the platform. As most applications require additional data, options to extend the model need to be provided. 
16 1
17 50 Andreas Müller
The [CDM v1.4](http://wp5.e-taxonomy.eu/cdm/v14/) covers the following object types (classes), grouped by packages:
18 19 Markus Döring
19 1
20
[!Model|Overview.gif!]
21
22
23 27 Markus Döring
24 1
25 26 Markus Döring
----
26 1
27 31 Markus Döring
28 45 Markus Döring
## Model Documentation
29 31 Markus Döring
30 1
31 38 Markus Döring
### CDM Version 1.0
32 36 Markus Döring
33 1
The [**first version of the CDM**](http://wp5.e-taxonomy.eu/cdm/v1/) has been completed and version:"CDM UML 1.0" reached. The modelling was done with Enterprise Architect and resulted in annotated UML class diagrams. The model is also available for download: attachment:"edit_cdm.eap".
34 50 Andreas Müller
35
36
37
### CDM Version 1.4
38
39 51 Andreas Müller
The [**version 1.4 of the CDM**](http://wp5.e-taxonomy.eu/cdm/v14/) has been completed together with the deliverable D11. The modelling was done in Java and import into Enterprise Architect. The model is also available for download: attachment:"edit_cdm_14.eap".
40 21 Markus Döring
41 40 Markus Döring
42 1
43 49 Markus Döring
### Current Working Verion
44 1
45 52 Andreas Kohlbecker
46
 **Towards [CDM v2.0](http://wp5.e-taxonomy.eu/cdm/v20/**) 
47
48 49 Markus Döring
49 1
Since the first version of the CDM was purely modelled in UML with implementation in mind, but no real world use yet, implementing the model in Java code will require minor changes all over. A stable second version of the CDM is expected for 4Q/2008.
50
51 49 Markus Döring
 
52
Since the freeze of version 1.0 we are primarily maintaining the model in the source:"trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model" and derive the UML documentation from Enterprise Architect from there using EA's import source-code feature that synchronizes classes by namespace (_in EA7 project browser "Common Data Model"-"Java Model" -> right click ->Code Engineering->Import Source Directory_). 
53 1
54
55 45 Markus Döring
The latest documentation of the post-version1 model can be found in *JavaDocs:cdmlib-model*. We also keep track of the major *CdmChanges*.
56 1
57
58
59 45 Markus Döring
### FAQ
60 43 Markus Döring
61 45 Markus Döring
Additionally to the UML and Java documentation we maintain a *CdmFaq*.
62
63
64
65 8 Markus Döring
66 1
----
67
68
69 45 Markus Döring
## Contributing
70 3 Markus Döring
71 49 Markus Döring
This wiki describes the latest stage of the modelling efforts. Discussions are being held on a mailing list dedicated only to the CDM. We invite everyone to join the mailinglist to follow discussions, raise questions or even suggest changes to the model. 
72 1
73 47 Markus Döring
74 1
 **mailto:cdm-edit@mnhn.fr** 
75
76 18 Markus Döring
77
The list has a public online archive that stores the discussions so decisions can be tracked back in time. We invite anyone to participate in the discussion, you can subscribe to the mailing list through the webinterface of the archive:
78 1
79
80 49 Markus Döring
https://webmail.mnhn.fr/wws/arc/cdm-edit 
81 18 Markus Döring
82 1
83 45 Markus Döring
As we sometimes cannot apply changes immediately to the model, we also keep track of issues to be done.
84
85 1
All notes regarding changes or additions to the CDM are managed with [[report13|tickets in TRAC]].
86 18 Markus Döring
87 1
88
89 18 Markus Döring
90 45 Markus Döring
## Partner
91 38 Markus Döring
92 49 Markus Döring
We try to collaborate with other projects outside of EDIT to base its development on a stable long-term perspective. Apart from shared software development it is essential that we test the CDM with different, diverse datasets. 
93 46 Markus Döring
94
Our main collaborators so far are:
95
96
* EDIT WP6 Exemplar groups, see also [[CdmDataportal]]
97
98
  * [Palmweb](http://www.palmweb.org,) Kew
99
100
  * [Cichorieae](http://wp6-cichorieae.e-taxonomy.eu,) BGBM
101
102
  * [Milichiidae](http://www.milichiidae.info/,) NHM
103 45 Markus Döring
104 1
* [CATE project](http://www.cate-project.org/,) London
105 44 Markus Döring
106 45 Markus Döring
* PESI, "Pan European Species-directories Infrastructure"
107 1
108 45 Markus Döring
  * [Euro+Med PlantBase](http://www.emplantbase.org)
109 1
110 45 Markus Döring
  * [Fauna Europaea](http://www.faunaeur.org/)
111 1
112 49 Markus Döring
  * [European Register of Marine Species (ERMS)](http://www.marbef.org/data/erms.php) 
113 1
114 45 Markus Döring
* [Key2Nature](http://www.key2nature.eu)
115 44 Markus Döring
116
117
118 45 Markus Döring
## Releases
119 44 Markus Döring
120 45 Markus Döring
The CDM is released as part of the [[CdmLibrary]]
121 44 Markus Döring
122
123
124
125 45 Markus Döring
----
126 44 Markus Döring
127
128
## Background Information
129
130
* [[TaxonomicGlossary]] - general taxonomic & nomenclatural glossary
131
132
* [[ZoologicalAdaptation]] - changes required for the [[BerlinModel]] to deal with zoological data
133 1
134
* [[ZooCode]] - the difference of the zoological code compared to the botanical code
135
136 2 Markus Döring
* [[NomenclaturalStatus]] - descriptions of the different nomenclatural status codes both for botany and zoology
137 1
138
* [[TaxonomicDataStandards]] - other taxonomic models and standards
139
140
* [[BibliographicalDataStandards]] - bibliographical models and standards
141 45 Markus Döring
142
143
144
### Modelling Guidelines
145
146
* [[BestPractices]] - best practices for the EDIT UML modelling and coding conventions for developers
147
148
* [[OntologyModelling]] - general remarks and links to OWL