EDIT

# Common Data Model

{{>toc}}

Subpages:

{{child_pages}}

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.

## Scope

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. 

The [CDM](http://cybertaxonomy.eu/cdm/latest/) covers the following object types (classes), grouped by packages:

![](http://cybertaxonomy.eu/cdm/latest/EARoot/EA1/EA42.png)

----

## Model Documentation

### CDM Version 1.0

The [**first version**](http://cybertaxonomy.eu/cdm/v1/)  of the CDM 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".

### CDM Version 1.4

 [**Version 1.4**](http://cybertaxonomy.eu/cdm/v14/) of the CDM 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".

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 has required changes all over.

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 in Enterprise Architect from the source code. 

To generate the UML model automatically from the Java code EA's import source-code feature was used that synchronizes classes by namespace (_in EA7 project browser "Common Data Model"-"Java Model" -> right click ->Code Engineering->Import Source Directory_). 

### CDM Version 2.0

[**Version 2.0**](http://cybertaxonomy.eu/cdm/v20/) of the CDM.

### CDM Version 2.2

[**Version 2.2**](http://cybertaxonomy.eu/cdm/v22/) of the CDM.

### CDM Version 3.0

[**Version 3.0**](http://cybertaxonomy.eu/cdm/v30/) of the CDM.

### CDM Version 3.1

[**Version 3.1**](http://cybertaxonomy.eu/cdm/v31/) of the CDM.

### CDM Version 3.3

[**Version 3.3**](http://cybertaxonomy.eu/cdm/v33/) of the CDM is the most current version.

The latest documentation of the model can be found in *JavaDocs:cdmlib-model*. We also keep track of the major *CdmChanges*.

### FAQ

Additionally to the UML and Java documentation we maintain a *CdmFaq*.

----

## Contributing

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. 

**mailto:cdm-edit@mnhn.fr** 

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:

https://webmail.mnhn.fr/wws/arc/cdm-edit 

As we sometimes cannot apply changes immediately to the model, we also keep track of issues to be done.

All notes regarding changes or additions to the CDM are managed with [[report13|tickets in TRAC]].

## Partner

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. 

Our main collaborators so far are:

* EDIT WP6 Exemplar groups, see also [[CdmDataportal]]

  * [Palmweb](http://www.palmweb.org,) Kew

  * [Cichorieae](http://wp6-cichorieae.e-taxonomy.eu,) BGBM

  * [Milichiidae](http://www.milichiidae.info/,) NHM

* [CATE project](http://www.cate-project.org/,) London

* PESI, "Pan European Species-directories Infrastructure"

  * [Euro+Med PlantBase](http://www.emplantbase.org)

  * [Fauna Europaea](http://www.faunaeur.org/)

  * [European Register of Marine Species (ERMS)](http://www.marbef.org/data/erms.php) 

* [Key2Nature](http://www.key2nature.eu)

## Releases

The CDM is released as part of the [[CdmLibrary]]

----

## Background Information

* [[TaxonomicGlossary]] - general taxonomic & nomenclatural glossary

* [[ZoologicalAdaptation]] - changes required for the [[BerlinModel]] to deal with zoological data

* [[ZooCode]] - the difference of the zoological code compared to the botanical code

* [[NomenclaturalStatus]] - descriptions of the different nomenclatural status codes both for botany and zoology

* [[TaxonomicDataStandards]] - other taxonomic models and standards

* [[BibliographicalDataStandards]] - bibliographical models and standards

### Modelling Guidelines

* [[BestPractices]] - best practices for the EDIT UML modelling and coding conventions for developers

* [[OntologyModelling]] - general remarks and links to OWL