EDIT

src/site/apt/download.apt -text

src/site/apt/getting-started.apt -text

src/site/apt/index.apt -text

src/site/apt/overview.apt -text

src/site/apt/reference.apt -text

src/site/apt/rest-api.apt -text

src/site/fml/faq.fml -text

src/site/fml/troubleshooting.fml -text

src/site/resources/images/cdmlib-arch4.png -text

Download

Getting Started

			------

			What is the Common Data Model

			------

			------

			2010-11-05

			------

What is the Common Data Model	

  The CDM Library is meant to be a shared library for the between several applications which can be of any kind, i.e. J2EE having an application container, simple command line tools or swing desktop applications. The library defines a persistent domain model, EDITs CommonDataModel, that can be serialised and read in XML. Business logic shared between applications should be part of this library as much as possible, while application specific logic has to stay out. We are developing this library in collaboration with the CATE project initially, but we seeking development collaboration with other projects like Key2Nature and PESI as well.

	------

	Overview

	------

	------

	2010-11-05

	------

Overview

  The CDM library itself is devided into several layers, as to provide a seperation of concerns.

[images/cdmlib-arch4.png] CDM Library layers

* Domain Model - <cdmlib-model>

  Domain objects (also called business objects sometimes) are directly taken as POJOs from the CommonDataModel. The logic inherent to the domain objects are restricted to their own object graph, i.e. their own properties and related objects. But not unrelated objects available through DAOs only. Typical logic includes validation and calculations.

** Property change support

  We have implemented java.bean propertyChangeSupport methods for the entire cdm domain classes to send change events to registered listeners. 

The TaxonomicEditor makes use of these through a data binding framework. See wiki:JavaResources#DataBinding for more.

** XML binding

  For data exchange purposes, serialization/deserialization of the domain objects of the cdmlib-model to/from XML format is supported via the [https://jaxb.dev.java.net/ JAXB] framework.

** Name parser

  Documentation is available at NameParserDocumentation

* Persistence Layer - <cdmlib-persistence>

  we use Hibernate for persistence. We run unit and integration tests for MySQL, Hypersonic, Postgres and MS SQL Server on a regular basis.

* API - <cdmlib-services>

  Work in progress. see "CdmLibrary#Servicelayer" or wiki:CdmAPI for now.

Reference

<?xml version="1.0" encoding="UTF-8"?>

<faqs xmlns="http://maven.apache.org/FML/1.0.1"

  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"

  title="Frequently Asked Questions"

  toplink="false">

  <part id="general">

    <title>General</title>

    <faq id="whats-foo">

      <question>

        What is Foo?

      </question>

      <answer>

        <p>some markup goes here</p>

        <source>some source code</source>

        <p>some markup goes here</p>

      </answer>

    </faq>

    <faq id="whats-bar">

      <question>

        What is Bar?

      </question>

      <answer>

        <p>some markup goes here</p>

      </answer>

    </faq>

  </part>

  <part id="install">

    <title>Installation</title>

    <faq id="how-install">

      <question>

        How do I install Foo?

      </question>

      <answer>

        <p>some markup goes here</p>

      </answer>

    </faq>

  </part>

</faqs>

<?xml version="1.0" encoding="UTF-8"?>

<faqs xmlns="http://maven.apache.org/FML/1.0.1"

  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"

  title="Troubleshooting"

  toplink="false">

  <part id="general">

    <title>General</title>

    <faq id="whats-foo">

      <question>

        What is Foo?

      </question>

      <answer>

        <p>some markup goes here</p>

        <source>some source code</source>

        <p>some markup goes here</p>

      </answer>

    </faq>

    <faq id="whats-bar">

      <question>

        What is Bar?

      </question>

      <answer>

        <p>some markup goes here</p>

      </answer>

    </faq>

  </part>

  <part id="install">

    <title>Installation</title>

    <faq id="how-install">

      <question>

        How do I install Foo?

      </question>

      <answer>

        <p>some markup goes here</p>

      </answer>

    </faq>

  </part>

</faqs>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="CDM Library" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">

	<skin>

		<groupId>eu.etaxonomy.site</groupId>

		<artifactId>platform-site-skin</artifactId>

		<version>1.0</version>

	</skin>

	<body>

		<links>

			<item name="Taxonomic Editor" href="http://wp5.e-taxonomy.eu/taxeditor/"/>

			<item name="CDM Server" href="http://wp5.e-taxonomy.eu/cdm-server/"/>

			<item name="Dataportal" href="http://wp5.e-taxonomy.eu/portal/"/>

			<item name="Print Publisher" href="http://wp5.e-taxonomy.eu/printpublisher/"/>

			<item name="CDM Setups" href="http://wp5.e-taxonomy.eu/cdm-setups/"/>

		</links>

		<menu name="General Information">

			<item name="What is the CDM Library?" href="index.html"/>

			<item name="Details" href="overview.html"/>

			<item name="FAQ" href="faq.html"/>

			<item name="License" href="license.html"/>

			<item name="Download" href="download.html"/>

		<menu name="Developer">

			<item name="Getting started" href="getting-started.html"/>

			<item name="Reference" href="reference.html"/>

			<item name="UML" href="http://wp5.e-taxonomy.eu/cdm-uml"/>

			<item name="API" href="apidocs/index.html"/>

			<item name="REST API" href="rest-api.html"/>

			<item name="Troubleshooting" href="troubleshooting.html"/>

			<item name="Wiki" href="http://dev.e-taxonomy.eu/trac/wiki/CdmLibrary"/>

		</menu>

		<menu name="Project">

			<item name="Mailing Lists" href="mail-lists.html"/>

			<item name="Project Team" href="team-list.html"/>

			<item name="Continuous Integration" href="integration.html"/>

			<item name="Issue Tracking" href="http://dev.e-taxonomy.eu/trac/"/>

			<item name="Source Repository" href="source-repository.html"/>

		</menu>

	</body>

</project>