Difference between revisions of "Teneo/Hibernate"

Revision as of 16:50, 1 November 2011

The EMF - Hibernate integration supports all EMF features and standard Hibernate features. EMF objects can be persisted in most major relational databases and retrieved using an EMF resource approach or HQL queries.

A distinctive feature of Teneo is that you can override/extend the Model-Relational mapping using JPA annotations in the model, see the JPA/EJB3 pages for more information.

Teneo offers full support for EMF XML Schema constructs, see the Teneo XML Schema pages for more information.

Note: binary incompatibility introduced from build of 11th November 2010. From the 11th of November Teneo supports Hibernate 3.6 and the persistence jpa 2.0 api in the EntityDataStore. The change is reflected in the version numbers of the features and main hibernate plugin: 1.2.0. The main change is the removal of the dataStore.getProperties method and the introduction of dataStore.getDataStoreProperties and dataStore.setDataStoreProperties. See here for more information.

NOTE: CDO Hibernate Store users should not use this latest version of Teneo. the Teneo 1.1.2/Hibernate 3.3.2 version (see update site below). When the CDO 4.0 Hibernate Store has been updated to Hibernate 3.6.0 then this will be changed. CDO 3.0 users should always use the Teneo 1.1.2/Hibernate 3.3.2 versions.

The Teneo update site delivers one version of Teneo (the latest) which should work for the following versions:

• Eclipse 3.5/EMF 2.5 and Eclipse 3.6/EMF 2.6
• Hibernate 3.6.0 and higher, earlier versions of Hibernate are *not* supported because Hibernate introduced a binary incompatibility in version 3.3.2 and Hibernate 3.6.0 supports the JPA 2.0 spec.

See the download page for retrieving an older version of Teneo for Hibernate 3.3.2 to Hibernate 3.6.0.

Overview, Download & Install and Quickstart

• Architecture Overview: describes the components of the Teneo solution and how they interact and work with Hibernate.

• Download and Install: describes downloading and installing Teneo for usage in OSGI as well as Web Container environments. Also the installation/download of the example projects used in the tutorials is discussed here.

• Quickstart: starting from an ecore model, the tutorial shows how to work with the generated model code and persist the objects in a (generated) database.

Tutorials

The tutorials are based on the example project which can be downloaded from git.

The tutorials assume a basic knowledge of EMF. If you are new to EMF then it can make sense to first try one of the core EMF tutorials which you can find here.

• Quickstart: starting from an ecore model, the tutorial shows how to work with the generated model code and persist the objects in a (generated) database.
• Tutorial: this tutorial takes you a bit further, it persists new objects, shows a number of HQL queries and also shows how the Hibernate EMF resource operates.
• Editor Tutorial: shows how the generated EMF editor can work using Teneo on a relational persistence layer.
• Dynamic EMF Tutorial: Teneo also works fine with dynamic EMF and can even handle changes to the EMF model at runtime. This tutorial shows some examples of this.
• GMF: Teneo works with GMF also. This tutorial shows how to setup the GMF mindmap example with Teneo.

Configuration and Usage Details

• Configuration Options: Teneo has many (40+) configuration options controlling mapping and runtime behavior.

• Hibernate Session and Entitymanager Datastores, Spring setup: Teneo implements the runtime persistence functionality through a data store concept which takes care of initializing the runtime layers. This section also describes integration with the Spring framework.

• Teneo extensions: the Teneo extensions mechanism allows you to override and replace core Teneo components with your own implementations.

• EMF Hibernate Integration Details: discusses several detailed aspects of the integration between Hibernate and EMF, for example: use of a package registry, classloading, escaping of table and column names, synthetic id and version, etc.

• Hibernate Resource: discusses the Teneo specific implementation of the EMF Resource concept.

• Collection Extra-Lazy Loading: describes how to work with very large collections.

Model Relational Mapping with EJB3/JPA Annotations

Teneo can map practically every ecore model to a relational store. The mapping logic can be overridden and controlled by in-model JPA annotations. The annotations are entered in the model (xsd or ecore) directly or set in a separate XML file.

This combination of automatic mapping and manual overrides with JPA annotations is very powerfull. The JPA annotations allow a developer to do many things, for example: determine the naming of columns and tables, enables or prevents join tables, specify embedded components, specify the name of foreign key columns, the inheritance mapping, if an index column is used, the sorting of a collection, enable external references, etc. etc.

For more information, see the following pages:

• Supported annotations: gives a complete overview of the support for JPA annotations including Hibernate annotation extensions and convenience Teneo extensions.

• Annotations format: describes in detail how annotations can be specified in the model itself or in a separate XML file. By supporting an external XML it is possible to annotate existing ecore models, so without the need to change them.

• Annotation examples: provides downloadable examples and discusses some special cases.

• Association Mapping: describes in detail how associations can be mapped to a relational store, also outlining which annotations and configuration options can be used.

• Inheritance Mapping: discusses the inheritance mapping strategies supported by Teneo.

• Entity Attribute Value Mapping: the entity-attribute-value mapping strategy is a special mapping suitable for models which change at runtime.

XML Schema Support

Teneo supports practically all XML Schema constructs which are also supported by EMF. Teneo tries to generate a sensible, practical, readable and performant database schema for a XML Schema model. It is important that the domain model concepts are also reflected in the database schema itself.

For more details on the Teneo XML Schema support, visit the following pages:

• Supported XML Schema Constructs: gives a detailed listing of the XML Schema which are supported by Teneo.
• Feature Map and Mixed Content: discusses how Teneo supports mixed content and feature maps.

CDO - CDO Hibernate Store

Teneo is also used within a component of the CDO solution: the CDO Hibernate Store. For more information visit the CDO Hibernate Store wiki page.

More Information

See:

• Teneo GIT, Support, Commit Mailing List and FAQ
• Teneo Continuous Build