Project

General

Profile

CommonDataModel » History » Version 49

Markus Döring, 03/27/2008 05:28 PM

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 45 Markus Döring
The [CDM v1.0](http://wp5.e-taxonomy.eu/cdm/v1/) 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 38 Markus Döring
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 21 Markus Döring
35 40 Markus Döring
36 1
37 49 Markus Döring
### Current Working Verion
38 1
39 49 Markus Döring
 **Towards CDM Version 2.0** 
40
41 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.
42
43 49 Markus Döring
 
44
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_). 
45 1
46
47 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*.
48 1
49
50
51 45 Markus Döring
### FAQ
52 43 Markus Döring
53 45 Markus Döring
Additionally to the UML and Java documentation we maintain a *CdmFaq*.
54
55
56
57 8 Markus Döring
58 1
----
59
60
61 45 Markus Döring
## Contributing
62 3 Markus Döring
63 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. 
64 1
65 47 Markus Döring
66 1
 **mailto:cdm-edit@mnhn.fr** 
67
68 18 Markus Döring
69
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:
70 1
71
72 49 Markus Döring
https://webmail.mnhn.fr/wws/arc/cdm-edit 
73 18 Markus Döring
74 1
75 45 Markus Döring
As we sometimes cannot apply changes immediately to the model, we also keep track of issues to be done.
76
77 1
All notes regarding changes or additions to the CDM are managed with [[report13|tickets in TRAC]].
78 18 Markus Döring
79 1
80
81 18 Markus Döring
82 45 Markus Döring
## Partner
83 38 Markus Döring
84 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. 
85 46 Markus Döring
86
Our main collaborators so far are:
87
88
* EDIT WP6 Exemplar groups, see also [[CdmDataportal]]
89
90
  * [Palmweb](http://www.palmweb.org,) Kew
91
92
  * [Cichorieae](http://wp6-cichorieae.e-taxonomy.eu,) BGBM
93
94
  * [Milichiidae](http://www.milichiidae.info/,) NHM
95 45 Markus Döring
96 1
* [CATE project](http://www.cate-project.org/,) London
97 44 Markus Döring
98 45 Markus Döring
* PESI, "Pan European Species-directories Infrastructure"
99 1
100 45 Markus Döring
  * [Euro+Med PlantBase](http://www.emplantbase.org)
101 1
102 45 Markus Döring
  * [Fauna Europaea](http://www.faunaeur.org/)
103 1
104 49 Markus Döring
  * [European Register of Marine Species (ERMS)](http://www.marbef.org/data/erms.php) 
105 1
106 45 Markus Döring
* [Key2Nature](http://www.key2nature.eu)
107 44 Markus Döring
108
109
110 45 Markus Döring
## Releases
111 44 Markus Döring
112 45 Markus Döring
The CDM is released as part of the [[CdmLibrary]]
113 44 Markus Döring
114
115
116
117 45 Markus Döring
----
118 44 Markus Döring
119
120
## Background Information
121
122
* [[TaxonomicGlossary]] - general taxonomic & nomenclatural glossary
123
124
* [[ZoologicalAdaptation]] - changes required for the [[BerlinModel]] to deal with zoological data
125 1
126
* [[ZooCode]] - the difference of the zoological code compared to the botanical code
127
128 2 Markus Döring
* [[NomenclaturalStatus]] - descriptions of the different nomenclatural status codes both for botany and zoology
129 1
130
* [[TaxonomicDataStandards]] - other taxonomic models and standards
131
132
* [[BibliographicalDataStandards]] - bibliographical models and standards
133 45 Markus Döring
134
135
136
### Modelling Guidelines
137
138
* [[BestPractices]] - best practices for the EDIT UML modelling and coding conventions for developers
139
140
* [[OntologyModelling]] - general remarks and links to OWL