Project

General

Profile

CommonDataModel » History » Version 46

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