October 2007 - hibernate-commits - Jboss List Archives

Hibernate SVN: r14075 - in core/trunk/documentation/manual/es-ES/src/main: docbook and 2 other directories.

by hibernate-commits＠lists.jboss.org

Author: steve.ebersole(a)jboss.com Date: 2007-10-09 14:45:36 -0400 (Tue, 09 Oct 2007) New Revision: 14075 Added: core/trunk/documentation/manual/es-ES/src/main/docbook/Hibernate_Reference.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/ core/trunk/documentation/manual/es-ES/src/main/docbook/content/architecture.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/association_mapping.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/basic_mapping.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/batch.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/best_practices.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/collection_mapping.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/component_mapping.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/configuration.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/events.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_mappings.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_parentchild.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_weblog.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/filters.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/inheritance_mapping.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/performance.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/persistent_classes.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/preface.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_criteria.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_hql.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_sql.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/quickstart.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/session_api.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/toolset_guide.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/transactions.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/tutorial.xml core/trunk/documentation/manual/es-ES/src/main/docbook/content/xml.xml core/trunk/documentation/manual/es-ES/src/main/docbook/images/ core/trunk/documentation/manual/es-ES/src/main/docbook/images/AuthorWork.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/AuthorWork.zargo core/trunk/documentation/manual/es-ES/src/main/docbook/images/CustomerOrderProduct.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/CustomerOrderProduct.zargo core/trunk/documentation/manual/es-ES/src/main/docbook/images/EmployerEmployee.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/EmployerEmployee.zargo core/trunk/documentation/manual/es-ES/src/main/docbook/images/full_cream.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/full_cream.svg core/trunk/documentation/manual/es-ES/src/main/docbook/images/hibernate_logo_a.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/lite.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/lite.svg core/trunk/documentation/manual/es-ES/src/main/docbook/images/overview.png core/trunk/documentation/manual/es-ES/src/main/docbook/images/overview.svg core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice.xml core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice2.xml core/trunk/documentation/manual/es-ES/src/main/docbook/translators.xml Removed: core/trunk/documentation/manual/es-ES/src/main/docbook/master.xml core/trunk/documentation/manual/es-ES/src/main/resources/ Log: new docbook layout (prep for translations migration to PO) Added: core/trunk/documentation/manual/es-ES/src/main/docbook/Hibernate_Reference.xml =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/Hibernate_Reference.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/Hibernate_Reference.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,88 @@ +<?xml version='1.0' encoding="iso-8859-1"?> + +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY versionNumber "3.3.0.alpha1"> + <!ENTITY copyrightYear "2004"> + <!ENTITY copyrightHolder "Red Hat Middleware, LLC."> +]> + +<book> + + <bookinfo> + <title>HIBERNATE - Persistencia Relacional para Java Idiomático</title> + <subtitle>Documentación de Referencia de Hibernate</subtitle> + <releaseinfo>&versionNumber;</releaseinfo> + <productnumber>&versionNumber;</productnumber> + <issuenum>1</issuenum> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/hibernate_logo_a.png" align="center" /> + </imageobject> + <imageobject role="html"> + <imagedata fileref="images/hibernate_logo_a.png" depth="3cm" /> + </imageobject> + </mediaobject> + <copyright> + <year>&copyrightYear;</year> + <holder>&copyrightHolder;</holder> + </copyright> + <xi:include href="translators.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="legal_notice2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </bookinfo> + + <toc/> + + <xi:include href="content/preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/tutorial.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/persistent_classes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/basic_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/collection_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/association_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/component_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/inheritance_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/session_api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/transactions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/batch.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/query_hql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_criteria.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_sql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/filters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/xml.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/performance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/toolset_guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/example_parentchild.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_weblog.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_mappings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/best_practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</book> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/architecture.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/architecture.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/architecture.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/architecture.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,279 @@ +<chapter id="architecture"> + + <title>Arquitectura</title> + + <sect1 id="architecture-overview" revision="1"> + <title>Visión General</title> + + <para> + Una visión a (muy) alto nivel de la arquitectura de Hibernate: + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/overview.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/overview.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + Este diagrama muestra a Hibernate usando la base de datos y los datos de + configuración para proveer servicios de persistencia (y objetos + persistentes) a la aplicación. + </para> + + <para> + Nos gustaría mostrar una vista más detallada de la arquitectura de tiempo + de ejecución. Desafortunadamente, Hibernate es flexible y soporta diferentes + enfoques. Mostraremos los dos extremos. En la arquitectura "sencilla", es la + aplicación la que provee su propias conexiones JDBC y gestiona sus propias + transacciones. Este enfoque usa un mínimo subconjunto de la API de Hibernate: + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/lite.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/lite.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + La arquitectura "full cream" abstrae a la aplicación de las APIs + de JDBC/JTA y deja que Hibernate se encargue de los detalles. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/full_cream.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/full_cream.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + He aquí algunas definiciones de los objetos en los diagramas: + <variablelist spacing="compact"> + <varlistentry> + <term>SessionFactory (<literal>org.hibernate.SessionFactory</literal>)</term> + <listitem> + <para> + Caché threadsafe (inmutable) de mapeos compilados para + una sola base de datos. Es una fábrica de <literal>Session</literal> + y un cliente de <literal>ConnectionProvider</literal>. Opcionalmente, + puede mantener una caché (de segundo nivel) de datos reusables + entre transacciones, a un nivel de proceso o de cluster. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Session (<literal>org.hibernate.Session</literal>)</term> + <listitem> + <para> + Objeto mono-hebra, de corta vida que representa una conversación + entre la aplicación y el almacenamiento persistente. Envuelve una + conexión JDBC. Es una fábrica de <literal>Transaction</literal>. + Mantiene una caché requerida (de primer nivel) de objetos persistentes, + usada mientras se navega el grafo de objetos o se recuperen objetos por + identificador. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Objetos y colecciones persistentes</term> + <listitem> + <para> + Objetos de corta vida, mono-hebra conteniendo estado persistente y + funciónalidad de negocio. Estos pueden ser JavaBeans/POJOs + (Plain Old Java Objects, o sea, cualquier objeto Java), la única + cosa especial en ellos es que estan asociados actualmente con una + (y sólo una) <literal>Session</literal>. Tan pronto como la + <literal>Session</literal> sea cerrada, serán separados y + estarán libres para ser usados en cualquier capa de aplicación. + (por ejemplo, directamente como objetos de transferencia de datos hacia + y desde la capa de presentación). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Objetos y colecciones transitorios y separados</term> + <listitem> + <para> + Instancias de clases persistentes que no estan acutualmente asociadas + con una <literal>Session</literal>. Pueden haber sido instanciadas por + la aplicación y (aún) no haber sido hechas persistentes, + o pueden haber sido instanciadas por una <literal>Session</literal> cerrada. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Transaction (<literal>org.hibernate.Transaction</literal>)</term> + <listitem> + <para> + (Opcional) Un objeto de corta vida, mono-hebra, usado por la aplicación + para especificar unidades atómicas de trabajo. Abstrae a la aplicación + de las subyacentes transacciones JDBC, JTA o CORBA. En algunos casos, una + <literal>Session</literal> puede extenderse sobre varias <literal>Transaction</literal>s. + Sin embargo, la demarcación de la transacción, ya sea usando la API + subyacente o <literal>Transaction</literal>, nunca es opcional! + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ConnectionProvider (<literal>org.hibernate.connection.ConnectionProvider</literal>)</term> + <listitem> + <para> + (Opcional) Una fábrica (y pool) de conexiones JDBC. Abstrae a la aplicación + del <literal>Datasource</literal> o <literal>DriverManager</literal> subyacente. + No se expone a la aplicación, pero puede ser extendido/implementado por + el desarrollador. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>TransactionFactory (<literal>org.hibernate.TransactionFactory</literal>)</term> + <listitem> + <para> + (Opcional) Una fábrica de instancias de <literal>Transaction</literal>. + No se expone a la aplicación, pero puede ser extendido/implementado por + el desarrollador. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Interfaces de Extensión</emphasis></term> + <listitem> + <para> + Hibernate ofrece muchas interfaces de extensión opcional que puedes + implementar para modificar a medida el comportamiento de tu capa de persistencia. + Para más detalles, mira la documentación de la API. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + Dada una arquitectura "sencilla", la aplicación pasa por alto las APIs + de <literal>Transaction</literal>/<literal>TransactionFactory</literal> y/o + <literal>ConnectionProvider</literal>, para hablar directamente a JTA o JDBC. + </para> + </sect1> + + <sect1 id="architecture-states" revision="1"> + <title>Estados de instancia</title> + <para> + Una instancia de una clase persistente puede estar en uno de tres estados + diferentes, definidos respecto de su <emphasis>contexto de persistencia</emphasis>. + El objeto <literal>Session</literal> de Hibernate es el contexto de persistencia: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>transitorio</term> + <listitem> + <para> + La instancia no está y nunca estuvo asociada con + un contexto de persistencia. No tiene identidad persistente + (valor de clave primaria). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>persistente</term> + <listitem> + <para> + La instancia está actualmente asociada con un + contexto de persistencia. Tiene una identidad persistente + (valor de clave primaria) y, quizás, una fila + correspondiente en la base de datos. Para un contexto de + persistencia en particular, Hibernate <emphasis>garantiza</emphasis> + que la identidad persistente es equivalente a la identidad + Java (localización en memoria del objeto). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>separado</term> + <listitem> + <para> + La instancia estuvo una vez asociada con un contexto + de persistencia, pero ese contexto fue cerrado, o la + instancia fue serializada a otro proceso. Tiene una + identidad persistente y, quizás, una fila correspondiente + en la base de datos. Para las instancias separadas, + Hibernate no establece ninguna garantía sobre + la relación entre identidad persistente e identidad Java. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 id="architecture-jmx" revision="1"> + <title>Integración JMX</title> + + <para> + JMX es el estándar J2EE para la gestión de componentes Java. Hibernate + puede ser gestionado por medio de un servicio estándar JMX. + Proveemos una implementación de MBean en la distribución, + <literal>org.hibernate.jmx.HibernateService</literal>. + </para> + + <para> + Para ejemplo de cómo desplegar Hibernate como un servicio JMX en un Servidor + de Aplicaciones JBoss, por favor, mira la Guía del Usuario de JBoss. + En JBoss AS, tienes además estos beneficios si despliegas usando JMX: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Gestión de Sesión:</emphasis> El ciclo de vida de la <literal>Session</literal> + de Hibernate puede estar automáticamente ligado al ámbito de una transacción + JTA. Esto significa que ya no tienes que abrir ni cerrar la <literal>Session</literal> manualmente, + esto pasa a ser trabajo de un interceptor EJB de JBoss. Además tampoco tienes + que preocuparte más de la demarcación de la transacción (a menos que + que quieras escribir una capa de persitencia portable, por supuesto, usa la API de + <literal>Transaction</literal> de Hibernate para esto). Para acceder a una + <literal>Session</literal> llama al <literal>HibernateContext</literal>. + </para> + </listitem> + <listitem> + <para> + <emphasis>Despliegue de HAR:</emphasis> Usualmente despliegas el servicio JMX de Hibernate + usando un descriptor de despliegue de servicio de JBoss (en un fichero EAR y/o SAR), que soporta + todas las opciones de configuración usuales de una <literal>SessionFactory</literal> de + Hibernate. Sin embargo, todavía tienes que nombrar todos tus ficheros de mapeo en el + descriptor de despliegue. Si decides usar el depliegue de HAR opcional, JBoss detectará + automáticamente todos los ficheros de mapeo en tu fichero HAR. + </para> + </listitem> + </itemizedlist> + + <para> + Para más información sobre estas opciones, consulta la + Guía de Usuario del JBoss AS. + </para> + + <para> + Otra funcionalidad disponible como un servicio JMX son las estadísticas en + tiempo de ejecución de Hibernate. Mira <xref linkend="configuration-optional-statistics"/>. + </para> + </sect1> + + <sect1 id="architecture-jca" revision="1"> + <title>Soporte JCA:</title> + <para> + Hiberate puede además ser configurado como un conector JCA. Por favor mira el + sitio web para más detalles. Por favor ten en cuenta que el soporte de JCA + de Hibernate está aún considerado experimental. + </para> + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/association_mapping.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/association_mapping.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/association_mapping.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/association_mapping.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,527 @@ +<chapter id="associations"> + + <title>Mapeos de Asociación</title> + + <sect1 id="assoc-intro" revision="1"> + <title>Introducción</title> + + <para> + Los mapeos de asociación son frecuentemente las cosas mas difíciles + de hacer correctamente. En esta sección iremos a través de los casos + canónicos uno a uno, comenzando con los mapeos unidireccionales, y considerando + luego los casos bidireccionales. Usaremos <literal>Person</literal> y <literal>Address</literal> + en todos los ejemplos. + </para> + + <para> + Clasificaremos las asociaciones por cuanto mapeen o no a una tabla + de unión interviniente, y por su multiplicidad. + </para> + + <para> + Las claves foráneas que aceptan valores nulos (en adelante, nullables) + no son consideradas una buena práctica en el modelado tradicional de datos, + así que todos nuestros ejemplos usan claves foráneas no nullables. + Esto no es un requerimiento de Hibernate, y todos los mapeos funcionarán + si quitas las restricciones de nulabilidad. + </para> + + </sect1> + + <sect1 id="assoc-unidirectional" revision="1"> + <title>Asociaciones Unidireccionales</title> + + <sect2 id="assoc-unidirectional-m21"> + <title>muchos a uno</title> + + <para> + Una <emphasis>asociación unidireccional muchos-a-uno</emphasis> es el tipo + más común de asociaciones unidireccionales. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-121"> + <title>uno a uno</title> + + <para> + Una <emphasis>asociación unidireccional uno-a-uno en una clave primaria</emphasis> + es casi idéntica. La única diferencia es la restricción de unicidad + de la columna. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + Usualmente, una <emphasis>asociación unidireccional uno-a-uno en una + clave primaria</emphasis> usa un generador de id especial. (Observa que hemos + invertido el sentido de la asociación en este ejemplo). + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-12m"> + <title>uno a muchos</title> + + <para> + Una <emphasis>asociación unidireccional uno-a-muchos en una clave foránea</emphasis> + es un caso muy inusual, y realmente no está recomendada. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses"> + <key column="personId" + not-null="true"/> + <one-to-many class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( addressId bigint not null primary key, personId bigint not null ) + ]]></programlisting> + + <para> + Creemos que es mejor usar una tabla de unión para este tipo de asociación. + </para> + + </sect2> + + </sect1> + + <sect1 id="assoc-unidirectional-join" revision="1"> + <title>Asociaciones unidireccionales con tablas de unión</title> + + <sect2 id="assoc-unidirectional-join-12m"> + <title>uno a muchos</title> + + <para> + Una <emphasis>asociación unidireccional uno-a-muchos en una tabla de unión</emphasis> + es más preferible. Observa que especificando <literal>unique="true"</literal>, hemos + cambiado la multiplicidad de muchos-a-muchos a uno-a-muchos. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m21"> + <title>muchos a uno</title> + + <para> + Una <emphasis>asociación unidireccional muchos-a-uno en una tabla de unión</emphasis> + es bastante común cuando la asociación es opcional. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-121"> + <title>uno a uno</title> + + <para> + Una <emphasis>asociación unidireccional uno-a-uno en una tabla de unión</emphasis> + es inusual en extremo, pero posible. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m2m"> + <title>muchos a muchos</title> + + <para> + Finalmente, tenemos una <emphasis>asociación unidireccional muchos-a-muchos</emphasis> + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional" revision="1"> + <title>Asociaciones Bidireccionales</title> + + <sect2 id="assoc-bidirectional-m21"> + <title>uno a muchos / muchos a uno</title> + + <para> + Una <emphasis>asociación bidireccional muchos-a-uno</emphasis> es + el tipo más común de asociación. (Esta es la relación + estándar padre/hijo.) + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true"> + <key column="addressId"/> + <one-to-many class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-121"> + <title>uno a uno</title> + + <para> + Una <emphasis>asociación bidireccional uno-a-uno en una clave foránea</emphasis> + es bastante común. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <one-to-one name="person" + property-ref="address"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + Una <emphasis>asociación bidireccional uno-a-uno en una clave primaria</emphasis> + usa el generador de id especial. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <one-to-one name="address"/> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" + constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional-join" revision="1"> + <title>Asociaciones bidireccionales con tablas de unión</title> + + <sect2 id="assoc-bidirectional-join-12m"> + <title>uno a muchos / muchos a uno</title> + + <para> + Una <emphasis>asociación bidireccional uno-a-muchos en una tabla de unión</emphasis>. + Observa que el <literal>inverse="true"</literal> puede ir a cualquier lado de la asociación, + en la colección, o en la unión. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" + table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + inverse="true" + optional="true"> + <key column="addressId"/> + <many-to-one name="person" + column="personId" + not-null="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-121"> + <title>uno a uno</title> + + <para> + Una <emphasis>asociación bidireccional uno-a-uno en una tabla de unión</emphasis> + es inusual en extremo, pero posible. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true" + inverse="true"> + <key column="addressId" + unique="true"/> + <many-to-one name="address" + column="personId" + not-null="true" + unique="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-m2m"> + <title>muchos a muchos</title> + + <para> + Finalmente, tenemos una <emphasis>asociación bidireccional muchos-a-muchos</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true"> + <key column="addressId"/> + <many-to-many column="personId" + class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/basic_mapping.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/basic_mapping.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/basic_mapping.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/basic_mapping.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,3222 @@ +<chapter id="mapping"> + <title>Mapeo O/R Básico</title> + + <sect1 id="mapping-declaration" revision="1"> + <title>Declaración de mapeo</title> + + <para> + Los mapeos objeto/relacional se definen usualmente en un documento XML. + El documento de mapeo está diseñado para ser leíble y + editable a mano. El lenguaje de mapeo es Java-céntrico, o sea que los + mapeos se construyen alrededor de declaraciones de clases persistentes, + no declaraciones de tablas. + </para> + + <para> + Observa que, incluso aunque muchos usuarios de Hibernate eligen escribir el + XML a mano, existe una cantidad de herramientas para generar el documento de + mapeo, incluyendo XDoclet, Middlegen y AndroMDA. + </para> + + <para> + Comencemos por un mapeo de ejemplo: + </para> + + <programlisting id="mapping-declaration-ex1" revision="1"><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" + table="cats" + discriminator-value="C"> + + <id name="id"> + <generator class="native"/> + </id> + + <discriminator column="subclass" + type="character"/> + + <property name="weight"/> + + <property name="birthdate" + type="date" + not-null="true" + update="false"/> + + <property name="color" + type="eg.types.ColorUserType" + not-null="true" + update="false"/> + + <property name="sex" + not-null="true" + update="false"/> + + <property name="litterId" + column="litterId" + update="false"/> + + <many-to-one name="mother" + column="mother_id" + update="false"/> + + <set name="kittens" + inverse="true" + order-by="litter_id"> + <key column="mother_id"/> + <one-to-many class="Cat"/> + </set> + + <subclass name="DomesticCat" + discriminator-value="D"> + + <property name="name" + type="string"/> + + </subclass> + + </class> + + <class name="Dog"> +  + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Discutiremos ahora el contenido del documento de mapeo. Describiremos sólo los + elementos y atributos que son usados por Hibernate en tiempo de ejecución. El + documento de mapeo contiene además algunos atributos y elementos extra opcionales + que afectan los esquemas de base de datos exportados por la herramienta de exportación + de esquemas. (Por ejemplo, el atributo <literal>not-null</literal>.) + </para> + + + + <sect2 id="mapping-declaration-doctype" revision="2"> + <title>Doctype</title> + + <para> + Todos los mapeos XML deben declarar el doctype mostrado. El DTD actual puede + ser encontrado en el URL mencionado arriba, en el directorio + <literal>hibernate-x.x.x/src/org/hibernate</literal>, o en <literal>hibernate3.jar</literal>. + Hibernate siempre buscará el DTD primero en el classpath. Si experimentas + búsquedas del DTD usando una conexión de Internet, chequea tu declaración + de DTD contra la contenida en el classpath. + </para> + </sect2> + + <sect2 id="mapping-declaration-mapping" revision="3"> + <title>hibernate-mapping</title> + + <para> + Este elemento tiene muchos atributos opcionales. Los atributos <literal>schema</literal> + y <literal>catalog</literal> especifican que las tablas a las que se refiere en el mapeo + pertenecen al esquema y/o catálogo mencionado(s). De especificarse, los nombres de + tablas serán cualificados por el nombre de esquema y catálogo dados. + De omitirse, los nombres de tablas no serán cualificados. El atributo + <literal>default-cascade</literal> especifica qué estilo de cascada debe asumirse + para las propiedades y colecciones que no especifican un atributo <literal>cascade</literal>. + El atributo <literal>auto-import</literal> nos permite usar nombres de clase sin cualificar + en el lenguaje de consulta, por defecto. + </para> + + <programlistingco> + <areaspec> + <area id="hm1" coords="2 55"/> + <area id="hm2" coords="3 55"/> + <area id="hm3" coords="4 55"/> + <area id="hm4" coords="5 55"/> + <area id="hm5" coords="6 55"/> + <area id="hm6" coords="7 55"/> + <area id="hm7" coords="8 55"/> + </areaspec> + <programlisting><![CDATA[<hibernate-mapping + schema="schemaName" + catalog="catalogName" + default-cascade="cascade_style" + default-access="field|property|ClassName" + default-lazy="true|false" + auto-import="true|false" + package="package.name" + />]]></programlisting> + <calloutlist> + <callout arearefs="hm1"> + <para> + <literal>schema</literal> (opcional): El nombre de un esquema de la base de datos. + </para> + </callout> + <callout arearefs="hm2"> + <para> + <literal>catalog</literal> (opcional): El nombre de un catálogo de la base de datos. + </para> + </callout> + <callout arearefs="hm3"> + <para> + <literal>default-cascade</literal> (opcional - por defecto a <literal>none</literal>): + Un estilo de cascada por defecto. + </para> + </callout> + <callout arearefs="hm4"> + <para> + <literal>default-access</literal> (opcional - por defecto a <literal>property</literal>): + La estrategia que Hibernate debe usar para acceder a todas las propiedades. + Puede ser una implementación personalizada de <literal>PropertyAccessor</literal>. + </para> + </callout> + <callout arearefs="hm5"> + <para> + <literal>default-lazy</literal> (opcional - por defecto a <literal>true</literal>): + El valor por defecto para los atributos <literal>lazy</literal> de mapeos de clase + y colleción no especificados. + </para> + </callout> + <callout arearefs="hm6"> + <para> + <literal>auto-import</literal> (opcional - por defecto a <literal>true</literal>): + Especifica si podemos usar nombres de clases no cualificados (de clases en este mapeo) + en el lenguaje de consulta. + </para> + </callout> + <callout arearefs="hm7"> + <para> + <literal>package</literal> (opcional): Especifica un prefijo de paquete a asumir + para los nombres no cualificados de clase en el documento de mapeo. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Si tienes dos clases persistentes con el mismo nombre (sin cualificar), debes establecer + <literal>auto-import="false"</literal>. Hibernate lanzará una excepción si + intentas asignar dos clases al mismo nombre "importado". + </para> + + <para> + Observa que el elemento <literal>hibernate-mapping</literal> te permite anidar + muchos mapeos <literal><class></literal> persistentes, como se muestra arriba. + Sin embargo, es una buena práctica (y se espera de algunas herramientas) mapear + sólo a una sola clase persistente (o a una sola jerarquía de clases) en + un fichero de mapeo y nombrarlo después de la superclase persistente; + por ejemplo, <literal>Cat.hbm.xml</literal>, <literal>Dog.hbm.xml</literal>, + o, si se usa herencia, <literal>Animal.hbm.xml</literal>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-class" revision="3"> + <title>class</title> + + <para> + Puedes declarar una clase persistente usando el elemento <literal>class</literal>: + </para> + + <programlistingco> + <areaspec> + <area id="class1" coords="2 55"/> + <area id="class2" coords="3 55" /> + <area id="class3" coords="4 55"/> + <area id="class4" coords="5 55" /> + <area id="class5" coords="6 55"/> + <area id="class6" coords="7 55" /> + <area id="class7" coords="8 55"/> + <area id="class8" coords="9 55" /> + <area id="class9" coords="10 55" /> + <area id="class10" coords="11 55"/> + <area id="class11" coords="12 55"/> + <area id="class12" coords="13 55"/> + <area id="class13" coords="14 55"/> + <area id="class14" coords="15 55"/> + <area id="class15" coords="16 55"/> + <area id="class16" coords="17 55"/> + <area id="class17" coords="18 55"/> + <area id="class18" coords="19 55"/> + <area id="class19" coords="20 55"/> + <area id="class20" coords="21 55"/> + <area id="class21" coords="22 55"/> + </areaspec> + <programlisting><![CDATA[<class + name="ClassName" + table="tableName" + discriminator-value="discriminator_value" + mutable="true|false" + schema="owner" + catalog="catalog" + proxy="ProxyInterface" + dynamic-update="true|false" + dynamic-insert="true|false" + select-before-update="true|false" + polymorphism="implicit|explicit" + where="arbitrary sql where condition" + persister="PersisterClass" + batch-size="N" + optimistic-lock="none|version|dirty|all" + lazy="true|false" + entity-name="EntityName" + check="arbitrary sql check condition" + rowid="rowid" + subselect="SQL expression" + abstract="true|false" + node="element-name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="class1"> + <para> + <literal>name</literal> (opcional): El nombre completamente cualificado de la clase + Java persistente (o interface). Si este atributo es omitido, se asume que el mapeo + es para una entidad non-POJO. + </para> + </callout> + <callout arearefs="class2"> + <para> + <literal>table</literal> (opcional - por defecto al nombre no cualificado de la clase): + El nombre de su tabla en base de datos. + </para> + </callout> + <callout arearefs="class3"> + <para> + <literal>discriminator-value</literal> (opcional - por defecto al nombre de la clase): + Un valor que distingue subclases individuales, usado para el comportamiento + polimórfico. Los valores aceptables incluyen <literal>null</literal> + y <literal>not null</literal>. + </para> + </callout> + <callout arearefs="class4"> + <para> + <literal>mutable</literal> (opcional, por defecto a <literal>true</literal>): + Especifica que las instancias de la clase (no) son mutables. + </para> + </callout> + <callout arearefs="class5"> + <para> + <literal>schema</literal> (opcional): Sobreescribe el nombre de esquema especificado + por el elemento raíz <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="class6"> + <para> + <literal>catalog</literal> (opcional): Sobreescribe el nombre de catálogo + especificado por el elemento raíz <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="class7"> + <para> + <literal>proxy</literal> (opcional): Especifica una interface a usar para proxies + de inicialización perezosa. Puedes especificar el nombre mismo de la clase. + </para> + </callout> + <callout arearefs="class8"> + <para> + <literal>dynamic-update</literal> (opcional, por defecto a <literal>false</literal>): + Especifica que el SQL <literal>UPDATE</literal> debe ser generado en tiempo de + ejecución y contener solamente aquellas columnas cuyo valor haya cambiado. + </para> + </callout> + <callout arearefs="class9"> + <para> + <literal>dynamic-insert</literal> (opcional, por defecto a <literal>false</literal>): + Especifica que el SQL <literal>INSERT</literal> debe ser generado en tiempo de + ejecución y contener solamente aquellas columnas cuyo valores no son nulos. + </para> + </callout> + <callout arearefs="class10"> + <para> + <literal>select-before-update</literal> (opcional, por defecto a <literal>false</literal>): + Especifica que Hibernate <emphasis>nunca</emphasis> debe realizar un SQL <literal>UPDATE</literal> + a menos que se tenga certeza que un objeto haya sido modificado realmente. + En ciertos casos, (realmente, sólo cuando un objeto transitorio ha sido asociado + con una sesión nueva usando <literal>update()</literal>), esto significa que Hibernate + realizará una SQL <literal>SELECT</literal> extra para determinar si un + <literal>UPDATE</literal> es realmente requerido. + </para> + </callout> + <callout arearefs="class11"> + <para> + <literal>polymorphism</literal> (opcional, por defecto a <literal>implicit</literal>): + Determina si se usa polimorfismo de consulta implícito o explícito. + </para> + </callout> + <callout arearefs="class12"> + <para> + <literal>where</literal> (opcional) especifica una condición SQL <literal>WHERE</literal> + arbitraria paraa ser usada al recuperar objetos de esta clase. + </para> + </callout> + <callout arearefs="class13"> + <para> + <literal>persister</literal> (opcional): Especifica un <literal>ClassPersister</literal> + personalizado. + </para> + </callout> + <callout arearefs="class14"> + <para> + <literal>batch-size</literal> (opcional, por defecto a <literal>1</literal>) + especifica un "tamaño de lote" para traer instancias de esta clase por + identificador. + </para> + </callout> + <callout arearefs="class15"> + <para> + <literal>optimistic-lock</literal> (opcional, por defecto a <literal>version</literal>): + Determina la estrategia optimista de bloqueo. + </para> + </callout> + <callout arearefs="class16"> + <para> + <literal>lazy</literal> (opcional): + La recuperación perezosa puede ser deshabilitada por completo estableciendo + <literal>lazy="false"</literal>. + </para> + </callout> + <callout arearefs="class17"> + <para> + <literal>entity-name</literal> (opcional): Hibernate3 permite que una clase sea + mapeada varias veces (potencialmente a tablas diferentes), y permite que los mapeos + de entidad sean representados por Maps o XML al nivel de Java. En estos casos, + debes proveer un nombre explícito arbitrario para la entidad. + Para más información, mira + <xref linkend="persistent-classes-dynamicmodels"/> y <xref linkend="xml"/>. + </para> + </callout> + <callout arearefs="class18"> + <para> + <literal>check</literal> (opcional): Una expresión SQL usada para generar + una restricción <emphasis>check</emphasis> multi-fila para la generación + automática de esquema. + </para> + </callout> + <callout arearefs="class19"> + <para> + <literal>rowid</literal> (opcional): Hibernate puede usar los llamados ROWIDs en las + bases de datos que los soporten. Por ejemplo, en Oracle, Hibernate puede usar la columna + extra <literal>rowid</literal> para actualizaciones rápidas si estableces esta + opción a <literal>rowid</literal>. Un ROWID es un detalle de implementación + y representa la posición física de la tupla almacenada. + </para> + </callout> + <callout arearefs="class20"> + <para> + <literal>subselect</literal> (opcional): Mapea una entidad inmutable y de sólo + lectura a una subselect de base de datos. Es útil si quieres tener una vista + en vez de una tabla base, pero no tienes vistas. Mira debajo para más información. + </para> + </callout> + <callout arearefs="class21"> + <para> + <literal>abstract</literal> (opcional): Usado para marcar superclases abstractas en + jerarquías <literal><union-subclass></literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Es perfectamente aceptable que la clase persistente mencionada sea una interface. + Entonces declararías clases que implementan esa interface usando el elemento + <literal><subclass></literal>. Puedes persistir cualquier clase interna + <emphasis>estática</emphasis>. Debes especificar el nombre de la clase usando la forma + estándar. Por ejemplo, <literal>eg.Foo$Bar</literal>. + </para> + + <para> + Las clases inmutables, <literal>mutable="false"</literal>, no pueden ser actualizadas o + borradas por la aplicación. Esto permite a Hibernate hacer ciertas optimizaciones + menores de rendimiento. + </para> + + <para> + El atributo opcional <literal>proxy</literal> habilita la inicialización postergada + de instancias persistentes de la clase. Hibernate inicialmente retornará proxies + CGLIB que implementan la interface mencionada. El objeto persistente real será + cargado cuando se invoque un método del proxy. Mira "Proxies para Inicialización + Postergada" debajo. + </para> + + <para> + Por polimorfismo <emphasis>implícito</emphasis> se entiende que las instancias de la clase + serán devueltas por una consulta que mencione cualquier superclase, o interface implementada, + o la clase misma; y que las instancias de cualquier subclase de la clase serán devueltas + por una clase que mencione a la clase en sí. + Por polimorfismo <emphasis>explícito</emphasis> se entiende que instancias de la clase + serán devueltas sólo por consultas que mencionen explícitamente la clase; + y que las consultas que mencionen la clase devolverán sólo instancias de subclases + mapeadas dentro de esta declaración <literal><class></literal> como una + <literal><subclass></literal> o <literal><joined-subclass></literal>. + Para la mayoría de los propósitos el defecto, + <literal>polymorphism="implicit"</literal>, resulta apropiado. + El polimorfismo explícito es útil cuando dos clases diferentes están + mapeadas a la misma tabla (esto permite tener una clase "liviana" que contenga un subconjunto + de columnas de la tabla). + </para> + + <para> + El atributo <literal>persister</literal> te permite personalizar la estrategia de persistencia + para la clase. Puedes, por ejemplo, especificar tu propia subclase de + <literal>org.hibernate.persister.EntityPersister</literal> o incluso puedes proveer una implementación + completamente nueva de la interface <literal>org.hibernate.persister.ClassPersister</literal> que implemente + la persistencia por medio, por ejemplo, de llamadas a procedimientos almacenados, serialización a + ficheros planos o LDAP. Para un ejemplo simple (de persistencia a una <literal>Hashtable</literal>) mira + <literal>org.hibernate.test.CustomPersister</literal>. + </para> + + <para> + Observa que los valores de <literal>dynamic-update</literal> y <literal>dynamic-insert</literal> + no son heredados por las subclases y por lo tanto deben especificarse en los elementos + <literal><subclass></literal> o <literal><joined-subclass></literal>. + Estos ajustes pueden incrementar el rendimiento en algunos casos, pero podrían mermarlo en otros. + Ten juicio en su uso. + </para> + + <para> + Generalmente el uso de <literal>select-before-update</literal> disminuirá el rendimiento. + Es muy útil prevenir que se llame innecesariamente a un disparador de actualización de + base de datos al volver a unir un grafo de instancias separadas a una <literal>Session</literal>. + </para> + + <para> + Si habilitas <literal>dynamic-update</literal>, tendrás opción de estrategias + de bloqueo optimistas: + </para> + <itemizedlist> + <listitem> + <para> + <literal>version</literal> chequea las columnas de versión/timestamp + </para> + </listitem> + <listitem> + <para> + <literal>all</literal> chequea todas las columnas + </para> + </listitem> + <listitem> + <para> + <literal>dirty</literal> chequea las columnas modificadas, permitiendo algunas + actualizaciones concurrentes + </para> + </listitem> + <listitem> + <para> + <literal>none</literal> no usa bloqueo optimista + </para> + </listitem> + </itemizedlist> + <para> + Recomendamos <emphasis>muy</emphasis> fuertemente que uses columnas de + versión/timestamp para bloqueo optimista con Hibernate. Esta es la estrategia + óptima con respecto al rendimiento y es la única estrategia que maneja + correctamente las modificaciones hechas a las instancias separadas. + (por ejemplo, cuando se usa <literal>Session.merge()</literal>). + </para> + + <para> + Para un mapeo de Hibernate, no hay diferencia entre una vista y una tabla base. + Como se supone esto es transparente a nivel de base de datos (observa que algunos + DBMS no soportan correctamente las vistas, especialmente con las actualizaciones). + A veces quieres usar una vista, pero no puedes crear una en la base de datos + (por ejemplo, con un esquema heredado). En este caso, puedes mapear una entidad inmutable + de sólo lectura a una expresión de subconsulta SQL dada. + </para> + + <programlisting><![CDATA[<class name="Summary"> + <subselect> + select item.name, max(bid.amount), count(*) + from item + join bid on bid.item_id = item.id + group by item.name + </subselect> + <synchronize table="item"/> + <synchronize table="bid"/> + <id name="name"/> + ... +</class>]]></programlisting> + + <para> + Declara las tablas con las que sincronizar esta entidad, asegurando que el auto-flush + ocurre correctamente, y que las consultas contra la entidad derivada no devuelven datos + desactualizados. El <literal><subselect></literal> está disponible tanto + como un atributo o como un elemento anidado de mapeo. + </para> + + </sect2> + + <sect2 id="mapping-declaration-id" revision="3"> + <title>id</title> + + <para> + Las clases mapeadas <emphasis>deben</emphasis> declarar la columna de clave primaria de la tabla + de la base de datos. En la mayoría de los casos tendrá también una propiedad + estilo Javabeans que tenga el identificador único de una instancia. El elemento + <literal><id></literal> define el mapeo de esa propiedad a la columna de clave primaria. + </para> + + <programlistingco> + <areaspec> + <area id="id1" coords="2 70"/> + <area id="id2" coords="3 70" /> + <area id="id3" coords="4 70"/> + <area id="id4" coords="5 70" /> + <area id="id5" coords="6 70" /> + </areaspec> + <programlisting><![CDATA[<id + name="propertyName" + type="typename" + column="column_name" + unsaved-value="null|any|none|undefined|id_value" + access="field|property|ClassName" + node="element-name|@attribute-name|element/@attribute|."> + + <generator class="generatorClass"/> +</id>]]></programlisting> + <calloutlist> + <callout arearefs="id1"> + <para> + <literal>name</literal> (opcional): El nombre de la propiedad del indentificador. + </para> + </callout> + <callout arearefs="id2"> + <para> + <literal>type</literal> (opcional): Un nombre que indica el tipo Hibernate. + </para> + </callout> + <callout arearefs="id3"> + <para> + <literal>column</literal> (opcional - por defecto al nombre de la propiedad): + El nombre de la columna de clave primaria. + </para> + </callout> + <callout arearefs="id4"> + <para> + <literal>unsaved-value</literal> (opcional - por defecto al valor "sensible"): + Una valor de la propiedad identificadora que indica que una instancia está + recién instanciada (sin salvar), distinguiéndola de instancias separadas + que fueran salvadas o cargadas en una sesión previa. + </para> + </callout> + <callout arearefs="id5"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): + La estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Si se omite el atributo <literal>name</literal>, se asume que la clase no tiene propiedad + identificadora. + </para> + + <para> + El atributo <literal>unsaved-value</literal> es importante! Si la propiedad identificadora de tu + clase no tiene por defecto el valor por defecto normal de Java (null o cero), entonces debes especificar + el valor por defecto real. + </para> + + <para> + Hay una declaración <literal><composite-id></literal> alternativa para permitir acceso + a datos heredados con claves compuestas. Desalentamos fuertemente su uso para cualquier otra cosa. + </para> + + <sect3 id="mapping-declaration-id-generator" revision="2"> + <title>Generator</title> + + <para> + El elemento hijo opcional <literal><generator></literal> nombra una clase Java + usada en generar identificadores únicos para instancias de la clase persistente. + De requerirse algún parámetro para configurar o inicializar la instancia del generador, + se pasa usando el elemento <literal><param></literal>. + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="org.hibernate.id.TableHiLoGenerator"> + <param name="table">uid_table</param> + <param name="column">next_hi_value_column</param> + </generator> +</id>]]></programlisting> + + <para> + Todos los generadores implementan la interface <literal>org.hibernate.id.IdentifierGenerator</literal>. + Esta es una interface muy simple; algunas aplicaciones pueden escoger proveer sus propias + implementaciones especializadas. Sin embargo, Hibernate provee un rango de implementaciones + prefabricadas. Hay nombres alias de atajo para los generadores prefabricados: + <variablelist> + <varlistentry> + <term><literal>increment</literal></term> + <listitem> + <para> + genera indentificadores de tipo <literal>long</literal>, <literal>short</literal> o + <literal>int</literal> que sólo son únicos cuando ningún otro proceso + está insertando datos en la misma tabla. <emphasis>No usar en un cluster.</emphasis> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>identity</literal></term> + <listitem> + <para> + soporta columnas de identidad en DB2, MySQL, MS SQL Server, Sybase y + HypersonicSQL. El identificador devuelto es de tipo <literal>long</literal>, + <literal>short</literal> o <literal>int</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>sequence</literal></term> + <listitem> + <para> + usa una secuencia en DB2, PostgreSQL, Oracle, SAP DB, McKoi o un generador + en Interbase. El identificador devuelto es de tipo <literal>long</literal>, + <literal>short</literal> o <literal>int</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>hilo</literal></term> + <listitem> + <para id="mapping-declaration-id-hilodescription" revision="1"> + usa un algoritmo alto/bajo para generar eficientemente identificadores de tipo + <literal>long</literal>, <literal>short</literal> o <literal>int</literal>, + dada una tabla y columna como fuente de valores altos (por defecto + <literal>hibernate_unique_key</literal> y <literal>next_hi</literal> respectivamente). + El algoritmo alto/bajo genera identificadores que son únicos sólo para una + base de datos particular. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>seqhilo</literal></term> + <listitem> + <para> + usa un algoritmo alto/bajo para generar eficientemente identificadores de tipo + <literal>long</literal>, <literal>short</literal> o <literal>int</literal>, + dada una secuencia de base de datos. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>uuid</literal></term> + <listitem> + <para> + usa un algoritmo UUID de 128 bits para generar identificadore de tipo + cadena, únicos en una ref (se usa la direccón IP). El UUID + se codifica como una cadena hexadecimal de 32 dígitos de largo. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>guid</literal></term> + <listitem> + <para> + usa una cadena GUID generada por base de datos en MS SQL Server y MySQL. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>native</literal></term> + <listitem> + <para> + selecciona <literal>identity</literal>, <literal>sequence</literal> o + <literal>hilo</literal> dependiendo de las capacidades de la base de datos + subyacente. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>assigned</literal></term> + <listitem> + <para> + deja a la aplicación asignar un identificador al objeto antes + de que se llame a <literal>save()</literal>. Esta es la estrategia + por defecto si no se especifica un elemento <literal><generator></literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>select</literal></term> + <listitem> + <para> + recupera una clave primaria asignada por un disparador de base de datos + seleccionando la fila por alguna clave única y recuperando el valor de + la clave primaria. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>foreign</literal></term> + <listitem> + <para> + usa el identificador de otro objeto asociado. Generalmente usado en conjuncón + a una asociacón de clave primaria <literal><uno-a-uno></literal> + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + </sect3> + + <sect3 id="mapping-declaration-id-hilo" revision="1"> + <title>Algoritmo alto/bajo</title> + <para> + Los generadores <literal>hilo</literal> y <literal>seqhilo</literal> proveen dos implementaciones + alternativas del algoritmo alto/bajo, un enfoque favorito en generación de identificadores. + La primera implementación requiere de una tabla "especial" de base de datos para tener el siguiente + valor "alto" disponible. + La segunda usa una secuencia del estilo de Oracle (donde se soporte). + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="hilo"> + <param name="table">hi_value</param> + <param name="column">next_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="seqhilo"> + <param name="sequence">hi_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + + <para> + Desafortunadamente, no puedes usar <literal>hilo</literal> cuando le proveas tu propia + <literal>Connection</literal> a Hibernate. Cuando Hibernate está usando un datasource + del servidor de aplicaciones para obtener conexiones alistadas con JTA, debes configurar + correctamente el <literal>hibernate.transaction.manager_lookup_class</literal>. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-uuid"> + <title>Algoritmo UUID</title> + <para> + El UUID contiene: la dirección IP, el instante de arranque de la JVM + (con una precisión de un cuarto de segundo), el tiempo de sistema y un valor + de contador (único en la JVM). No es posible obtener una dirección MAC o + una dirección de memoria desde código Java, así que esto es lo mejor + que podemos hacer sin usar JNI. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-sequences"> + <title>Columnas de identidad y secuencias</title> + <para> + Para las bases de datos que soportan columnas de identidad (DB2, MySQL, Sybase, MS SQL), + puedes usar generación de claves <literal>identity</literal>. Para las bases de datos + que soportan secuencias (DB2, Oracle, PostgreSQL, Interbase, McKoi, SAP DB) puedes usar la generación + de claves del estilo <literal>sequence</literal>. Ambas estrategias requieren dos consultas SQL + para insertar un nuevo objeto. + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="sequence"> + <param name="sequence">person_id_sequence</param> + </generator> +</id>]]></programlisting> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id" unsaved-value="0"> + <generator class="identity"/> +</id>]]></programlisting> + + <para> + Para desarrollos multiplataforma, la estrategia <literal>native</literal> + eiligirá de entre las estrategias <literal>identity</literal>, + <literal>sequence</literal> y <literal>hilo</literal>, dependiendo de las capacidades + de la base de datos subyacentes. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-assigned"> + <title>Identificadores asignados</title> + <para> + Si quieres que la aplicación asigne los identificadores (en contraposición + a que los genere Hibernate), puedes usar el generador <literal>assigned</literal>. + Este generador especial usará el valor identificador ya asignado a la + propiedad identificadora del objeto. Este generador se usa cuandola clave primaria es + una clave natural en vez de una clave sustituta. Este es el comportamiento por defecto si + no especificas un elemento <literal><generator></literal>. + </para> + + <para> + Elegir el generador <literal>assigned</literal> hace que Hibernate use + <literal>unsaved-value="undefined"</literal>, forzando a Hibernate a ir + a la base de datos para determinar si una instancia es transitoria o separada, + a menos que haya una propiedad de versión o timestamp, o que tu definas + <literal>Interceptor.isUnsaved()</literal>. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-select"> + <title>Claves primarias asignadas por disparadores</title> + <para> + Para esquemas heredados solamente (Hibernate no genera DDL con disparadores). + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="select"> + <param name="key">socialSecurityNumber</param> + </generator> +</id>]]></programlisting> + + <para> + En el ejemplo de arriba, hay una propiedad ánica llamada + <literal>socialSecurityNumber</literal> definida por la clase, como + una clave natural, y una clave sustituta llamada <literal>person_id</literal> + cuyo valor es generado por un disparador. + </para> + + </sect3> + + </sect2> + + <sect2 id="mapping-declaration-compositeid" revision="2"> + <title>composite-id</title> + + <programlisting><![CDATA[<composite-id + name="propertyName" + class="ClassName" + unsaved-value="undefined|any|none" + access="field|property|ClassName" + node="element-name|."> + + <key-property name="propertyName" type="typename" column="column_name"/> + <key-many-to-one name="propertyName class="ClassName" column="column_name"/> + ...... +</composite-id>]]></programlisting> + + <para> + Para una tabla con clave compuesta, puedes mapear múltiples propiedades + de la clase como propiedades identificadoras. El elemento <literal><composite-id></literal> + acepta los mapeos de propiedad <literal><key-property></literal> y + los mapeos <literal><key-many-to-one></literal> como elementos hijo. + </para> + + <programlisting><![CDATA[<composite-id> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + + <para> + Tu clase persistente <emphasis>debe</emphasis> sobreescribir <literal>equals()</literal> + y <literal>hashCode()</literal> para implementar igualdad de identificador compuesto. + Debe también implementar <literal>Serializable</literal>. + </para> + + <para> + Desafortunadamente, este enfoque de identificadores compuestos significa que un objeto + persistente es su propio identificador. No existe otra "asa" conveniente más que el + objeto mismo. Debes instanciar una instancia de la clase misma y poblar sus propiedades + identificadoras antes que puedas <literal>load()</literal> el estado persistente asociado + a una clave compuesta. Describiremos un enfoque mucho más conveniente donde el identificador + compuesto está implementado como una clase separada en <xref linkend="components-compositeid"/>. + Los atributos descriptos debajo solamente se aplican a este enfoque alternativo: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>name</literal> (opcional): Una propiedad de tipo componente que tiene el identificador + compuesto (ver siguiente sección). + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (opcional - por defecto al tipo de la propiedad determinado + por reflección): La clase del componente usado como identificador compuesto (ver siguiente sección). + </para> + </listitem> + <listitem> + <para> + <literal>unsaved-value</literal> (opcional - por defecto a <literal>undefined</literal>): + Indica que las instancias transitorias deben ser consideradas como recién instanciadas, + si se establece a <literal>any</literal>, o separadas, si se establece a <literal>none</literal>. + Lo mejor + + Indicates that transient instances should be considered newly instantiated, if set + to <literal>any</literal>, or detached, if set to <literal>none</literal>. + Lo mejor en todos los casos es dejar el valor por defecto. + </para> + </listitem> + </itemizedlist> + + </sect2> + + <sect2 id="mapping-declaration-discriminator" revision="3"> + <title>discriminator</title> + + <para> + El elemento <literal><discriminator></literal> es requerido para la persistencia + polimórfica usando la estrategia de mapeo de tabla-por-jerarquía-de-clases y + declara una columna discriminadora de la tabla. La columna discriminidora contiene valores + de marca que le dicen a la capa de persistencia qué subclase instanciar para una fila + en particular. Un conjunto restringido de tipos puede ser usado: + <literal>string</literal>, <literal>character</literal>, <literal>integer</literal>, + <literal>byte</literal>, <literal>short</literal>, <literal>boolean</literal>, + <literal>yes_no</literal>, <literal>true_false</literal>. + </para> + + <programlistingco> + <areaspec> + <area id="discriminator1" coords="2 60"/> + <area id="discriminator2" coords="3 60" /> + <area id="discriminator3" coords="4 60" /> + <area id="discriminator4" coords="5 60" /> + <area id="discriminator5" coords="6 60" /> + </areaspec> + <programlisting><![CDATA[<discriminator + column="discriminator_column" + type="discriminator_type" + force="true|false" + insert="true|false" + formula="arbitrary sql expression" +/>]]></programlisting> + <calloutlist> + <callout arearefs="discriminator1"> + <para> + <literal>column</literal> (opcional - por defecto a <literal>class</literal>) el + nombre de la columna discriminadora. + </para> + </callout> + <callout arearefs="discriminator2"> + <para> + <literal>type</literal> (opcional - por defecto a <literal>string</literal>) un + nombre que indique el tipo Hibernate + </para> + </callout> + <callout arearefs="discriminator3"> + <para> + <literal>force</literal> (optconal - por defecto a <literal>false</literal>) + "fuerza" a Hibernate a especificar valores discriminadores permitidos incluso + cuando se recuperan todas las instancias de la clase raíz. + </para> + </callout> + <callout arearefs="discriminator4"> + <para> + <literal>insert</literal> (opcional - por defecto a <literal>true</literal>) + establezca este a <literal>false</literal> si tu columna discriminadora es + también parte de un identificador mapeado compuesto. (Le dice a Hibernate + que no incluya la columna en los SQL <literal>INSERT</literal>s.) + </para> + </callout> + <callout arearefs="discriminator5"> + <para> + <literal>formula</literal> (opcional) una expresión SQL arbitraria que + es ejecutada cuando un tipo tenga que ser evaluado. Permite dicriminación + basada en el contenido. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Los valores reales de la columna discriminadora están especificados por + el atributo <literal>discriminator-value</literal> de los elementos + <literal><class></literal> y <literal><subclass></literal>. + </para> + + <para> + El atributo <literal>force</literal> es (sólo) útil si la tabla contiene + filas con valores discriminadores "extra" que no están mapeados a la clase + persistente. Generalmente este no es el caso. + </para> + + <para> + Usando el atributo <literal>formula</literal> puedes declarar una expresión SQL + arbitraria que será usada para evaluar el tipo de una fila: + </para> + + <programlisting><![CDATA[<discriminator + formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end" + type="integer"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-version" revision="1"> + <title>version (opcional)</title> + + <para> + El elemento <literal><version></literal> es opcional e indica que la + tabla contiene datos versionados. Esto es particularmente útil si planeas + usar <emphasis>transacciones largas</emphasis> (ver debajo). + </para> + + <programlistingco> + <areaspec> + <area id="version1" coords="2 70"/> + <area id="version2" coords="3 70"/> + <area id="version3" coords="4 70"/> + <area id="version4" coords="5 70"/> + <area id="version5" coords="6 70"/> + </areaspec> + <programlisting><![CDATA[<version + column="version_column" + name="propertyName" + type="typename" + access="field|property|ClassName" + unsaved-value="null|negative|undefined" + node="element-name|@attribute-name|element/@attribute|." +/>]]></programlisting> + <calloutlist> + <callout arearefs="version1"> + <para> + <literal>column</literal> (opcional - por defecto al nombre de la propiedad): El nombre + de la columna que tiene el número de versión. + </para> + </callout> + <callout arearefs="version2"> + <para> + <literal>name</literal>: El nombre de una propiedad de la clase persistente. + </para> + </callout> + <callout arearefs="version3"> + <para> + <literal>type</literal> (opcional - por defecto a <literal>integer</literal>): + El tipo del nú.mero de vesión. + </para> + </callout> + <callout arearefs="version4"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="version5"> + <para> + <literal>unsaved-value</literal> (opcional - por defecto a <literal>undefined</literal>): + Un valor de la propiedad de versión que indica que una instancia está + recién instanciada (sin guardar), distinguiéndola de instancias + separadas que fueran guardadas o cargadas en una sesión previa. + (<literal>undefined</literal> especifica que debe usarse el valor de la + propiedad identificadora.) + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Los números de versión deben ser de tipo <literal>long</literal>, + <literal>integer</literal>, <literal>short</literal>, <literal>timestamp</literal> o + <literal>calendar</literal> de Hibernate. + </para> + + <para> + Una propiedad de versión o timestamp nunca debe ser nula para una instancia + separada, de modo que Hibernate detectará cualquier instancia con una versión + o timestamp nulo como transitoria, sin importar qué otras estrategias + <literal>unsaved-value</literal> se hayan especificado. + <emphasis>Declarar una propiedad de versón o timestamp nulable es una forma + fácil de evitar cualquier problema con la re-unión transitiva en Hibernate, + especialmente útil para que usa identificadores asignados o claves compuestas!</emphasis> + </para> + </sect2> + + <sect2 id="mapping-declaration-timestamp"> + <title>timestamp (opcional)</title> + + <para> + El elemento opcional <literal><timestamp></literal> indica que la tabla contiene + datos con sellos de tiempo. Esto esta concebido como una alternativa al versionado. + Los timestamps (sellos de tiempo) son por su naturaleza una implementación menos + segura de bloqueo optimista. Sin embrago, a veces la aplicación puede usar los + timestamps en otras formas. + </para> + + <programlistingco> + <areaspec> + <area id="timestamp1" coords="2 70"/> + <area id="timestamp2" coords="3 70" /> + <area id="timestamp3" coords="4 70" /> + <area id="timestamp4" coords="5 70" /> + </areaspec> + <programlisting><![CDATA[<timestamp + column="timestamp_column" + name="propertyName" + access="field|property|ClassName" + unsaved-value="null|undefined" + node="element-name|@attribute-name|element/@attribute|." +/>]]></programlisting> + <calloutlist> + <callout arearefs="timestamp1"> + <para> + <literal>column</literal> (opcional - por defecto al nombre de la propiedad): El nombre + de una columna que tiene el timestamp. + </para> + </callout> + <callout arearefs="timestamp2"> + <para> + <literal>name</literal>: El nombre de una propiedad del estilo JavaBeans de tipo + Java <literal>Date</literal> o <literal>Timestamp</literal> de la clase persistente. + </para> + </callout> + <callout arearefs="timestamp3"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="timestamp4"> + <para> + <literal>unsaved-value</literal> (opcional - por defecto a <literal>null</literal>): + Un valor de propiedad de versión que indica que una instancia está + recién instanciada (sin guardar), distinguiéndola de instancias separadas + que hayan sido guardadas o cargadas en una sesión previa. + (<literal>undefined</literal> especifica que debe usarse el valor de la propiedad + identificadora.) + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Note that <literal><timestamp></literal> is equivalent to + <literal><version type="timestamp"></literal>. + </para> + </sect2> + + + <sect2 id="mapping-declaration-property" revision="2"> + <title>property</title> + + <para> + El elemento <literal><property></literal> declara una propiedad persistente estilo + JavaBean de la clase. + </para> + + <programlistingco> + <areaspec> + <area id="property1" coords="2 70"/> + <area id="property2" coords="3 70"/> + <area id="property3" coords="4 70"/> + <areaset id="property4-5" coords=""> + <area id="property4" coords='5 70'/> + <area id="property5" coords='6 70'/> + </areaset> + <area id="property6" coords="7 70"/> + <area id="property7" coords="8 70"/> + <area id="property8" coords="9 70"/> + <area id="property9" coords="10 70"/> + <area id="property10" coords="11 70"/> + <area id="property11" coords="12 70"/> + </areaspec> + <programlisting><![CDATA[<property + name="propertyName" + column="column_name" + type="typename" + update="true|false" + insert="true|false" + formula="arbitrary SQL expression" + access="field|property|ClassName" + lazy="true|false" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + node="element-name|@attribute-name|element/@attribute|." + index="index_name" + unique_key="unique_key_id" + length="L" + precision="P" + scale="S" +/>]]></programlisting> + <calloutlist> + <callout arearefs="property1"> + <para> + <literal>name</literal>: el nombre de la propiedad, con la letra inicial + en minúsculas. + </para> + </callout> + <callout arearefs="property2"> + <para> + <literal>column</literal> (opcional - por defecto al nombre de la propiedad): el nombre + de la columna de tabla de base de datos mapeada. Esto puede también ser especificado + con elemento(s) <literal><column></literal> anidado(s). + </para> + </callout> + <callout arearefs="property3"> + <para> + <literal>type</literal> (opcional): un nombre que indica el nobre Hibernate. + </para> + </callout> + <callout arearefs="property4-5"> + <para> + <literal>update, insert</literal> (opcional - por defecto a <literal>true</literal>) : + especifica que las columnas mapeadas deben ser incluídas en las sentencias SQL + <literal>UPDATE</literal> y/o <literal>INSERT</literal> . Especificando ambas a + <literal>false</literal> permite una propiedad "derivada" cuyo valor es inicializado desde + alguna otra propiedad que mapee a la misma columna (o columnas) o por un disparador u otra + aplicación. + </para> + </callout> + <callout arearefs="property6"> + <para> + <literal>formula</literal> (opcional): una expresión SQL que define el valor + para una propiedad <emphasis>computada</emphasis>. Las propiedades computadas no tienen + una columna mapeada propia. + </para> + </callout> + <callout arearefs="property7"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="property8"> + <para> + <literal>lazy</literal> (opcional - por defecto a <literal>false</literal>): Especifica + que esta propiedad debe ser traída perezosamente cuando la variable de instancia + sea accedida por primera vez (requiere instrumentación en tiempo de compilación). + </para> + </callout> + <callout arearefs="property9"> + <para> + <literal>unique</literal> (opcional): Habilita la generació DDL de una restricción + de unicidad para las columnas. Además, permite que ésta sea un blanco objetivo de + una <literal>property-ref</literal>. + </para> + </callout> + <callout arearefs="property10"> + <para> + <literal>not-null</literal> (opcional): Habilita la generació DDL de una restricción + de nulabilidad para las columnas. + </para> + </callout> + <callout arearefs="property11"> + <para> + <literal>optimistic-lock</literal> (opcional - por defecto a <literal>true</literal>): + Especifica que las actualizaciones a esta propiedad requieran o no de la obtención + de un bloqueo optimista. En otras palabras, determina si debe ocurrir un incremento de versión + cuando la propiedad este sucia (desactualizada). + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + <emphasis>typename</emphasis> puede ser: + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + El nombre de un tipo básico Hibernate (por ejemplo, <literal>integer, string, character, + date, timestamp, float, binary, serializable, object, blob</literal>). + </para> + </listitem> + <listitem> + <para> + El nombre de una clase Java de tipo básico (por ejemplo, <literal>int, float, + char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob</literal>). + </para> + </listitem> + <listitem> + <para> + El nombre de una clase Java serializable. + </para> + </listitem> + <listitem> + <para> + El nombre de un tipo personalizado (por ejemplo, <literal>com.illflow.type.MyCustomType</literal>). + </para> + </listitem> + </orderedlist> + + <para> + Si no especificas un tipo, Hibernate usará reflección sobre la + propiedad mencionada para deducir el tipo Hibernate correcto. Hibernate intentará + interpretar el nombre de la clase de retorno del getter de la propiedad usando las reglas + 2, 3 y 4 en ese orden. Sin embargo, esto no siempre suficiente. En ciertos casos, necesitarás + aún el atributo <literal>type</literal>. (Por ejemplo, para distinguir entre + <literal>Hibernate.DATE</literal> y <literal>Hibernate.TIMESTAMP</literal>, + o especificar un tipo personalizado.) + </para> + + <para> + El atributo <literal>access</literal> te deja controlar cómo Hibernate + accederá a la propiedad en tiempo de ejecución. Por defecto, Hibernate + llamará al par de getter/setter de la propiedad. Si especificas + <literal>access="field"</literal>, Hibernate se saltará el par get/set y + accederá al campo directamente usando reflección. Puedes especificar tu + propia estrategia de acceso a la propiedad mencionando una clase que implemente + la interface <literal>org.hibernate.property.PropertyAccessor</literal>. + </para> + + <para> + Una aspecto especialmente poderoso son las propiedades derivadas. Estas propiedades + son por definición de sólo lectura, el valor de la propiedad es computado + en tiempo de carga. Tu declaras la computación como una expresión SQL, + y ésta se traduce a cláusula de subconsulta <literal>SELECT</literal> + en la consulta SQL que cargue una instancia: + </para> + + <programlisting><![CDATA[ +<property name="totalPrice" + formula="( SELECT SUM (li.quantity*p.price) FROM LineItem li, Product p + WHERE li.productId = p.productId + AND li.customerId = customerId + AND li.orderNumber = orderNumber )"/>]]></programlisting> + + <para> + Observa que puedes referenciar la propia tabla de las entidades sin declarar un alias + o una columna particular (<literal>customerId</literal> en el ejemplo dado). Observa + además que puedes usar el elemento anidado de mapeo <literal><formula></literal> + si no te gusta usar el atributo. + </para> + + </sect2> + + <sect2 id="mapping-declaration-manytoone" revision="3"> + <title>many-to-one</title> + + <para> + Una asociación ordinaria a otra clase persistente se declara usando + el elemento <literal>many-to-one</literal>. El modelo relacional es una + asociación muchos-a-uno: una clave foránea en una tabla está + referenciando la columna (o columnas) de la clave primaria de la tabla objetivo. + </para> + + <programlistingco> + <areaspec> + <area id="manytoone1" coords="2 70"/> + <area id="manytoone2" coords="3 70"/> + <area id="manytoone3" coords="4 70"/> + <area id="manytoone4" coords="5 70"/> + <area id="manytoone5" coords="6 70"/> + <areaset id="manytoone6-7" coords=""> + <area id="manytoone6" coords='7 70'/> + <area id="manytoone7" coords='8 70'/> + </areaset> + <area id="manytoone8" coords="9 70"/> + <area id="manytoone9" coords="10 70"/> + <area id="manytoone10" coords="11 70"/> + <area id="manytoone11" coords="12 70"/> + <area id="manytoone12" coords="13 70"/> + <area id="manytoone13" coords="14 70"/> + <area id="manytoone14" coords="15 70"/> + <area id="manytoone15" coords="16 70"/> + <area id="manytoone16" coords="17 70"/> + </areaspec> + <programlisting><![CDATA[<many-to-one + name="propertyName" + column="column_name" + class="ClassName" + cascade="cascade_style" + fetch="join|select" + update="true|false" + insert="true|false" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + lazy="true|proxy|false" + not-found="ignore|exception" + entity-name="EntityName" + formula="cualquier expresión SQL" + node="element-name|@attribute-name|element/@attribute|." + embed-xml="true|false" + index="index_name" + unique_key="unique_key_id" + foreign-key="foreign_key_name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="manytoone1"> + <para> + <literal>name</literal>: El nombre de la propiedad. + </para> + </callout> + <callout arearefs="manytoone2"> + <para> + <literal>column</literal> (opcional): El nombre de la columna clave foránea. + También puede ser especificado por uno o varios elementos anidados + <literal><column></literal>. + </para> + </callout> + <callout arearefs="manytoone3"> + <para> + <literal>class</literal> (opcional - por defecto al tipo de la propiedad + determinado por reflección): El nombre de la clase asociada. + </para> + </callout> + <callout arearefs="manytoone4"> + <para> + <literal>cascade</literal> (opcional): Especifica qué operaciones deben + ir en cascada desde el objeto padre al objeto asociado + </para> + </callout> + <callout arearefs="manytoone5"> + <para> + <literal>fetch</literal> (opcional - por defecto a 1<literal>select</literal>): + Escoge entre recuperación outer-join o por selección secuencial. + </para> + </callout> + <callout arearefs="manytoone6-7"> + <para> + <literal>update, insert</literal> (opcional - por defecto a <literal>true</literal>) + especifica que las columnas mapeadas deben ser incluídas en las sentencias SQL + <literal>UPDATE</literal> y/o <literal>INSERT</literal>. Establecer ambas a + <literal>false</literal> permite una asociación puramente "derivada" cuyo + valor es inicializado desde alguna otra propiedad que mapea a las misma columna (o columnas), + o por un disparador, o por otra aplicación. + </para> + </callout> + <callout arearefs="manytoone8"> + <para> + <literal>property-ref</literal>: (opcional) El nombre de la propiedad de la clase + asociada que está unida a la clave foránea. Si no se especifica, se usa + la clave primaria de la clase asociada. + </para> + </callout> + <callout arearefs="manytoone9"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="manytoone10"> + <para> + <literal>unique</literal> (opcional): Habilita la generación DDL de una + restricción de unicidad para la columna de clave foránea. Además, + permite que ésta sea el objetivo de una <literal>property-ref</literal>. + Esto hace efectivamente la multiplicidad de la asociación uno a uno. + </para> + </callout> + <callout arearefs="manytoone11"> + <para> + <literal>not-null</literal> (opcional): Habilita la generación DDL de una + restricción de nulabilidad para las columnas de clave foránea. + </para> + </callout> + <callout arearefs="manytoone12"> + <para> + <literal>optimistic-lock</literal> (opcional - por defecto a <literal>true</literal>): + Especifica que las actualizaciones a esta propiedad requieran o no la obtención + del bloqueo optimista. En otras palabras, determina si debe darse un incremento de versión + cuando esta propiedad esté desactualizada. + </para> + </callout> + <callout arearefs="manytoone13"> + <para> + <literal>lazy</literal> (opcional - por defecto a <literal>proxy</literal>): + Por defecto, las asociaciones de punto único van con proxies. + <literal>lazy="true"</literal> especifica que esta propiedad debe ser + traída perezosamente cuando la variable de instancia sea accedida por primera + vez (requiere instrumentación del bytecode en tiempo de compilación). + <literal>lazy="false"</literal> especifica que la asociación siempre será + recuperada tempranamente. + </para> + </callout> + <callout arearefs="manytoone14"> + <para> + <literal>not-found</literal> (opcional - por defecto a <literal>exception</literal>): + Especifica cómo deben manejarse las claves foráneas que referencien + filas inexistentes: <literal>ignore</literal> tratará una fila perdida como + una asociación nula. + </para> + </callout> + <callout arearefs="manytoone15"> + <para> + <literal>entity-name</literal> (opcional): El nombre de entidad de la clase + asociada. + </para> + </callout> + <callout arearefs="manytoone16"> + <para> + <literal>formula</literal> (opcional): una expresión SQL que define el valor + para una clave foránea <emphasis>computada</emphasis>. + </para> + </callout> + + </calloutlist> + </programlistingco> + + <para> + Establecer el valor del atributo <literal>cascade</literal> a cualquier valor + significativo distinto de <literal>none</literal> propagará ciertas + operaciones al objeto asociado. Los valores significativos son los nombres de las + operaciones básicas de Hibernate, <literal>persist, merge, delete, save-update, + evict, replicate, lock, refresh</literal>, así como los valores especiales + <literal>delete-orphan</literal> y <literal>all</literal> y combinaciones de operaciones + separadas por coma, por ejemplo, <literal>cascade="persist,merge,evict"</literal> o + <literal>cascade="all,delete-orphan"</literal>. Para una explicación completa, + ver <xref linkend="objectstate-transitive"/>. + </para> + + <para> + Una declaración típica <literal>muchos-a-uno</literal> se parece a esto: + </para> + + <programlisting><![CDATA[<many-to-one name="product" class="Product" column="PRODUCT_ID"/>]]></programlisting> + + <para> + El atributo <literal>property-ref</literal> debe ser usado solamente para el mapeo + de datos heredados donde una clave foránea referencia una clave única de + la tabla asociada, distinta de la clave primaria. Este es un modelo relacional feo. + Por ejemplo, supón que la clase <literal>Product</literal> tuviera un número + único serial que no es la clave primaria. (El atributo <literal>unique</literal> + controla la generación de DDL con la herramienta SchemaExport.) + </para> + + <programlisting><![CDATA[<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>]]></programlisting> + + <para> + Entonces el mapeo para <literal>OrderItem</literal> debería usar: + </para> + + <programlisting><![CDATA[<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>]]></programlisting> + + <para> + Sin embargo, esto no esta ciertamente alentado. + </para> + + <para> + Si la clave única referenciada abarca múltiples propiedades de la entidad asociada, + debes mapear las propiedades dentro de un elemento <literal><properties></literal>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-onetoone" revision="2"> + <title>one-to-one</title> + + <para> + Una asociación uno-a-uno a otra clase persistente se declara usando + un elemento <literal>one-to-one</literal>. + </para> + + <programlistingco> + <areaspec> + <area id="onetoone1" coords="2 70"/> + <area id="onetoone2" coords="3 70"/> + <area id="onetoone3" coords="4 70"/> + <area id="onetoone4" coords="5 70"/> + <area id="onetoone5" coords="6 70"/> + <area id="onetoone6" coords="7 70"/> + <area id="onetoone7" coords="8 70"/> + <area id="onetoone8" coords="9 70"/> + <area id="onetoone9" coords="10 70"/> + <area id="onetoone10" coords="11 70"/> + </areaspec> + <programlisting><![CDATA[<one-to-one + name="propertyName" + class="ClassName" + cascade="cascade_style" + constrained="true|false" + fetch="join|select" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + formula="cualquier expresión SQL" + lazy="true|proxy|false" + entity-name="EntityName" + node="element-name|@attribute-name|element/@attribute|." + embed-xml="true|false" + foreign-key="foreign_key_name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="onetoone1"> + <para> + <literal>name</literal>: El nombre de la propiedad. + </para> + </callout> + <callout arearefs="onetoone2"> + <para> + <literal>class</literal> (opcional - por defecto al tipo de la propiedad + determinado por reflección): El nombre de la clase asociada. + </para> + </callout> + <callout arearefs="onetoone3"> + <para> + <literal>cascade</literal> (opcional) especifica qué operaciones deben + ir en cascada desde el objeto padre al objeto asociado. + </para> + </callout> + <callout arearefs="onetoone4"> + <para> + <literal>constrained</literal> (opcional) especifica que una restricción + de clave foránea de la tabla mapeada referencia a la tabla de la clase + asociada. Esta opción afecta el orden en que van en cascada + <literal>save()</literal> y <literal>delete()</literal>, y determina cuándo + la asociación pueden ser virtualizados por proxies (es también usado por + la herramienta de exportación de esquemas). + </para> + </callout> + <callout arearefs="onetoone5"> + <para> + <literal>fetch</literal> (opcional - por defecto <literal>select</literal>): + Elige entre recuperación outer-join o recuperación por consulta secuencial. + </para> + </callout> + <callout arearefs="onetoone6"> + <para> + <literal>property-ref</literal>: (opcional) El nombre de una propiedad de la clase + asociada que esté unida a la clave primaria de esta clase. Si no se especifica, + se usa la clave primaria de la clase asociada. + </para> + </callout> + <callout arearefs="onetoone7"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="onetoone8"> + <para> + <literal>formula</literal> (opcional): Casi todas las asociaciones uno-a-uno mapean + a la clave primaria de la entidad propietaria. En el raro caso en que este no sea el caso, + puedes especificar alguna otra columna, o columnas, o expresión para unir usando una + fórmula SQL. (Para un ejemplo ver <literal>org.hibernate.test.onetooneformula</literal>). + </para> + </callout> + <callout arearefs="onetoone9"> + <para> + <literal>lazy</literal> (opcional - por defecto a <literal>proxy</literal>): + Por defecto, las asociaciones de punto único van con proxies. + <literal>lazy="true"</literal> especifica que esta propiedad debe ser + traída perezosamente cuando la variable de instancia sea accedida por primera + vez (requiere instrumentación del bytecode en tiempo de compilación). + <literal>lazy="false"</literal> especifica que la asociación siempre será + recuperada tempranamente. <emphasis>Observa que si <literal>constrained="false"</literal>, + la aplicación de proxies es imposible e Hibernate traerá temprano la + asociación!</emphasis> + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Hay dos variedades de asociaciones uno-a-uno: + </para> + <itemizedlist> + <listitem><para> + asociaciones de clave primaria + </para></listitem> + <listitem><para> + asociaciones de clave foráneas única + </para></listitem> + </itemizedlist> + + <para> + Las asociaciones de clave primaria no necesitan una columna de tabla extra; si dos filas + están relacionadas por la asociación entonces las dos filas de tablas comparten + el mismo valor de clave primaria. Por lo tanto, si quieres que dos objetos estén relacionados + por una asociación de clave primaria, debes asegurarte que se les asigne el mismo valor de + identificador! + </para> + + <para> + Para una asociación de clave primaria, añade los siguientes mapeos a + <literal>Employee</literal> y <literal>Person</literal>, respectivamente. + </para> + + <programlisting><![CDATA[<one-to-one name="person" class="Person"/>]]></programlisting> + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" constrained="true"/>]]></programlisting> + + <para> + Ahora debemos asegurarnos que las claves primarias de las filas relacionadas en las tablas + PERSON y EMPLOYEE sean iguales. Usamos una estrategia especial de generación de identificador + de Hibernate llamada <literal>foreign</literal>: + </para> + + <programlisting><![CDATA[<class name="person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="foreign"> + <param name="property">employee</param> + </generator> + </id> + ... + <one-to-one name="employee" + class="Employee" + constrained="true"/> +</class>]]></programlisting> + + <para> + A una instancia recién salvada de <literal>Person</literal> se le asigna entonces + el mismo valor de clave primaria con que la instancia <literal>Employee</literal> + referida por la propiedad <literal>employee</literal> de esta <literal>Person</literal>. + </para> + + <para> + Alternativamente, una clave foránea con una restricción de unicidad, desde + <literal>Employee</literal> a <literal>Person</literal>, puede ser expresada como: + </para> + + <programlisting><![CDATA[<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>]]></programlisting> + + <para> + Y esta asociación puede hacerse bidireccional agregando lo siguiente al mapeo de + <literal>Person</literal> : + </para> + + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" property-ref="person"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-naturalid"> + <title>natural-id</title> + + <programlisting><![CDATA[<natural-id mutable="true|false"/> + <property ... /> + <many-to-one ... /> + ...... +</natural-id>]]></programlisting> + + <para> + Aunque recomendamos el uso de claves delegadas como claves primarias, todavía debes + intentar identificar claves naturales para todas las entidades. Una clave natural es una + propiedad o combinación de propiedades que es única y no nula. Si además + es inmutable, mejor aún. Mapea las propiedades de la clave natural dentro del elemento + <literal><natural-id></literal>. Hibernate generará las restricciones de clave + única y nulabilidad necesarias, y tu mapeo será más auto-documentado. + </para> + + <para> + Recomendamos fuertemente que implementes <literal>equals()</literal> y + <literal>hashCode()</literal> para comparar las propiedades de clave natural + de la entidad. + </para> + + <para> + Este mapeo no está concebido para usar con entidades con claves + primarias naturales. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mutable</literal> (opcional, por defecto a <literal>false</literal>): + Por defecto, se asume que las propiedades de identificadores naturales son + inmutables (constantes). + </para> + </listitem> + </itemizedlist> + </sect2> + + + + <sect2 id="mapping-declaration-component" revision="2"> + <title>component, dynamic-component</title> + + <para> + El elemento <literal><component></literal> mapea propiedades de un objeto + hijo a columnas de la tabla de la clase padre. Los componentes pueden a su vez + declarar sus propias propiedades, componentes o colecciones. Ver debajo "Componentes". + </para> + + <programlistingco> + <areaspec> + <area id="component1" coords="2 45"/> + <area id="component2" coords="3 45"/> + <area id="component3" coords="4 45"/> + <area id="component4" coords="5 45"/> + <area id="component5" coords="6 45"/> + <area id="component6" coords="7 45"/> + <area id="component7" coords="8 45"/> + <area id="component8" coords="9 45"/> + </areaspec> + <programlisting><![CDATA[<component + name="propertyName" + class="className" + insert="true|false" + update="true|false" + access="field|property|ClassName" + lazy="true|false" + optimistic-lock="true|false" + unique="true|false" + node="element-name|." +> + + <property ...../> + <many-to-one .... /> + ........ +</component>]]></programlisting> + <calloutlist> + <callout arearefs="component1"> + <para> + <literal>name</literal>: El nombre de la propiedad. + </para> + </callout> + <callout arearefs="component2"> + <para> + <literal>class</literal> (opcional - por defecto al tipo de la propiedad + determinado por reflección): El nombre de la clase del componente (hijo). + </para> + </callout> + <callout arearefs="component3"> + <para> + <literal>insert</literal>: Aparecen las columnas mapeadas en + <literal>INSERT</literal>s SQL? + </para> + </callout> + <callout arearefs="component4"> + <para> + <literal>update</literal>: Aparecen las columnas mapeadas en + <literal>UPDATE</literal>s SQL? + </para> + </callout> + <callout arearefs="component5"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="component6"> + <para> + <literal>lazy</literal> (opcional - por defecto a <literal>false</literal>): Especifica + que este componente debe ser recuperado perezosamente cuando la variable de instancia + sea accedida por primera vez (requiere instrumentación de bytecode en tiempo de + compilación). + </para> + </callout> + <callout arearefs="component7"> + <para> + <literal>optimistic-lock</literal> (opcional - por defecto a <literal>true</literal>): + Especifica si las actualizaciones de este componente requieren o no la + adquisición de un bloqueo optimista. En otras palabras, determina si + debe ocurrir un incremento de versión cuando esta propiedad está + desactualizada. + </para> + </callout> + <callout arearefs="component8"> + <para> + <literal>unique</literal> (opcional - por defecto a <literal>false</literal>): + Especifica que existe una restricción de unicidad sobre todas las + columnas mapeadas del componente. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Las etiquetas hijas <literal><property></literal> mapean propiedades de la + clase hija columnas de la tabla. + </para> + + <para> + El elemento <literal><component></literal> permite un subelemento + <literal><parent></literal> que mapea una propiedad de la clase del componente + como una referencia de regreso a la entidad contenedora. + </para> + + <para> + El elemento <literal><dynamic-component></literal> permite que un + <literal>Map</literal> sea mapeado como un componente, donde los nombres de + las propiedades se corresponden a las claves del mapa, ver <xref linkend="components-dynamic"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-properties" revision="2"> + <title>properties</title> + + <para> + El elemento <literal><properties></literal> permite la definición de + un grupo de propiedades lógico con nombre de una clase. El uso más + importante de la contrucción es que permite que una combinación + de propiedades sea objetivo de una <literal>property-ref</literal>. Es también + una forma conveniente de definir una restricción de unicidad multicolumna. + </para> + + <programlistingco> + <areaspec> + <area id="properties1" coords="2 45"/> + <area id="properties2" coords="3 45"/> + <area id="properties3" coords="4 45"/> + <area id="properties4" coords="5 45"/> + <area id="properties5" coords="6 45"/> + </areaspec> + <programlisting><![CDATA[<properties + name="logicalName" + insert="true|false" + update="true|false" + optimistic-lock="true|false" + unique="true|false" +> + + <property ...../> + <many-to-one .... /> + ........ +</properties>]]></programlisting> + <calloutlist> + <callout arearefs="properties1"> + <para> + <literal>name</literal>: El nombre lógico del agrupamiento - + <emphasis>no</emphasis> un nombre de propiedad real. + </para> + </callout> + <callout arearefs="properties2"> + <para> + <literal>insert</literal>: Aparecen las columnas mapeadas en + <literal>INSERT</literal>s SQL? + </para> + </callout> + <callout arearefs="properties3"> + <para> + <literal>update</literal>: Aparecen las columnas mapeadas en + <literal>UPDATE</literal>s SQL? + </para> + </callout> + <callout arearefs="properties4"> + <para> + <literal>optimistic-lock</literal> (opcional - por defecto a <literal>true</literal>): + Especifica si las actualizaciones de estas propiedades requieren o no de la + adquisición de un bloqueo optimista. En otras palabras, determina si + debe ocurrir un incremento de versión cuando estas propiedades están + desactualizadas. + </para> + </callout> + <callout arearefs="properties5"> + <para> + <literal>unique</literal> (opcional - por defecto a <literal>false</literal>): + Especifica que existe una restricción de unicidad sobre todas las + columnas mapeadas del componente. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Por ejemplo, si tenemos el siguiente mapeo de <literal><properties></literal>: + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="personNumber"/> + ... + <properties name="name" + unique="true" update="false"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </properties> +</class>]]></programlisting> + + <para> + Entonces puede que tengamos alguna asociación de datos heredados que se refiera + a esta clave única de la tabla de <literal>Person</literal>, en vez de la clave + primaria: + </para> + + <programlisting><![CDATA[<many-to-one name="person" + class="Person" property-ref="name"> + <column name="firstName"/> + <column name="initial"/> + <column name="lastName"/> +</many-to-one>]]></programlisting> + + <para> + No recomendamos el uso de este tipo de cosas fuera del contexto del mapeo de + datos heredados. + </para> + + </sect2> + + <sect2 id="mapping-declaration-subclass" revision="3"> + <title>subclass</title> + + <para> + Finalmente, la persistencia polimórfica requiere la declaración + de la clase persistente raíz. Para la estrategia de mapeo + tabla-por-jerarquía-de-clases, se usa la declaración de + <literal><subclass></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="subclass1" coords="2 55"/> + <area id="subclass2" coords="3 55"/> + <area id="subclass3" coords="4 55"/> + <area id="subclass4" coords="5 55"/> + </areaspec> + <programlisting><![CDATA[<subclass + name="ClassName" + discriminator-value="discriminator_value" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + entity-name="EntityName" + node="element-name"> + + <property .... /> + ..... +</subclass>]]></programlisting> + <calloutlist> + <callout arearefs="subclass1"> + <para> + <literal>name</literal>: El nombre de clase cualificado completamente + de la subclase. + </para> + </callout> + <callout arearefs="subclass2"> + <para> + <literal>discriminator-value</literal> (opcional - por defecto al nombre de la clase): + Un valor que distingue a subclases individuales. + </para> + </callout> + <callout arearefs="subclass3"> + <para> + <literal>proxy</literal> (opcional): Especifica una clase o interface a usar para + proxies de inicialización perezosa. + </para> + </callout> + <callout arearefs="subclass4"> + <para> + <literal>lazy</literal> (opcional, por defecto a <literal>true</literal>): + Establecer <literal>lazy="false"</literal> deshabilita el uso de recuperación + perezosa. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Cada subclase debe declarar sus propias propiedades persistentes y subclases. + Se asume que las propiedades <literal><version></literal> y <literal><id></literal> + son heredadas de la clase raíz. Cada subclase en una jerarquía debe + definir un <literal>discriminator-value</literal> único. Si no se especifica ninguno, + se usa el nombre completamente cualificado de clase Java. + </para> + + <para> + Es posible definir mapeos <literal>subclass</literal>, <literal>union-subclass</literal>, + y <literal>joined-subclass</literal> en documentos de mapeo separados, directamente debajo + de <literal>hibernate-mapping</literal>. Esto te permite extender una jerarquía de clases + con sólo agregar un nuevo fichero de mapeo. Debes especificar un atributo + <literal>extends</literal> en el mapeo de la subclase, mencionando una superclase previamente mapeada. + Nota: Previamente esta funcionalidad hacía importante el orden de los documentos de mapeo. + Desde Hibernate3, el orden de los ficheros de mapeo no importa cuando se usa la palabra reservada + extends. El orden dentro de un mismo fichero de mapeo todavía necesita ser definido como + superclases antes de subclases. + </para> + + <programlisting><![CDATA[ +<hibernate-mapping> + <subclass name="DomesticCat" extends="Cat" discriminator-value="D"> + <property name="name" type="string"/> + </subclass> +</hibernate-mapping>]]></programlisting> + + <para> + Para información acerca de mapeos de herencia, ver <xref linkend="inheritance"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-joinedsubclass" revision="3"> + <title>joined-subclass</title> + + <para> + Alternativamente, cada subclase puede ser mapeada a su propia tabla + (estrategia de mapeo tabla-por-subclase). El estado heredado se recupera + uniendo con la tabla de la superclase. + Usamos el elemento <literal><joined-subclass></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="joinedsubclass1" coords="2 45"/> + <area id="joinedsubclass2" coords="3 45"/> + <area id="joinedsubclass3" coords="4 45"/> + <area id="joinedsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<joined-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName" + node="element-name"> + + <key .... > + + <property .... /> + ..... +</joined-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="joinedsubclass1"> + <para> + <literal>name</literal>: El nombre de clase completamente cualificado de + la subclase. + </para> + </callout> + <callout arearefs="joinedsubclass2"> + <para> + <literal>table</literal>: El nombre de tabla de la subclase. + </para> + </callout> + <callout arearefs="joinedsubclass3"> + <para> + <literal>proxy</literal> (opcional): Especifica una clase o interface a + usar para proxies de inicializacón perezosa. + </para> + </callout> + <callout arearefs="joinedsubclass4"> + <para> + <literal>lazy</literal> (opcional, por defecto a <literal>true</literal>): + Establecer <literal>lazy="false"</literal> deshabilita el uso de recuperación + perezosa. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + No se requiere de una columna discriminadora para esta estrategia de mapeo. Cada subclase debe, + sin embargo, declarar una columna de tabla que tenga el identificador del objeto usando el + elemento <literal><key></literal>. El mapeo del comienzo del capítulo + debería ser reescrito como: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" table="CATS"> + <id name="id" column="uid" type="long"> + <generator class="hilo"/> + </id> + <property name="birthdate" type="date"/> + <property name="color" not-null="true"/> + <property name="sex" not-null="true"/> + <property name="weight"/> + <many-to-one name="mate"/> + <set name="kittens"> + <key column="MOTHER"/> + <one-to-many class="Cat"/> + </set> + <joined-subclass name="DomesticCat" table="DOMESTIC_CATS"> + <key column="CAT"/> + <property name="name" type="string"/> + </joined-subclass> + </class> + + <class name="eg.Dog"> +  + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Para información acerca de mapeos de herencia, ver <xref linkend="inheritance"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-unionsubclass" revision="2"> + <title>union-subclass</title> + + <para> + Una tercera opción es mapear sólo las clases concretas de una + jerarquía de clases a tablas, (la estrategia tabla-por-clase-concreta) + donde cada tabla define todo el estado persistente de la clase, incluyendo el + estado heredado. En Hibernate, no es absolutamente necesario mapear dichas + jerarquías de herencia. Puedes simplemente mapear cada clase con una + declaración <literal><class></literal> separada. Sin embargo, + si deseas usar asociaciones polimórficas (por ejemplo, una asociación + a la superclase de tu jerarquía), debes usar el mapeo + <literal><union-subclass></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="unionsubclass1" coords="2 45"/> + <area id="unionsubclass2" coords="3 45"/> + <area id="unionsubclass3" coords="4 45"/> + <area id="unionsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<union-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + abstract="true|false" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName" + node="element-name"> + + <property .... /> + ..... +</union-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="unionsubclass1"> + <para> + <literal>name</literal>: El nombre de clase completamente cualificado de la subclase. + </para> + </callout> + <callout arearefs="unionsubclass2"> + <para> + <literal>table</literal>: El nombre de tabla de la subclase. + </para> + </callout> + <callout arearefs="unionsubclass3"> + <para> + <literal>proxy</literal> (optional): Especifica una clase o interface a + usar para proxies de inicializacón perezosa. + </para> + </callout> + <callout arearefs="unionsubclass4"> + <para> + <literal>lazy</literal> (opcional, por defecto a <literal>true</literal>): + Establecer <literal>lazy="false"</literal> deshabilita el uso de recuperación + perezosa. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + No se requiere columna o columna clave discriminadora para esta estrategia de mapeo. + </para> + + <para> + Para información acerca de mapeos de herencia, ver <xref linkend="inheritance"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-join" revision="3"> + <title>join</title> + + <para> + Usando el elemento <literal><join></literal>, es posible mapear + propiedades de una clase a varias tablas. + </para> + + <programlistingco> + <areaspec> + <area id="join1" coords="2 50"/> + <area id="join2" coords="3 50"/> + <area id="join3" coords="4 50"/> + <area id="join4" coords="5 50"/> + <area id="join5" coords="6 50"/> + <area id="join6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<join + table="tablename" + schema="owner" + catalog="catalog" + fetch="join|select" + inverse="true|false" + optional="true|false"> + + <key ... /> + + <property ... /> + ... +</join>]]></programlisting> + + <calloutlist> + <callout arearefs="join1"> + <para> + <literal>table</literal>: El nombre de la clase unida. + </para> + </callout> + <callout arearefs="join2"> + <para> + <literal>schema</literal> (opcional): Sobrescribe el nombre de esquema + especificado por el elemento raíz <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="join3"> + <para> + <literal>catalog</literal> (opcional): Sobrescribe el nombre de catálogo + especificado por el elemento raíz <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="join4"> + <para> + <literal>fetch</literal> (opcional - por defecto a <literal>join</literal>): + Si se establece a <literal>join</literal>, por defecto, Hibernate usará + una unión interior (inner join) para recuperar un <literal><join></literal> + definido por una clase o sus superclases y una unión externa (outer join) + para un <literal><join></literal> definido por una subclase. + Si se establece a <literal>select</literal>, entonces Hibernate usará una + select secuencial para un <literal><join></literal> definido en una subclase, + que será publicada sólo si una fila resulta representar una instancia + de la subclase. Las uniones interiores todavía serán usados para + recuperar un <literal><join></literal> definido por la clase y sus superclases. + </para> + </callout> + <callout arearefs="join5"> + <para> + <literal>inverse</literal> (opcional - por defecto a <literal>false</literal>): + De habilitarse, Hibernate no intentará insertar o actualizar las propiedades + definidas por esta unión. + </para> + </callout> + <callout arearefs="join6"> + <para> + <literal>optional</literal> (opcional - por defecto a <literal>false</literal>): + De habilitarse, Hibernate insertará una fila sólo si las propiedades + definidas por esta unión son no nulas y siempre usará una unión + externa para recuperar las propiedades. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Por ejemplo, la información domiciliaria de una persona puede ser mapeada + a una tabla separada (preservando a la vez la semántica de tipo de valor para + todas las propiedades): + </para> + + <programlisting><![CDATA[<class name="Person" + table="PERSON"> + + <id name="id" column="PERSON_ID">...</id> + + <join table="ADDRESS"> + <key column="ADDRESS_ID"/> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </join> + ...]]></programlisting> + + <para> + Esta funcionalidad es a menudo solamente útil para modelos de datos + heredados; recomendamos menos tablas que clases un modelo de dominio más + granularizado. Sin embargo, es útil para cambiar entre estrategias de mapeo + de herencias en una misma jerarquía, como se explica luego. + </para> + + </sect2> + + <sect2 id="mapping-declaration-key"> + <title>key</title> + + <para> + Hasta ahora hemos visto el elemento <literal><key></literal> pocas veces. + Aparece en cualquier sitio en que el elemento padre de mapeo defina una unión + a una nueva tabla, y define la clave foránea en la tabla unida, + que referencia la clave primaria de la tabla original. + </para> + + <programlistingco> + <areaspec> + <area id="key1" coords="2 50"/> + <area id="key2" coords="3 50"/> + <area id="key3" coords="4 50"/> + <area id="key4" coords="5 50"/> + <area id="key5" coords="6 50"/> + <area id="key6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<key + column="columnname" + on-delete="noaction|cascade" + property-ref="propertyName" + not-null="true|false" + update="true|false" + unique="true|false" +/>]]></programlisting> + + <calloutlist> + <callout arearefs="key1"> + <para> + <literal>column</literal> (opcional): El nombre de columna de la clave foránea. + Puede ser también especificado por elemento(s) anidado(s) + <literal><column></literal>. + </para> + </callout> + <callout arearefs="key2"> + <para> + <literal>on-delete</literal> (opcional, por defecto a <literal>noaction</literal>): + Especifica si la restricción de clave foránea tiene el borrado en cascada + habilitado a nivel de base de datos. + </para> + </callout> + <callout arearefs="key3"> + <para> + <literal>property-ref</literal> (opcional): Especifica que la clave foránea + referencia columnas que no son del la clave primaria de la tabla original. + (Provisto para datos heredados.) + </para> + </callout> + <callout arearefs="key4"> + <para> + <literal>not-null</literal> (opcional): Especifica que las columnas de la clave + foránea son no nulables (esto está implicado si la clave foránea + es también parte de la clave primaria). + </para> + </callout> + <callout arearefs="key5"> + <para> + <literal>update</literal> (opcional): Especifica que la clave foránea nunca + debe ser actualizada (esto está implicado si la clave foránea + es también parte de la clave primaria). + </para> + </callout> + <callout arearefs="key6"> + <para> + <literal>unique</literal> (opcional): Especifica que la clave foránea + debe tener una restricción de unicidad (esto está implicado si + la clave foránea es también la clave primaria). + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Recomendamos que, para los sistemas en donde el rendimiento sea importante, todas las + claves deben ser definidas <literal>on-delete="cascade"</literal>, e Hibernate usará + una restricción <literal>ON CASCADE DELETE</literal> a nivel de base de datos, + en vez de muchas sentencias <literal>DELETE</literal> individuales. Ten en cuenta que + esta funcionalidad se salta la habitual estrategia de bloqueo optimista de Hibernate para + datos versionados. + </para> + + <para> + Los atributos <literal>not-null</literal> y <literal>update</literal> son útiles + al mapear una asociación uno a muchos unidireccional. Si mapeas una uno a muchos + unidireccional a una clave foránea no nulable, <emphasis>debes</emphasis> declarar + la columna clave usando <literal><key not-null="true"></literal>. + </para> + + </sect2> + + <sect2 id="mapping-column" revision="3"> + <title>los elementos column y formula</title> + <para> + Cualquier elemento de mapeo que acepte un atributo <literal>column</literal> aceptará + alternativamente un subelemento <literal><column></literal>. De forma similar, + <literal><formula></literal> es una alternativa al atributo <literal>formula</literal>. + </para> + + <programlisting><![CDATA[<column + name="column_name" + length="N" + precision="N" + scale="N" + not-null="true|false" + unique="true|false" + unique-key="multicolumn_unique_key_name" + index="index_name" + sql-type="sql_type_name" + check="SQL expression"/>]]></programlisting> + + <programlisting><![CDATA[<formula>expresión SQL</formula>]]></programlisting> + + <para> + Los atributos <literal>column</literal> y <literal>formula</literal> pueden + incluso ser combinados dentro del mismo mapeo de propiedad o asociación para + expresar, por ejemplo, condiciones de unión exóticas. + </para> + + <programlisting><![CDATA[<many-to-one name="homeAddress" class="Address" + insert="false" update="false"> + <column name="person_id" not-null="true" length="10"/> + <formula>'MAILING'</formula> +</many-to-one>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-import"> + <title>import</title> + + <para> + Supón que tu aplicación tiene dos clases persistentes con el mismo nombre, + y no quieres especificar el nombre completamenta cualificado (paquete) en las consultas + Hibernate. Las clases pueden ser "importadas" explícitamente, en vez de confiar en + <literal>auto-import="true"</literal>. Puedes incluso importar clases e interfaces que + no estén mapeadas explícitamente. + </para> + + <programlisting><![CDATA[<import class="java.lang.Object" rename="Universe"/>]]></programlisting> + + <programlistingco> + <areaspec> + <area id="import1" coords="2 40"/> + <area id="import2" coords="3 40"/> + </areaspec> + <programlisting><![CDATA[<import + class="ClassName" + rename="ShortName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="import1"> + <para> + <literal>class</literal>: El nombre de clase completamente cualificado de + cualquier clase Java. + </para> + </callout> + <callout arearefs="import2"> + <para> + <literal>rename</literal> (opcional - por defecto al nombre de clase sin cualificar): + Un nombre que será usado en el leguaje de consulta. + </para> + </callout> + </calloutlist> + </programlistingco> + + </sect2> + + <sect2 id="mapping-types-anymapping" revision="2"> + <title>any</title> + + <para> + Hay un tipo más de mapeo de propiedad. El elemento de mapeo <literal><any></literal> + define una asociacián polimórfica a clases desde múltiples tablas. Este tipo + de mapeo siempre requiere más de una columna. La primera columna contiene el tipo de la + entidad asociada. Las columnas restantes contienen el identificador. Es imposible especificar una + restricción de clave foránea para este tipo de asociación, por lo que + esto ciertamente no está concebido como la forma habitual de mapear asociaciones + (polimórficas). Sólo debes usar esto en casos muy especiales (por ejemplo, + trazas de auditoréa, datos de sesión de usuario, etc). + </para> + + <para> + El atributo <literal>meta-type</literal> permite a la aplicación especificar un tipo + personalizado que mapee columnas de base de datos a clases persistentes que tengan propiedades + identificadoras del tipo especificado por <literal>id-type</literal>. Debes especificar el + mapeo de valores del meta-type a nombres de clase. + </para> + + <programlisting><![CDATA[<any name="being" id-type="long" meta-type="string"> + <meta-value value="TBL_ANIMAL" class="Animal"/> + <meta-value value="TBL_HUMAN" class="Human"/> + <meta-value value="TBL_ALIEN" class="Alien"/> + <column name="table_name"/> + <column name="id"/> +</any>]]></programlisting> + + <programlistingco> + <areaspec> + <area id="any1" coords="2 50"/> + <area id="any2" coords="3 50"/> + <area id="any3" coords="4 50"/> + <area id="any4" coords="5 50"/> + <area id="any5" coords="6 50"/> + <area id="any6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<any + name="propertyName" + id-type="idtypename" + meta-type="metatypename" + cascade="cascade_style" + access="field|property|ClassName" + optimistic-lock="true|false" +> + <meta-value ... /> + <meta-value ... /> + ..... + <column .... /> + <column .... /> + ..... +</any>]]></programlisting> + <calloutlist> + <callout arearefs="any1"> + <para> + <literal>name</literal>: el nombre de la propiedad. + </para> + </callout> + <callout arearefs="any2"> + <para> + <literal>id-type</literal>: el tipo del identificador. + </para> + </callout> + <callout arearefs="any3"> + <para> + <literal>meta-type</literal> (opcional - por defecto a <literal>string</literal>): + Cualquier tipo que sea permitido para un mapeo de discriminador. + </para> + </callout> + <callout arearefs="any4"> + <para> + <literal>cascade</literal> (opcional- por defecto a <literal>none</literal>): + el estilo de cascada. + </para> + </callout> + <callout arearefs="any5"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): La + estrategia que Hibernate debe usar para acceder al valor de la propiedad. + </para> + </callout> + <callout arearefs="any6"> + <para> + <literal>optimistic-lock</literal> (opcional - por defecto a <literal>true</literal>): + Especifica si las actualizaciones de esta propiedad requieren o no de la + adquisición del bloqueo optimista. En otras palabras, determina si debe ocurrir + un incremento de versión cuando esta propiedad está desactualizada. + </para> + </callout> + </calloutlist> + </programlistingco> + + </sect2> + + </sect1> + + <sect1 id="mapping-types"> + <title>Tipos de Hibernate</title> + + <sect2 id="mapping-types-entitiesvalues" revision="1"> + <title>Entidades y Valores</title> + + <para> + Para entender el comportamiento de varios objetos a nivel de lenguaje Java + con respecto al servicio de persistencia, necesitamos clasificarlos en dos grupos: + </para> + + <para> + Una <emphasis>entidad</emphasis> existe independientemente de cualquier otros + objetos que referencien a la entidad. Contrasta esto con el model habitual de Java + donde un objeto desreferenciado es recolectado como basura. Las entidades deben ser + salvadas y borradas explícitamente (excepto que las grabaciones y borrados + puedan ser <emphasis>tratados en cascada</emphasis> desde una entidad padre a sus hijos). + Esto es diferente al modelo de persistencia de objetos por alcance - y se corresponde + más de cerca a cómo los objetos de aplicación son usados + habitualmente en grandes sistemas. Las entidades soportan referencias circulares y + compartidas, que tambié pueden ser versionadas. + </para> + + <para> + El estado persistente de una entidad consiste en referencias a otras entidades + e instancias de tipo <emphasis>valor</emphasis>. Los valores son primitivos, + colecciones (no lo que está dentro de la colección), componentes + y ciertos objetos inmutables. A diferencia de las entidades, los valores + (en particular las colecciones y los componentes) <emphasis>son</emphasis> + hechos persitentes y borrados por alcance. Como los objetos valor (y primitivos) + son persistidos y borrados junto a sus entidades contenedoras, no pueden ser + versionados independientemente. Los valores no tienen identidad independiente, + por los que no pueden ser compartidos por dos entidades o colleciones. + </para> + + <para> + Hasta ahora, hemos estado usando el término "clase persistente" + para referirnos a entidades. Continuaremos haciéndolo. Hablando + estrictamente, sin embargo, no todas la clases con estado persistente + definidas por el usuario son entidades. Un <emphasis>componente</emphasis> + es una clase definida por el usuario con semántica de valor. + Una propiedad Java de tipo <literal>java.lang.String</literal> también + tiene semántica de valor. Dada esta definición, podemos decir + que todos los tipo (clases) provistos por el JDK tienen una semántica + de tipo valor en Java, mientras que los tipos definidos por el usuario + pueden ser mapeados con semántica de tipo valor o de entidad. + La desición corre por cuenta del desarrollador de la aplicación. + Un buen consejo para una clase entidad en un modelo de dominio son las referencias + compartidas a una sola instancia de esa clase, mientras que la composición + o agregación usualmente se traducen a un tipo de valor. + </para> + + <para> + Volveremos a visitar ambos conceptos a lo largo de la documentación. + </para> + + <para> + EL desafío es mapear el sistema de tipos de Java (y la definición + de entidades y tipos de valor de los desarrolladores) al sistema de tipos de + SQL/base de datos. EL puente entre ambos sistemas es provisto por Hibernate: + para las entidades usamos <literal><class></literal>, + <literal><subclass></literal>, etc. Para los tipos de valor usamos + <literal><property></literal>, <literal><component></literal>, etc, + usualmente con un atributo <literal>type</literal>. El valor de este atributo + es el nombre de un <emphasis>tipo de mapeo</emphasis> de Hibernate. Hibernate + provee de fábrica muchos mapeos (para tipos de valores del JDK + estándar). Puedes escribir tus propios mapeos de tipo, así como + implementar tus estrategias de conversión personalizadas, como veremos luego. + </para> + + <para> + Todos los tipos prefabricados de Hibernate soportan semántica de nulos + excepto las colecciones. + </para> + + </sect2> + + <sect2 id="mapping-types-basictypes" revision="2"> + <title>Tipos de valores básicos</title> + + <para> + Los <emphasis>tipos de mapeo básicos</emphasis> prefabricados pueden ser + categorizado a grandes rasgos en: + + <variablelist> + <varlistentry> + <term><literal>integer, long, short, float, double, character, byte, + boolean, yes_no, true_false</literal></term> + <listitem> + <para> + Mapeos de tipos primitivos de Java o clases de envoltura a + la tipos de columna SQL (especícifica del vendedor). + <literal>boolean, yes_no</literal> y <literal>true_false</literal> + son codificaciones alternativas a <literal>boolean</literal> de + Java o <literal>java.lang.Boolean</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>string</literal></term> + <listitem> + <para> + Un mapeo del tipo <literal>java.lang.String</literal> a + <literal>VARCHAR</literal> (u Oracle <literal>VAARCHAR2</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>date, time, timestamp</literal></term> + <listitem> + <para> + Mapeos de tipo desde <literal>java.util.Date</literal> y sus subclases + a tipos SQL <literal>DATE</literal>, <literal>TIME</literal> y + <literal>TIMESTAMP</literal> (o equivalente). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>calendar, calendar_date</literal></term> + <listitem> + <para> + Mapeos de tipo desde <literal>java.util.Date</literal> y sus subclases + a tipos SQL <literal>TIMESTAMP</literal> y <literal>DATE</literal> + (o equivalente). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>big_decimal, big_integer</literal></term> + <listitem> + <para> + Mapeos de tipo desde <literal>java.math.BigDecimal</literal> y + <literal>java.math.BigInteger</literal> a <literal>NUMERIC</literal> + (o <literal>NUMBER</literal> de Oracle). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>locale, timezone, currency</literal></term> + <listitem> + <para> + Mapeos de tipo desde <literal>java.util.Locale</literal>, + <literal>java.util.TimeZone</literal> y + <literal>java.util.Currency</literal> a + <literal>VARCHAR</literal> (o <literal>VARCHAR2</literal> de Oracle). + Las instancias de <literal>Locale</literal> y <literal>Currency</literal> + son mapeadas a sus códigos ISO. Las instancias de + <literal>TimeZone</literal> son mapeadas a sus <literal>ID</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>class</literal></term> + <listitem> + <para> + Un mapeo de tipo <literal>java.lang.Class</literal> a + <literal>VARCHAR</literal> (o <literal>VARCHAR2</literal> de Oracle). + Una <literal>Class</literal> es mapeara a su nombre completamente + cualificado. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>binary</literal></term> + <listitem> + <para> + Mapea arreglos de bytes a un tipo binario SQL apropiado. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>text</literal></term> + <listitem> + <para> + Mapea cadenas largas Java al tipo SQL <literal>CLOB</literal> o + <literal>TEXT</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>serializable</literal></term> + <listitem> + <para> + Mapea tipos serializables Java a un tipo binario SQL apropiado. + Puedes además indicar el tipo <literal>serializable</literal> + de Hibernate con el nombre de una clase o interface serializable Java + que no sea por defecto un tipo básico. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>clob, blob</literal></term> + <listitem> + <para> + Mapeos de tipo para las clases JDBC <literal>java.sql.Clob</literal> y + <literal>java.sql.Blob</literal>. Estos tipos pueden ser inconvenientes + para algunas aplicaciones, pues el objeto blob o clob no puede ser reusado + fuera de una transacción (Además, el soporte del driver suele + ser malo e inconsistente). + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + + <para> + Los identificadores únicos de entidades y collecciones pueden ser de cualquier + tipo básico excepto <literal>binary</literal>, <literal>blob</literal> + y <literal>clob</literal>. + (Los identificadores compuestos están también permitidos, ver debajo.) + </para> + + <para> + Los tipos de valor básicos tienen sus constantes <literal>Type</literal> + correspondientes definidas en <literal>org.hibernate.Hibernate</literal>. Por ejemplo, + <literal>Hibernate.STRING</literal> representa el tipo <literal>string</literal>. + </para> + + </sect2> + + <sect2 id="mapping-types-custom" revision="2"> + <title>Tipos de valor personalizados</title> + + <para> + Es relativamente fácil para los desarrolladores crear sus propios tipos de valor. + Por ejemplo, podrías querer persistir propiedades del tipo <literal>java.lang.BigInteger</literal> + a columnas <literal>VARCHAR</literal>. Hibernate no provee un tipo de fábrica para esto. + Pero los tipos personalizados no están limitados a mapear una propiedad (o elemento de colección) + a una sola columna de tabla. Así, por ejemplo, podrías tener una propiedad Java + <literal>getName()</literal>/<literal>setName()</literal> de tipo <literal>java.lang.String</literal> + que fuera persistida a las columnas <literal>FIRST_NAME</literal>, <literal>INITIAL</literal>, + <literal>SURNAME</literal>. + </para> + + <para> + Para implementar un tipo personalizado, implementa bien <literal>org.hibernate.UserType</literal> + o <literal>org.hibernate.CompositeUserType</literal> y declara las propiedades usando el nombre + de clase completamente cualificado del tipo. Revisa <literal>org.hibernate.test.DoubleStringType</literal> + para ver qué tipo de cosas son posibles. + </para> + + <programlisting><![CDATA[<property name="twoStrings" type="org.hibernate.test.DoubleStringType"> + <column name="first_string"/> + <column name="second_string"/> +</property>]]></programlisting> + + <para> + Observa el uso de etiquetas <literal><column></literal> para mapear una propiedad + a múltiples columnas. + </para> + + <para> + Las interfaces <literal>CompositeUserType</literal>, <literal>EnhancedUserType</literal>, + <literal>UserCollectionType</literal>, y <literal>UserVersionType</literal> proveen + soporte a usos más especializados. + </para> + + <para> + Puedes incluso proveer de parámetros a un <literal>UserType</literal> en el + fichero de mapeo. Para hacer esto, tu <literal>UserType</literal> debe implementar + la interface <literal>org.hibernate.usertype.ParameterizedType</literal>. Para + proveer de parámetros a tu tipo personalizado, puedes usar el elemento + <literal><type></literal> en tus ficheros de mapeo. + </para> + + <programlisting><![CDATA[<property name="priority"> + <type name="com.mycompany.usertypes.DefaultValueIntegerType"> + <param name="default">0</param> + </type> +</property>]]></programlisting> + + <para> + Ahora el <literal>UserType</literal> puede recuperar el valor del parámetro + llamado <literal>default</literal> del objeto <literal>Properties</literal> + que se le pasa. + </para> + + <para> + Si usas cierto <literal>UserType</literal> muy frecuentemente, puede ser útil + definir un nombre corto para é. Puedes hacer esto usando el elemento + <literal><typedef></literal>. Los typedefs asignan un nombre a un tipo + personalizado, y pueden también contener una lista de valores por defecto + de parámetros si el tipo fuese parametrizado. + </para> + + <programlisting><![CDATA[<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero"> + <param name="default">0</param> +</typedef>]]></programlisting> + + <programlisting><![CDATA[<property name="priority" type="default_zero"/>]]></programlisting> + + <para> + también es posible sobrescribir los parámetros provistos en un typedef sobre + una base caso por caso usando parámetros de tipo en el mapeo de la propiedad. + </para> + + <para> + Aunque el rico espectro de tipos prefabricados y soporte de componentes de Hibernate + significa que raramente <emphasis>necesites</emphasis> usar un tipo personalizado; + sin embargo se considera una buena forma usar tipos personalizados para clases (no-entidades) + que aparezcan frecuentemente en tu aplicación. Por ejemplo, una clase + <literal>MonetaryAmount</literal> es una buena candidata para un + <literal>CompositeUserType</literal>, incluso cuando puede ser facilmente mapeada como un + componente. Un motivo para esto es la abstracción. Con un tipo personalizado, + tus documentos de mapeo estará impermeabilizados contra posibles cambios futuros en la + forma de representar valores monetarios. + </para> + </sect2> + + </sect1> + + + <sect1 id="mapping-entityname"> + <title>Mapeando una clase más de una vez</title> + <para> + Es posible proveer más de un mapeo para una clase persistente en particular. En este caso debes + especificar un <emphasis>nombre de entidad</emphasis> para desambiguar entr las instancias de las + dos entidades mapeadas. (Por defectom, el nombre de la entidad es el mismo que el nombre de la clase.) + Hibernate te deja especificar el nombre de entidad al trabajar con objetos persistentes, al escribir + consultas, o al mapear asociaciones a la entidad mencionada. + </para> + + <programlisting><![CDATA[<class name="Contract" table="Contracts" + entity-name="CurrentContract"> + ... + <set name="history" inverse="true" + order-by="effectiveEndDate desc"> + <key column="currentContractId"/> + <one-to-many entity-name="HistoricalContract"/> + </set> +</class> + +<class name="Contract" table="ContractHistory" + entity-name="HistoricalContract"> + ... + <many-to-one name="currentContract" + column="currentContractId" + entity-name="CurrentContract"/> +</class>]]></programlisting> + + <para> + Observa cómo las asociaciones ahora se especifican usando <literal>entity-name</literal> en vez de + <literal>class</literal>. + </para> + + </sect1> + + + <sect1 id="mapping-quotedidentifiers"> + <title>identificadores SQL encomillados</title> + <para> + Puedes forzar a Hibernate a encomillar un identificador en el SQL generado encerrando el nombre + de tabla o columna entre backticks en el documento de mapeo. Hibernate usará el estilo de + encomillado para el <literal>Dialect</literal> SQL (usualmente comillas dobles, excepto corchetes + para SQL Server y backsticks para MySQL). + </para> + + <programlisting><![CDATA[<class name="LineItem" table="`Line Item`"> + <id name="id" column="`Item Id`"/><generator class="assigned"/></id> + <property name="itemNumber" column="`Item #`"/> + ... +</class>]]></programlisting> + + </sect1> + + + <sect1 id="mapping-alternatives"> + <title>Alternativas de metadatos</title> + + <para> + XML no es para todos, asá que hay algunas formas alternativas de definir metadatos de mapeo O/R + en Hibernate. + </para> + + <sect2 id="mapping-xdoclet"> + <title>Usando marcado de XDoclet</title> + + <para> + Muchos usuarios de Hibernate prefieren embeber la información de mapeo directamente + en el código fuente usando las <literal>@hibernate.etiquetas</literal> XDoclet. + No cubriremos este enfoque en este documento, pues estrictamente es considerado parte + de XDoclet. Sin embargo, incluímos el siguiente ejemplo de la clase + <literal>Cat</literal> con mapeos XDoclet. + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +/** + * @hibernate.class + * table="CATS" + */ +public class Cat { + private Long id; // identifier + private Date birthdate; + private Cat mother; + private Set kittens + private Color color; + private char sex; + private float weight; + + /* + * @hibernate.id + * generator-class="native" + * column="CAT_ID" + */ + public Long getId() { + return id; + } + private void setId(Long id) { + this.id=id; + } + + /** + * @hibernate.many-to-one + * column="PARENT_ID" + */ + public Cat getMother() { + return mother; + } + void setMother(Cat mother) { + this.mother = mother; + } + + /** + * @hibernate.property + * column="BIRTH_DATE" + */ + public Date getBirthdate() { + return birthdate; + } + void setBirthdate(Date date) { + birthdate = date; + } + /** + * @hibernate.property + * column="WEIGHT" + */ + public float getWeight() { + return weight; + } + void setWeight(float weight) { + this.weight = weight; + } + + /** + * @hibernate.property + * column="COLOR" + * not-null="true" + */ + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + /** + * @hibernate.set + * inverse="true" + * order-by="BIRTH_DATE" + * @hibernate.collection-key + * column="PARENT_ID" + * @hibernate.collection-one-to-many + */ + public Set getKittens() { + return kittens; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kittens.add(kitten); + } + + /** + * @hibernate.property + * column="SEX" + * not-null="true" + * update="false" + */ + public char getSex() { + return sex; + } + void setSex(char sex) { + this.sex=sex; + } +}]]></programlisting> + + <para> + Para más ejemplos de XDoclet e Hibernate ver en el sitio web de Hibernate. + </para> + + </sect2> + + <sect2 id="mapping-annotations" revision="2"> + <title>Usando anotaciones JDK 5.0</title> + <para> + El JDK 5.0 introdujo anotaciones del estilo XDoclet a nivel del lenguaje, + con chequeo seguro de tipos en tiempo de compilación. Este mecanismo es más + potente y que las anotaciones XDoclet, y mejor soportado por herramientas e IDEs. + IntelliJ IDEA, por ejemplo, soporta auto-compleción y resaltado de sintaxis de anotaciones + JDK 5.0. La nueva revisión de la especificación de EJB (JSR-220) usa anotaciones + JDK 5.0 como el mecanismo primario de metadatos para beans de entidad. Hibernate3 implementa + el <literal>EntityManager</literal> del JSR-220 (la API de persistencia), y el soporte para + metadatos de mapeo está disponible vía el paquete <emphasis>Hibernate Annotations</emphasis>, + como una descarga por separado. Tanto metadatos de EJB3 (JSR-220) como de Hibernate3 están soportados. + </para> + + <para> + Este es un ejemplo de una clase POJO anotada como un bean de entidad EJB: + </para> + + <programlisting><![CDATA[@Entity(access = AccessType.FIELD) +public class Customer implements Serializable { + + @Id; + Long id; + + String firstName; + String lastName; + Date birthday; + + @Transient + Integer age; + + @Embedded + private Address homeAddress; + + @OneToMany(cascade=CascadeType.ALL) + + @JoinColumn(name="CUSTOMER_ID") + Set<Order> orders; + + // Getter/setter and business methods +}]]></programlisting> + + <para> + Ten en cuenta que el soporte a anotaciones JDK 5.0 (y JSR-220) es todavía un + trabajo en progreso y no completado. Por favor, para más detalles refiérete al modulo + de Anotaciones de Hibernate. + </para> + + </sect2> + </sect1> + +</chapter> + + + + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/batch.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/batch.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/batch.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/batch.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,192 @@ +<chapter id="batch"> + <title>Procesamiento por lotes</title> + + <para> + Un enfoque ingenuo para insertar 100.000 filas en la base de datos usando Hibernate podría verse así: + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); +} +tx.commit(); +session.close();]]></programlisting> + + <para> + Esto podría caer sobre una <literal>OutOfMemoryException</literal> en algún sitio + cerca de la fila 50.000. Esto es porque Hibernate tiene en caché todas las instancias + de <literal>Customer</literal> recién instanciadas en el caché de nivel de sesión. + </para> + + <para> + En este capítulo te mostraremos cómo evitar este problema. Primero, sin embargo, + si estás haciendo procesamiento por lotes (batch processing), es absolutamente crítico + que habilites el uso de loteo JDBC, si pretendes lograr un rendimiento razonable. + Establece el tamaño de lote JDBC a un número razonable (digamos 10-50): + </para> + +<programlisting><![CDATA[hibernate.jdbc.batch_size 20]]></programlisting> + + <para> + Podrías además querer hacer este tipo de trabajo en un proceso donde la interacción con el caché de + segundo nivel esté completamente deshabilitado: + </para> + +<programlisting><![CDATA[hibernate.cache.use_second_level_cache false]]></programlisting> + + <sect1 id="batch-inserts"> + <title>Inserciones en lote</title> + + <para> + Al hacer persistentes objetos nuevos, debes limpiar con <literal>flush()</literal> y + llamar a <literal>clear()</literal> en la sesión regularmente, para controlar el tamaño + del caché de primer nivel. + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); + if ( i % 20 == 0 ) { //20, same as the JDBC batch size + //flush a batch of inserts and release memory: + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-update" > + <title>Actualizaciones en lote</title> + + <para> + Para recuperar y actualizar datos se aplican las mismas ideas. Adicionalmente, necesitas usar + <literal>scroll()</literal> para sacar ventaja de los cursores del lado del servidor en consultas + que devuelvan muchas filas de datos. + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .setCacheMode(CacheMode.IGNORE) + .scroll(ScrollMode.FORWARD_ONLY); +int count=0; +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + if ( ++count % 20 == 0 ) { + //flush a batch of updates and release memory: + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-direct"> + <title>update/delete en masa</title> + + <para> + Como ya se ha discutido, el mapeo objeto/relacional automático y transparente se refiere + al manejo de estado de objetos. Esto implica que el estado del objeto está disponible + en memoria, por lo tanto actualizar o borrar (usando <literal>UPDATE</literal> y + <literal>DELETE</literal> de SQL) datos directamente en la base de datos no afectará el + estado en memoria. Sin embargo, Hibernate provee métodos para la ejecución de sentencias + del estilo de <literal>UPDATE</literal> y <literal>DELETE</literal> de SQL que se realizan + a través del Lenguaje de Consulta de Hibernate (Hibernate Query Language o + <xref linkend="queryhql">HQL</xref>). + </para> + + <para> + La pseudo-sintáxis para sentencias <literal>UPDATE</literal> y <literal>DELETE</literal> es: + <literal>( UPDATE | DELETE ) FROM? ClassName (WHERE WHERE_CONDITIONS)?</literal>. Algunos puntos + a tener en cuenta: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + En la cláusula-from, la palabra clave FROM es opcional + </para> + </listitem> + <listitem> + <para> + Puede haber sólo una clase mencionada en la cláusula-from, y <emphasis>no puede</emphasis> + tener un alias. + </para> + </listitem> + <listitem> + <para> + No puede especificarse ningún join (bien implícito o explícito) en una consulta masiva de HQL. + Pueden usarse subconsultas en la cláusula-where. + </para> + </listitem> + <listitem> + <para> + La cláusula-where es también opcional. + </para> + </listitem> + </itemizedlist> + + <para> + Como un ejemplo, para ejecutar un <literal>UPDATE</literal> HQL, usa el + método <literal>Query.executeUpdate()</literal>: + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); + Transaction tx = session.beginTransaction(); + + String hqlUpdate = "update Customer set name = :newName where name = :oldName"; + int updatedEntities = s.createQuery( hqlUpdate ) + .setString( "newName", newName ) + .setString( "oldName", oldName ) + .executeUpdate(); + tx.commit(); + session.close();]]></programlisting> + + <para> + Para ejecutar un <literal>DELETE</literal> HQL, usa el mismo método <literal>Query.executeUpdate()</literal> + (el método está nombrado para aquellos familiarizados con + <literal>PreparedStatement.executeUpdate()</literal> de JDBC): + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); + Transaction tx = session.beginTransaction(); + + String hqlDelete = "delete Customer where name = :oldName"; + int deletedEntities = s.createQuery( hqlDelete ) + .setString( "oldName", oldName ) + .executeUpdate(); + tx.commit(); + session.close();]]></programlisting> + + <para> + El valor <literal>int</literal> devuelto por el método <literal>Query.executeUpdate()</literal> + indica el número de entidades afectadas por la operación. Considera que esto puede o no + correlacionarse al número de filas afectadas en la base de datos. Una operación masiva HQL podría + resultar en que se ejecuten múltiples sentencias de SQL reales, para joined-subclass, por ejemplo. + El número devuelto indica el número de entidades reales afectadas por la sentencia. Volviendo al + ejemplo de joined-subclass, un borrado contra una de las subclases puede resultar realmente en + borrados contra no sólo la tabla a la que está mapeada esa subclase, sino también la tabla "raíz" + y potencialmente tablas de joined-subclass más debajo en la jerarquía de herencia. + </para> + + <para> + Ten en cuenta que existen actualmente unas pocas limitaciones con las operaciones HQL masivas, + que serán atendidas en lanzamientos futuros; consulta la hoja de ruta de JIRA para más detalles. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/best_practices.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/best_practices.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/best_practices.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/best_practices.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,229 @@ +<chapter id="best-practices" revision="3"> + <title>Mejores Prácticas</title> + + <variablelist spacing="compact"> + <varlistentry> + <term>Escribe clase finamente granularizadas y mapealas usando <literal><component></literal>.</term> + <listitem> + <para> + Usa una clase <literal>Dirección</literal> para encapsular <literal>calle</literal>, + <literal>distrito</literal>, <literal>estado</literal>, <literal>código postal</literal>. + Esto alienta la reutilización de código y simplifica el refactoring. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Declara las propiedades identificadoras en clases persistentes.</term> + <listitem> + <para> + Hibernate hace opcionales las propiedades identificadoras. Existen todo tipo de razones + por las que debes usarlas. Recomendamos que los identificadores sean 'sintéticos' + (generados, sin ningún significado de negocio). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Identifica las claves naturales.</term> + <listitem> + <para> + Identifica las claves naturales de todas las entidades, y mapealas usando + <literal><natural-id></literal>. Implementa <literal>equals()</literal> y + <literal>hashCode()</literal> para comparar las propiedades que componen la clave natural. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Coloca cada mapeo de clase en su propio fichero.</term> + <listitem> + <para> + No uses un solo documento monolítico de mapeo. Mapea <literal>com.eg.Foo</literal> en + el fichero <literal>com/eg/Foo.hbm.xml</literal>. Esto tiene sentido particularmente en un + ambiente de equipo. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Carga los mapeos como recursos.</term> + <listitem> + <para> + Despliega los mapeos junto a las clases que mapean. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Considera externalizar las cadenas de consulta.</term> + <listitem> + <para> + Esta es una buena práctica si tus consultas llaman a funciones SQL que no son del + estándar ANSI. Externalizar las cadenas de consulta a ficheros de mapeo hará la + aplicación más portable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Usa variables de ligado.</term> + <listitem> + <para> + Igual que en JDBC, siempre remplaza valores no constantes con "?". ¡Nunca uses manipulación + de cadenas para ligar un valor no constante en una consulta! Incluso mejor, considera usar + parámetros con nombre en las consultas. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>No manejes tus propias conexiones JDBC.</term> + <listitem> + <para> + Hibernate deja a la aplicación administre las conexiones JDBC. Este enfoque debe considerarse + como último recurso. Si no puedes usar los provedores de conexión prefabricados, considera + prover tu propia implementación de <literal>org.hibernate.connection.ConnectionProvider</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Considera usar un tipo personalizado.</term> + <listitem> + <para> + Supón que tienes un tipo Java, digamos de alguna biblioteca, que necesita hacerse persistente + pero no provee los métodos de acceso necesarios para mapearlo como un componente. Debes considerar + implementar <literal>org.hibernate.UserType</literal>. Este enfoque libera al código de aplicación + de implementar transformaciones a / desde un tipo Hibernate. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Usa JDBC codificado a mano en cuellos de botella.</term> + <listitem> + <para> + En áreas del sistema de rendimiento crítico, algunos tipos de operaciones podrían beneficiarse + del JDBC directo. Pero por favor, espero hasta que <emphasis>sepas</emphasis> que algo es + un cuello de botella. Y no asumas que el JDBC directo es necesariamente más rápido. Si necesitas + usar JDBC directo, podría ser valioso abrir una <literal>Session</literal> de Hibernate y usar esa + conexión JDBC. De esta forma puedes usar aún la misma estrategia de transacción y el mismo + proveedor de conexiones subyacente. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Comprende la limpieza (flushing) de <literal>Session</literal>.</term> + <listitem> + <para> + De vez en cuando la sesión sincroniza su estado persistente con la base de datos. El rendimiento + se verá afectado si este proceso ocurre demasiado frecuentemente. A veces puedes minimizar + limpieza innecesaria deshabilitando la limpieza automática o incluso cambiando el orden de las + consultas u otras operaciones en una transacción en particular. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>En una aplicación en tres gradas, considera usar objetos separados.</term> + <listitem> + <para> + Al usar una arquitectura de servlet / sesión, puedes pasar objetos persistentes en el bean de + sesión hacia y desde la capa de servlet / JSP. Usa una sesión nueva para atender el servicio de cada + petición. Usa <literal>Session.merge()</literal> o <literal>Session.saveOrUpdate()</literal> para + sincronizar los objetos con la base de datos. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>En una arquitectura en dos gradas, considera usar contexto de persistencia largos.</term> + <listitem> + <para> + Las transacciones de base de datos tienen que ser tan cortas como sea posible. Sin embargo, + frecuentemente es necesario implementar <emphasis>transacciones de aplicación</emphasis> + ejecutándose en largo, una sola unidad de trabajo desde el punto de vista de un usuario. + Una transacción de aplicación puede abarcar muchos ciclos petición/respuesta del cliente. + Es común usar objetos separados para implementar transacciones de aplicación. Una alternativa, + extremadamente apropiada en arquitecturas en dos gradas, es mantener un solo contacto de persistencia + abierto (sesión) para todo el ciclo de vida de la transacción de aplicación y simplemente + desconectar de la conexión JDBC al final de cada petición, y reconectar al comienzo de la + petición subsecuente. Nunca compartas una única sesión a través de más de una transacción + de aplicación, o estarás trabajando con datos añejos. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>No trates la excepciones como recuperables.</term> + <listitem> + <para> + Esto es más una práctica necesaria que una "mejor" práctica. Cuando ocurra una excepción, + deshaz (rollback) la <literal>Transaction</literal> y cierra la <literal>Session</literal>. + Si no lo haces, Hibernate no puede garantizar que el estado en memoria representa con exactitud + el estado persistente. Como un caso especial de esto, no uses <literal>Session.load()</literal> + para determinar si una instancia con el identificador dado existe en la base de datos. En cambio, + usa <literal>Session.get()</literal> o una consulta. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Prefiere la recuperación perezosa para las asociaciones.</term> + <listitem> + <para> + Usa escasamente la recuperación temprana. Usa proxies y colecciones perezosas para la mayoría + de asociaciones a clases probablemente no estén mantenidas en el caché de segundo nivel. Para + las asociaciones a clases en caché, donde hay una probabilidad de acceso a caché extremadamente + alta, deshabilita explícitamente la recuperación temprana usando <literal>lazy="false"</literal>. + Cuando sea apropiada la recuperación por unión (join fetching) para un caso de uso en particular, + usa una consulta con un <literal>left join fetch</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Usa el patrón <emphasis>sesión abierta en vista</emphasis>, o una <emphasis>fase de ensamblado</emphasis> + disciplinada para evitar problemas con datos no recuperados. + </term> + <listitem> + <para> + Hibernate liberal al desarrollador de escribir <emphasis>Objetos de Transferencia de Datos + (Data Transfer Objects)</emphasis> (DTO). En una arquitectura tradicional de EJB, los DTOs tienen + un propósito doble: primero, atacan el problema que los beans de entidad no son serializables. + Segundo, definen implícitamente una fase de ensamblado cuando se recuperan y se forman (marshalling) + todos los datos a usar por la vista en los DTOs antes de devolver el control a la grada de + presentación. Hibernate elimina el primer propósito. Sin embargo, aún necesitas una fase + de ensamblado (piensa en tus métodos de negocio como si tuviesen un contrato estricto con la grada + de presentación sobre qué datos están disponibles en los objetos separados) a menos que estés + preparado para tener el contexto de persistencia (la sesión) abierto a través del proceso + de renderización de la vista. ¡Esta no es una limitación de Hibernate! Es un requerimiento + fundamental de acceso seguro a datos transaccionales. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Considera abstraer tu lógica de negocio de Hibernate</term> + <listitem> + <para> + Oculta el código de acceso a datos (Hibernate) detrás de una interface. Combina los patrones + <emphasis>DAO</emphasis> y <emphasis>Sesión de Hebra Local</emphasis>. Incluso puedes tener + algunas clases hechas persistentes por JDBC escrito a mano, asociadas a Hibernate por medio + de un <literal>UserType</literal>. (Este consejo está pensado para aplicaciones "suficientemente + grandes"; ¡no es apropiado para una aplicación con cinco tablas!) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>No uses mapeos de asociación exóticos.</term> + <listitem> + <para> + Son raros los casos de uso de asociaciones reales muchos-a-muchos. La mayor parte del tiempo + necesitas información adicional almacenada en una "tabla de enlace". En este caso, es mucho + mejor usar dos asociaciones uno-a-muchos a una clase de enlace intermedia. De hecho, pensamos + que la mayoría de asociaciones son uno-a-muchos y muchos-a-uno, debes ser cuidadoso al usr + cualquier otro estilo de asociación y preguntarte si es realmente necesario. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Prefiere las asociaciones bidireccionales.</term> + <listitem> + <para> + Las asociaciones unidireccionales son más difíciles de consultar. En una aplicación grande, + casi todas las asociaciones deben ser navegables en ambas direcciones en consultas. + </para> + </listitem> + </varlistentry> + </variablelist> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/collection_mapping.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/collection_mapping.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/collection_mapping.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/collection_mapping.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,1241 @@ +<chapter id="collections"> + <title>Mapeo de Colecciones</title> + + <sect1 id="collections-persistent" revision="3"> + <title>Colecciones persistentes</title> + + <para> + Hibernate requiere que los campos valuados en colección + persistentes sean declarados como un tipo de interface, por ejemplo: + </para> + + <programlisting><![CDATA[public class Product { + private String serialNumber; + private Set parts = new HashSet(); + + public Set getParts() { return parts; } + void setParts(Set parts) { this.parts = parts; } + public String getSerialNumber() { return serialNumber; } + void setSerialNumber(String sn) { serialNumber = sn; } +}]]></programlisting> + + <para> + La interface real podría ser <literal>java.util.Set</literal>, + <literal>java.util.Collection</literal>, <literal>java.util.List</literal>, + <literal>java.util.Map</literal>, <literal>java.util.SortedSet</literal>, + <literal>java.util.SortedMap</literal> o ... lo que te guste! + (Donde "lo que te guste" significa que tendrás que escribir una + implementación de <literal>org.hibernate.usertype.UserCollectionType</literal>.) + </para> + + <para> + Nota cómo hemos inicializado la variable de instancia de + <literal>HashSet</literal>. Esta es la mejor forma de inicializar + propiedades valuadas en colección de instancias recién + instanciadas (no persistentes). Cuando haces persistente la instancia + - llamando a <literal>persist()</literal>, por ejemplo - Hibernate realmente + remplazará el <literal>HashSet</literal> con una instancia de una + implementación de <literal>Set</literal> propia de Hibernate. + Observa errores como este: + </para> + + <programlisting><![CDATA[Cat cat = new DomesticCat(); +Cat kitten = new DomesticCat(); +.... +Set kittens = new HashSet(); +kittens.add(kitten); +cat.setKittens(kittens); +session.persist(cat); +kittens = cat.getKittens(); // Okay, kittens collection is a Set +(HashSet) cat.getKittens(); // Error!]]></programlisting> + + <para> + Las colecciones persistentes inyectadas por Hibernate se comportan + como <literal>HashMap</literal>, <literal>HashSet</literal>, + <literal>TreeMap</literal>, <literal>TreeSet</literal> o + <literal>ArrayList</literal>, dependiendo del tipo de interface. + </para> + + <para> + Las instancias de colecciones tienen el comportamiento usual de tipos de valor. + Son automáticamente persistidas al ser referenciadas por un objeto + persistente y automáticamente borradas al desreferenciarse. Si una + colección es pasada de un objeto persistente a otro, sus elementos + serían movidos de una tabla a otra. Dos entidades pueden no + compartir una referencia a la misma instancia de colección. + Debido al modelo relacional subyacente, las propiedades valuadas en + colección no soportan la semántica de valor nulo. Hibernate no + distingue entre una referencia de colección nula y una colección + vacía. + </para> + + <para> + No debes tener que preocuparte demasiado por esto. Usa las colecciones + persistentes de la misma forma en que usas colecciones de Java ordinarias. + Sólo asegúrate que entiendes la semántica de las asociaciones + bidireccionales (discutida luego). + </para> + + </sect1> + + <sect1 id="collections-mapping" revision="2"> + <title>Mapeos de colección</title> + + <para> + El elemento de mapeo de Hibernate usado para mapear una colección + depende del tipo de la interface. Por ejemplom un elemento + <literal><set></literal> se usa para mapear propiedades de tipo + <literal>Set</literal>. + </para> + + <programlisting><![CDATA[<class name="Product"> + <id name="serialNumber" column="productSerialNumber"/> + <set name="parts"> + <key column="productSerialNumber" not-null="true"/> + <one-to-many class="Part"/> + </set> +</class>]]></programlisting> + + <para> + Aparte de <literal><set></literal>, existen además + los elementos de mapeo <literal><list></literal>, + <literal><map></literal>, <literal><bag></literal>, + <literal><array></literal> y <literal><primitive-array></literal>. + El elemento <literal><map></literal> es representativo: + </para> + + <programlistingco> + <areaspec> + <area id="mappingcollection1" coords="2 65"/> + <area id="mappingcollection2" coords="3 65"/> + <area id="mappingcollection3" coords="4 65"/> + <area id="mappingcollection4" coords="5 65"/> + <area id="mappingcollection5" coords="6 65"/> + <area id="mappingcollection6" coords="7 65"/> + <area id="mappingcollection7" coords="8 65"/> + <area id="mappingcollection8" coords="9 65"/> + <area id="mappingcollection9" coords="10 65"/> + <area id="mappingcollection10" coords="11 65"/> + <area id="mappingcollection11" coords="12 65"/> + <area id="mappingcollection12" coords="13 65"/> + <area id="mappingcollection13" coords="14 65"/> + </areaspec> + <programlisting><![CDATA[<map + name="propertyName" + table="table_name" + schema="schema_name" + lazy="true|false" + inverse="true|false" + cascade="all|none|save-update|delete|all-delete-orphan" + sort="unsorted|natural|comparatorClass" + order-by="column_name asc|desc" + where="arbitrary sql where condition" + fetch="join|select|subselect" + batch-size="N" + access="field|property|ClassName" + optimistic-lock="true|false" + node="element-name|." + embed-xml="true|false" +> + + <key .... /> + <map-key .... /> + <element .... /> +</map>]]></programlisting> + <calloutlist> + <callout arearefs="mappingcollection1"> + <para> + <literal>name</literal> el nombre de la propiedad de colección + </para> + </callout> + <callout arearefs="mappingcollection2"> + <para> + <literal>table</literal> (opcional - por defecto al nombre de la propiedad) + el nombre de la tabla de coleciión (no usado para asociaciones + uno-a-muchos) + </para> + </callout> + <callout arearefs="mappingcollection3"> + <para> + <literal>schema</literal> (opcional) el nombre de un esquema de tablas + para sobrescribir el esquema declarado en el elemento raíz + </para> + </callout> + <callout arearefs="mappingcollection4"> + <para> + <literal>lazy</literal> (opcional - por defecto a <literal>true</literal>) + puede ser usado para deshabilitar la recuperación perezosa y + especificar que la asociación es siempre recuperada tempranamente + (no disponible para arrays) + </para> + </callout> + <callout arearefs="mappingcollection5"> + <para> + <literal>inverse</literal> (opcional - por defecto a <literal>false</literal>) + marca esta colección como el extremo "inverso" de una asociación + bidireccional. + </para> + </callout> + <callout arearefs="mappingcollection6"> + <para> + <literal>cascade</literal> (opcional - por defecto a <literal>none</literal>) + habilita operaciones en cascada a entidades hijas + </para> + </callout> + <callout arearefs="mappingcollection7"> + <para> + <literal>sort</literal> (opcional) especifica una colección + con ordenamiento <literal>natural</literal>, o una clase comparadora + dada + </para> + </callout> + <callout arearefs="mappingcollection8"> + <para> + <literal>order-by</literal> (opcional, sólo JDK1.4) especifica una columna + de tabla (o columnas) que definen el orden de iteración del + <literal>Map</literal>, <literal>Set</literal> o bag, junto a un + <literal>asc</literal> o <literal>desc</literal> opcional. + </para> + </callout> + <callout arearefs="mappingcollection9"> + <para> + <literal>where</literal> (opcional) especifica una condición + <literal>WHERE</literal> de SQL arbitrario para ser usada al recuperar o + quitar la colección (útil si la colección debe + contener sólo un subconjunto de los datos disponibles) + </para> + </callout> + <callout arearefs="mappingcollection10"> + <para> + <literal>fetch</literal> (opcional, por defecto a <literal>select</literal>) + Elige entre recuperación por unión externa (outer-join), + recuperar por selección secuencial, y recuperación por + subselección secuencial. + </para> + </callout> + <callout arearefs="mappingcollection11"> + <para> + <literal>batch-size</literal> (opcional, por defecto a <literal>1</literal>) + especifica un "tamaño de lote" para la recuperar + perezosamente instancias de esta colección. + </para> + </callout> + <callout arearefs="mappingcollection12"> + <para> + <literal>access</literal> (opcional - por defecto a <literal>property</literal>): + La estrategia que debe usar Hibernate para acceder al valor de la + propiedad. + </para> + </callout> + <callout arearefs="mappingcollection12"> + <para> + <literal>optimistic-lock</literal> (opcional - por defecto a <literal>true</literal>): + Especifica que los cambios de estado de la colección resultan en + incrementos de versión de la entidad dueña. (Para asociaciones + uno a muchos, frecuentemente es razonable deshabilitar esta opción.) + </para> + </callout> + </calloutlist> + </programlistingco> + + <sect2 id="collections-foreignkeys" > + <title>Claves foráneas de collección</title> + + <para> + Las instancias de colección se distinguen en la base de datos por la + clave foránea de la entidad que posee la colección. Se hace + referencia a esta clave foránea como la <emphasis>columna clave de + colección</emphasis> (o columnas) de la tabla de colección. + La columna clave de la colección es mapeada por el elemento + <literal><key></literal>. + </para> + + <para> + Puede haber una restricción de nulabilidad sobre la columna de clave + foránea. Para la mayoría de colecciones, esto está implicado. + Para asociaciones unidireccionales uno a muchos, la columna de clave + foránea es nulable por defecto, de modo que podrías necesitar + especificar <literal>not-null="true"</literal>. + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" not-null="true"/>]]></programlisting> + + <para> + La restricción de clave foránea puede usar + <literal>ON DELETE CASCADE</literal>. + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" on-delete="cascade"/>]]></programlisting> + + <para> + Mira el capítulo anterior por una definición completa del + elemento <literal><key></literal>. + </para> + + </sect2> + + <sect2 id="collections-elements" > + <title>Elementos de collección</title> + + <para> + Las colecciones pueden contener casi cualquier tipo de Hibernate, incluyendo + todos los tipos básicos, componentes, y por supuesto, referencias a otras + entidades. Esta es una distinción importante: un objeto en una colección + puede ser manejado con una semántica de "valor" (su ciclo de vida depende + completamente del propietario de la colección) o podría ser una referencia + a otra entidad, con su propio ciclo de vida. En el último caso, sólo + el estado del "enlace" entre los dos objetos se considera mantenido por la + colección. + </para> + + <para> + Se hace referencia al tipo contenido como el <emphasis>tipo de elemento + de la colección</emphasis>. Los elementos de colección son + mapeados por <literal><element></literal> o + <literal><composite-element></literal>, o en el caso de referencias + de entidades, con <literal><one-to-many></literal> o + <literal><many-to-many></literal>. Las dos primeras mapean elementos + con semántica de valor, los dos siguientes son usados para mapear + asociaciones de entidades. + </para> + + </sect2> + + <sect2 id="collections-indexed"> + <title>Colecciones indexadas</title> + + <para> + Todos los mapeos de colección, excepto aquellos con semántica de + set o bag, necesitan una <emphasis>columna índice</emphasis> en la tabla + de colección, una columna que mapea a un índice de array, o + índice de <literal>List</literal>, o clave de <literal>Map</literal>. + El índice de un <literal>Map</literal> puede ser de cualquier tipo + básico, mapeado con <literal><map-key></literal>, o puede ser + una referencia de entidad, mapeada con <literal><map-key-many-to-many></literal>, + o puede ser un tipo compuesto, mapeado con <literal><composite-map-key></literal>. + El índice de un array o lista es siempre de tipo <literal>integer</literal> + y se mapea usando el elemento <literal><list-index></literal>. La columna + mapeada contiene enteros secuenciales (numerados desde cero, por defecto). + </para> + + <programlistingco> + <areaspec> + <area id="index1" coords="2 45"/> + <area id="index2" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<list-index + column="column_name" + base="0|1|..."/>]]></programlisting> + <calloutlist> + <callout arearefs="index1"> + <para> + <literal>column_name</literal> (requerido): El nombre de la columna que tiene + los valores índice de la colección. + </para> + </callout> + <callout arearefs="index1"> + <para> + <literal>base</literal> (opcional, por defecto a <literal>0</literal>): El valor + de la columna índice que corresponde al primer elemento de la lista o + array. + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="mapkey1" coords="2 45"/> + <area id="mapkey2" coords="3 45"/> + <area id="mapkey3" coords="4 45"/> + </areaspec> + <programlisting><![CDATA[<map-key + column="column_name" + formula="any SQL expression" + type="type_name" + node="@attribute-name" + length="N"/>]]></programlisting> + <calloutlist> + <callout arearefs="mapkey1"> + <para> + <literal>column</literal> (opcional): El nombre de la columna que tiene + los valores índice de la colección. + </para> + </callout> + <callout arearefs="mapkey2"> + <para> + <literal>formula</literal> (opcional): Una fórmula SQL usada para + evaluar la clave del mapa. + </para> + </callout> + <callout arearefs="mapkey3"> + <para> + <literal>type</literal> (requerido): el tipo de las claves del mapa. + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="indexmanytomany1" coords="2 45"/> + <area id="indexmanytomany2" coords="3 45"/> + <area id="indexmanytomany3" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<map-key-many-to-many + column="column_name" + formula="any SQL expression" + class="ClassName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="indexmanytomany1"> + <para> + <literal>column</literal> (opcional): El nombre de la columna clave + foránea para los valores índice de la colección. + </para> + </callout> + <callout arearefs="indexmanytomany2"> + <para> + <literal>formula</literal> (opcional): Una fórmula SQL usada para + evaluar la clave foránea de la clave del mapa. + </para> + </callout> + <callout arearefs="indexmanytomany3"> + <para> + <literal>class</literal> (requerido): La clase de entidad usada como clave del mapa. + </para> + </callout> + </calloutlist> + </programlistingco> + + + <para> + Si tu tabla no tiene una columna índice, y deseas aún usar <literal>List</literal> como + tipo de propiedad, debes mapear la propiedad como un <emphasis><bag></emphasis> + de Hibernate. Un bag (bolsa) no retiene su orden al ser recuperado de la base de datos, + pero puede ser ordenado o clasificado opcionalmente. + </para> + + </sect2> + + <para> + Hay absolutamente un rango de mapeos que pueden ser generados para colecciones, + cubriendo muchos modelos relacionales comunes. Te sugerimos que experimentes con + la herramienta de generación de esquemas para obtener una idea de cómo varias + declaraciones de mapeo se traducen a tablas de base de datos. + </para> + + <sect2 id="collections-ofvalues" revision="1"> + <title>Colecciones de valores y asociaciones muchos-a-muchos</title> + + <para> + Cualquier colección de valores o asociación muchos a muchos requiere una + <emphasis>tabla de colección</emphasis> dedicada con una columna o columnas + de clave foránea, <emphasis>columna de elemento de colección</emphasis> o + columnas y posiblemente una columna o columnas índice. + </para> + + <para> + Para una colección de valores, usamos la etiqueta <literal><element></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="element1b" coords="2 50"/> + <area id="element2b" coords="3 50"/> + <area id="element3b" coords="4 50"/> + </areaspec> + <programlisting><![CDATA[<element + column="column_name" + formula="any SQL expression" + type="typename" + length="L" + precision="P" + scale="S" + not-null="true|false" + unique="true|false" + node="element-name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="element1b"> + <para> + <literal>column</literal> (opcional): El nombre de la columna que tiene + los valores de los elementos de la colección. + </para> + </callout> + <callout arearefs="element2b"> + <para> + <literal>formula</literal> (opcional): Una fórmula SQL usada para evaluar + el elemento. + </para> + </callout> + <callout arearefs="element3b"> + <para> + <literal>type</literal> (requerido): El tipo del elemento de colección. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Una <emphasis>asociación muchos-a-muchos</emphasis> se especifica usando + el elemento <literal><many-to-many></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="manytomany1" coords="2 60"/> + <area id="manytomany2" coords="3 60"/> + <area id="manytomany3" coords="4 60"/> + <area id="manytomany4" coords="5 60"/> + <area id="manytomany5" coords="6 60"/> + <area id="manytomany6" coords="7 60"/> + <area id="manytomany7" coords="8 60"/> + </areaspec> + <programlisting><![CDATA[<many-to-many + column="column_name" + formula="any SQL expression" + class="ClassName" + fetch="select|join" + unique="true|false" + not-found="ignore|exception" + entity-name="EntityName" + node="element-name" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="manytomany1"> + <para> + <literal>column</literal> (opcional): El nombre de la columna de clave + foránea del elemento. + </para> + </callout> + <callout arearefs="manytomany2"> + <para> + <literal>formula</literal> (opcional): Una fórmula SQL opcional usada + para evaluar el valor de clave foránea del elemento. + </para> + </callout> + <callout arearefs="manytomany3"> + <para> + <literal>class</literal> (requerido): El nombre de la clase asociada. + </para> + </callout> + <callout arearefs="manytomany4"> + <para> + <literal>fetch</literal> (opcional - por defecto a <literal>join</literal>): + habilita la recuperación por unión externa o selección secuencial para esta + asociación. Este es un caso especial; para una recuperación completamente + temprana (en un solo <literal>SELECT</literal>) de una entidad y sus relaciones + muchos-a-muchos a otras entidades, deberías habilitar la recuperación + <literal>join</literal> no sólo de la colección misma, sino también con este + atributo en el elemento anidado <literal><many-to-many></literal>. + </para> + </callout> + <callout arearefs="manytomany5"> + <para> + <literal>unique</literal> (opcional): Habilita la generación DDL de una + restricción de unicidad para la columna clave foránea. Esto hace la + multiplicidad de la asociación efectivamente uno a muchos. + </para> + </callout> + <callout arearefs="manytomany6"> + <para> + <literal>not-found</literal> (opcional - por defecto a <literal>exception</literal>): + Especifica cómo serán manejadas las claves foráneas que referencian + filas perdidas: <literal>ignore</literal> tratará una fila perdida como + una asociación nula. + </para> + </callout> + <callout arearefs="manytomany7"> + <para> + <literal>entity-name</literal> (opcional): El nombre de entidad de la clase + asociada, como una alternativa a <literal>class</literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Algunos ejemplos, primero, un conjunto de cadenas: + </para> + + <programlisting><![CDATA[<set name="names" table="person_names"> + <key column="person_id"/> + <element column="person_name" type="string"/> +</set>]]></programlisting> + + <para> + Un bag conteniendo enteros (con un orden de iteración determinado por el + atributo <literal>order-by</literal>): + </para> + + <programlisting><![CDATA[<bag name="sizes" + table="item_sizes" + order-by="size asc"> + <key column="item_id"/> + <element column="size" type="integer"/> +</bag>]]></programlisting> + + <para> + Un array de entidades - en este caso, una asociación muchos a muchos: + </para> + + <programlisting><![CDATA[<array name="addresses" + table="PersonAddress" + cascade="persist"> + <key column="personId"/> + <list-index column="sortOrder"/> + <many-to-many column="addressId" class="Address"/> +</array>]]></programlisting> + + <para> + Un mapa de índices de cadenas a fechas: + </para> + + <programlisting><![CDATA[<map name="holidays" + table="holidays" + schema="dbo" + order-by="hol_name asc"> + <key column="id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + Una lista de componentes (discutidos en el próximo capítulo): + </para> + + <programlisting><![CDATA[<list name="carComponents" + table="CarComponents"> + <key column="carId"/> + <list-index column="sortOrder"/> + <composite-element class="CarComponent"> + <property name="price"/> + <property name="type"/> + <property name="serialNumber" column="serialNum"/> + </composite-element> +</list>]]></programlisting> + + </sect2> + + <sect2 id="collections-onetomany"> + <title>Asociaciones uno-a-muchos</title> + + <para> + Una <emphasis>asociación uno a muchos</emphasis> enlaza las tablas de dos clases + por medio de una clave foránea, sin intervención de tabla de colección alguna. + Este mapeo pierde cierta semántica de colecciones Java normales: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Una instancia de la clase entidad contenida no puede pertenecer + a más de una instancia de la colección. + </para> + </listitem> + <listitem> + <para> + Una instancia de la clase entidad contenida no puede aparecer en más + de un valor del índice de colección. + </para> + </listitem> + </itemizedlist> + + <para> + Una asociación de <literal>Product</literal> a <literal>Part</literal> requiere la + existencia de una columna clave foránea y posiblemente una columna índice a la tabla + <literal>Part</literal>. Una etiqueta <literal><one-to-many></literal> indica + que ésta es una asociación uno a muchos. + </para> + + <programlistingco> + <areaspec> + <area id="onetomany1" coords="2 60"/> + <area id="onetomany2" coords="3 60"/> + <area id="onetomany3" coords="4 60"/> + </areaspec> + <programlisting><![CDATA[<one-to-many + class="ClassName" + not-found="ignore|exception" + entity-name="EntityName" + node="element-name" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="onetomany1"> + <para> + <literal>class</literal> (requerido): El nombre de la clase asociada. + </para> + </callout> + <callout arearefs="onetomany2"> + <para> + <literal>not-found</literal> (opcional - por defecto a <literal>exception</literal>): + Especifica cómo serán manejados los identificadores en caché que referencien + filas perdidas: <literal>ignore</literal> tratará una fila perdida como una + asociación nula. + </para> + </callout> + <callout arearefs="onetomany3"> + <para> + <literal>entity-name</literal> (opcional): El nombre de entidad de la clase + asociada, como una alternativa a <literal>class</literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Observa que el elemento <literal><one-to-many></literal> no necesita + declarar ninguna columna. Ni es necesario especificar el nombre de <literal>table</literal> + en ningún sitio. + </para> + + <para> + <emphasis>Nota muy importante:</emphasis> Si la columna clave foránea de una asociación + <literal><one-to-many></literal> es declarada <literal>NOT NULL</literal>, debes + declarar el mapeo de <literal><key></literal> <literal>not-null="true"</literal> + o <emphasis>usar una asociación bidireccional</emphasis> con el mapeo de colección + marcado <literal>inverse="true"</literal>. Ver la discusión sobre asociaciones + bidireccionales más adelante en este capítulo. + </para> + + <para> + Este ejemplo muestra un mapa de entidades <literal>Part</literal> por nombre + (donde <literal>partName</literal> es una propiedad persistente de <literal>Part</literal>). + Observa el uso de un índice basado en fórmula. + </para> + + <programlisting><![CDATA[<map name="parts" + cascade="all"> + <key column="productId" not-null="true"/> + <map-key formula="partName"/> + <one-to-many class="Part"/> +</map>]]></programlisting> + </sect2> + + </sect1> + + <sect1 id="collections-advancedmappings"> + <title>Mapeos de colección avanzados</title> + + <sect2 id="collections-sorted" revision="2"> + <title>Colecciones ordenadas</title> + + <para> + Hibernate soporta colecciones implementando <literal>java.util.SortedMap</literal> y + <literal>java.util.SortedSet</literal>. Debes especificar un comparador en el fichero de + mapeo: + </para> + + <programlisting><![CDATA[<set name="aliases" + table="person_aliases" + sort="natural"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" sort="my.custom.HolidayComparator"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + Los valores permitidos del atributo <literal>sort</literal> son <literal>unsorted</literal>, + <literal>natural</literal> y el nombre de una clase que implemente + <literal>java.util.Comparator</literal>. + </para> + + <para> + Las colecciones ordenadas realmente se comportan como <literal>java.util.TreeSet</literal> o + <literal>java.util.TreeMap</literal>. + </para> + + <para> + Si quieres que la misma base de datos ordene los elementos de colección usa el + atributo <literal>order-by</literal> de los mapeos <literal>set</literal>, + <literal>bag</literal> o <literal>map</literal>. Esta solución está disponible sólo + bajo el JDK 1.4 o superior (está implementado usando <literal>LinkedHashSet</literal> o + <literal>LinkedHashMap</literal>). Esto realiza la ordenación en la consulta SQL, + no en memoria. + </para> + + <programlisting><![CDATA[<set name="aliases" table="person_aliases" order-by="lower(name) asc"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" order-by="hol_date, hol_name"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date type="date"/> +</map>]]></programlisting> + + <para> + Observa que el valor del atributo <literal>order-by</literal> es una ordenación SQL, no + una ordenación HQL! + </para> + + <para> + Las asociaciones pueden incluso ser ordenadas por algún criterio arbitrario en tiempo de + ejecución usando un <literal>filter()</literal> de colección. + </para> + + <programlisting><![CDATA[sortedUsers = s.createFilter( group.getUsers(), "order by this.name" ).list();]]></programlisting> + + </sect2> + + <sect2 id="collections-bidirectional" revision="1"> + <title>Asociaciones bidireccionales</title> + + <para> + Una <emphasis>asociación bidireccional</emphasis> permite la nevegación desde + ambos "extremos" de la asociación. Son soportados dos tipos de asociación + bidireccional: + + <variablelist> + <varlistentry> + <term>uno-a-muchos</term> + <listitem> + <para> + set o bag valorados en un extremo, monovaluados al otro + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>muchos-a-muchos</term> + <listitem> + <para> + set o bag valorados a ambos extremos + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + + <para> + Puedes especificar una asociación bidireccional muchos-a-muchos simplemente + mapeando dos asociaciones muchos-a-muchos a la misma tabla de base de datos + y declarando un extremo como <emphasis>inverse</emphasis> (cuál de ellos es tu + elección, pero no puede ser una colección indexada). + </para> + + <para> + He aquí un ejemplo de una asociación bidireccional muchos-a-muchos; cada categoría + puede tener muchos ítems y cada ítem puede estar en muchas categorías: + </para> + + <programlisting><![CDATA[<class name="Category"> + <id name="id" column="CATEGORY_ID"/> + ... + <bag name="items" table="CATEGORY_ITEM"> + <key column="CATEGORY_ID"/> + <many-to-many class="Item" column="ITEM_ID"/> + </bag> +</class> + +<class name="Item"> + <id name="id" column="ITEM_ID"/> + ... + +  + <bag name="categories" table="CATEGORY_ITEM" inverse="true"> + <key column="ITEM_ID"/> + <many-to-many class="Category" column="CATEGORY_ID"/> + </bag> +</class>]]></programlisting> + + <para> + Los cambios hechos sólo al extremo inverso de la asociación <emphasis>no</emphasis> + son persistidos. Esto significa que Hibernate tiene dos representaciones en memoria + para cada asociación bidireccional, una enlaza de A a B y otra enlaza de B a A. + Esto es más fácil de entender si piensas en el modelo de objetos de Java y cómo + creamos una relación muchos-a-muchos en Java: + </para> + + <programlisting><![CDATA[ +category.getItems().add(item); // The category now "knows" about the relationship +item.getCategories().add(category); // The item now "knows" about the relationship + +session.persist(item); // The relationship won't be saved! +session.persist(category); // The relationship will be saved]]></programlisting> + + <para> + El lado no-inverso se usa para salvar la representación en memoria a la base de datos. + </para> + + <para> + Puedes definir una asociación bidireccional uno-a-muchos mapeando una asociación uno-a-muchos + a la misma columna (o columnas) de tabla como una asociación muchos-a-uno y declarando el + extremo multivaluado <literal>inverse="true"</literal>. + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> +</class> + +<class name="eg.Child"> + <id name="id" column="id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + Mapear un extremo de una asociación con <literal>inverse="true"</literal> no afecta + la operación de cascadas; éstos son conceptos ortogonales! + </para> + + </sect2> + + <sect2 id="collections-indexedbidirectional"> + <title>Asociaciones bidireccionales con colecciones indexadas</title> + <para> + Requiere especial consideración una asociación bidireccional donde un extremo esté representado + como una <literal><list></literal> o <literal><map></literal>. Si hay una propiedad + de la clase hija que mapee a la columna índice, no hay problema, podemos seguir usando + <literal>inverse="true"</literal> en el mapeo de la colección: + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children" inverse="true"> + <key column="parent_id"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <property name="name" + not-null="true"/> + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + Pero, si no existe tal proiedad en la clase hija, no podemos pensar en la asociación como + verdaderamente bidireccional (hay información en un extremo de la asociación que no está + disponible en el otro extremo). En este caso, no podemos mapear la colección con + <literal>inverse="true"</literal>. En cambio, podríamos usar el siguiente mapeo: + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children"> + <key column="parent_id" + not-null="true"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + insert="false" + update="false" + not-null="true"/> +</class>]]></programlisting> + + <para> + Nota que, en este mapeo, el extremo de la asociación valuado en colección es responsable de las + actualizaciones a la clave foránea. + </para> + + </sect2> + + <sect2 id="collections-ternary"> + <title>Asociaciones ternarias</title> + + <para> + Hay tres enfoques posibles para mapear una asociación ternaria. + Una es usar un <literal>Map</literal> con una asociación como su índice: + </para> + + <programlisting><![CDATA[<map name="contracts"> + <key column="employer_id" not-null="true"/> + <map-key-many-to-many column="employee_id" class="Employee"/> + <one-to-many class="Contract"/> +</map>]]></programlisting> + + <programlisting><![CDATA[<map name="connections"> + <key column="incoming_node_id"/> + <map-key-many-to-many column="outgoing_node_id" class="Node"/> + <many-to-many column="connection_id" class="Connection"/> +</map>]]></programlisting> + + <para> + Un segundo enfoque es simplemente remodelar la asociación como una clase de entidad. + Este es el enfoque que usamos más comunmente. + </para> + + <para> + Una alternativa final es usar elementos compuestos, que discutiremos más adelante. + </para> + + </sect2> + + <sect2 id="collections-idbag" revision="1"> + <title><literal>Usando un <idbag></literal></title> + + <para> + Si has adoptado completamente nuestra visión de que las claves compuestas son una + cosa mala y que las entidades deben tener identificadores sitéticos (claves delegadas), + entonces podrías encontrar un poco raro que todas las asociaciones muchos a muchos y + las colecciones de valores que hemos mostrado hasta ahora mapeen a tablas con claves + compuestas! Ahora, este punto es discutible; una tabla de pura asociación no parece + beneficiarse demasiado de una clave delegada (aunque sí <emphasis>podría</emphasis> una + colección de valores compuestos). Sin embargo, Hibernate provee una funcionalidad que + te permite mapear asociaciones muchos a muchos y colecciones de valores a una tabla con + una clave delegada. + </para> + + <para> + El elemento <literal><idbag></literal> te permite mapear una <literal>List</literal> + (o <literal>Collection</literal>) con semántica de bag. + </para> + +<programlisting><![CDATA[<idbag name="lovers" table="LOVERS"> + <collection-id column="ID" type="long"> + <generator class="sequence"/> + </collection-id> + <key column="PERSON1"/> + <many-to-many column="PERSON2" class="Person" fetch="join"/> +</idbag>]]></programlisting> + + <para> + Como puedes ver, un <literal><idbag></literal> tiene un generador de id sintético, + igual que una clase de entidad! Una clave delegada diferente se asigna a cada fila + de la colección. Hibernate no provee ningún mecanismo para descubrir el valor de clave + delegada de una fila en particular, sin embargo. + </para> + + <para> + Observa que el rendimiento de actualización de un <literal><idbag></literal> es + <emphasis>mucho</emphasis> mejor que el de un <literal><bag></literal> regular! + Hibernate puede localizar filas individuales eficientemente y actualizarlas o borrarlas + individualmente, igual que si fuese una lista, mapa o conjunto. + </para> + + <para> + En la implementación actual, la estrategia de generación de identificador + <literal>native</literal> no está soportada para identificadores de colecciones + <literal><idbag></literal>. + </para> + + </sect2> + + </sect1> + +  + +  + + <sect1 id="collections-example" revision="1"> + <title>Ejemplos de colección</title> + + <para> + Las secciones previas son bastantes confusas. Así que miremos un ejemplo. + Esta clase: + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; + +public class Parent { + private long id; + private Set children; + + public long getId() { return id; } + private void setId(long id) { this.id=id; } + + private Set getChildren() { return children; } + private void setChildren(Set children) { this.children=children; } + + .... + .... +}]]></programlisting> + + <para> + tiene una colección de instancias de <literal>Child</literal>. + Si cada hijo tiene como mucho un padre, el mapeo más natural es + una asociación uno-a-muchos: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Esto mapea a las siguientes definiciones de tablas: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255), parent_id bigint ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + Si el padre es <emphasis>requerido</emphasis>, usa una asociación bidireccional + uno-a-muchos: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Observa la restricción <literal>NOT NULL</literal>: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null + primary key, + name varchar(255), + parent_id bigint not null ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + Alternativamente, si absolutamente insistes que esta asociación debe ser unidireccional, + puedes declarar la restricción <literal>NOT NULL</literal> en el mapeo de + <literal><key></literal>: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + En la otra mano, si un hijo pudiera tener múltiples padres, sería apropiada + una asociación muchos-a-muchos: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" table="childset"> + <key column="parent_id"/> + <many-to-many class="Child" column="child_id"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Definiciones de tabla: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255) ) +create table childset ( parent_id bigint not null, + child_id bigint not null, + primary key ( parent_id, child_id ) ) +alter table childset add constraint childsetfk0 (parent_id) references parent +alter table childset add constraint childsetfk1 (child_id) references child]]></programlisting> + + <para> + Para más ejemplos y un paseo completo a través del mapeo de relaciones padre/hijo, + ver <xref linkend="example-parentchild"/>. + </para> + + <para> + Son posibles mapeos de asociación aún más complejos. Catalogaremos todas las posibilidades + en el próximo capítulo. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/component_mapping.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/component_mapping.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/component_mapping.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/component_mapping.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,403 @@ +<chapter id="components"> + <title>Mapeo de Componentes</title> + + <para> + La noción de un <emphasis>componente</emphasis> es reusada en muchos contextos diferentes, + para propósitos diferentes, a través de Hibernate. + </para> + + <sect1 id="components-dependentobjects"> + <title>Objetos dependientes</title> + + <para> + Un componente es un objeto contenido que es persistido como un tipo de valor, no una + referencia de entidad. El término "componente" hace referencia a la noción orientada a + objetos de composición (no a componentes a nivel de arquitectura). Por ejemplo, podrías + modelar una persona como: + </para> + + <programlisting><![CDATA[public class Person { + private java.util.Date birthday; + private Name name; + private String key; + public String getKey() { + return key; + } + private void setKey(String key) { + this.key=key; + } + public java.util.Date getBirthday() { + return birthday; + } + public void setBirthday(java.util.Date birthday) { + this.birthday = birthday; + } + public Name getName() { + return name; + } + public void setName(Name name) { + this.name = name; + } + ...... + ...... +}]]></programlisting> + +<programlisting><![CDATA[public class Name { + char initial; + String first; + String last; + public String getFirst() { + return first; + } + void setFirst(String first) { + this.first = first; + } + public String getLast() { + return last; + } + void setLast(String last) { + this.last = last; + } + public char getInitial() { + return initial; + } + void setInitial(char initial) { + this.initial = initial; + } +}]]></programlisting> + + <para> + Ahora <literal>Name</literal> puede ser persistido como un componente de + <literal>Person</literal>. Observa que <literal>Name</literal> define métodos + getter y setter para sus propiedades persistentes, pero no necesita declarar + ninguna interface ni propiedades identificadoras. + </para> + + <para> + Nuestro mapeo de Hibernate se vería así: + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid.hex"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name">  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + <para> + La tabla person tendría las columnas <literal>pid</literal>, + <literal>birthday</literal>, + <literal>initial</literal>, + <literal>first</literal> y + <literal>last</literal>. + </para> + + <para> + Como todos los tipos de valor, los componentes no soportan referencias compartidas. + En otras palabras, dos personas pueden tener el mismo nombre, pero los dos objetos + persona contendrían dos objetos nombre independientes, sólo "iguales" en valor. + La semántica de valor nulo de un componente es <emphasis>ad hoc</emphasis>. + Cuando se recargue el objeto contenedor, Hibernate asumirá que si todas las columnas del + componente son nulas, el componente entero es nulo. Esto debe estar bien para la mayoría + de propósitos. + </para> + + <para> + Las propiedades de un componentes pueden ser de cualquier tipo de Hibernate + (colecciones, muchos-a-uno, asociaciones, otros componentes, etc). Los componentes + anidados <emphasis>no</emphasis> deben ser considerados un uso exótico. Hibernate está + concebido para soportar un modelo de objetos granularizado en fino. + </para> + + <para> + El elemento <literal><component></literal> permite un subelemento + <literal><parent></literal> que mapee una propiedad de la clase del componente + como una referencia de regreso a la entidad contenedora. + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid.hex"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name" unique="true"> + <parent name="namedPerson"/>  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-incollections" revision="1"> + <title>Colecciones de objetos dependientes</title> + + <para> + Las colecciones de componentes están soportadas (por ejemplo, + un array de tipo <literal>Name</literal>). Declara tu colección + de componentes remplazando la etiqueta <literal><element></literal> + por una etiqueta <literal><composite-element></literal>. + </para> + + <programlisting><![CDATA[<set name="someNames" table="some_names" lazy="true"> + <key column="id"/> + <composite-element class="eg.Name">  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </composite-element> +</set>]]></programlisting> + + <para> + Nota: si defines un <literal>Set</literal> de elementos compuestos, es muy + importante implementar <literal>equals()</literal> y <literal>hashCode()</literal> + correctamente. + </para> + + <para> + Los elementos compuestos pueden contener componentes pero no colecciones. + Si tu elemento compuesto contiene a su vez componentes, usa la etiqueta + <literal><nested-composite-element></literal>. Este es un caso bastante + exótico - una colección de componentes que a su vez tienen componentes. A esta + altura debes estar preguntándote si una asociación uno-a-muchos es más + apropiada. Intenta remodelar el elemento compuesto como una entidad - pero + observa que aunque el modelo Java es el mismo, el modelo relacional y la + semántica de persistencia siguen siendo ligeramente diferentes. + </para> + + <para> + Por favor observa que un mapeo de elemento compuesto no soporta + propiedades nulables si estás usando un <literal><set></literal>. + Hibernate tiene que usar cada columna para identificar un registro + al borrar objetos (no hay una columna clave primaria separada en la tabla del + elemento compuesto), lo que es imposible con valores nulos. Tienes que, o bien usar + sólo propiedades no nulas en un elemento compuesto o elegir un + <literal><list></literal>, <literal><map></literal>, + <literal><bag></literal> o <literal><idbag></literal>. + </para> + + <para> + Un caso especial de un elemento compuesto es un elemento compuesto con un + elemento anidado <literal><many-to-one></literal>. Un mapeo como este + te permite mapear columnas extra de una tabla de asociación muchos-a-muchos + a la clase del elemento compuesto. La siguiente es una asociación muchos-a-muchos + de <literal>Order</literal> a <literal>Item</literal> donde + <literal>purchaseDate</literal>, <literal>price</literal> y + <literal>quantity</literal> son propiedades de la asociación: + </para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.Purchase"> + <property name="purchaseDate"/> + <property name="price"/> + <property name="quantity"/> + <many-to-one name="item" class="eg.Item"/>  + </composite-element> + </set> +</class>]]></programlisting> + + <para> + Por supuesto, no puede haber una referencia a la compra del otro lado para la + navegación bidireccional de la asociación. Recuerda que los componentes son tipos de + valor no permiten referencias compartidas. Una sola <literal>Purchase</literal> puede + estar en el conjunto de una <literal>Order</literal>, pero no puede ser referenciada + por el <literal>Item</literal> al mismo tiempo. + </para> + + <para>Incluso son posibles las asociaciones ternarias (o cuaternarias, etc):</para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.OrderLine"> + <many-to-one name="purchaseDetails class="eg.Purchase"/> + <many-to-one name="item" class="eg.Item"/> + </composite-element> + </set> +</class>]]></programlisting> + + <para> + Los elementos compuestos pueden aparecer en consultas usando la misma + sintáxis que las asociaciones a otras entidades. + </para> + + </sect1> + + <sect1 id="components-asmapindex"> + <title>Componentes como índices de Map</title> + + <para> + El elemento <literal><composite-map-key></literal> te permite mapear + una clase componente como la clave de un <literal>Map</literal>. Asegúrate que + sobrescribes <literal>hashCode()</literal> y <literal>equals()</literal> + correctamente en la clase componente. + </para> + </sect1> + + <sect1 id="components-compositeid" revision="1"> + <title>Componentes como identificadores compuestos</title> + + <para> + Puedes usar un componente como un identidicador de una clase entidad. Tu clase + componente debe satisfacer ciertos requerimientos: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Debe implementar <literal>java.io.Serializable</literal>. + </para> + </listitem> + <listitem> + <para> + Debe re-implementar <literal>equals()</literal> y + <literal>hashCode()</literal>, consistentemente con la + noción de base de datos de igualdad de clave compuesta. + </para> + </listitem> + </itemizedlist> + + <para> + <emphasis>Nota: en Hibernat3, el segundo requerimiento no es absolutamente un + requerimiento rígido de Hibernate. Pero de todas formas, házlo.</emphasis> + </para> + + <para> + No puedes usar un <literal>IdentifierGenerator</literal> para generar claves + compuestas. La aplicación debe, en cambio, asignar sus propios identificadores. + </para> + + <para> + Usa la etiqueta <literal><composite-id></literal> (con elementos + anidados <literal><key-property></literal>) en lugar de la usual + declaración <literal><id></literal>. Por ejemplo, la clase + <literal>OrderLine</literal> tiene una clave primaria que depende de + la clave primaria (compuesta) de <literal>Order</literal>. + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + + <composite-id name="id" class="OrderLineId"> + <key-property name="lineId"/> + <key-property name="orderId"/> + <key-property name="customerId"/> + </composite-id> + + <property name="name"/> + + <many-to-one name="order" class="Order" + insert="false" update="false"> + <column name="orderId"/> + <column name="customerId"/> + </many-to-one> + .... + +</class>]]></programlisting> + + <para> + Ahora, cualquier clave foránea que referencie la tabla de <literal>OrderLine</literal> + es también compuesta. Debes declarar esto en tus mapeos de otras clases. Una asociación + a <literal>OrderLine</literal> sería mapeado así: + </para> + + <programlisting><![CDATA[<many-to-one name="orderLine" class="OrderLine"> + + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> +</many-to-one>]]></programlisting> + + <para> + (Nota que la etiqueta <literal><column></literal> es una alternativa al + atributo <literal>column</literal> en cualquier sitio.) + </para> + + <para> + Una asociación <literal>muchos-a-muchos</literal> a <literal>OrderLine</literal> + también usa la clave foránea compuesta: + </para> + + <programlisting><![CDATA[<set name="undeliveredOrderLines"> + <key column name="warehouseId"/> + <many-to-many class="OrderLine"> + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </many-to-many> +</set>]]></programlisting> + + <para> + La colección de <literal>OrderLine</literal>s en <literal>Order</literal> usaría: + </para> + + <programlisting><![CDATA[<set name="orderLines" inverse="true"> + <key> + <column name="orderId"/> + <column name="customerId"/> + </key> + <one-to-many class="OrderLine"/> +</set>]]></programlisting> + + <para> + (El elemento <literal><one-to-many></literal>, como es usual, no declara columnas.) + </para> + + <para> + Si <literal>OrderLine</literal> posee una colección por sí misma, tiene también + una clave foránea compuesta. + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + .... + .... + <list name="deliveryAttempts"> + <key>  + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </key> + <list-index column="attemptId" base="1"/> + <composite-element class="DeliveryAttempt"> + ... + </composite-element> + </set> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-dynamic" revision="1"> + <title>Componentes dinámicos</title> + + <para> + Puedes incluso mapear una propiedad de tipo <literal>Map</literal>: + </para> + + <programlisting><![CDATA[<dynamic-component name="userAttributes"> + <property name="foo" column="FOO" type="string"/> + <property name="bar" column="BAR" type="integer"/> + <many-to-one name="baz" class="Baz" column="BAZ_ID"/> +</dynamic-component>]]></programlisting> + + <para> + La semántica de un mapeo <literal><dynamic-component></literal> es ídentica + a la de <literal><component></literal>. La ventaja de este tipo de mapeos es + la habilidad para determinar las propiedades reales del bean en tiempo de despliegue, + sólo con editar el documento de mapeo. La manipulación del documento de mapeo en tiempo + de ejecución es también posible, usando un analizador DOM. Incluso mejor, puedes acceder + (y cambiar) el metamodelo de tiempo de configuración de Hibernate por medio del objeto + <literal>Configuration</literal>. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/configuration.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/configuration.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/configuration.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/configuration.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,1761 @@ +<chapter id="session-configuration" revision="1"> + + <title>Configuración</title> + + <para> + Debido a que Hibernate está diseñado para operar en muchos entornos + diferentes, hay un gran número de parámetros de configuración. + Afortunadamente, la mayoría tiene valores por defecto sensibles e Hibernate + se distribuye con un fichero <literal>hibernate.properties</literal> de ejemplo en + <literal>etc/</literal> que muestra las diversas opciones. Tan sólo pon el + fichero de ejemplo en tu classpath y personalízalo. + </para> + + <sect1 id="configuration-programmatic" revision="1"> + <title>Configuración programática</title> + + <para> + Una instancia de <literal>org.hibernate.cfg.Configuration</literal> + representa un conjunto entero de mapeos de los tipos Java de una aplicación + a una base de datos SQL. La <literal>Configuration</literal> es usada para + construir una <literal>SessionFactory</literal> (inmutable). Los mapeos se + compilan de varios ficheros de mapeo XML. + </para> + + <para> + Puedes obtener una instancia de <literal>Configuration</literal> instanciándola + directamente y especificando documentos de mapeo XML. Si los ficheros de mapeo + están en el classpath, usa <literal>addResource()</literal>: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addResource("Item.hbm.xml") + .addResource("Bid.hbm.xml");]]></programlisting> + + <para> + Una forma alternativa (a veces mejor) es especificar la clase mapeada, + y dejar que Hibernate encuentre el documento de mapeo por ti: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class);]]></programlisting> + + <para> + Entonces Hibernate buscará ficheros de mapeo llamados + <literal>/org/hibernate/auction/Item.hbm.xml</literal> y + <literal>/org/hibernate/auction/Bid.hbm.xml</literal> en el classpath. + Este enfoque elimina cualquier nombre de fichero en el código. + </para> + + <para> + Una <literal>Configuration</literal> también te permite especificar + propiedades de configuración: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class) + .setProperty("hibernate.dialect", "org.hibernate.dialect.MySQLInnoDBDialect") + .setProperty("hibernate.connection.datasource", "java:comp/env/jdbc/test") + .setProperty("hibernate.order_updates", "true");]]></programlisting> + + <para> + Esta no es la única forma de pasar propiedades de configuración + a Hibernate. La diversas opciones incluyen: + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + Pasar una instancia de <literal>java.util.Properties</literal> a + <literal>Configuration.setProperties()</literal>. + </para> + </listitem> + <listitem> + <para> + Colocar <literal>hibernate.properties</literal> en un directorio + raíz del classpath. + </para> + </listitem> + <listitem> + <para> + Establecer propiedades <literal>System</literal> + usando <literal>java -Dproperty=value</literal>. + </para> + </listitem> + <listitem> + <para> + Incluir elementos <literal><property></literal> + en <literal>hibernate.cfg.xml</literal> (discutido luego). + </para> + </listitem> + </orderedlist> + + <para> + <literal>hibernate.properties</literal> es el enfoque más fácil + si quieres comenzar rápido. + </para> + + <para> + La <literal>Configuration</literal> está concebida como un objeto + de tiempo de arranque, para ser descartado una vez que una + <literal>SessionFactory</literal> es creada. + </para> + + </sect1> + + <sect1 id="configuration-sessionfactory"> + <title>Obteniendo una SessionFactory</title> + + <para> + Cuando todos los mapeos han sido parseados por la <literal>Configuration</literal>, + la aplicación debe obtener una fábrica de instancias de <literal>Session</literal>. + Esta fábrica está concebida para ser compartida por todas las hebras de + aplicación: + </para> + + <programlisting><![CDATA[SessionFactory sessions = cfg.buildSessionFactory();]]></programlisting> + + <para> + Hibernate permite que tu aplicación instancie más de una + <literal>SessionFactory</literal>. Esto es útil si estás usando + más de una base de datos. + </para> + + </sect1> + + <sect1 id="configuration-hibernatejdbc" revision="1"> + <title>Conexiones JDBC</title> + + <para> + Usualmente, quieres que la <literal>SessionFactory</literal> cree y almacene + en pool conexiones JDBC para ti. Si adoptas este enfoque, abrir una <literal>Session</literal> + es tan simple como: + </para> + + <programlisting><![CDATA[Session session = sessions.openSession(); // open a new Session]]></programlisting> + + <para> + En cuanto hagas algo que requiera acceso a la base de datos, se obtendrá una + conexión JDBC del pool. + </para> + + <para> + Para que esto funcione, necesitamos pasar algunas propiedades de conexión + JDBC a Hibernate. Todos los nombres de propiedades y su semántica + están definidas en la clase <literal>org.hibernate.cfg.Environment</literal>. + Describiremos ahora las configuraciones más importantes para la conexión + JDBC. + </para> + + <para> + Hibernate obtendrá (y tendrá en pool) conexiones usando + <literal>java.sql.DriverManager</literal> si configuras las siguientes propiedades: + </para> + + <table frame="topbot"> + <title>Propiedades JDBC de Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.driver_class</literal> + </entry> + <entry> + <emphasis>clase del driver jdbc</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.url</literal> + </entry> + <entry> + <emphasis>URL de jdbc</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>usuario de base de datos</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>contraseña del usuario de base de datos</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.pool_size</literal> + </entry> + <entry> + <emphasis>número máximo de conexiones manejadas por pooling</emphasis> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + El algoritmo de pooling de conexiones propio de Hibernate es sin embargo + algo rudimentario. Está concebido para ayudarte a comenzar y + <emphasis>no está concebido para usar en un sistema de producción</emphasis> + ni siquiera para pruebas de rendimiento. Debes usar un pool de terceros para + un mejor rendimiento y estabilidad. Sólo remplaza la propiedad + <literal>hibernate.connection.pool_size</literal> con configuraciones + específicas del pool de conexiones. Esto desactivará el pool + interno de Hibernate. Por ejemplo, podrías querer usar C3P0. + </para> + + <para> + C3P0 es un pool de conexiones JDBC de código abierto distribuido + junto a Hibernate en el directorio <literal>lib</literal>. + Hibernate usará su <literal>C3P0ConnectionProvider</literal> + para pooling de conexiones si estableces propiedades <literal>hibernate.c3p0.*</literal>. + Si quieres usar Proxool refiérete al <literal>hibernate.properties</literal> + empaquetado y al sitio web de Hibernate para más información. + </para> + + <para> + Aquí hay un fichero <literal>hibernate.properties</literal> de ejemplo para C3P0: + </para> + + <programlisting id="c3p0-configuration" revision="1"><![CDATA[hibernate.connection.driver_class = org.postgresql.Driver +hibernate.connection.url = jdbc:postgresql://localhost/mydatabase +hibernate.connection.username = myuser +hibernate.connection.password = secret +hibernate.c3p0.min_size=5 +hibernate.c3p0.max_size=20 +hibernate.c3p0.timeout=1800 +hibernate.c3p0.max_statements=50 +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + Para su uso en un servidor de aplicaciones, casi siempre debes configurar + Hibernate para que obtenga conexiones de un <literal>Datasource</literal> + del servidor de aplicaciones registrado en JNDI. Necesitarás establecer + al menos una de las siguientes propiedades: + </para> + + <table frame="topbot"> + <title>Propiedades de Datasource de Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.datasource</literal> + </entry> + <entry> + <emphasis>nombre del datasource JNDI</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.url</literal> + </entry> + <entry> + <emphasis>URL del provedor JNDI</emphasis> (optional) + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.class</literal> + </entry> + <entry> + <emphasis>clase de la <literal>InitialContextFactory</literal> de JNDI</emphasis> (opcional) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>usuario de base de datos</emphasis> (opcional) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>contraseña del usuario de base de datos</emphasis> (opcional) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + He aquí un fichero <literal>hibernate.properties</literal> de ejemplo + para un un datasource JNDI provisto por un servidor de aplicaciones. + </para> + + <programlisting><![CDATA[hibernate.connection.datasource = java:/comp/env/jdbc/test +hibernate.transaction.factory_class = \ + org.hibernate.transaction.JTATransactionFactory +hibernate.transaction.manager_lookup_class = \ + org.hibernate.transaction.JBossTransactionManagerLookup +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + Las conexiones JDBC obtenidas de un datasource JNDI participarán automáticamente + en las transacciones del servidor de aplicaciones manejadas por contenedor. + </para> + + <para> + Pueden darse propiedades de conexión arbitrarias anteponiendo + "<literal>hibernate.connnection</literal>" al nombre de propiedad. + Por ejemplo, puedes especificar un <literal>charSet</literal> usando + <literal>hibernate.connection.charSet</literal>. + </para> + + <para> + Puedes definir tu propia estrategia de plugin para obtener conexiones JDBC implementando + la interface <literal>org.hibernate.connection.ConnectionProvider</literal>. Puedes + seleccionar una implementación personalizada estableciendo + <literal>hibernate.connection.provider_class</literal>. + </para> + + </sect1> + + <sect1 id="configuration-optional" revision="1"> + <title>Parámetros de configuración opcionales</title> + + <para> + Hay un número de otras propiedades que controlan el comportamiento + de Hibernate en tiempo de ejecución. Todas son opcionales y tienen + valores por defecto razonables. + </para> + + <para> + <emphasis>Advertencia: algunas de estas propiedades son de "nivel-de-sistema" + solamente.</emphasis>. Las propiedades a nivel de sistema sólo pueden ser + establecidas por medio de <literal>java -Dproperty=value</literal> o + <literal>hibernate.properties</literal>. <emphasis>No</emphasis> pueden + establecerse por medio de las otras técnicas arriba descritas. + </para> + + <table frame="topbot" id="configuration-optional-properties" revision="8"> + <title>Propiedades de Configuración de Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.dialect</literal> + </entry> + <entry> + El nombre de clase de un <literal>Dialect</literal> + de Hibernate que permite a Hibernate generar SQL optimizado + para una base de datos relacional en particular. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>full.classname.of.Dialect</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.show_sql</literal> + </entry> + <entry> + Escribe todas las sentencias SQL a la consola. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_schema</literal> + </entry> + <entry> + Cualifica, en el SQL generado, los nombres de tabla sin cualificar + con el esquema/tablespace dado. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>SCHEMA_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_catalog</literal> + </entry> + <entry> + Cualifica, en el SQL generado, los nombres de tabla sin cualificar + con el catálogo dado. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>CATALOG_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.session_factory_name</literal> + </entry> + <entry> + La <literal>SessionFactory</literal> será + ligada a este nombre en JNDI automáticamente + después de ser creada. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>jndi/composite/name</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.max_fetch_depth</literal> + </entry> + <entry> + Establece una "profundidad" máxima del + árbol de recuperación por outer join + para asociaciones de un extremo solo (uno-a-uno, muchos-a-uno). + Un <literal>0</literal> deshabilita la recuperación + por outer join por defecto. + <para> + <emphasis role="strong">ej.</emphasis> + valores recomendados entre <literal>0</literal> y + <literal>3</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_batch_fetch_size</literal> + </entry> + <entry> + Establece un tamaño por defecto para la recuperación + en lote de asociaciones de Hibernate. + <para> + <emphasis role="strong">ej.</emphasis> + valores recomendados <literal>4</literal>, <literal>8</literal>, + <literal>16</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_entity_mode</literal> + </entry> + <entry> + Establece un modo por defecto de representación de + entidades para todas las sesiones abiertas por esta + <literal>SessionFactory</literal> + <para> + <literal>dynamic-map</literal>, <literal>dom4j</literal>, + <literal>pojo</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.order_updates</literal> + </entry> + <entry> + Fuerza a Hibernate a ordenar las actualizaciones SQL + por el valor de la clave primaria de los items a actualizar. + Esto resultará en menos bloqueos muertos de transacción + en sistemas altamente concurrentes. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.generate_statistics</literal> + </entry> + <entry> + De habilitarse, Hibernate colectará estadísticas + útiles para la afinación de rendimiento. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_identifer_rollback</literal> + </entry> + <entry> + De habilitarse, las propiedades identificadoras + generadas serán reseteadas a valores por + defecto cuando los objetos sean borrados. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_sql_comments</literal> + </entry> + <entry> + De activarse, Hibernate generará comentarios dentro del SQL, + para una más fácil depuración, por defecto a + <literal>false</literal>. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-jdbc-properties" revision="8"> + <title>Propiedades de JDBC y Conexiones de Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propoósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.jdbc.fetch_size</literal> + </entry> + <entry> + Un valor distinto de cero que determina el tamaño + de recuperación de JDBC (llama a + <literal>Statement.setFetchSize()</literal>). + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_size</literal> + </entry> + <entry> + Un valor distinto de cero habilita el uso de actualizaciones + en lote de JDBC2 por Hibernate. + <para> + <emphasis role="strong">ej.</emphasis> + valores recomendados entre <literal>5</literal> y <literal>30</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_versioned_data</literal> + </entry> + <entry> + Establece esta propiedad a <literal>true</literal> si tu driver JDBC + devuelve cuentas correctas de filas desde <literal>executeBatch()</literal> + (usualmente es seguro activar esta opción). Hibernate usará + DML en lote para versionar automáticamente los datos. + Por defecto a <literal>false</literal>. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.factory_class</literal> + </entry> + <entry> + Selecciona un <literal>Batcher</literal> personalizado. + La mayoría de las aplicaciones no necesitarán + esta propiedad de configuración. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>classname.of.BatcherFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_scrollable_resultset</literal> + </entry> + <entry> + Habilita el uso de resultados scrollables de JDBC2 por Hibernate. + Esta propiedad sólo es necesaria cuando se usan conexiones + JDBC provistas por el usuario, en caso contrario Hibernate usa los + metadatos de conexión. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_streams_for_binary</literal> + </entry> + <entry> + Usa flujos (streams) al escribir/leer tipos + <literal>binary</literal> o <literal>serializable</literal> + a/desde JDBC (propiedad a nivel de sistema). + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_get_generated_keys</literal> + </entry> + <entry> + Habilita el uso de <literal>PreparedStatement.getGeneratedKeys()</literal> + de JDBC3 para traer claves generadas nativamente después de insertar. + Requiere un driver JDBC3+ y un JRE1.4+. Establécela a false si tu + driver tiene problemas con los generadores de identificador de Hibernate. + Por defecto, se intenta determinar las capacidades del driver usando los + metadatos de conexión. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.provider_class</literal> + </entry> + <entry> + EL nombre de clase de un <literal>ConnectionProvider</literal> personalizado + que provea conexiones JDBC a Hibernate. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>classname.of.ConnectionProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.isolation</literal> + </entry> + <entry> + Establece el nivel de aislamiento de transacción JDBC. + Comprueba <literal>java.sql.Connection</literal> para valores + significativos pero observa que la mayoría de las bases de + datos no soportan todos los niveles de aislamiento. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>1, 2, 4, 8</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.autocommit</literal> + </entry> + <entry> + Habilita compromiso automático (autocommit) para + las conexiones JDBC en pool (no recomendado). + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.release_mode</literal> + </entry> + <entry> + Especifica cuándo Hibernate debe liberar las conexiones JDBC. + Por defecto, una conexión JDBC es retenida hasta que la sesión + es cerrada explícitamente o desconectada. Para un datasource JTA + del servidor de aplicaciones, debes usar <literal>after_statement</literal> + para liberar agresivamente las conexiones después de cada llamada + JDBC. Para una conexión no JTA, frecuentemente tiene sentido liberar + la conexión al final de cada transacción, usando + <literal>after_transaction</literal>. <literal>auto</literal> eligirá + <literal>after_statement</literal> para las estrategias JTA o CMT + de transacción y <literal>after_transaction</literal> para la + estrategia JDBC de transacción. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>on_close</literal> (por defecto)| <literal>after_transaction</literal> | + <literal>after_statement</literal> | <literal>auto</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.<emphasis><propertyName></emphasis></literal> + </entry> + <entry> + Pasa la propiedad JDBC <literal>propertyName</literal> + a <literal>DriverManager.getConnection()</literal>. + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.<emphasis><propertyName></emphasis></literal> + </entry> + <entry> + Pasa la propiedad <literal>propertyName</literal> + a <literal>InitialContextFactory</literal> de JNDI. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-cache-properties" revision="7"> + <title>Propiedades de Caché de Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.cache.provider_class</literal> + </entry> + <entry> + El nombre de clase de un <literal>CacheProvider</literal> personalizado. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>classname.of.CacheProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_minimal_puts</literal> + </entry> + <entry> + Optimiza la operación del caché de segundo nivel + para minimizar escrituras, al costo de lecturas más frecuentes. + Esto es más útil para cachés en cluster y, + en Hibernate3, está habilitado por defecto para implementaciones + de caché en cluster. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_query_cache</literal> + </entry> + <entry> + Habilita el caché de lectura, consultas individuales todavía + tienen que ponerse cachables. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_second_level_cache</literal> + </entry> + <entry> + Puede ser usado para deshabilitar completamente el caché + de segundo nivel, que está habilitado por defecto para clases + que especifican un mapeo <literal><cache></literal>. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.query_cache_factory</literal> + </entry> + <entry> + El nombre de clase de una interface <literal>QueryCache</literal> + personalizada, por defecto al <literal>StandardQueryCache</literal> + prefabricado. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>classname.of.QueryCache</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.region_prefix</literal> + </entry> + <entry> + Un prefijo a usar para los nombres de región + del caché de segundo nivel. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>prefix</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_structured_entries</literal> + </entry> + <entry> + Fuerza a Hibernate a almacenar los datos en el caché + de segundo nivel en un formato más amigable al humano. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-transaction-properties" revision="8"> + <title>Propiedades de Transacción de Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.transaction.factory_class</literal> + </entry> + <entry> + El nombre de clase de un <literal>TransactionFactory</literal> + a usar con la API de <literal>Transaction</literal> de Hibernate + (por defectoa <literal>JDBCTransactionFactory</literal>). + <para> + <emphasis role="strong">ej.</emphasis> + <literal>classname.of.TransactionFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>jta.UserTransaction</literal> + </entry> + <entry> + Un nombre JNDI usado por <literal>JTATransactionFactory</literal> para + obtener la <literal>UserTransaction</literal> JTA del servidor + de aplicaciones. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>jndi/composite/name</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.manager_lookup_class</literal> + </entry> + <entry> + El nombre de clase de un <literal>TransactionManagerLookup</literal> + requerido cuando el chaché a nivel de JVM está + habilitado o cuando se usa un generador alto/bajo en un + entorno JTA. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>classname.of.TransactionManagerLookup</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.flush_before_completion</literal> + </entry> + <entry> + De habilitarse, la sesión se limpiará (flushed) + automáticamente durante la fase previa a la compleción + de la transacción. (Muy útil cuando se usa Hibernate + con CMT). + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.auto_close_session</literal> + </entry> + <entry> + De habilitarse, la sesión será cerrada automáticamente + durante la fase posterior a la compleción de la transacción. + (Muy útil cuando se usa Hibernate con CMT). + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-misc-properties" revision="7"> + <title>Propiedades Misceláneas</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nombre de propiedad</entry> + <entry>Propósito</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.query.factory_class</literal> + </entry> + <entry> + Elige la implementación de parser HQL. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>org.hibernate.hql.ast.ASTQueryTranslatorFactory</literal> or + <literal>org.hibernate.hql.classic.ClassicQueryTranslatorFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.substitutions</literal> + </entry> + <entry> + Mapeos de símbolos en consultas Hibernate a + símbolos SQL. (los símbolos puedem ser + nombres de función o literales, por ejemplo). + <para> + <emphasis role="strong">ej.</emphasis> + <literal>hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.hbm2ddl.auto</literal> + </entry> + <entry> + Exporta automáticamente DDL de esquema cuando + al crear la <literal>SessionFactory</literal>. + Con <literal>create-drop</literal>, el esquema de + base de datos será desechado cuando la + <literal>SessionFactory</literal> se cierre explícitamente. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>update</literal> | <literal>create</literal> | <literal>create-drop</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cglib.use_reflection_optimizer</literal> + </entry> + <entry> + Habilita el uso de CGLIB en vez de refleccón en tiempo de + ejecución (propiedad a nivel de sistema). La reflección + a veces puede ser útil ante la aparición de problemas. + Observa que Hibernate siempre requiere CGLIB incluso si desactivas + el optimizador. No puedes establecer esta propiedad en + <literal>hibernate.cfg.xml</literal>. + <para> + <emphasis role="strong">ej.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="configuration-optional-dialects" revision="1"> + <title>SQL Dialects</title> + + <para> + You should always set the <literal>hibernate.dialect</literal> property to the correct + <literal>org.hibernate.dialect.Dialect</literal> subclass for your database. If you + specify a dialect, Hibernate will use sensible defaults for some of the + other properties listed above, saving you the effort of specifying them manually. + </para> + + <table frame="topbot" id="sql-dialects" revision="2"> + <title>Dialectos SQL de Hibernate(<literal>hibernate.dialect</literal>)</title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>RDBMS</entry> + <entry>Dialecto</entry> + </row> + </thead> + <tbody> + <row> + <entry>DB2</entry> <entry><literal>org.hibernate.dialect.DB2Dialect</literal></entry> + </row> + <row> + <entry>DB2 AS/400</entry> <entry><literal>org.hibernate.dialect.DB2400Dialect</literal></entry> + </row> + <row> + <entry>DB2 OS390</entry> <entry><literal>org.hibernate.dialect.DB2390Dialect</literal></entry> + </row> + <row> + <entry>PostgreSQL</entry> <entry><literal>org.hibernate.dialect.PostgreSQLDialect</literal></entry> + </row> + <row> + <entry>MySQL</entry> <entry><literal>org.hibernate.dialect.MySQLDialect</literal></entry> + </row> + <row> + <entry>MySQL con InnoDB</entry> <entry><literal>org.hibernate.dialect.MySQLInnoDBDialect</literal></entry> + </row> + <row> + <entry>MySQL con MyISAM</entry> <entry><literal>org.hibernate.dialect.MySQLMyISAMDialect</literal></entry> + </row> + <row> + <entry>Oracle (cualquier versión)</entry> <entry><literal>org.hibernate.dialect.OracleDialect</literal></entry> + </row> + <row> + <entry>Oracle 9i/10g</entry> <entry><literal>org.hibernate.dialect.Oracle9Dialect</literal></entry> + </row> + <row> + <entry>Sybase</entry> <entry><literal>org.hibernate.dialect.SybaseDialect</literal></entry> + </row> + <row> + <entry>Sybase Anywhere</entry> <entry><literal>org.hibernate.dialect.SybaseAnywhereDialect</literal></entry> + </row> + <row> + <entry>Microsoft SQL Server</entry> <entry><literal>org.hibernate.dialect.SQLServerDialect</literal></entry> + </row> + <row> + <entry>SAP DB</entry> <entry><literal>org.hibernate.dialect.SAPDBDialect</literal></entry> + </row> + <row> + <entry>Informix</entry> <entry><literal>org.hibernate.dialect.InformixDialect</literal></entry> + </row> + <row> + <entry>HypersonicSQL</entry> <entry><literal>org.hibernate.dialect.HSQLDialect</literal></entry> + </row> + <row> + <entry>Ingres</entry> <entry><literal>org.hibernate.dialect.IngresDialect</literal></entry> + </row> + <row> + <entry>Progress</entry> <entry><literal>org.hibernate.dialect.ProgressDialect</literal></entry> + </row> + <row> + <entry>Mckoi SQL</entry> <entry><literal>org.hibernate.dialect.MckoiDialect</literal></entry> + </row> + <row> + <entry>Interbase</entry> <entry><literal>org.hibernate.dialect.InterbaseDialect</literal></entry> + </row> + <row> + <entry>Pointbase</entry> <entry><literal>org.hibernate.dialect.PointbaseDialect</literal></entry> + </row> + <row> + <entry>FrontBase</entry> <entry><literal>org.hibernate.dialect.FrontbaseDialect</literal></entry> + </row> + <row> + <entry>Firebird</entry> <entry><literal>org.hibernate.dialect.FirebirdDialect</literal></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-outerjoin" revision="4"> + <title>Recuperación por Unión Externa (Outer Join Fetching)</title> + + <para> + Si tu base de datos soporta uniones externas del estilo ANSI, Oracle o Sybase, la + <emphasis>recuperación por unión externa</emphasis> aumentará + frecuentemente el rendimiento limitando el número de llamadas a la base de datos + (al costo de más trabajo posiblemente realizado por la base de datos misma). + La recuperación por unión externa permite que un grafo completo de objetos + conectados por asociaciones muchos-a-uno, uno-a-muchos, muchos-a-muchos y uno-a-uno sea + traído en una sola <literal>SELECT</literal> SQL. + </para> + + <para> + La recuperación por unión externa puede ser deshabilitada + <emphasis>globalmente</emphasis> estableciendo la propiedad + <literal>hibernate.max_fetch_depth</literal> a <literal>0</literal>. + Un valor de <literal>1</literal> o mayor habilita la recuperación + por unión externa para asociaciones uno-a-uno y muchos-a-uno que + hayan sido mapeadas con <literal>fetch="join"</literal>. + </para> + + <para> + Ver <xref linkend="performance-fetching"/> para más información. + </para> + + </sect2> + + <sect2 id="configuration-optional-binarystreams" revision="1"> + <title>Flujos Binarios</title> + + <para> + Oracle limita el tamaño de arrays de <literal>byte</literal> + que puedan ser pasados a/desde su driver JDBC. Si deseas usar instancias + grandes de tipo <literal>binary</literal> o <literal>serializable</literal>, + debes habilitar <literal>hibernate.jdbc.use_streams_for_binary</literal>. + <emphasis>Esta es una propiedad a nivel de sistema solamente.</emphasis> + </para> + + </sect2> + + <sect2 id="configuration-optional-cacheprovider" revision="2"> + <title>Caché de segundo nivel y de lectura</title> + + <para> + Las propiedades prefijadas por <literal>hibernate.cache</literal> + te permiten usar un sistema de caché de segundo nivel + en el ámbito de un proceso o cluster con Hibernate. + Ver <xref linkend="performance-cache"/> para más detalles. + </para> + + </sect2> + + <sect2 id="configuration-optional-querysubstitution"> + <title>Sustitución de Lenguaje de Consulta</title> + + <para> + Puedes definir nuevos símbolos de consulta de Hibernate usando + <literal>hibernate.query.substitutions</literal>. Por ejemplo: + </para> + + <programlisting>hibernate.query.substitutions true=1, false=0</programlisting> + + <para> + causaría que los símbolos <literal>true</literal> y <literal>false</literal> sean + traducidos a literales enteros en el SQL generado. + </para> + + <programlisting>hibernate.query.substitutions toLowercase=LOWER</programlisting> + + <para> + te permitiría renombrar la función <literal>LOWER</literal> de SQL. + </para> + + </sect2> + + <sect2 id="configuration-optional-statistics" revision="2"> + <title>Hibernate statistics</title> + + <para> + Si habilitas <literal>hibernate.generate_statistics</literal>, Hibernate + expondrá un número de métricas que son útiles + al afinar un sistema en ejecución vía + <literal>SessionFactory.getStatistics()</literal>. Hibernate puede incluso ser + configurado para exponer estas estadísticas vía JMX. Lee el + Javadoc de las interfaces en <literal>org.hibernate.stats</literal> + para más información. + </para> + + </sect2> + </sect1> + + <sect1 id="configuration-logging"> + <title>Registros de mensajes (Logging)</title> + + <para> + Hibernate registra varios eventos usando commons-logging + de Apache. + </para> + + <para> + El servicio de commons-logging saldrá directamente ya sea a + Log4J (si incluyes <literal>log4j.jar</literal> in your classpath) o + JDK1.4 logging (al ejecutar bajo JDK1.4 o superior). Puedes descargar + Log4J desde <literal>http://logging.apache.org</literal>. Para usar + Log4J necesitarás colocar un fichero <literal>log4j.properties</literal> + en tu classpath. Un fichero de propiedades de ejemplo se distribuye con + Hibernate en el directorio <literal>src/</literal>. + </para> + + <para> + Recomendamos fuertemente que te familiarices con los registros de mensajes + de Hibernate. Se ha puesto un gran trabajo en hacer los registros de Hibernate + tan detallados como se puede, sin hacerlos ilegibles. Es un dispositivo esencial + en la resolución de problemas. Las categorías de registro + más interesantes son las siguientes: + </para> + + <table frame="topbot" id="log-categories" revision="2"> + <title>Categorías de Registro de Hibernate</title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>Categoría</entry> + <entry>Función</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.SQL</literal></entry> + <entry>Registra todas las sentencias DML de SQL a + medida que se ejecutan</entry> + </row> + <row> + <entry><literal>org.hibernate.type</literal></entry> + <entry>Registra todos los parámetros JDBC</entry> + </row> + <row> + <entry><literal>org.hibernate.tool.hbm2ddl</literal></entry> + <entry>Registra todas las sentencias DDL de SQL a + medida que se ejecutan</entry> + </row> + <row> + <entry><literal>org.hibernate.pretty</literal></entry> + <entry> + Registra el estado de todas las entidades (máximo + de 20 entidades) asociadas con la sesión en tiempo + de limpieza (flush) + </entry> + </row> + <row> + <entry><literal>org.hibernate.cache</literal></entry> + <entry>Registra toda la actividad del caché de segundo nivel</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction</literal></entry> + <entry>Registra la actividad relacionada con la transacción</entry> + </row> + <row> + <entry><literal>org.hibernate.jdbc</literal></entry> + <entry>Registra toda adquisición de recursos JDBC</entry> + </row> + <row> + <entry><literal>org.hibernate.hql.ast</literal></entry> + <entry>Regista los ASTs de HQL y SQL, así como + otra información sobre análisis de consultas.</entry> + </row> + <row> + <entry><literal>org.hibernate.secure</literal></entry> + <entry>Registra todas las peticiones de autorización JAAS</entry> + </row> + <row> + <entry><literal>org.hibernate</literal></entry> + <entry> + Registra todo (mucha información, pero muy útil + para la resolución de problemas) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Al desarrollar aplicacinoes con Hibernate, casi siempre debes trabajar con + <literal>debug</literal> habilitado para la categoría <literal>org.hibernate.SQL</literal> + o, alternativamente, la propiedad <literal>hibernate.show_sql</literal> habilitada. + </para> + + + </sect1> + + <sect1 id="configuration-namingstrategy"> + <title>Implementando una <literal>NamingStrategy</literal></title> + + <para> + La interface <literal>org.hibernate.cfg.NamingStrategy</literal> te permite + especificar un "estándar de nombrado" para objetos de la base de datos + y elementos de esquema. + </para> + + <para> + Puedes proveer reglas para generar automáticamente identificadores de + base de datos a partir de identificadores JDBC o para procesar nombres + "lógicos" de columnas y tablas dados en el fichero de mapeo en nombres + "físicos" de columnas y tablas. Esta funcionalidad ayuda a reducir + la verborragia del documento de mapeo, eliminando ruido repetitivo + (prefijos <literal>TBL_</literal>, por ejemplo). La estrategia por defecto + usada por Hibernate mínima en absoluto. + </para> + + <para> + Puedes especificar una estrategia diferente llamando a + <literal>Configuration.setNamingStrategy()</literal> antes de agregar los mapeos: + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .setNamingStrategy(ImprovedNamingStrategy.INSTANCE) + .addFile("Item.hbm.xml") + .addFile("Bid.hbm.xml") + .buildSessionFactory();]]></programlisting> + + <para> + <literal>org.hibernate.cfg.ImprovedNamingStrategy</literal> + es una estrategia prefabricada que puede ser un punto de + partida útil para algunas aplicaciones. + </para> + + </sect1> + + <sect1 id="configuration-xmlconfig" revision="2"> + <title>Fichero de configuración XML</title> + + <para> + Un enfoque alternativo de configuración es especificar una + configuración completa en un fichero llamado <literal>hibernate.cfg.xml</literal>. + Este fichero puede ser usado como un remplazo del fichero <literal>hibernate.properties</literal> o, + si ambos están presentes, para sobrescribir propiedades. + </para> + + <para> + El fichero de configuración XML se espera por defecto en la + raíz o tu <literal>CLASSPATH</literal>. He aquí un ejemplo: + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + +  + <session-factory + name="java:hibernate/SessionFactory"> + +  + <property name="connection.datasource">java:/comp/env/jdbc/MyDB</property> + <property name="dialect">org.hibernate.dialect.MySQLDialect</property> + <property name="show_sql">false</property> + <property name="transaction.factory_class"> + org.hibernate.transaction.JTATransactionFactory + </property> + <property name="jta.UserTransaction">java:comp/UserTransaction</property> + +  + <mapping resource="org/hibernate/auction/Item.hbm.xml"/> + <mapping resource="org/hibernate/auction/Bid.hbm.xml"/> + +  + <class-cache class="org.hibernate.auction.Item" usage="read-write"/> + <class-cache class="org.hibernate.auction.Bid" usage="read-only"/> + <collection-cache collection="org.hibernate.auction.Item.bids" usage="read-write"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + Como puedes ver, la ventaja de este enfoque es la externalización de los + nombres de los fichero de mapeo a configuración. El + <literal>hibernate.cfg.xml</literal> es también más conveniente + una vez que hayas afinado el caché de Hibernate. Observa que elección + tuya usar ya sea <literal>hibernate.properties</literal> o + <literal>hibernate.cfg.xml</literal>, ambos son equivalentes, excepto por los + beneficios de usar la sintaxis XML arriba mencionados. + </para> + + <para> + Con la configuración XML, arrancar Hibernate es tan simple como + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration().configure().buildSessionFactory();]]></programlisting> + + <para> + Puedes tomar un fichero XML diferente usando + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .configure("catdb.cfg.xml") + .buildSessionFactory();]]></programlisting> + + </sect1> + + <sect1 id="configuration-j2ee" revision="1"> + <title>Integració con Servidores de Aplicaciones J2EE</title> + + <para> + Hibernate tiene los siguientes puntos de integración con la + infraestructura J2EE: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Datasources manejados por contenedor</emphasis>: Hibernate puede usar + conexiones JDBC manejadas por el contenedor y provistas a través de JNDI. + Usualmente, un <literal>TransactionManager</literal> compatible con JTA y un + <literal>ResourceManager</literal> cuidan del manejo de transacciones (CMT), + esp. manejo de transacciones distribuídas a través de varios + datasources. Puedes también, por supuesto, demarcar los límites + de las transacciones programáticamente (BMT) o podrías querer usar + para esto la API opcional de <literal>Transaction</literal> de Hibernate para + mantener tu código portable. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>Ligamento Automático JNDI</emphasis>: Hibernate puede ligar sus + <literal>SessionFactory</literal> a JNDI después del arranque. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>Ligamento de Sesión JTA:</emphasis> + La <literal>Session</literal> de Hibernate puede ser ligada automáticamente + al ámbito de transacciones JTA si usas EJBs. Simplemente busca la + <literal>SessionFactory</literal> de JNDI y obtén la <literal>Session</literal> + actual. Deja que Hibernate cuide de limpiar y cerrar la <literal>Session</literal> + cuando se complete tu transacción JTA. La demarcación de transacción + es declarativa, en descriptores de despliegue de EJB. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>Despliegue JMX:</emphasis> Si tienes un servidor de aplicaciones capaz + de JMX (por ejemplo, JBoss AS), puedes optar por desplegar Hibernate como un MBean + manejado. Esto te ahorra el código de una línea de arranque para + construir tu <literal>SessionFactory</literal> desde una <literal>Configuration</literal>. + El contenedor arrancará tu <literal>HibernateService</literal>, e idealmente también + cuidará de las dependencias entre servicios (El datasource debe estar + disponible antes que arranque Hibernate, etc). + </para> + </listitem> + </itemizedlist> + + <para> + Dependiendo de tu entorno, podrías tener que establecer la opción + de configuración <literal>hibernate.connection.aggressive_release</literal> + a true si tu servidor de aplicaciones muestra excepciones "connection containment". + </para> + + <sect2 id="configuration-optional-transactionstrategy" revision="3"> + <title>Configuración de la estrategia de transacción</title> + + <para> + La API de <literal>Session</literal> de Hibernate es independiente de cualquier + demarcación de transacción en tu arquitectura. Si dejas que Hibernate + use JDBC directamente, a través de un pool de conexiones. puedes comenzar y + acabar tus transacciones llamando la API de JDBC. Si ejecutas en un servidor de + aplicaciones J2EE, podréas querer usar transacciones manejadas por bean y + llamar la API de JTA y <literal>UserTransaction</literal> cuando sea necesario. + </para> + + <para> + Para mantener tu código portable entre estos dos (y otros) entornos recomendamos la API + de <literal>Transaction</literal> de Hibernate, que envuelve y oculta el sistema subyacente. + Tienes que especificar una clase fábrica para las instancias de <literal>Transaction</literal> + estableciendo la propiedad de configuración <literal>hibernate.transaction.factory_class</literal> + de Hibernate. + </para> + + <para> + Hay tres elecciones estándar (prefabricadas): + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term><literal>org.hibernate.transaction.JDBCTransactionFactory</literal></term> + <listitem> + <para>delega a transacciones de base de datos (JDBC) (por defecto)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.JTATransactionFactory</literal></term> + <listitem> + <para> + delega a transacciones manejadas por contenedor si una transacción + existente estó por debajo en este contexto (ej. método de un + bean de sesión EJB), en otro caso una nueva transacción es + comenzada y se usan transacciones manejadas por bean. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.CMTTransactionFactory</literal></term> + <listitem> + <para>delega a transacciones JTA manejadas por contenedor</para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Puedes definir también tus propias estrategias de transacción + (para un servicio de transacción CORBA, por ejemplo). + </para> + + <para> + Algunas funcionalidades en Hibernate (ej, el caché de segundo nivel, ligamento + automático de JTA y Session, etc.) requieren acceso al <literal>TransactionManager</literal> + de JTA en un entorno manejado. En un servidor de aplicaciones tienes que especificar + cómo Hibernate debe obtener una referencia al <literal>TransactionManager</literal>, + pues J2EE no estandariza un solo mecanismo: + </para> + + <table frame="topbot" id="jtamanagerlookup" revision="1"> + <title>TransactionManagers de JTA</title> + <tgroup cols="2"> + <colspec colwidth="2.5*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry>Transaction Factory</entry> + <entry align="center">Servidor de Aplicaciones</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.transaction.JBossTransactionManagerLookup</literal></entry> + <entry align="center">JBoss</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WeblogicTransactionManagerLookup</literal></entry> + <entry align="center">Weblogic</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereTransactionManagerLookup</literal></entry> + <entry align="center">WebSphere</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereExtendedJTATransactionLookup</literal></entry> + <entry align="center">WebSphere 6</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.OrionTransactionManagerLookup</literal></entry> + <entry align="center">Orion</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.ResinTransactionManagerLookup</literal></entry> + <entry align="center">Resin</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOTMTransactionManagerLookup</literal></entry> + <entry align="center">JOTM</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOnASTransactionManagerLookup</literal></entry> + <entry align="center">JOnAS</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JRun4TransactionManagerLookup</literal></entry> + <entry align="center">JRun4</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.BESTransactionManagerLookup</literal></entry> + <entry align="center">Borland ES</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-jndi" revision="2"> + <title><literal>SessionFactory</literal> ligada a JNDI</title> + + <para> + Una <literal>SessionFactory</literal> de Hibernate ligada a JNDI puede simplificar + la obtención de la fábrica y la creación de nuevas + <literal>Session</literal>s. Observa que esto no está relacionado a un + <literal>Datasource</literal> ligado a JNDI, simplemente ambos usan el mismo + registro! + </para> + + <para> + Si deseas tener la <literal>SessionFactory</literal> ligada a un espacio de nombres de JNDI, + especifica un nombre (ej. <literal>java:hibernate/SessionFactory</literal>) usando la + propiedad <literal>hibernate.session_factory_name</literal>. Si esta propiedad es omitida, + la <literal>SessionFactory</literal> no será ligada a JNDI (Esto es especialmente + útil en entornos con una implementació JNDI de sólo lectura por defecto, + ej. Tomcat.) + </para> + + <para> + Al ligar la <literal>SessionFactory</literal> a JNDI, Hibernate usará los valores de + <literal>hibernate.jndi.url</literal>, <literal>hibernate.jndi.class</literal> para instanciar + un contexto inicial. Si étos no se especifican, se usará el + <literal>InitialContext</literal> por defecto. + </para> + + <para> + Hibernate colocará automáticamente la <literal>SessionFactory</literal> + en JNDI después que llames a <literal>cfg.buildSessionFactory()</literal>. + Esto significa que tendrás al menos esta llamada en algún código + de arranque (o clase de utilidad) en tu aplicación, a menos qie uses el despliegue + JMX con el <literal>HibernateService</literal> (discutido luego). + </para> + + <para> + Si usas una <literal>SessionFactory</literal> de JNDI, un EJB o cualquier otra + clase puede obtener la <literal>SessionFactory</literal> usando una búsqueda + JNDI. Observa que esta configuración no es necesaria si usas la clase de ayuda + <literal>HibernateUtil</literal> introducida en el capítulo uno, que actúa + como un registro Singleton. Sin embargo, <literal>HibernateUtil</literal> es más + común en un entorno no manejado. + </para> + + </sect2> + + <sect2 id="configuration-j2ee-currentsession" revision="1"> + <title>Ligado automático de JTA y Session</title> + + <para> + Para entornos no manejados hemos sugerido <literal>HibernateUtil</literal> con una + <literal>SessionFactory</literal> estática, y administración de la + <literal>Session</literal> de Hibernate. Este enfoque no es fácil de usar + en un entorno EJB, al poder ejecutarse muchos EJBs dentro de la misma transacción + pero no en la misma hebra. Recomendados que ligues la <literal>SessionFactory</literal> + a JNDI en un entorno manejado. + </para> + + <para> + En vez de rodar tu propia utilidad de <literal>ThreadLocal</literal>, + usa el método <literal>getCurrentSession()</literal> en la + <literal>SessionFactory</literal> para obtener una <literal>Session</literal> + de Hibernate. Si no hubiese una <literal>Session</literal> de Hibernate en la + transacción JTA actual, se arrancará y asignará una. + Ambas opciones de configuración <literal>hibernate.transaction.flush_before_completion</literal> + y <literal>hibernate.transaction.auto_close_session</literal>, serán establecidas + automáticamente para cada <literal>Session</literal> que obtengas con + <literal>getCurrentSession()</literal>, de modo que éstas serán + limpiadas (flushed) y cerradas automáticamente cuando el contenedor complete + las transacciones JTA. + </para> + + <para> + Si tu, por ejemplo, usas el patrón de diseño DAO para escribir tu + capa de persistencia, todos los DAO's buscan la <literal>SessionFactory</literal> + cuando se necesite y abren la sesión "actual". No hay necesidad de pasar + las instancias de <literal>SessionFactory</literal> o <literal>Session</literal> + alrededor entre el código de control y el código DAO. + </para> + + </sect2> + + <sect2 id="configuration-j2ee-jmx" revision="1"> + <title>Despliegue JMX</title> + + <para> + La línea <literal>cfg.buildSessionFactory()</literal> todavía tiene + que ser ejecutada en algun sitio para obtener una <literal>SessionFactory</literal> + en JNDI. Puedes hacer esto bien en un bloque inicializador <literal>static</literal> + (como aquel en <literal>HibernateUtil</literal>) o bien despliegas Hibernate como un + <emphasis>servicio manejado</emphasis>. + </para> + + <para> + Hibernate se distribuye con <literal>org.hibernate.jmx.HibernateService</literal> + para despliegue en un servidor de aplicaciones con capacidades JMX, como JBoss AS. + El despliegue y la configuracón reales son específicos del vendedor. + He aquí un <literal>jboss-service.xml</literal> de ejemplo para JBoss 4.0.x: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<server> + +<mbean code="org.hibernate.jmx.HibernateService" + name="jboss.jca:service=HibernateFactory,name=HibernateFactory"> + +  + <depends>jboss.jca:service=RARDeployer</depends> + <depends>jboss.jca:service=LocalTxCM,name=HsqlDS</depends> + +  + <attribute name="JndiName">java:/hibernate/SessionFactory</attribute> + +  + <attribute name="Datasource">java:HsqlDS</attribute> + <attribute name="Dialect">org.hibernate.dialect.HSQLDialect</attribute> + +  + <attribute name="TransactionStrategy"> + org.hibernate.transaction.JTATransactionFactory</attribute> + <attribute name="TransactionManagerLookupStrategy"> + org.hibernate.transaction.JBossTransactionManagerLookup</attribute> + <attribute name="FlushBeforeCompletionEnabled">true</attribute> + <attribute name="AutoCloseSessionEnabled">true</attribute> + +  + <attribute name="MaximumFetchDepth">5</attribute> + +  + <attribute name="SecondLevelCacheEnabled">true</attribute> + <attribute name="CacheProviderClass">org.hibernate.cache.EhCacheProvider</attribute> + <attribute name="QueryCacheEnabled">true</attribute> + +  + <attribute name="ShowSqlEnabled">true</attribute> + +  + <attribute name="MapResources">auction/Item.hbm.xml,auction/Category.hbm.xml</attribute> + +</mbean> + +</server>]]></programlisting> + + <para> + Este fichero es desplegado en un directorio llamado <literal>META-INF</literal> y + empaquetado en un fichero JAR con la extensión <literal>.sar</literal> + (fichero de servicio). También necesitas empaquetar Hibernate, sus bibliotecas + de terceros requeridas, tus clases persistentes compiladas, así como tus ficheros de mapeo + en el mismo fichero. Tus beans de empresa (usualmente beans de sesión) pueden ser + mantenidos en su propio fichero JAR, pero debes incluir este fichero EJB JAR en el fichero + de servicio principal para obtener una unidad desplegable (en caliente). Consulta la documentación + de JBoss AS para más información sobre el servicio JMX y despliegue de EJB. + </para> + + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/events.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/events.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/events.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/events.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,233 @@ +<chapter id="events"> + <title>Interceptores y eventos</title> + + <para> + Frecuentemente es útil para la aplicación reaccionar a ciertos eventos que ocurran dentro de Hibernate. + Esto permite la implementación de ciertos tipos de funcionalidade genérica, y extensión de la + funcionalidad de Hibernate. + </para> + + <sect1 id="objectstate-interceptors" revision="1"> + <title>Interceptores</title> + + <para> + La interface <literal>Interceptor</literal> provee callbacks desde la sesión a la aplicación + permitiendo a ésta última inspeccionar y/o manipular las propiedades de un objeto persistente + antes que sea salvado, actualizado, borrado o cargado. Un uso posible de esto es seguir la pista + de información de auditoría. Por ejemplo, el siguiente <literal>Interceptor</literal> establece + automáticamente el <literal>createTimestamp</literal> cuando un <literal>Auditable</literal> es + creado y actualiza la propiedad <literal>lastUpdateTimestamp</literal> cuando un + <literal>Auditable</literal> es acutalizado. + </para> + + <programlisting><![CDATA[package org.hibernate.test; + +import java.io.Serializable; +import java.util.Date; +import java.util.Iterator; + +import org.hibernate.Interceptor; +import org.hibernate.type.Type; + +public class AuditInterceptor implements Interceptor, Serializable { + + private int updates; + private int creates; + + public void onDelete(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + // do nothing + } + + public boolean onFlushDirty(Object entity, + Serializable id, + Object[] currentState, + Object[] previousState, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + updates++; + for ( int i=0; i < propertyNames.length; i++ ) { + if ( "lastUpdateTimestamp".equals( propertyNames[i] ) ) { + currentState[i] = new Date(); + return true; + } + } + } + return false; + } + + public boolean onLoad(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + return false; + } + + public boolean onSave(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + creates++; + for ( int i=0; i<propertyNames.length; i++ ) { + if ( "createTimestamp".equals( propertyNames[i] ) ) { + state[i] = new Date(); + return true; + } + } + } + return false; + } + + public void postFlush(Iterator entities) { + System.out.println("Creations: " + creates + ", Updates: " + updates); + } + + public void preFlush(Iterator entities) { + updates=0; + creates=0; + } + + ... + +}]]></programlisting> + + <para> + El interceptor podría ser especificado cuando se crea la sesión: + </para> + + <programlisting><![CDATA[Session session = sf.openSession( new AuditInterceptor() );]]></programlisting> + + <para> + Puedes además establecer un interceptor a un nivel global, usando la <literal>Configuration</literal>: + </para> + + <programlisting><![CDATA[new Configuration().setInterceptor( new AuditInterceptor() );]]></programlisting> + + </sect1> + + <sect1 id="objectstate-events" revision="2"> + <title>Sistema de eventos</title> + + <para> + Si tienes que reaccionar a eventos particulares en tu capa de persistencia, puedes también la + arquitectura de <emphasis>eventos</emphasis> de Hibernate3. El sistema de eventos puede ser usado + en adición o como un remplazo a los interceptores. + </para> + + <para> + Esencialmente todos los métodos de la interface <literal>Session</literal> se correlacionan + con un evento. Tienes un <literal>LoadEvent</literal>, un <literal>FlushEvent</literal>, etc + (consulta el DTD del fichero de configuración XML o el paquete <literal>org.hibernate.event</literal> + para la lista completa de tipos de evento definidos). Cuando se hace una petición de uno de estos + métodos, la <literal>Session</literal> de Hibernate genera un evento apropiado y se lo pasa + al oyente (listener) de eventos configurado para ese tipo. De fábrica, estos oyentes implementan + el mismo procesamiento en los que siempre resultan aquellos métodos. Sin embargo, eres libre de + implementar una personalización de una de las interfaces oyentes (es decir, el + <literal>LoadEvent</literal> es procesado por la implementación registrada de la interface + <literal>LoadEventListener</literal>), en cuyo caso su implementación sería responsable + de procesar cualquier petición <literal>load()</literal> hecha a la <literal>Session</literal>. + </para> + + <para> + Los oyentes deben ser considerados efectivamente singletons; quiere decir, que son compartidos + entre las peticiones, y por lo tanto no guardan ningún estado en variables de instancia. + </para> + + <para> + Un oyente personalizado debe implementar la interface apropiada para el evento que quiere procesar y/o + extender una de las clases base de conveniencia (o incluso los oyentes de eventos por defecto + usados por Hibernate de fábrica al ser éstos declarados non-final para este propósito). Los + oyentes personalizados pueden ser registrados programáticamente a través del objeto + <literal>Configuration</literal>, o especificados en el XML de configuración de Hibernate + (la declaración declarativa a través del fichero de propiedades no está soportada). + He aquí un ejemplo de un oyente personalizado de eventos load: + </para> + + <programlisting><![CDATA[public class MyLoadListener extends DefaultLoadEventListener { + // this is the single method defined by the LoadEventListener interface + public Object onLoad(LoadEvent event, LoadEventListener.LoadType loadType) + throws HibernateException { + if ( !MySecurity.isAuthorized( event.getEntityClassName(), event.getEntityId() ) ) { + throw MySecurityException("Unauthorized access"); + } + return super.onLoad(event, loadType); + } +}]]></programlisting> + + <para> + Necesitas además una entrada de configuración diciéndole a Hibernate que use el + oyente en vez del oyente por defecto: + </para> + +<programlisting><![CDATA[<hibernate-configuration> + <session-factory> + ... + <listener type="load" class="MyLoadListener"/> + </session-factory> +</hibernate-configuration>]]></programlisting> + + <para> + En cambio, puedes registrarlo programáticamente: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration(); +cfg.getSessionEventListenerConfig().setLoadEventListener( new MyLoadListener() );]]></programlisting> + + <para> + Los oyentes registrados declarativamente no pueden compartir instancias. Si el mismo nombre de clase es + usado en múltiples elementos <literal><listener/></literal>, cada referencia resultará en una instancia + separada de esa clase. Si necesitas la capacidad de compartir instancias de oyentes entre tipos de oyente + debes usar el enfoque de registración programática. + </para> + + <para> + ¿Por qué implementar una interface y definir el tipo espcífico durante la configuración? + Bueno, una implementación de oyente podría implementar múltiples interfaces de oyente + de eventos. Teniendo el tipo definido adicionalmente durante la registración lo hace más + fácil para activar o desactivar oyentes personalizados durante la configuración. + </para> + + </sect1> + + <sect1 id="objectstate-decl-security"> + <title>Seguridad declarativa de Hibernate</title> + <para> + Usualmente, la seguridad declarativa en aplicaciones Hibernate es manejada en una capa de fachada + de sesión. Ahora, Hibernate3 permite que ciertas acciones sean permitidas vía JACC, y autorizadas vía + JAAS. Esta en una funcionalidad opcional construída encima de la arquitectura de eventos. + </para> + + <para> + Primero, debes configurar los oyentes de eventos apropiados, para habilitar el uso de + autorización JAAS. + </para> + + <programlisting><![CDATA[<listener type="pre-delete" class="org.hibernate.secure.JACCPreDeleteEventListener"/> +<listener type="pre-update" class="org.hibernate.secure.JACCPreUpdateEventListener"/> +<listener type="pre-insert" class="org.hibernate.secure.JACCPreInsertEventListener"/> +<listener type="pre-load" class="org.hibernate.secure.JACCPreLoadEventListener"/>]]></programlisting> + + <para> + Seguido, aún en <literal>hibernate.cfg.xml</literal>, liga los permisos a roles: + </para> + + <programlisting><![CDATA[<grant role="admin" entity-name="User" actions="insert,update,read"/> +<grant role="su" entity-name="User" actions="*"/>]]></programlisting> + + <para> + Los nombres de role son los roles entendidos por tu proveedor de JACC. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_mappings.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/example_mappings.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_mappings.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_mappings.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,654 @@ +<chapter id="example-mappings"> + <title>Ejemplo: Varios Mapeos</title> + + <para> + Este capítulo muestra mapeos de asociaciones más complejos. + </para> + + <sect1 id="example-mappings-emp"> + <title>Empleador/Empleado</title> + + <para> + El siguiente modelo de la relación entre <literal>Employer</literal> y <literal>Employee</literal> + usa una clase de entidad real (<literal>Employment</literal>) para representar la asociación. + Esto se ha hecho esto porque podría haber más de un período de empleo para los mismos dos participantes. + Se usan componentes para modelar valores monetarios y nombres de empleado. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/EmployerEmployee.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/EmployerEmployee.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + He aquí un documento de mapeo posible: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Employer" table="employers"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employer_id_seq</param> + </generator> + </id> + <property name="name"/> + </class> + + <class name="Employment" table="employment_periods"> + + <id name="id"> + <generator class="sequence"> + <param name="sequence">employment_id_seq</param> + </generator> + </id> + <property name="startDate" column="start_date"/> + <property name="endDate" column="end_date"/> + + <component name="hourlyRate" class="MonetaryAmount"> + <property name="amount"> + <column name="hourly_rate" sql-type="NUMERIC(12, 2)"/> + </property> + <property name="currency" length="12"/> + </component> + + <many-to-one name="employer" column="employer_id" not-null="true"/> + <many-to-one name="employee" column="employee_id" not-null="true"/> + + </class> + + <class name="Employee" table="employees"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employee_id_seq</param> + </generator> + </id> + <property name="taxfileNumber"/> + <component name="name" class="Name"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </component> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Y he aquí el esquema de tablas generado por <literal>SchemaExport</literal>. + </para> + + <programlisting><![CDATA[create table employers ( + id BIGINT not null, + name VARCHAR(255), + primary key (id) +) + +create table employment_periods ( + id BIGINT not null, + hourly_rate NUMERIC(12, 2), + currency VARCHAR(12), + employee_id BIGINT not null, + employer_id BIGINT not null, + end_date TIMESTAMP, + start_date TIMESTAMP, + primary key (id) +) + +create table employees ( + id BIGINT not null, + firstName VARCHAR(255), + initial CHAR(1), + lastName VARCHAR(255), + taxfileNumber VARCHAR(255), + primary key (id) +) + +alter table employment_periods + add constraint employment_periodsFK0 foreign key (employer_id) references employers +alter table employment_periods + add constraint employment_periodsFK1 foreign key (employee_id) references employees +create sequence employee_id_seq +create sequence employment_id_seq +create sequence employer_id_seq]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-authorwork"> + <title>Autor/Obra</title> + + <para> + Considera el siguiente modelo de las relaciones entre <literal>Work</literal>, + <literal>Author</literal> y <literal>Person</literal>. Representamos la relación entre <literal>Work</literal> + y <literal>Author</literal> como una asociación muchos-a-muchos. Elegimos representar la relación entre + <literal>Author</literal> y <literal>Person</literal> como una asociación uno-a-uno. Otra posibilidad + hubiese sido que <literal>Author</literal> extendiera <literal>Person</literal>. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/AuthorWork.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/AuthorWork.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + El siguiente documento de mapeo representa estas relaciones correctamente: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Work" table="works" discriminator-value="W"> + + <id name="id" column="id"> + <generator class="native"/> + </id> + <discriminator column="type" type="character"/> + + <property name="title"/> + <set name="authors" table="author_work"> + <key column name="work_id"/> + <many-to-many class="Author" column name="author_id"/> + </set> + + <subclass name="Book" discriminator-value="B"> + <property name="text"/> + </subclass> + + <subclass name="Song" discriminator-value="S"> + <property name="tempo"/> + <property name="genre"/> + </subclass> + + </class> + + <class name="Author" table="authors"> + + <id name="id" column="id"> +  + <generator class="assigned"/> + </id> + + <property name="alias"/> + <one-to-one name="person" constrained="true"/> + + <set name="works" table="author_work" inverse="true"> + <key column="author_id"/> + <many-to-many class="Work" column="work_id"/> + </set> + + </class> + + <class name="Person" table="persons"> + <id name="id" column="id"> + <generator class="native"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Hay cuatro tablas en este mapeo. <literal>works</literal>, <literal>authors</literal> y <literal>persons</literal> + tienen los datos de obra, autor y persona respectivamente. <literal>author_work</literal> es una tabla de + asociación enlazando autores a obras. He aquí el esquema de tablas, tal como fue generado por + <literal>SchemaExport</literal>. + </para> + + <programlisting><![CDATA[create table works ( + id BIGINT not null generated by default as identity, + tempo FLOAT, + genre VARCHAR(255), + text INTEGER, + title VARCHAR(255), + type CHAR(1) not null, + primary key (id) +) + +create table author_work ( + author_id BIGINT not null, + work_id BIGINT not null, + primary key (work_id, author_id) +) + +create table authors ( + id BIGINT not null generated by default as identity, + alias VARCHAR(255), + primary key (id) +) + +create table persons ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +alter table authors + add constraint authorsFK0 foreign key (id) references persons +alter table author_work + add constraint author_workFK0 foreign key (author_id) references authors +alter table author_work + add constraint author_workFK1 foreign key (work_id) references works]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-customerorderproduct"> + <title>Cliente/Orden/Producto</title> + + <para> + Ahora considera un modelo de las relaciones entre <literal>Customer</literal>, + <literal>Order</literal> y <literal>LineItem</literal> y <literal>Product</literal>. + Hay una asociación uno-a-muchos entre <literal>Customer</literal> y <literal>Order</literal>, + pero, ¿cómo deberíamos representar <literal>Order</literal> / <literal>LineItem</literal> / <literal>Product</literal>? + He elegido mapear <literal>LineItem</literal> como una clase de asociación representando la + asociación muchos-a-muchos entre <literal>Order</literal> y <literal>Product</literal>. En Hibernate, + esto se llama un elemento compuesto. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/CustomerOrderProduct.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/CustomerOrderProduct.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + El documento de mapeo: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Customer" table="customers"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name"/> + <set name="orders" inverse="true"> + <key column="customer_id"/> + <one-to-many class="Order"/> + </set> + </class> + + <class name="Order" table="orders"> + <id name="id"> + <generator class="native"/> + </id> + <property name="date"/> + <many-to-one name="customer" column="customer_id"/> + <list name="lineItems" table="line_items"> + <key column="order_id"/> + <list-index column="line_number"/> + <composite-element class="LineItem"> + <property name="quantity"/> + <many-to-one name="product" column="product_id"/> + </composite-element> + </list> + </class> + + <class name="Product" table="products"> + <id name="id"> + <generator class="native"/> + </id> + <property name="serialNumber"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + <literal>customers</literal>, <literal>orders</literal>, <literal>line_items</literal> y + <literal>products</literal> tienen los datos de cliente, orden, ítem de línea de orden y producto + respectivamente. Además <literal>line_items</literal> actúa como una tabla de asociación enlazando + órdenes con productos. + </para> + + <programlisting><![CDATA[create table customers ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +create table orders ( + id BIGINT not null generated by default as identity, + customer_id BIGINT, + date TIMESTAMP, + primary key (id) +) + +create table line_items ( + line_number INTEGER not null, + order_id BIGINT not null, + product_id BIGINT, + quantity INTEGER, + primary key (order_id, line_number) +) + +create table products ( + id BIGINT not null generated by default as identity, + serialNumber VARCHAR(255), + primary key (id) +) + +alter table orders + add constraint ordersFK0 foreign key (customer_id) references customers +alter table line_items + add constraint line_itemsFK0 foreign key (product_id) references products +alter table line_items + add constraint line_itemsFK1 foreign key (order_id) references orders]]></programlisting> + + </sect1> + + <sect1 id="misc"> + <title>Mapeos misceláneos de ejemplo</title> + + <para> + Todos estos ejemplos están tomados de la batería de pruebas de Hibernate. + Encontrarás muchos otros mapeos de ejemplo útiles allí. Mira en la carpeta + <literal>test</literal> de la distribución de Hibernate. + </para> + + <para>POR HACER: poner palabras alrededor de este material</para> + + <sect2 id="example-mappings-typed-onetone"> + <title>Asociación uno-a-uno "Tipificada"</title> +<programlisting><![CDATA[<class name="Person"> + <id name="name"/> + <one-to-one name="address" + cascade="all"> + <formula>name</formula> + <formula>'HOME'</formula> + </one-to-one> + <one-to-one name="mailingAddress" + cascade="all"> + <formula>name</formula> + <formula>'MAILING'</formula> + </one-to-one> +</class> + +<class name="Address" batch-size="2" + check="addressType in ('MAILING', 'HOME', 'BUSINESS')"> + <composite-id> + <key-many-to-one name="person" + column="personName"/> + <key-property name="type" + column="addressType"/> + </composite-id> + <property name="street" type="text"/> + <property name="state"/> + <property name="zip"/> +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key"> + <title>Ejemplo de clave compuesta</title> +<programlisting><![CDATA[<class name="Customer"> + + <id name="customerId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="name" not-null="true" length="100"/> + <property name="address" not-null="true" length="200"/> + + <list name="orders" + inverse="true" + cascade="save-update"> + <key column="customerId"/> + <index column="orderNumber"/> + <one-to-many class="Order"/> + </list> + +</class> + +<class name="Order" table="CustomerOrder" lazy="true"> + <synchronize table="LineItem"/> + <synchronize table="Product"/> + + <composite-id name="id" + class="Order$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + </composite-id> + + <property name="orderDate" + type="calendar_date" + not-null="true"/> + + <property name="total"> + <formula> + ( select sum(li.quantity*p.price) + from LineItem li, Product p + where li.productId = p.productId + and li.customerId = customerId + and li.orderNumber = orderNumber ) + </formula> + </property> + + <many-to-one name="customer" + column="customerId" + insert="false" + update="false" + not-null="true"/> + + <bag name="lineItems" + fetch="join" + inverse="true" + cascade="save-update"> + <key> + <column name="customerId"/> + <column name="orderNumber"/> + </key> + <one-to-many class="LineItem"/> + </bag> + +</class> + +<class name="LineItem"> + + <composite-id name="id" + class="LineItem$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + <key-property name="productId" length="10"/> + </composite-id> + + <property name="quantity"/> + + <many-to-one name="order" + insert="false" + update="false" + not-null="true"> + <column name="customerId"/> + <column name="orderNumber"/> + </many-to-one> + + <many-to-one name="product" + insert="false" + update="false" + not-null="true" + column="productId"/> + +</class> + +<class name="Product"> + <synchronize table="LineItem"/> + + <id name="productId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="description" + not-null="true" + length="200"/> + <property name="price" length="3"/> + <property name="numberAvailable"/> + + <property name="numberOrdered"> + <formula> + ( select sum(li.quantity) + from LineItem li + where li.productId = productId ) + </formula> + </property> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key-manytomany"> + <title>Muchos-a-muchos con atributo de clave compuesta compartido</title> +<programlisting><![CDATA[<class name="User" table="`User`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <set name="groups" table="UserGroup"> + <key> + <column name="userName"/> + <column name="org"/> + </key> + <many-to-many class="Group"> + <column name="groupName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> + +<class name="Group" table="`Group`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <property name="description"/> + <set name="users" table="UserGroup" inverse="true"> + <key> + <column name="groupName"/> + <column name="org"/> + </key> + <many-to-many class="User"> + <column name="userName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> +]]></programlisting> + </sect2> + + <sect2 id="example-mappings-content-discrimination"> + <title>Discriminación basada en contenido</title> +<programlisting><![CDATA[<class name="Person" + discriminator-value="P"> + + <id name="id" + column="person_id" + unsaved-value="0"> + <generator class="native"/> + </id> + + + <discriminator + type="character"> + <formula> + case + when title is not null then 'E' + when salesperson is not null then 'C' + else 'P' + end + </formula> + </discriminator> + + <property name="name" + not-null="true" + length="80"/> + + <property name="sex" + not-null="true" + update="false"/> + + <component name="address"> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </component> + + <subclass name="Employee" + discriminator-value="E"> + <property name="title" + length="20"/> + <property name="salary"/> + <many-to-one name="manager"/> + </subclass> + + <subclass name="Customer" + discriminator-value="C"> + <property name="comments"/> + <many-to-one name="salesperson"/> + </subclass> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-association-alternatekeys" > + <title>Asociaciones sobre claves alternativas</title> +<programlisting><![CDATA[<class name="Person"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="name" length="100"/> + + <one-to-one name="address" + property-ref="person" + cascade="all" + fetch="join"/> + + <set name="accounts" + inverse="true"> + <key column="userId" + property-ref="userId"/> + <one-to-many class="Account"/> + </set> + + <property name="userId" length="8"/> + +</class> + +<class name="Address"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="address" length="300"/> + <property name="zip" length="5"/> + <property name="country" length="25"/> + <many-to-one name="person" unique="true" not-null="true"/> + +</class> + +<class name="Account"> + <id name="accountId" length="32"> + <generator class="uuid.hex"/> + </id> + + <many-to-one name="user" + column="userId" + property-ref="userId"/> + + <property name="type" not-null="true"/> + +</class>]]></programlisting> + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_parentchild.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/example_parentchild.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_parentchild.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_parentchild.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,362 @@ +<chapter id="example-parentchild"> + <title>Ejemplo: Padre/Hijo</title> + + <para> + Una de las primerísimas cosas que los usuarios nuevos intentan hacer con Hibernate es modelar una relación de + tipo padre / hijo. Para esto hay dos enfoques diferentes. Por varias razones, el enfoque más conveniente, + especialmente para usuarios nuevos, es modelar tanto <literal>Parent</literal> como <literal>Child</literal> + como clases de entidad con una asociación <literal><one-to-many></literal> desde <literal>Parent</literal> + a <literal>Child</literal>. (El enfoque alternativo es declarar el <literal>Child</literal> como un + <literal><composite-element></literal>.) Ahora, resulta que la semántica por defecto de una asociación + uno a muchos (en Hibernate) es mucho menos cercana a la semántica usual de una relación padre / hijo que aquellas + de un mapeo de elementos compuestos. Explicaremos cómo usar una <emphasis>asociación uno a muchos bidireccional + con tratamiento en cascada</emphasis> para modelar una relación padre / hijo eficiente y elegantemente. + ¡No es para nada difícil! + </para> + + <sect1 id="example-parentchild-collections"> + <title>Una nota sobre las colecciones</title> + + <para> + Se considera que las colecciones de Hibernate son una parte lógica de la entidad que las posee; nunca de + las entidades contenidas. ¡Esta es una distinción crucial! Esto tiene las siguientes consecuencias: + </para> + + <itemizedlist> + <listitem> + <para> + Cuando se quita / añade un objeto desde / a una colección, se incrementa el número de versión del + dueño de la colección. + </para> + </listitem> + <listitem> + <para> + Si un objeto que fue quitado de una colección es una instancia de un tipo de valor (por ejemplo, un + elemento compuesto), ese objeta cesará de ser persistente y su estado será completamente quitado de la + base de datos. Asimismo, añadir una instancia de tipo de valor a la colección causará que su estado + sea inmediatamente persistente. + </para> + </listitem> + <listitem> + <para> + Por otro lado, si se quita una entidad de una colección (una asociación uno-a-muchos o muchos-a-muchos), + no será borrado, por defecto. Este comportamiento es completamente consistente. ¡Un cambio en el + estado interno de otra entidad no hace desaparecer la entidad asociada! Asimismo, añadir una entidad a + una colección no causa que la entidad se vuelva persistente, por defecto. + </para> + </listitem> + </itemizedlist> + + <para> + En cambio, el comportamiento por defecto es que al añadir una entidad a una colección se crea meramente + un enlace entre las dos entidades, mientras que al quitarla se quita el enlace. Esto es muy apropiado para + todos los tipos de casos. Donde no es para nada apropiado es en el caso de una relación padre / hijo. donde + la vida del hijo está ligada al ciclo de vida del padre. + </para> + + </sect1> + + <sect1 id="example-parentchild-bidir"> + <title>Uno-a-muchos bidirectional</title> + + <para> + Supón que empezamos con una asociación simple <literal><one-to-many></literal> desde + <literal>Parent</literal> a <literal>Child</literal>. + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Si ejecutásemos el siguiente código + </para> + + <programlisting><![CDATA[Parent p = .....; +Child c = new Child(); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + Hibernate publicaría dos sentencias SQL: + </para> + + <itemizedlist> + <listitem> + <para>un <literal>INSERT</literal> para crear el registro de <literal>c</literal></para> + </listitem> + <listitem> + <para> + un <literal>UPDATE</literal> para crear el enlace desde <literal>p</literal> a + <literal>c</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Esto no es sólo ineficiente, sino que además viola cualquier restricción <literal>NOT NULL</literal> en la + columna <literal>parent_id</literal>. Podemos reparar la violación de restricción de nulabilidad + especificando <literal>not-null="true"</literal> en el mapeo de la colección: + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Sin embargo, esta no es la solución recomendada. + </para> + <para> + El caso subyacente de este comportamiento es que el enlace (la clave foránea <literal>parent_id</literal>) + de <literal>p</literal> a <literal>c</literal> no es considerado parte del estado del objeto + <literal>Child</literal> y por lo tanto no es creada en el <literal>INSERT</literal>. De modo que la + solución es hacer el enlace parte del mapeo del <literal>Child</literal>. + </para> + + <programlisting><![CDATA[<many-to-one name="parent" column="parent_id" not-null="true"/>]]></programlisting> + + <para> + (Necesitamos además añadir la propiedad <literal>parent</literal> a la clase <literal>Child</literal>.) + </para> + + <para> + Ahora que la entidad <literal>Child</literal> está gestionando el estado del enlace, le decimos a la + colección que no actualice el enlace. Usamos el atributo <literal>inverse</literal>. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + El siguiente código podría ser usado para añadir un nuevo <literal>Child</literal> + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +c.setParent(p); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + Y ahora, ¡Sólo se publicaría un <literal>INSERT</literal> de SQL! + </para> + + <para> + Para ajustar un poco más las cosas, podríamos crear un método <literal>addChild()</literal> en + <literal>Parent</literal>. + </para> + + <programlisting><![CDATA[public void addChild(Child c) { + c.setParent(this); + children.add(c); +}]]></programlisting> + + <para> + Ahora, el código para añadir un <literal>Child</literal> se ve así + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.save(c); +session.flush();]]></programlisting> + + </sect1> + + <sect1 id="example-parentchild-cascades"> + <title>Ciclo de vida en cascada</title> + + <para> + La llamada explícita a <literal>save()</literal> es aún molesta. Apuntaremos a esto usando tratamientos + en cascada. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Esto simplifica el código anterior a + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.flush();]]></programlisting> + + <para> + Similarmente, no necesitamos iterar los hijos al salvar o borrar un <literal>Parent</literal>. + Lo siguiente quita <literal>p</literal> y todos sus hijos de la base de datos. + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +session.delete(p); +session.flush();]]></programlisting> + + <para> + Sin embargo, este código + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +c.setParent(null); +session.flush();]]></programlisting> + + <para> + no quitará <literal>c</literal> de la base de datos; sólo quitará el enlace a <literal>p</literal> + (y causará una violación a una restricción <literal>NOT NULL</literal>). Necesitas borrar el hijo + explícitamente llamando a <literal>delete()</literal>. + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +session.delete(c); +session.flush();]]></programlisting> + + <para> + Ahora, en nuestro caso, un <literal>Child</literal> no puede existir realmente sin su padre. De modo que + si quitamos un <literal>Child</literal> de la colección, realmente queremos que sea borrado. Para esto, + debemos usar <literal>cascade="all-delete-orphan"</literal>. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all-delete-orphan"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Nota: aunque el mapeo de la colección especifique <literal>inverse="true"</literal>, el tratamiento en + cascada se procesa aún al iterar los elementos de colección. De modo que si requieres que un objeto sea + salvado, borrado o actualizado en cascada, debes añadirlo a la colección. No es suficiente con simplemente + llamar a <literal>setParent()</literal>. + </para> + + </sect1> + + <sect1 id="example-parentchild-update"> + <title>Tratamiento en cascada y <literal>unsaved-value</literal></title> + + <para> + Supón que hemos cargado un <literal>Parent</literal> en una <literal>Session</literal>, hemos hecho algunos + cambios en una acción de UI y deseamos hacer persistentes estos cambios en una nueva sesión llamando a + <literal>update()</literal>. El <literal>Parent</literal> contendrá una colección de hijos y, ya que + está habilitado el tratamiento en cascada, Hibernate necesita saber qué hijos están recién instanciados + y cuáles representan filas existentes en la base de datos. Asumamos que tanto <literal>Parent</literal> como + <literal>Child</literal> tienen propiedades identificadoras generadas de tipo <literal>Long</literal>. + Hibernate usará el identificador y el valor de la propiedad de versión/timestamp para determinar cuáles de + los hijos son nuevos. (Ver <xref linkend="objectstate-saveorupdate"/>.) <emphasis>En Hibernate3, no es + más necesario especificar un <literal>unsaved-value</literal> explícitamente.</emphasis> + </para> + + <para> + The following code will update <literal>parent</literal> and <literal>child</literal> and insert + <literal>newChild</literal>. + </para> + + <programlisting><![CDATA[//parent and child were both loaded in a previous session +parent.addChild(child); +Child newChild = new Child(); +parent.addChild(newChild); +session.update(parent); +session.flush();]]></programlisting> + + <para> + Bueno, todo eso está muy bien para el caso de un identificador generado, pero ¿qué de los + identificadores asignados y de los identificadores compuestos? Esto es más difícil, ya que Hibernate + no puede usar la propiedad identificadora para distinguir entre un objeto recién instanciado (con un + identificador asignado por el usuario) y un objeto cargado en una sesión previa. En este caso, Hibernate + bien usará la propiedad de versión o timestamp, o bien consultará realmente el caché de segundo nivel, + o bien, en el peor de los casos, la base de datos, para ver si existe la fila. + </para> + +  + </sect1> + + <sect1 id="example-parentchild-conclusion"> + <title>Conclusión</title> + + <para> + Hay que resumir un poco aquí y podría parecer confuso a la primera vez. Sin embargo, en la práctica, + todo funciona muy agradablemente. La mayoría de las aplicaciones de Hibernate usan el patrón + padre / hijo en muchos sitios. + </para> + + <para> + Hemos mencionado una alternativa en el primer párrafo. Ninguno de los temas anteriores existe en el caso + de los mapeos <literal><composite-element></literal>, que tienen exactamente la semántica de una + relación padre / hijo. Desafortunadamente, hay dos grandes limitaciones para las clases de elementos + compuestos: los elementos compuestos no pueden poseer sus propias colecciones, y no deben ser el hijo + de cualquier otra entidad que no sea su padre único. + </para> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_weblog.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/example_weblog.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_weblog.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/example_weblog.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,429 @@ +<chapter id="example-weblog"> + <title>Ejemplo: Aplicación de Weblog</title> + + <sect1 id="example-weblog-classes"> + <title>Clases Persistentes</title> + + <para> + Las clases persistentes representan un weblog, y un ítem enviado a un weblog. Van a ser modelados como una + relación padre/hijo estñndar, pero usaremos un bag ordenado, en vez de un conjunto (set). + </para> + + <programlisting><![CDATA[package eg; + +import java.util.List; + +public class Blog { + private Long _id; + private String _name; + private List _items; + + public Long getId() { + return _id; + } + public List getItems() { + return _items; + } + public String getName() { + return _name; + } + public void setId(Long long1) { + _id = long1; + } + public void setItems(List list) { + _items = list; + } + public void setName(String string) { + _name = string; + } +}]]></programlisting> + + <programlisting><![CDATA[package eg; + +import java.text.DateFormat; +import java.util.Calendar; + +public class BlogItem { + private Long _id; + private Calendar _datetime; + private String _text; + private String _title; + private Blog _blog; + + public Blog getBlog() { + return _blog; + } + public Calendar getDatetime() { + return _datetime; + } + public Long getId() { + return _id; + } + public String getText() { + return _text; + } + public String getTitle() { + return _title; + } + public void setBlog(Blog blog) { + _blog = blog; + } + public void setDatetime(Calendar calendar) { + _datetime = calendar; + } + public void setId(Long long1) { + _id = long1; + } + public void setText(String string) { + _text = string; + } + public void setTitle(String string) { + _title = string; + } +}]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-mappings"> + <title>Mapeos de Hibernate</title> + + <para> + Los mapeos XML ahora deben ser absolutamente directos. + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="Blog" + table="BLOGS"> + + <id + name="id" + column="BLOG_ID"> + + <generator class="native"/> + + </id> + + <property + name="name" + column="NAME" + not-null="true" + unique="true"/> + + <bag + name="items" + inverse="true" + order-by="DATE_TIME" + cascade="all"> + + <key column="BLOG_ID"/> + <one-to-many class="BlogItem"/> + + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="BlogItem" + table="BLOG_ITEMS" + dynamic-update="true"> + + <id + name="id" + column="BLOG_ITEM_ID"> + + <generator class="native"/> + + </id> + + <property + name="title" + column="TITLE" + not-null="true"/> + + <property + name="text" + column="TEXT" + not-null="true"/> + + <property + name="datetime" + column="DATE_TIME" + not-null="true"/> + + <many-to-one + name="blog" + column="BLOG_ID" + not-null="true"/> + + </class> + +</hibernate-mapping>]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-code"> + <title>Código Hibernate</title> + + <para> + La siguiente clase demuestra algunos de los tipos de cosas que podemos haces con estas clases, + usando Hibernate. + </para> + + <programlisting><![CDATA[package eg; + +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Iterator; +import java.util.List; + +import org.hibernate.HibernateException; +import org.hibernate.Query; +import org.hibernate.Session; +import org.hibernate.SessionFactory; +import org.hibernate.Transaction; +import org.hibernate.cfg.Configuration; +import org.hibernate.tool.hbm2ddl.SchemaExport; + +public class BlogMain { + + private SessionFactory _sessions; + + public void configure() throws HibernateException { + _sessions = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class) + .buildSessionFactory(); + } + + public void exportTables() throws HibernateException { + Configuration cfg = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class); + new SchemaExport(cfg).create(true, true); + } + + public Blog createBlog(String name) throws HibernateException { + + Blog blog = new Blog(); + blog.setName(name); + blog.setItems( new ArrayList() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.persist(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public BlogItem createBlogItem(Blog blog, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setBlog(blog); + item.setDatetime( Calendar.getInstance() ); + blog.getItems().add(item); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public BlogItem createBlogItem(Long blogid, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setDatetime( Calendar.getInstance() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + Blog blog = (Blog) session.load(Blog.class, blogid); + item.setBlog(blog); + blog.getItems().add(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public void updateBlogItem(BlogItem item, String text) + throws HibernateException { + + item.setText(text); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public void updateBlogItem(Long itemid, String text) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + BlogItem item = (BlogItem) session.load(BlogItem.class, itemid); + item.setText(text); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public List listAllBlogNamesAndItemCounts(int max) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "select blog.id, blog.name, count(blogItem) " + + "from Blog as blog " + + "left outer join blog.items as blogItem " + + "group by blog.name, blog.id " + + "order by max(blogItem.datetime)" + ); + q.setMaxResults(max); + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } + + public Blog getBlogAndAllItems(Long blogid) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + Blog blog = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "left outer join fetch blog.items " + + "where blog.id = :blogid" + ); + q.setParameter("blogid", blogid); + blog = (Blog) q.uniqueResult(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public List listBlogsAndRecentItems() throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "inner join blog.items as blogItem " + + "where blogItem.datetime > :minDate" + ); + + Calendar cal = Calendar.getInstance(); + cal.roll(Calendar.MONTH, false); + q.setCalendar("minDate", cal); + + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/filters.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/filters.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/filters.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/filters.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,130 @@ +<chapter id="filters"> + <title>Filtrando datos</title> + + <para> + Hibernate3 provee un nuevo enfoque innovador para manejar datos con reglas de "visibilidad". + Un <emphasis>filtro de Hibernate</emphasis> es un filtro global, con nombre y parametrizado + que puede ser habilitado o deshabilitado para una sesión de Hibernate en particular. + </para> + + <sect1 id="objectstate-filters"> + <title>Filtros de Hibernate</title> + + <para> + Hibernate3 añade la habilidad de predefinir criterios de filtros y unir esos filtros tanto a + nivel de una clase como de una colección. Un criterio de filtro es la habilidad de definir una + cláusula de restricción muy similar al atributo existente "where" disponible en el elemento + class y varios elementos de colección. Excepto en que estos filtros pueden ser parametrizados. + La aplicación puede tomar la decisión en tiempo de ejecución de qué filtros deben estar + habilitados y cuáles deben ser sus parámetros. Los filtros pueden ser usados como vistas de + base de datos, pero parametrizados dentro de la aplicación. + </para> + + <para> + Para usar los filtros, éstos deben primero ser definidos y luego unidos a los elementos de mapeo + apropiados. Para definir un filtro, usa el elemento <literal><filter-def/></literal> dentro + de un elemento <literal><hibernate-mapping/></literal>: + </para> + + <programlisting><![CDATA[<filter-def name="myFilter"> + <filter-param name="myFilterParam" type="string"/> +</filter-def>]]></programlisting> + + <para> + Entonces este filtro puede ser unido a una clase: + </para> + + <programlisting><![CDATA[<class name="myClass" ...> + ... + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</class>]]></programlisting> + + <para> + o a una colección: + </para> + + <programlisting><![CDATA[<set ...> + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</set>]]></programlisting> + + <para> + o incluso a ambos (o muchos de cada uno) al mismo tiempo. + </para> + + <para> + Los métodos en <literal>Session</literal> son: <literal>enableFilter(String filterName)</literal>, + <literal>getEnabledFilter(String filterName)</literal>, y <literal>disableFilter(String filterName)</literal>. + Por defecto, los filtros <emphasis>no</emphasis> están habilitados para una sesión dada; deben ser + habilitados explícitamente por medio del uso del método <literal>Session.enableFilter()</literal>, + que devuelve una instancia de la interface <literal>Filter</literal>. Usando el filtro simple definido + arriba, esto se vería así: + </para> + + <programlisting><![CDATA[session.enableFilter("myFilter").setParameter("myFilterParam", "some-value");]]></programlisting> + + <para> + Nota que los métodos en la interface org.hibernate.Filter permiten el encadenamiento de métodos + común en gran parte de Hibernate. + </para> + + <para> + Un ejemplo completo, usando datos temporales con un patrón efectivo de fechas de registro: + </para> + + <programlisting><![CDATA[<filter-def name="effectiveDate"> + <filter-param name="asOfDate" type="date"/> +</filter-def> + +<class name="Employee" ...> +... + <many-to-one name="department" column="dept_id" class="Department"/> + <property name="effectiveStartDate" type="date" column="eff_start_dt"/> + <property name="effectiveEndDate" type="date" column="eff_end_dt"/> +... +  + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> +</class> + +<class name="Department" ...> +... + <set name="employees" lazy="true"> + <key column="dept_id"/> + <one-to-many class="Employee"/> + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> + </set> +</class>]]></programlisting> + + <para> + Entonces, en orden de asegurar que siempre tendrás de vuelta registros actualmente efectivos, + simplemente habilita el filtro en la sesión previo a recuperar los datos de empleados: + </para> + +<programlisting><![CDATA[Session session = ...; +session.enabledFilter("effectiveDate").setParameter("asOfDate", new Date()); +List results = session.createQuery("from Employee as e where e.salary > :targetSalary") + .setLong("targetSalary", new Long(1000000)) + .list(); +]]></programlisting> + + <para> + En el HQL de arriba, aunque sólo hemos mencionado explícitamente una restricción de salario en + los resultados, debido al filtro habilitado la consulta sólo devolverá empleados actualmente activos + que tengan un salario mayor que un millón de dólares. + </para> + + <para> + Nota: si planeas usar filtros con unión externa (outer joining) (bien a través de HQL, o bien + de recuperación de carga) sé cuidadoso en la dirección de expresión de la condición. Lo más seguro + es establecer esto para unión externa izquierda (left outer joining). En general, coloca el primer + parámetro seguido del nombre(s) de columna(s) después del operador. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/inheritance_mapping.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/inheritance_mapping.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/inheritance_mapping.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/inheritance_mapping.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,464 @@ +<chapter id="inheritance"> + <title>Mapeo de Herencia</title> + + <sect1 id="inheritance-strategies" revision="2"> + <title>Las Tres Estrategias</title> + + <para> + Hibernate soporta las tres estrategias básicas de mapeo de herencia: + </para> + + <itemizedlist> + <listitem> + <para> + tabla por jerarquía de clases + </para> + </listitem> + <listitem> + <para> + tabla por subclase + </para> + </listitem> + <listitem> + <para> + tabla por clase concreta + </para> + </listitem> + </itemizedlist> + + <para> + En adición, Hibernate soporta un cuarto, ligeramente diferente tipo + de polimorfismo: + </para> + + <itemizedlist> + <listitem> + <para> + polimorfismo implícito + </para> + </listitem> + </itemizedlist> + + <para> + Es posible usar estrategias de mapeo diferentes para diferentes + ramificaciones de la misma jerarquía de herencia, y entonces usar + polimorfismo implícito para conseguir polimorfismo a través de + toda la jerarquía. Sin embargo, Hibernate no soporta la mezcla de + mapeos <literal><subclass></literal>, + y <literal><joined-subclass></literal> + y <literal><union-subclass></literal> bajo el mismo elemento + <literal><class></literal> raíz. Es posible mezclar juntas las + estrategias de tabla por jerarquía y tabla por subclase, bajo el mismo + elemento <literal><class></literal>, combinando los elementos + <literal><subclass></literal> y <literal><join></literal> + (ver debajo). + </para> + + <sect2 id="inheritance-tableperclass" > + <title>Tabla por jerarquía de clases</title> + + <para> + Supón que tenemos una interface <literal>Payment</literal>, con + los implementadores <literal>CreditCardPayment</literal>, + <literal>CashPayment</literal>, <literal>ChequePayment</literal>. + El mapeo de tabla por jerarquía se vería así: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + Se requiere exactamente una tabla. Hay una gran limitación de esta estrategia de mapeo: + las columnas declaradas por las subclases, como <literal>CCTYPE</literal>, no pueden + tener restricciones <literal>NOT NULL</literal>. + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass"> + <title>Tabla por subclase</title> + + <para> + Un mapeo de tabla por sublclase se vería así: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <joined-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </joined-subclass> + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + Se requieren cuatro tablas. Las tres tablas de subclase tienen + asociaciones de clave primaria a la tabla de superclase (de modo + que en el modelo relacional es realmente una asociación uno-a-uno). + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass-discriminator" revision="2"> + <title>Tabla por subclase, usando un discriminador</title> + + <para> + Observa que la implementación de Hibernate de tabla por subclase + no requiere ninguna columna discriminadora. Otros mapeadores + objeto/relacional usan una implementación diferente de tabla por + subclase que requiere una columna discriminadora de tipo en la tabla + de superclase. Este enfoque es mucho más difícil de implementar + pero discutiblemente más correcto desde un punto de vista relacional. + Si quisieras usar una columna discriminadora con la estrategia de + tabla por subclase, puedes combinar el uso de <literal><subclass></literal> + y <literal><join></literal>, como sigue: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + <join table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + <join table="CHEQUE_PAYMENT" fetch="select"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> +</class>]]></programlisting> + + <para> + la declaración opcional <literal>fetch="select"</literal> dice a Hibernate + que no recupere los datos de la subclase <literal>ChequePayment</literal> + usando una unión externa (outer join) al consultar la superclase. + </para> + + </sect2> + + <sect2 id="inheritance-mixing-tableperclass-tablepersubclass"> + <title>Mezclando tabla por jerarquía de clases con tabla por subclase</title> + + <para> + Puedes incluso mezclar las estrategias de tabla po jerarquía y tabla por + subclase usando este enfoque: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + Para cualquiera de estas estrategias de mapeo, una asociación polimórfica + a la clase raíz <literal>Payment</literal> es mapeada usando <literal><many-to-one></literal>. + </para> + + <programlisting><![CDATA[<many-to-one name="payment" column="PAYMENT_ID" class="Payment"/>]]></programlisting> + + </sect2> + + <sect2 id="inheritance-tableperconcrete" revision="1"> + <title>Tabla por clase concreta</title> + + <para> + Podríamos ir de dos maneras a la estrategia de mapeo de tabla por clase + concreta. La primera es usar <literal><union-subclass></literal>. + </para> + + <programlisting><![CDATA[<class name="Payment"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="sequence"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <union-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </union-subclass> + <union-subclass name="CashPayment" table="CASH_PAYMENT"> + ... + </union-subclass> + <union-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + ... + </union-subclass> +</class>]]></programlisting> + + <para> + Están implicadas tres tablas. Cada tabla define columnas para todas las + propiedades de la clase, inccluyendo las propiedades heredadas. + </para> + + <para> + La limitación de este enfoque es que si una propiedad es mapeada en la + superclase, el nombre de columna debe ser el mismo en todas las tablas + de subclase. (Podríamos relajar esto en un lanzamiento futuro de Hibernate.) + La estrategia de generador de indentidad no está permitida en la herencia + de unión de subclase, de hecho la semilla de clave primaria tiene que ser + compartida a través de todas las subclases unidas de una jerarquía. + </para> + + </sect2> + + <sect2 id="inheritance-tableperconcreate-polymorphism"> + <title>Tabla por clase concreta, usando polimorfismo implícito</title> + + <para> + Un enfoque alternativo es hacer uso de polimorfismo implícito: + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CREDIT_AMOUNT"/> + ... +</class> + +<class name="CashPayment" table="CASH_PAYMENT"> + <id name="id" type="long" column="CASH_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CASH_AMOUNT"/> + ... +</class> + +<class name="ChequePayment" table="CHEQUE_PAYMENT"> + <id name="id" type="long" column="CHEQUE_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... +</class>]]></programlisting> + + <para> + Nota que en ningún sitio mencionamos la interface <literal>Payment</literal> + explícitamente. Nota además que las propiedades de <literal>Payment</literal> + son mapeadas en cada una de las subclases. Si quieres evitar duplicación, + considera usar entidades XML. (por ejemplo, + <literal>[ <!ENTITY allproperties SYSTEM "allproperties.xml"> ]</literal> + en la declaración <literal>DOCTYPE</literal> y <literal>&allproperties;</literal> + en el mapeo). + </para> + + <para> + La desventaja de este enfoque es que Hibernate no genera <literal>UNION</literal>s + de SQL al realizar consultas polimórficas. + </para> + + <para> + Para esta estrategia de mapeo, una asociación polimórfica a <literal>Payment</literal> + es mapeada generalmente usando <literal><any></literal>. + </para> + + <programlisting><![CDATA[<any name="payment" meta-type="string" id-type="long"> + <meta-value value="CREDIT" class="CreditCardPayment"/> + <meta-value value="CASH" class="CashPayment"/> + <meta-value value="CHEQUE" class="ChequePayment"/> + <column name="PAYMENT_CLASS"/> + <column name="PAYMENT_ID"/> +</any>]]></programlisting> + + </sect2> + + <sect2 id="inheritace-mixingpolymorphism"> + <title>Mezclando polimorfismo implícito con otros mapeos de herencia</title> + + <para> + Hay una cosa más por notar acerca de este mapeo. Ya que las subclases se mapean + cada una en su propio elemento <literal><class></literal> (y ya que + <literal>Payment</literal> es sólo una interface), cada una de las subclases + podría ser parte de otra jerarquía de herencia! (Y todavía puedes seguir usando + consultas polimórficas contra la interface <literal>Payment</literal>.) + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="CREDIT_CARD" type="string"/> + <property name="amount" column="CREDIT_AMOUNT"/> + ... + <subclass name="MasterCardPayment" discriminator-value="MDC"/> + <subclass name="VisaPayment" discriminator-value="VISA"/> +</class> + +<class name="NonelectronicTransaction" table="NONELECTRONIC_TXN"> + <id name="id" type="long" column="TXN_ID"> + <generator class="native"/> + </id> + ... + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CASH_AMOUNT"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + Una vez más, no mencionamos a <literal>Payment</literal> explícitamente. + Si ejecutamos una consulta contra la interface <literal>Payment</literal> + - por ejemplo, <literal>from Payment</literal> - Hibernate devuelve + automáticamente instancias de <literal>CreditCardPayment</literal> + (y sus subclases, ya que ellas también implementan <literal>Payment</literal>), + <literal>CashPayment</literal> y <literal>ChequePayment</literal> pero + no instancias de <literal>NonelectronicTransaction</literal>. + </para> + + </sect2> + + </sect1> + + <sect1 id="inheritance-limitations"> + <title>Limitaciones</title> + + <para> + Existen ciertas limitaciones al enfoque de "polimorfismo implícito" en + la estrategia de mapeo de tabla por clase concreta. Existen limitaciones + algo menos restrictivas a los mapeos <literal><union-subclass></literal>. + </para> + + <para> + La siguiente tabla muestra las limitaciones de mapeos de tabla por + clase concreta, y de polmorfismo implícito, en Hibernate. + </para> + + <table frame="topbot"> + <title>Funcionalidades de mapeo de herencia</title> + <tgroup cols='8' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <colspec colname='c6' colwidth="1*"/> + <colspec colname='c7' colwidth="1*"/> + <colspec colname='c8' colwidth="1*"/> + <thead> + <row> + <entry>Estrategia de herencia</entry> + <entry>muchos-a-uno polimórfica</entry> + <entry>uno-a-uno polimórfica</entry> + <entry>uno-a-muchos polimórfica</entry> + <entry>mushos-a-muchos polimórfica</entry> + <entry><literal>load()/get()</literal> polimórficos</entry> + <entry>Consultas polimórficas</entry> + <entry>Uniones polimórficas</entry> + <entry>Recuperación por unión externa (outer join)</entry> + </row> + </thead> + <tbody> + <row> + <entry>tabla por jerarquía de clases</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal></entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>soportada</emphasis></entry> + </row> + <row> + <entry>tabla por subclase</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal></entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>soportada</emphasis></entry> + </row> + <row> + <entry>tabla por clase concreta (union-subclass)</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal> (para <literal>inverse="true"</literal> solamente)</entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>soportada</emphasis></entry> + </row> + <row> + <entry>tabla por clase concreta (polimorfismo implícito)</entry> + <entry><literal><any></literal></entry> + <entry><emphasis>no soportada</emphasis></entry> + <entry><emphasis>no soportada</emphasis></entry> + <entry><literal><many-to-any></literal></entry> + <entry><literal>s.createCriteria(Payment.class).add( Restrictions.idEq(id) ).uniqueResult()</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><emphasis>no suportadas</emphasis></entry> + <entry><emphasis>no soportada</emphasis></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/performance.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/performance.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/performance.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/performance.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,1334 @@ +<chapter id="performance"> + <title>Mejorando el rendimiento</title> + + <sect1 id="performance-fetching"> + <title>Estrategias de recuperación</title> + + <para> + Una <emphasis>estrategia de recuperación</emphasis> es la estrategia que usará Hibernate para recuperar + los objetos asociados cuando la aplicación necesite navegar la asociación. Las estrategias de recuperación + pueden ser declaradas en los metadatos de mapeo O/R, o sobrescritas por una consulta HQL o + <literal>Criteria</literal> en particular. + </para> + + <para> + Hibernate3 define las siguientes estrategias de recuperación: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Recuperación por unión (join fetching)</emphasis> - Hibernate recupera la + instancia asociada o colección en la misma <literal>SELECT</literal>, usando una + <literal>OUTER JOIN</literal>. + </para> + </listitem> + <listitem> + <para> + <emphasis>Recuperación por selección (select fetching)</emphasis> - se usa una segunda + <literal>SELECT</literal> para recuperar la entidad asociada o colección. A menos que + deshabilites explícitamente la recuperación perezosa especificando <literal>lazy="false"</literal>, + la segunda selección sólo será ejecutada cuando realmente accedas a la asociación. + </para> + </listitem> + <listitem> + <para> + <emphasis>Recuperación por subselección (subselect fetching)</emphasis> - se usa una segunda + <literal>SELECT</literal> para recuperar las colecciones asociadas de todas las entidades + recuperadas en una consulta o recuperación previa. A menos que deshabilites explícitamente la + recuperación perezosa especificando <literal>lazy="false"</literal>, esta segunda selección sólo + será ejecutada cuando realmente accedas a la asociación. + </para> + </listitem> + <listitem> + <para> + <emphasis>Recuperación en lote</emphasis> - una estrategia de optimización para la recuperación + por selección - Hibernate recupera un lote de instancias de entidad o colecciones en una sola + <literal>SELECT</literal>, especificando una lista de claves primarias o de claves foráneas. + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate también distingue entre: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Recuperación inmediata</emphasis> - una asociación, colección o atributo es recuperado + inmediatamente, cuando el dueño es cargado. + </para> + </listitem> + <listitem> + <para> + <emphasis>Recuperación perezosa de colecciones</emphasis> - se recupera una colección cuando la + aplicación invoca una operación sobre la colección. (Esto es por defecto para las colecciones.) + </para> + </listitem> + <listitem> + <para> + <emphasis>Recuperación por proxy</emphasis> - se recupera una asociación monovaluada cuando se + invoca un método que no sea el getter del identificador sobre el objeto asociado. + </para> + </listitem> + <listitem> + <para> + <emphasis>Recuperación perezosa de atributos</emphasis> - se recupera un atributo o una asociación + monovaluada cuando se accede a la variable de instancia (requiere instrumentación del bytecode en + tiempo de ejecución). Este enfoque es raramente necesario. + </para> + </listitem> + </itemizedlist> + + <para> + Aquí tenemos dos nociones ortogonales: <emphasis>cuándo</emphasis> se recupera la aplicación, + y <emphasis>cómo</emphasis> es recuperada (qué SQL es usado). ¡No las confundas! Usamos + <literal>fetch</literal> para afinar el rendimiento. Podemos usar <literal>lazy</literal> para + definir un contrato sobre qué datos están siempre disponibles en cualquier instancia separada de + una clase en particular. + </para> + + <sect2 id="performance-fetching-lazy"> + <title>Trabajando con asociaciones perezosas</title> + + <para> + Por defecto, Hibernate3 usa una recuperación perezosa por selección para colecciones + y una recuperación por proxy perezosa para asociaciones monovaluadas. Estas políticas por + defecto tienen sentido para casi todas las asociaciones en casi todas las aplicaciones. + </para> + + <para> + <emphasis>Nota:</emphasis> si estableces <literal>hibernate.default_batch_fetch_size</literal>, Hibernate + usará la optimización de recuperación en lotes para recuperación perezosa (esta optimización también puede + ser habilitada a un nivel más granularizado). + </para> + + <para> + Sin embargo, la recuperación perezosa plantea un problema del que tienes que estar al tanto. Acceder + a una asociación perezosa fuera del contexto de una sesión de Hibernate abierta resultará en una + excepción. Por ejemplo: + </para> + + <programlisting><![CDATA[s = sessions.openSession(); +Transaction tx = s.beginTransaction(); + +User u = (User) s.createQuery("from User u where u.name=:userName") + .setString("userName", userName).uniqueResult(); +Map permissions = u.getPermissions(); + +tx.commit(); +s.close(); + +Integer accessLevel = (Integer) permissions.get("accounts"); // Error!]]></programlisting> + + <para> + Ya que la colección de permisos no fue inicializada cuando se cerró la <literal>Session</literal>, + la colección no será capaz de cargar su estado. <emphasis>Hibernate no soporta la inicialización + perezosa de objetos separados</emphasis>. La solución es mover el código que lee de la colección + a justo antes que la transacción sea comprometida. + </para> + + <para> + Alternativamente, podríamos usar una colección no perezosa o asociación, especificando + <literal>lazy="false"</literal> para el mapeo de asociación. Sin embargo, está pensado + que la inicialización perezosa sea usada para casi todas las colecciones y asociaciones. + ¡Si defines demasiadas asociaciones no perezosas en tu modelo de objetos, Hibernate terminará + necesitando recuperar la base de datos entera en cada transacción! + </para> + + <para> + Por otro lado, frecuentemente necesitamos elegir la recuperación por unión (que es no perezosa + por naturaleza) en vez de la recuperación por selección en una transacción en particular. Veremos + ahora cómo personalizar la estrategia de recuperación. En Hibernate3, los mecanismos para elegir una + estrategia de recuperación son idénticas a las de las asociaciones monovaluadas y colecciones. + </para> + + </sect2> + + <sect2 id="performance-fetching-custom" revision="3"> + <title>Afinando las estrategias de recuperación</title> + + <para> + La recuperación por selección (la preestablecida) es extremadamente vulnerable a problemas de + selección N+1, de modo querríamos habilitar la recuperación por unión (join fetching) en el + documento de mapeo: + </para> + + <programlisting><![CDATA[<set name="permissions" + fetch="join"> + <key column="userId"/> + <one-to-many class="Permission"/> +</set]]></programlisting> + + <programlisting><![CDATA[<many-to-one name="mother" class="Cat" fetch="join"/>]]></programlisting> + + <para> + La estrategia de recuperación definida en el documento de mapeo afecta a: + </para> + + <itemizedlist> + <listitem> + <para> + las recuperaciones vía <literal>get()</literal> o <literal>load()</literal> + </para> + </listitem> + <listitem> + <para> + las recuperaciones que ocurren implícitamente cuando se navega una asociación + (recuperación perezosa) + </para> + </listitem> + <listitem> + <para> + las consultas de <literal>Criteria</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Usualmente, no usamos el documento de mapeo para personalizar la recuperación. En cambio, mantenemos el + comportamiento por defecto, y lo sobrescribimos para una transacción en particular, usando + <literal>left join fetch</literal> en HQL. Esto le dice a Hibernate que recupere la asociación + tempranamente en la primera selección, usando una unión externa. En la API de consulta de + <literal>Criteria</literal>, usarías <literal>setFetchMode(FetchMode.JOIN)</literal>. + </para> + + <para> + Si acaso lo deseases, podrías cambiar la estrategia de recuperación usada por + <literal>get()</literal> or <literal>load()</literal>; simplemente usa una consulta + <literal>Criteria</literal>, por ejemplo: + </para> + + <programlisting><![CDATA[User user = (User) session.createCriteria(User.class) + .setFetchMode("permissions", FetchMode.JOIN) + .add( Restrictions.idEq(userId) ) + .uniqueResult();]]></programlisting> + + <para> + (Esto es el equivalente de Hibernate de lo que otras soluciones ORM llaman un "plan de recuperación".) + </para> + + <para> + Una forma completamente diferente de evitar problemas con selecciones N+1 es usar el caché de + segundo nivel. + </para> + + </sect2> + + <sect2 id="performance-fetching-proxies" revision="2"> + <title>Proxies de asociaciones de un solo extremo</title> + + <para> + La recuperación perezosa de colecciones está implementada usando la implementación de colecciones + persistentes propia de Hibernate. Sin embargo, se necesita un mecanismo diferente para un comportamiento + perezoso en las asociaciones de un solo extremo. La entidad objetivo de la asociación debe ser tratada + con proxies. Hibernate implementa proxies de inicialización perezosa para objetos persistentes usando + mejora del bytecode en tiempo de ejecución (por medio de la excelente biblioteca CGLIB). + </para> + + <para> + Por defecto, Hibernate3 genera proxies (en el arranque) para todas las clases persistentes y los usa + para habilitar la recuperación perezosa de asociaciones <literal>muchos-a-uno</literal> y + <literal>uno-a-uno</literal>. + </para> + + <para> + El fichero de mapeo puede declarar una interface a usar como interface de proxy para esa clase, + con el atributo <literal>proxy</literal>. Por defecto, Hibernate usa una subclase de la clase. + <emphasis>Nota que la clase tratada con proxies debe implementar un constructor por defecto con al + menos visibilidad de paquete. ¡Recomendamos este constructor para todas las clases persistentes!</emphasis> + </para> + + <para> + Hay algunos puntos a tener en cuenta al extender este enfoque a clases polimórficas, por ejemplo. + </para> + + <programlisting><![CDATA[<class name="Cat" proxy="Cat"> + ...... + <subclass name="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + Primero, las instancias de <literal>Cat</literal> nunca serán objeto de un cast a + <literal>DomesticCat</literal>, incluso aunque la instancia subyacente sea instancia de + <literal>DomesticCat</literal>: + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instantiate a proxy (does not hit the db) +if ( cat.isDomesticCat() ) { // hit the db to initialize the proxy + DomesticCat dc = (DomesticCat) cat; // Error! + .... +}]]></programlisting> + + <para> + Segundo, es posible romper con el operador <literal>==</literal> de un proxy. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instantiate a Cat proxy +DomesticCat dc = + (DomesticCat) session.load(DomesticCat.class, id); // acquire new DomesticCat proxy! +System.out.println(cat==dc); // false]]></programlisting> + + <para> + Sin embargo, la situación no en absoluta tan mala como parece. Aunque tenemos ahora dos referencias + a objetos proxy diferentes, la instancia subyacente será aún el mismo objeto: + </para> + + <programlisting><![CDATA[cat.setWeight(11.0); // hit the db to initialize the proxy +System.out.println( dc.getWeight() ); // 11.0]]></programlisting> + + <para> + Tercero, no debes usar un proxy CGLIB para una clase <literal>final</literal> o una clase + con algún método <literal>final</literal>. + </para> + + <para> + Finalmente, si tu objeto persistente adquiere cualquier recurso bajo instanciación + (por ejemplo, en inicializadores o constructores por defecto), entonces esos recursos + serán adquiridos también por el proxy. La clase del proxy es una subclase real de la clase + persistente. + </para> + + <para> + Estos problemas se deben a limitaciones fundamentales en el modelo de herencia única de Java. + Si deseas evitar estos problemas cada una de tus clases persistentes deben implementar una + interface que declare sus métodos de negocio. Debes especificar estas interfaces en el fichero + de mapeo. Por ejemplo: + </para> + + <programlisting><![CDATA[<class name="CatImpl" proxy="Cat"> + ...... + <subclass name="DomesticCatImpl" proxy="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + donde <literal>CatImpl</literal> implementa la interface <literal>Cat</literal> y + <literal>DomesticCatImpl</literal> implementa la interface <literal>DomesticCat</literal>. + Entonces <literal>load()</literal> o <literal>iterate()</literal> pueden devolver instancias de + <literal>Cat</literal> y <literal>DomesticCat</literal>. (Nota que <literal>list()</literal> + usualmente no devuelve proxies.) + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(CatImpl.class, catid); +Iterator iter = session.createQuery("from CatImpl as cat where cat.name='fritz'").iterate(); +Cat fritz = (Cat) iter.next();]]></programlisting> + + <para> + Las relaciones también son inicializadas perezosamente. Esto significa que debes declarar + cualquier propiedad como de tipo <literal>Cat</literal>, no <literal>CatImpl</literal>. + </para> + + <para> + Ciertas operaciones <emphasis>no</emphasis> requieren inicialización de proxies. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>equals()</literal>, si la clase persistente no sobrescribe <literal>equals()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hashCode()</literal>, si la clase persistente no sobrescribe + <literal>hashCode()</literal> + </para> + </listitem> + <listitem> + <para> + El método getter del identificador + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate detectará las clase persistentes que sobrescriban <literal>equals()</literal> o + <literal>hashCode()</literal>. + </para> + + </sect2> + + <sect2 id="performance-fetching-initialization"> + <title>Inicializando colecciones y proxies</title> + + <para> + Una <literal>LazyInitializationException</literal> será lanzada por Hibernate si una colección + o proxy sin inicializar es accedido fuera del ámbito de la <literal>Session</literal>, es decir, + cuando la entidad que posee la colección o que tiene la referencia al proxy esté en el estado + separada. + </para> + + <para> + A veces necesitamos asegurarnos que un proxy o colección esté inicializado antes de cerrar la + <literal>Session</literal>. Por supuesto, siempre podemos forzar la inicialización llamando a + <literal>cat.getSex()</literal> o <literal>cat.getKittens().size()</literal>, por ejemplo. + Pero esto es confuso a lectores del código y no es conveniente para código genérico. + </para> + + <para> + Los métodos estáticos <literal>Hibernate.initialize()</literal> y + <literal>Hibernate.isInitialized()</literal> proveen a la aplicación de una forma conveniente de + trabajar con colecciones o proxies inicializados perezosamente. + <literal>Hibernate.initialize(cat)</literal> forzará la inicialización de un proxy, + <literal>cat</literal>, en tanto su <literal>Session</literal> esté todavía abierta. + <literal>Hibernate.initialize( cat.getKittens() )</literal> tiene un efecto similar para la colección + de gatitos. + </para> + + <para> + Otra opción es mantener la <literal>Session</literal> abierta hasta que todas las colecciones + y proxies necesarios hayan sido cargados. En algunas arquitecturas de aplicación, particularmente + en aquellas donde el código que accede a los datos usando Hibernate, y el código que los usa están + en capas de aplicación diferentes o procesos físicos diferentes, puede ser un problema asegurar que + la <literal>Session</literal> esté abierta cuando se inicializa una colección. Existen dos formas + básicas de tratar este tema: + </para> + + <itemizedlist> + <listitem> + <para> + En una aplicación basada web, puede usarse un filtro de servlets para cerrar la + <literal>Session</literal> sólo bien al final de una petición de usuario, una + vez que el rendering de la vista esté completa (el patrón <emphasis>Sesión Abierta en + Vista (Open Session in View)</emphasis>). Por supuesto, estos sitios requieren una + fuerte demanda de corrección del manejo de excepciones de tu infraestructura de + aplicación. Es de una importancia vital que la <literal>Session</literal> esté + cerrada y la transacción terminada antes de volver al usuario, incluso cuando ocurra + una excepción durante el rendering de la página. Para este enfoque, el filtro de servlet tiene + que ser capaz de accceder la <literal>Session</literal>. Recomendamos que se use una variable + <literal>ThreadLocal</literal> para tener la <literal>Session</literal> actual (ver + el capítulo 1, <xref linkend="quickstart-playingwithcats"/>, para una implementación de ejemplo). + </para> + </listitem> + <listitem> + <para> + En una aplciación con una grada de negocios separada, la lógica de negocio debe "preparar" + todas las colecciones que se vayan a necesitar por la grada web antes de volver. + Esto significa que la grada de negocios debe cargar todos los datos y devolver a la grada de + presentación web todos los datos que se requieran para un caso de uso en particular + ya inicializados. Usualmente, la aplicación llama a <literal>Hibernate.initialize()</literal> + para cada colección que se necesitará en la grada web (esta llamada debe ocurrir antes que la + sesión sea cerrada) o recupera la colección tempranamente usando una consulta de Hibernate con una + cláusula <literal>FETCH</literal> o una <literal>FetchMode.JOIN</literal> en + <literal>Criteria</literal>. Esto es usualmente más fácil si adoptas el patrón + <emphasis>Comando</emphasis> en vez de un <emphasis>Fachada de Sesión</emphasis>. + </para> + </listitem> + <listitem> + <para> + Puedes también adjuntar un objeto cargado previamente a una nueva <literal>Session</literal> + con <literal>merge()</literal> o <literal>lock()</literal> antes de acceder a colecciones + no inicializadas (u otros proxies). ¡No, Hibernate no, y ciertamente <emphasis>no + debe</emphasis> hacer esto automáticamente, ya que introduciría semánticas de transacción ad hoc! + </para> + </listitem> + </itemizedlist> + + <para> + A veces no quieres inicializar una colección grande, pero necesitas aún alguna informacion sobre + ella (como su tamaño) o un subconjunto de los datos. + </para> + + <para> + Puedes usar un filtro de colecciones para obtener el tamaño de una colección sin inicializarla: + </para> + + <programlisting><![CDATA[( (Integer) s.createFilter( collection, "select count(*)" ).list().get(0) ).intValue()]]></programlisting> + + <para> + El método <literal>createFilter()</literal> se usa también para recuperar eficientemente subconjuntos + de una colección sin necesidad de inicializar toda la colección: + </para> + + <programlisting><![CDATA[s.createFilter( lazyCollection, "").setFirstResult(0).setMaxResults(10).list();]]></programlisting> + + </sect2> + + <sect2 id="performance-fetching-batch"> + <title>Usando recuperación en lotes</title> + + <para> + Hibernate puede hacer un uso eficiente de la recuperación en lotes, esto es, Hibernate puede cargar + muchos proxies sin inicializar si se accede a un proxy (o colecciones). La recuperación en lotes es una + optimización de la estrategia de recuperación por selección perezosa. Hay dos formas en que puedes afinar + la recuperación en lotes: a nivel de la clase o de la colección. + </para> + + <para> + La recuperación en lotes para clases/entidades es más fácil de entender. Imagina que tienes la siguiente + situación en tiempo de ejecución: Tienes 25 instancias de <literal>Cat</literal> cargadas en una + <literal>Session</literal>, cada <literal>Cat</literal> tiene una referencia a su <literal>owner</literal>, + una <literal>Person</literal>. La clase <literal>Person</literal> está mapeada con un proxy, + <literal>lazy="true"</literal>. Si ahora iteras a través de todos los gatos y llamas a + <literal>getOwner()</literal> para cada uno, Hibernate por defecto ejecutará 25 sentencias + <literal>SELECT</literal> para traer los dueños tratados con proxies. Puedes afinar este comportamiento + especificando un <literal>batch-size</literal> en el mapeo de <literal>Person</literal>: + </para> + + <programlisting><![CDATA[<class name="Person" batch-size="10">...</class>]]></programlisting> + + <para> + Hibernate ahora ejecutará sólo tres consultas, el patrón es 10, 10, 5. + </para> + + <para> + También puedes habilitar la recuperación en lotes para colecciones. Por ejemplo, si cada + <literal>Person</literal> tiene una colección perezosa de <literal>Cat</literal>s, y hay 10 + personas actualmente cargadas en la <literal>Session</literal>, iterar a través de las 10 personas + generará 10 <literal>SELECT</literal>s, una para cada llamada a <literal>getCats()</literal>. + Si habilitas la recuperación en lotes para la colección de <literal>cats</literal> en el mapeo de + <literal>Person</literal>, Hibernate puede recuperar por adelantado las colecciones: + </para> + + <programlisting><![CDATA[<class name="Person"> + <set name="cats" batch-size="3"> + ... + </set> +</class>]]></programlisting> + + <para> + Con un <literal>batch-size</literal> de 3, Hibernate cargará 3, 3, 3, 1 colecciones en cuatro + <literal>SELECT</literal>s. Una vez más, el valor del atributo depende del número esperado de + colecciones sin inicializar en una <literal>Session</literal> en particular. + </para> + + <para> + La recuperación de coleccione en lotes es particularmente útil si tienes un árbol anidado de + ítems, es decir, el típico patrón de cuenta de materiales. (Aunque un <emphasis>conjunto + anidado</emphasis> o una <emphasis>ruta materializada</emphasis> podría ser una mejor opción + para árboles que sean de lectura en la mayoría de los casos.) + </para> + + </sect2> + + <sect2 id="performance-fetching-subselect"> + <title>Usando recuperación por subselección</title> + + <para> + Si una colección perezosa o proxy monovaluado tiene que ser recuperado, Hibernate los carga a todos, + volviendo a ejecutar la consulta original en una subselección. Esto funciona de la misma forma que + la recuperación en lotes, sin carga fragmentaria. + </para> + +  + + </sect2> + + <sect2 id="performance-fetching-lazyproperties"> + <title>Usando recuperación perezosa de propiedades</title> + + <para> + Hibernate3 soporta la recuperación perezosa de propiedades individuales. Esta técnica de optimización + es también conocida como <emphasis>grupos de recuperación (fetch groups)</emphasis>. Por favor, nota + que éste es mayormente un aspecto de marketing, ya que en la práctica, optimizar lecturas de filas es + mucho más importante que la optimización de lectura de columnas. Sin embargo, cargar sólo algunas + propiedades de una clase podría ser útil en casos extremos, cuando tablas heredadas tienen cientos de + columnas y el modelo de datos no puede ser mejorado. + </para> + + <para> + Para habilitar la carga perezosa de propiedades, establece el atributo <literal>lazy</literal> en tus + mapeos de propiedades: + </para> + + <programlisting><![CDATA[<class name="Document"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name" not-null="true" length="50"/> + <property name="summary" not-null="true" length="200" lazy="true"/> + <property name="text" not-null="true" length="2000" lazy="true"/> +</class>]]></programlisting> + + <para> + ¡La carga perezosa de propiedades requiere la instrumentación del bytecode en tiempo + de construcción! Si tus clases persistentes no son mejoradas, Hibernate ignorará silenciosamente + la configuración perezosa de propiedades y caerá en recuperación inmediata. + </para> + + <para> + Para la instrumentación del bytecode, usa la siguiente tarea Ant: + </para> + + <programlisting><![CDATA[<target name="instrument" depends="compile"> + <taskdef name="instrument" classname="org.hibernate.tool.instrument.InstrumentTask"> + <classpath path="${jar.path}"/> + <classpath path="${classes.dir}"/> + <classpath refid="lib.class.path"/> + </taskdef> + + <instrument verbose="true"> + <fileset dir="${testclasses.dir}/org/hibernate/auction/model"> + <include name="*.class"/> + </fileset> + </instrument> +</target>]]></programlisting> + + <para> + Una forma diferente (¿mejor?) de evitar lecturas innecesarias de columnas, al menos para + transacciones de sólo lectura es usar las funcionalidades de proyección de consultas HQL o Criteria. + Esto evita la necesidad de procesar el bytecode en tiempo de construcción y ciertamente es una solución + preferida. + </para> + + <para> + Puedes forzar la usual recuperación temprana de propiedades usando <literal>fetch all properties</literal> + en HQL. + </para> + + </sect2> + + </sect1> + + <sect1 id="performance-cache" revision="1"> + <title>El Caché de Segundo Nivel</title> + + <para> + Una <literal>Session</literal> de Hibernate es una caché de datos persistentes a nivel de transacción. + Es posible configurar un cluster o caché a nivel de JVM (a nivel de <literal>SessionFactory</literal>) + sobre una base de clase-a-clase o colección-a-colección. Puedes incluso enchufar una caché en cluster. + Sé cuidadoso. Las cachés nunca están al tanto de los cambios hechos por otra aplicación al almacén persistente + (aunque pueden ser configurados para expirar regularmente los datos en caché). + </para> + + <para> + Por defecto, Hibernate usa EHCache para caching a nivel de JVM. (El soporte a JCS ahora está despreciado + y será quitado en una futura versión de Hibernate.) Puedes elegir una implementación diferente estableciendo + el nombre de una clase que implemente <literal>org.hibernate.cache.CacheProvider</literal> usando la propiedad + <literal>hibernate.cache.provider_class</literal>. + </para> + + <table frame="topbot" id="cacheproviders" revision="1"> + <title>Proveedores de Caché</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Caché</entry> + <entry>clase del Provedor</entry> + <entry>Tipo</entry> + <entry>Cluster Seguro</entry> + <entry>Caché de Consultas Soportado</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (no pensado para uso en producción)</entry> + <entry><literal>org.hibernate.cache.HashtableCacheProvider</literal></entry> + <entry>memoria</entry> + <entry></entry> + <entry>sí</entry> + </row> + <row> + <entry>EHCache</entry> + <entry><literal>org.hibernate.cache.EhCacheProvider</literal></entry> + <entry>memoria, disco</entry> + <entry></entry> + <entry>sí</entry> + </row> + <row> + <entry>OSCache</entry> + <entry><literal>org.hibernate.cache.OSCacheProvider</literal></entry> + <entry>memoria, disco</entry> + <entry></entry> + <entry>sí</entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry><literal>org.hibernate.cache.SwarmCacheProvider</literal></entry> + <entry>clusterizado (ip multicast)</entry> + <entry>sí (invalidación en cluster)</entry> + <entry></entry> + </row> + <row> + <entry>TreeCache de JBoss</entry> + <entry><literal>org.hibernate.cache.TreeCacheProvider</literal></entry> + <entry>clusterizado (ip multicast), transaccional</entry> + <entry>sí (replicación)</entry> + <entry>sí (requiere sincronización de reloj)</entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="performance-cache-mapping"> + <title>Mapeos de caché</title> + + <para> + El elemento <literal><cache></literal> de una mapeo de clase o colección tiene la siguiente + forma: + </para> + + <programlistingco> + <areaspec> + <area id="cache1" coords="2 70"/> + </areaspec> + <programlisting><![CDATA[<cache + usage="transactional|read-write|nonstrict-read-write|read-only" +/>]]></programlisting> + <calloutlist> + <callout arearefs="cache1"> + <para> + <literal>usage</literal> especifica la estrategia de caching: + <literal>transactional</literal>, + <literal>read-write</literal>, + <literal>nonstrict-read-write</literal> o + <literal>read-only</literal> + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Alternativamente (¿preferiblemente?), puedes especificar los elementos + <literal><class-cache></literal> y <literal><collection-cache></literal> en + <literal>hibernate.cfg.xml</literal>. + </para> + + <para> + El atributo <literal>usage</literal> especifica una <emphasis>estrategia de concurrencia al + caché</emphasis>. + </para> + + </sect2> + + <sect2 id="performance-cache-readonly"> + <title>Estrategia: sólo lectura (read only)</title> + + <para> + Si tu aplicación necesita leer pero nunca modificar las instancias de una clase persistente, + puede usarse un caché <literal>read-only</literal>. Esta es la mejor y más simple estrategia. + Es incluso perfectamente segura de usar en un cluster. + </para> + + <programlisting><![CDATA[<class name="eg.Immutable" mutable="false"> + <cache usage="read-only"/> + .... +</class>]]></programlisting> + + </sect2> + + + <sect2 id="performance-cache-readwrite"> + <title>Estrategia: lectura/escritura (read/write)</title> + + <para> + Si la aplicación necesita actualizar datos, un caché <literal>read-write</literal> podría ser apropiado. + Esta estrategia de caché nunca debe ser usada si se requiere nivel de aislamiento serializable de + transacciones. Si el caché es usado en un entorno JTA, debes especificar la propiedad + <literal>hibernate.transaction.manager_lookup_class</literal>, mencionando una estrategia para obtener + el <literal>TransactionManager</literal> de JTA. En otros entornos, debes asegurarte que la transacción + esté completada cuando se llame a <literal>Session.close()</literal> o + <literal>Session.disconnect()</literal>. Si deseas usar esta estrategia en un cluster, debes asegurarte + que la implementación de caché subyacente soporta bloqueos. Los provedores de caché internos + predeterminados <emphasis>no</emphasis> no lo soportan. + </para> + + <programlisting><![CDATA[<class name="eg.Cat" .... > + <cache usage="read-write"/> + .... + <set name="kittens" ... > + <cache usage="read-write"/> + .... + </set> +</class>]]></programlisting> + + </sect2> + + <sect2 id="performance-cache-nonstrict"> + <title>Estrategia: lectura/escritura no estricta (nonstrict read/write)</title> + + <para> + Si la aplicación necesita sólo ocasionalmente actualizar datos (es decir, es extremadamente inprobable + que dos transacciones intenten actualizar el mismo ítem simultáneamente) y no se requiere de un + aislamiento de transacciones estricto, un caché <literal>nonstrict-read-write</literal> podría ser + apropiado. Si se usa el caché en un entorno JTA, debes especificar + <literal>hibernate.transaction.manager_lookup_class</literal>. En otros entornos, debes asegurarte que la + transacción se haya completado cuando se llame a <literal>Session.close()</literal> o + <literal>Session.disconnect()</literal>. + </para> + + </sect2> + + <sect2 id="performance-cache-transactional"> + <title>Estrategia: transaccional</title> + + <para> + La estrategia de caché <literal>transactional</literal> brinda soporte a provedores de cachés + completamente transaccionales como TreeCache de JBoss. Un caché así, puede sólo ser usado en un + entorno JTA y debes especificar <literal>hibernate.transaction.manager_lookup_class</literal>. + </para> + + </sect2> + + <para> + Ninguno de los provedores de caché soporta todas las estrategias de concurrencia al caché. La siguiente + tabla muestra qué provedores son compatibles con qué estrategias de concurrencia. + </para> + + <table frame="topbot"> + <title>Soporte a Estrategia de Concurrencia a Caché</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Caché</entry> + <entry>read-only</entry> + <entry>nonstrict-read-write</entry> + <entry>read-write</entry> + <entry>transactional</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (no pensado para uso en producción)</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry></entry> + </row> + <row> + <entry>EHCache</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry></entry> + </row> + <row> + <entry>OSCache</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry></entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry>sí</entry> + <entry>sí</entry> + <entry></entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry>sí</entry> + <entry></entry> + <entry></entry> + <entry>sí</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + + <sect1 id="performance-sessioncache" revision="2"> + <title>Gestionando los cachés</title> + + <para> + Siempre que pases un objeto a <literal>save()</literal>, <literal>update()</literal> + o <literal>saveOrUpdate()</literal> y siempre que recuperes un objeto usando + <literal>load()</literal>, <literal>get()</literal>, <literal>list()</literal>, + <literal>iterate()</literal> o <literal>scroll()</literal>, ese objeto es agregado + al caché interno de la <literal>Session</literal>. + </para> + <para> + Cuando subsecuentemente se llame a <literal>flush()</literal>, el estado de ese objeto será + sincronizado con la base de datos. Si no quieres que ocurra esta sincronización o si estás + procesando un número enorme de objetos y necesitas gestionar la memoria eficientemente, + puede usarse el método <literal>evict()</literal> para quitar el objeto y sus colecciones + del caché de primer nivel. + </para> + + <programlisting><![CDATA[ScrollableResult cats = sess.createQuery("from Cat as cat").scroll(); //a huge result set +while ( cats.next() ) { + Cat cat = (Cat) cats.get(0); + doSomethingWithACat(cat); + sess.evict(cat); +}]]></programlisting> + + <para> + La <literal>Session</literal> también provee un método <literal>contains()</literal> para determinar + si una instancia pertenece al caché de la sesión. + </para> + + <para> + Para desahuciar (evict) todos los objetos del caché de sesión, llama a <literal>Session.clear()</literal>. + </para> + + <para> + Para el caché de segundo nivel, hay métodos definidos en <literal>SessionFactory</literal> para + desahuciar el estado en caché de una instancia, clase entera, instancia de colección o rol + enter de colección. + </para> + + <programlisting><![CDATA[sessionFactory.evict(Cat.class, catId); //evict a particular Cat +sessionFactory.evict(Cat.class); //evict all Cats +sessionFactory.evictCollection("Cat.kittens", catId); //evict a particular collection of kittens +sessionFactory.evictCollection("Cat.kittens"); //evict all kitten collections]]></programlisting> + + <para> + El <literal>CacheMode</literal> controla cómo una sesión en particular interactúa con el caché de segundo + nivel. + </para> + + <itemizedlist> + <listitem> + <para> + <literal>CacheMode.NORMAL</literal> - lee ítems desde y escribe ítems hacia el caché de segundo nivel + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.GET</literal> - lee ítems del caché de segundo nivel, pero no escribe al caché de + segundo nivel excepto al actualizar datos + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.PUT</literal> - escribe ítems al caché de segundo nivel, pero no lee del caché de segundo + nivel + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.REFRESH</literal> - escribe ítems al caché de segundo nivel, pero no lee del caché de + segundo nivel, saltándose el efecto de <literal>hibernate.cache.use_minimal_puts</literal>, forzando + un refresco del caché de segundo nivel para todos los ítems leídos de la base de datos + </para> + </listitem> + </itemizedlist> + + <para> + Para navegar por los contenidos de una región de caché de segundo nivel o de consultas, usa la API de + <literal>Statistics</literal>: + </para> + + <programlisting><![CDATA[Map cacheEntries = sessionFactory.getStatistics() + .getSecondLevelCacheStatistics(regionName) + .getEntries();]]></programlisting> + + <para> + Necesitarás habilitar las estadísticas y, opcionalmente, forzar a Hibernate para que guarde las + entradas del caché en un formato más entendible por humanos: + </para> + + <programlisting><![CDATA[hibernate.generate_statistics true +hibernate.cache.use_structured_entries true]]></programlisting> + + </sect1> + + <sect1 id="performance-querycache" revision="1"> + <title>El Caché de Consultas</title> + + <para> + Los conjuntos resultado de consultas también pueden tratarse en caché. Esto sólo es útil para + consultas que se ejecutan frecuentemente con los mismos parámetros. Para usar el caché de consultas + primero debes habilitarlo: + </para> + + <programlisting><![CDATA[hibernate.cache.use_query_cache true]]></programlisting> + + <para> + Esta configuración causa la creación de dos nuevas regiones de caché - una teniendo en caché + conjuntos resultado de consulta (<literal>org.hibernate.cache.StandardQueryCache</literal>), + el otro teniendo timestamps de las actualizaciones más recientes a tablas consultables + (<literal>org.hibernate.cache.UpdateTimestampsCache</literal>). Nota que el caché de consultas + no pone en caché el estado de las entidades reales en el conjunto resultado; sólo tiene en caché + valores indentificadores y resultados de tipo de valor. De modo que el caché de consultas siempre + debe ser usado en conjunción con el caché de segundo nivel. + </para> + + <para> + La mayoría de consultas no se benefician del tratamiento en caché, de modo que por defecto las + consultas no son tratadas en caché. Para habilitar el tratamiento en caché, llama a + <literal>Query.setCacheable(true)</literal>. Esta llamada permite a la consulta buscar + resultados existentes en caché o agregar sus resultados al caché cuando se ejecuta. + </para> + + <para> + Si requieres un control finamente granularizado sobre las políticas de expiración del caché de + consultas, puedes especificar una región de caché con nombre para una consulta en particular + llamando a <literal>Query.setCacheRegion()</literal>. + </para> + + <programlisting><![CDATA[List blogs = sess.createQuery("from Blog blog where blog.blogger = :blogger") + .setEntity("blogger", blogger) + .setMaxResults(15) + .setCacheable(true) + .setCacheRegion("frontpages") + .list();]]></programlisting> + + <para> + Si la consulta debe forzar un refresco de si región del caché de consultas, debes llamar a + <literal>Query.setCacheMode(CacheMode.REFRESH)</literal>. Esto es particularmente útil en casos donde + los datos subyacentes pueden haber sido actualizados por medio de un proceso separado (es decir, + no modificados a través de Hibernate) y permite a la aplicación refrescar selectivamente conjuntos + resultado de consultas en particular. Esto es una alternativa más eficient al desahuciamiento de una + región del caché de consultas vía <literal>SessionFactory.evictQueries()</literal>. + </para> + + </sect1> + + <sect1 id="performance-collections"> + <title>Entendiendo el rendimiento de Colecciones</title> + + <para> + Ya hemos llevado un buen tiempo hablando sobre colecciones. + En esta sección resaltaremos un par de temas más sobre cómo las colecciones + se comportan en tiempo de ejecución. + </para> + + <sect2 id="performance-collections-taxonomy"> + <title>Taxonomia</title> + + <para>Hibernate define tres tipos básicos de colecciones:</para> + + <itemizedlist> + <listitem> + <para>colecciones de valores</para> + </listitem> + <listitem> + <para>asociaciones uno a muchos</para> + </listitem> + <listitem> + <para>asociaciones muchos a muchos</para> + </listitem> + </itemizedlist> + + <para> + Esta clasificación distingue las varias tablas y relaciones de clave foránea pero no nos + dice absolutamente todo lo que necesitamos saber sobre el modelo relacional. Para entender + completamente la estructura relacional y las características de rendimiento, debemos considerar + la estructura de la clave primaria que es usada por Hibernate para actualizar o borrar filas de + colección. Esto sugiere la siguiente clasificación: + </para> + + <itemizedlist> + <listitem> + <para>colecciones indexadas</para> + </listitem> + <listitem> + <para>conjuntos (sets)</para> + </listitem> + <listitem> + <para>bolsas (bags)</para> + </listitem> + </itemizedlist> + + <para> + Todas las colecciones indexadas (mapas, listas, arrays) tienen una clave primaria + consistente de las columnas <literal><key></literal> y <literal><index></literal>. + En este caso las actualizaciones de colecciones son usualmente extremadamente eficientes. + La clave primaria puede ser indexada fácilmente y una fila en particular puede ser localizada + cuando Hibernate intenta actualizarla o borrarla. + </para> + + <para> + Los conjuntos (sets) tienen una clave primaria consistente en <literal><key></literal> + y columnas de elemento. Esto puede ser menos eficiente para algunos tipos de elemento de + colección, particularmente elementos compuestos o texto largo, o campos binarios. La base de datos + puede no ser capaz de indexar una clave primaria compleja eficientemente. Por otra parte, + para asociaciones uno a muchos o muchos a muchos, particularmente en el caso de identificadores + sintéticos, es probable que sólo sea tan eficiente. (Nota al márgen: si quieres que + <literal>SchemaExport</literal> realmente cree la clave primaria de un <literal><set></literal> + por ti, debes declarar todas las columnas como <literal>not-null="true"</literal>.) + </para> + + <para> + Los mapeos de <literal><idbag></literal> definen una clave delegada, de modo que siempre + resulten eficientes de actualizar. De hecho, son el mejor caso. + </para> + + <para> + Los bags son el peor caso. Ya que un bag permite valores de elementos duplicados y no tiene + ninguna columna índice, no puede definirse ninguna clave primaria. Hibernate no tiene forma de + distinguir entre filas duplicadas. Hibernate resuelve este problema quitando completamente + (en un solo <literal>DELETE</literal>) y recreando la colección siempre que cambia. + Esto podría ser muy ineficiente. + </para> + + <para> + Nota que para una asociación uno-a-muchos, la "clave primaria" puede no ser la clave + primaria física de la tabla de base de datos; pero incluso en este caso, la clasificación + anterior es útil todavía. (Aún refleja cómo Hibernate "localiza" filas individuales de la + colección.) + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficientupdate"> + <title>Las listas, mapas, idbags y conjuntos son las colecciones más eficientes de actualizar</title> + + <para> + Desde la discusión anterior, debe quedar claro que las colecciones indexadas y + (usualmente) los conjuntos permiten la operación más eficiente en términos de añadir, + quitar y actualizar elementos. + </para> + + <para> + Hay, discutiblemente, una ventaja más que las colecciones indexadas tienen sobre otros + conjuntos para las asociaciones muchos a muchos o colecciones de valores. Debido a la + estructura de un <literal>Set</literal>, Hibernate ni siquiera actualiza una fila con + <literal>UPDATE</literal> cuando se "cambia" un elemento. Los cambios a un <literal>Set</literal> + siempre funcionan por medio de <literal>INSERT</literal> y <literal>DELETE</literal> + (de filas individuales). Una vez más, esta consideración no se aplica a las asociaciones + uno a muchos. + </para> + + <para> + Después de observar que los arrays no pueden ser perezosos, podríamos concluir que las + listas, mapas e idbags son los tipos más eficientes de colecciones (no inversas), con los + conjuntos (sets) no muy por detrás. Se espera que los sets sean el tipo más común de colección + en las aplicaciones de Hibernate. Esto es debido a que la semántica de los sets es la más + natural en el modelo relacional. + </para> + + <para> + Sin embargo, en modelos de dominio de Hibernate bien dieñados, usualmente vemos que la mayoría + de las colecciones son de hecho asociaciones uno-a-muchos con <literal>inverse="true"</literal>. + Para estas asociaciones, la actualización es manejada por el extremo muchos-a-uno de la asociación, + y las consideraciones de este tipo sobre el rendimiento de actualización de colecciones simplemente + no se aplican. + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficentinverse"> + <title>Los Bags y las listas son las colecciones inversas más eficientes</title> + + <para> + Justo antes que tires a la zanja los bags para siempre, hay un caso en particular en el que + los bags son muchos más eficientes que los conjuntos. Para una colección con + <literal>inverse="true"</literal> (el idioma estándar de relaciones uno-a-muchos bidireccionales, + por ejemplo) ¡podemos añadir elementos a un bag o lista sin necesidad de inicializar (fetch) + los elementos del bag! Esto se debe a que <literal>Collection.add()</literal> o + <literal>Collection.addAll()</literal> siempre deben devolver true para un bag o <literal>List</literal> + (no como un <literal>Set</literal>). Esto puede hacer el siguiente código común mucho más rápido. + </para> + + <programlisting><![CDATA[Parent p = (Parent) sess.load(Parent.class, id); + Child c = new Child(); + c.setParent(p); + p.getChildren().add(c); //no need to fetch the collection! + sess.flush();]]></programlisting> + + </sect2> + + <sect2 id="performance-collections-oneshotdelete"> + <title>Borrado de un solo tiro</title> + + <para> + Ocasionalmente, borrar los elementos de una colección uno a uno puede ser extremadamente ineficiente. + Hibernate no es completamente estúpido, de modo que sabe no hacer eso, en el caso de una colección + nueva-vacía (si has llamado a <literal>list.clear()</literal>, por ejemplo). En este caso, Hibernate + publicará una sola <literal>DELETE</literal>, ¡y listo! + </para> + + <para> + Supón que añadimos un solo elemento a una colección de tamaño veinte y luego quitamos dos elementos. + Hibernate publicará una sentencia <literal>INSERT</literal> y dos sentencias <literal>DELETE</literal> + (a menos que la colección sea un bag). Esto es ciertamente deseable. + </para> + + <para> + Sin embargo, supón que quitamos dieciocho elementos, dejando dos y luego añadimos tres nuevos elementos. + Hay dos formas posibles de proceder + </para> + + <itemizedlist> + <listitem> + <para>borrar dieciocho filas una a una y luego insertar tres filas</para> + </listitem> + <listitem> + <para>quitar toda la colección (en un solo <literal>DELETE</literal> de SQL) e insertar todos los + cinco elementos actuales (uno a uno)</para> + </listitem> + </itemizedlist> + + <para> + Hibernate no es lo suficientemente inteligente para saber que la segunda opción es probablemente más + rápida en este caso. (Y que sería probablemente indeseable para Hibernate ser tan inteligente; + este comportamiento podría confundir a disparadores de base de datos, etc.) + </para> + + <para> + Afortunadamente, puedes forzar este comportamiento (es decir, la segunda estrategia) en cualquier + momento descartando (es decir, desreferenciando) la colección original y devolviendo una colección + nuevamente instanciada con todos los elementos actuales. Esto puede ser muy útil y potente de vez en + cuando. + </para> + + <para> + Por supuesto, el borrado-de-un-solo-tiro no se aplica a colecciones mapeadas + <literal>inverse="true"</literal>. + </para> + + </sect2> + + </sect1> + + <sect1 id="performance-monitoring" revision="1"> + <title>Monitoreando el rendimiento</title> + + <para> + La optimización no es de mucho uso sin el monitoreo y el acceso a números de rendimiento. Hibernate provee + un rango completo de figuras sobre sus operaciones internas. Las estadísticas en Hibernate están disponibles + por <literal>SessionFactory</literal>. + </para> + + <sect2 id="performance-monitoring-sf" revision="2"> + <title>Monitoreando una SessionFactory</title> + + <para> + Puedes acceder a las métricas de <literal>SessionFactory</literal> de dos formas. + Tu primera opción es llamar a <literal>sessionFactory.getStatistics()</literal> y + leer o mostrar por pantalla la <literal>Statistics</literal> por ti mismo. + </para> + + <para> + Hibernate puede también usar JMX para publicar las métricas si habilitas el MBean + <literal>StatisticsService</literal>. Puede habilitar un solo MBean para todas tus + <literal>SessionFactory</literal> o una por fábrica. Mira el siguiente código para + ejemplos de configuración minimalistas: + </para> + + <programlisting><![CDATA[// MBean service registration for a specific SessionFactory +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "myFinancialApp"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +stats.setSessionFactory(sessionFactory); // Bind the stats to a SessionFactory +server.registerMBean(stats, on); // Register the Mbean on the server]]></programlisting> + + +<programlisting><![CDATA[// MBean service registration for all SessionFactory's +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "all"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +server.registerMBean(stats, on); // Register the MBean on the server]]></programlisting> + + <para> + POR HACER: Esto no tiene sentido: En el primer caso, recuperamos y usamos el MBean directamente. + En el segundo, debemos proporcionar el nombre JNDI en el que se guarda la fábrica de sesiones antes + de usarlo. Usa <literal>hibernateStatsBean.setSessionFactoryJNDIName("my/JNDI/Name")</literal> + </para> + <para> + Puedes (des)activar el monitoreo de una <literal>SessionFactory</literal> + </para> + <itemizedlist> + <listitem> + <para> + en tiempo de configuración, establece <literal>hibernate.generate_statistics</literal> a + <literal>false</literal> + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + en tiempo de ejecución: <literal>sf.getStatistics().setStatisticsEnabled(true)</literal> + o <literal>hibernateStatsBean.setStatisticsEnabled(true)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Las estadísticas pueden ser reajustadas programáticamente usando el método <literal>clear()</literal>. + Puede enviarse un resumen a un logger (nivel info) usando el método <literal>logSummary()</literal>. + </para> + + </sect2> + + <sect2 id="performance-monitoring-metrics" revision="1"> + <title>Métricas</title> + + <para> + Hibernate provee un número de métricas, desde información muy básica a la especializada + sólo relevante en ciertos escenarios. Todos los contadores disponibles se describen en la + API de la interface <literal>Statistics</literal>, en tres categorías: + </para> + <itemizedlist> + <listitem> + <para> + Métricas relacionadas al uso general de <literal>Session</literal> usage, tales como + número de sesiones abiertas, conexiones JDBC recuperadas, etc, + </para> + </listitem> + <listitem> + <para> + Métricas relacionadas a las entidades, colecciones, consultas, y cachés como un todo. + (también conocidas como métricas globales). + </para> + </listitem> + <listitem> + <para> + Métricas detalladas relacionadas a una entidad, colección, consulta o región de caché + en particular. + </para> + </listitem> + </itemizedlist> + + <para> + Por ejemplo, puedes comprobar el acceso, pérdida, y radio de colocación de entidades, colecciones + y consultas en el caché, y el tiempo promedio que necesita una consulta. Ten en cuenta que el número + de milisegundos está sujeto a aproximación en Java. Hibernate está pegado a la precisión de la JVM, + en algunas plataformas esto podría incuso ser tener sólo una exactitud de 10 segundos. + </para> + + <para> + Se usan getters simples para acceder a las métricas globales (es decir, no pegadas a una entidad, + colección, región de caché, etc, en particular). Puedes acceder a las métricas de una entidad, + colección, región de caché en particular a través de su nombre, y a través de su representación HQL + o SQL para las consultas. Por favor refiérete al Javadoc de la API de <literal>Statistics</literal>, + <literal>EntityStatistics</literal>, <literal>CollectionStatistics</literal>, + <literal>SecondLevelCacheStatistics</literal>, y <literal>QueryStatistics</literal> para más información. + El siguiente código muestra un ejemplo sencillo: + </para> + + <programlisting><![CDATA[Statistics stats = HibernateUtil.sessionFactory.getStatistics(); + +double queryCacheHitCount = stats.getQueryCacheHitCount(); +double queryCacheMissCount = stats.getQueryCacheMissCount(); +double queryCacheHitRatio = + queryCacheHitCount / (queryCacheHitCount + queryCacheMissCount); + +log.info("Query Hit ratio:" + queryCacheHitRatio); + +EntityStatistics entityStats = + stats.getEntityStatistics( Cat.class.getName() ); +long changes = + entityStats.getInsertCount() + + entityStats.getUpdateCount() + + entityStats.getDeleteCount(); +log.info(Cat.class.getName() + " changed " + changes + "times" );]]></programlisting> + + <para> + Para trabajar sobre todas las entidades, colecciones, consultas y regiones de cachés, puedes recuperar la + lista de nombres de entidades, colecciones, consultas y regiones de cachés con los siguientes métodos: + <literal>getQueries()</literal>, <literal>getEntityNames()</literal>, + <literal>getCollectionRoleNames()</literal>, y <literal>getSecondLevelCacheRegionNames()</literal>. + </para> + + </sect2> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/persistent_classes.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/persistent_classes.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/persistent_classes.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/persistent_classes.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,478 @@ +<chapter id="persistent-classes" revision="2"> + <title>Clases Persistentes</title> + + <para> + Clases presistentes son clases en una aplicación que implementan las + entidades del problema de negocio (por ejemplo, Customer y Order en una + aplicación de comercio electrónico). No todas las instancias de una + clase persistente se considera que estén en el estado persistente, + una instancia puede en cambio ser transitoria o estar separada. + </para> + + <para> + Hibernate funciona mejor si las clases siguen algunas simples reglas, también + conocidas como el modelo de programación de Viejas Clases Java Planas + (Plain Old Java Object o POJO). Sin embargo, ninguna de estas reglas son + requerimientos rígidos. En cambio, Hibernate3 asume muy poco acerca de + la naturaleza de tus objetos persistentes. Puedes expresar un modelo de dominio en + otras formas: usando árboles de instancias de <literal>Map</literal>, + por ejemplo. + </para> + + <sect1 id="persistent-classes-pojo"> + <title>Un ejemplo simple de POJO</title> + + <para> + La mayoría de aplicaciones Java requieren una clase + representando felinos. + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +public class Cat { + private Long id; // identifier + + private Date birthdate; + private Color color; + private char sex; + private float weight; + private int litterId; + + private Cat mother; + private Set kittens = new HashSet(); + + private void setId(Long id) { + this.id=id; + } + public Long getId() { + return id; + } + + void setBirthdate(Date date) { + birthdate = date; + } + public Date getBirthdate() { + return birthdate; + } + + void setWeight(float weight) { + this.weight = weight; + } + public float getWeight() { + return weight; + } + + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + + void setSex(char sex) { + this.sex=sex; + } + public char getSex() { + return sex; + } + + void setLitterId(int id) { + this.litterId = id; + } + public int getLitterId() { + return litterId; + } + + void setMother(Cat mother) { + this.mother = mother; + } + public Cat getMother() { + return mother; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + public Set getKittens() { + return kittens; + } + + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kitten.setMother(this); + kitten.setLitterId( kittens.size() ); + kittens.add(kitten); + } +}]]></programlisting> + + <para> + Aquí hay cuatro reglas principales a seguir: + </para> + + <sect2 id="persistent-classes-pojo-constructor" revision="1"> + <title>Implementa un constructor sin argumentos</title> + + <para> + <literal>Cat</literal> tiene un contructor sin argumentos. Todas las clases persistentes + deben tener un constructor por defecto (que puede no ser público) de modo que Hibernate + pueda instanciarlas usando <literal>Constructor.newInstance()</literal>. Recomendamos fuertemente tener + un constructor por defecto con al menos visibilidad de <emphasis>package</emphasis> para la + generación de proxies en tiempo de ejecución en Hibernate. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-identifier" revision="2"> + <title>Provee una propiedad identificadora (opcional)</title> + + <para> + <literal>Cat</literal> tiene una propiedad llamada <literal>id</literal>. Esta + propiedad mapea a la columna clave primaria de la tabla de base de datos. La propiedad + podría llamarse cualquierCosa, y su tipo podría haber sido cualquier tipo + primitivo, cualquier tipo de "envoltura" primitivo, <literal>java.lang.String</literal> + o <literal>java.util.Date</literal>. (Si tu tabla de base de datos heredada tiene claves + compuestas, puedes incluso usar una clase definida por el usuario con propiedades de + estos tipos, ver la sección sobre identificadores compuestos luego.) + </para> + + <para> + La propiedad identificadora es estrictamente opcional. Puedes olvidarla y dejar que Hibernate + siga internamente la pista de los identificadores del objeto. Sin embargo, no recomendamos esto. + </para> + + <para> + De hecho, alguna funcionalidad está disponible sólo para clases que + declaran una propiedad identificadora: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Reasociación transitiva de objetos separados (actualizaciones o + fusiones en cascada) - ver <xref linkend="objectstate-transitive"/> + </para> + </listitem> + <listitem> + <para> + <literal>Session.saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>Session.merge()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Recomendamos que declares propiedades identificadoras nombradas-consistentemente + en clases persistentes. Mas aún, recomendamos que uses un tipo nulable + (es decir, no primitivo). + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-final"> + <title>Prefiere las clases no finales (opcional)</title> + <para> + Un aspecto central de Hibernate, <emphasis>proxies</emphasis>, depende de que + las clases persistentes sean ya no finales, o sean ya la implementación + de una interface que declare todos los métodos públicos. + </para> + <para> + Puedes persistir con Hibernate clases <literal>final</literal> que no implementen una + interface, pero no serás capaz de usar proxies para recuperación perezosa + de asociaciones, lo que limitará tus opciones para afinar el rendimiento. + </para> + <para> + Debes también evitar declarar métodos <literal>public final</literal> + en clases non-final. Si quieres usar una clase con un método <literal>public + final</literal>, debes deshabilitar explícitamente el uso de proxies estableciendo + <literal>lazy="false"</literal>. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-accessors" revision="2"> + <title>Declara métodos de acceso y modificación para los campos persistentes (opcional)</title> + <para> + <literal>Cat</literal> declara métodos de acceso para todos sus campos persistente. + Muchas otras herramientas ORM persisten directamente variables de instancia. Creemos que + es mejor proveer una indirección entre el esquema relacional y las estructuras internas de la clase. + Por defecto, Hibernate persiste propiedades del estilo JavaBeans, y reconoce nombres de método + de la forma <literal>getFoo</literal>, <literal>isFoo</literal> y <literal>setFoo</literal>. + Puedes cambiar a acceso directo a campos para propiedades en particular, de ser necesario. + </para> + + <para> + Las propiedades <emphasis>no</emphasis> necesitan ser declaradas públicas. Hibernate puede + persistir una propiedad con un par get / set <literal>protected</literal> o <literal>private</literal>. + </para> + </sect2> + </sect1> + + <sect1 id="persistent-classes-inheritance"> + <title>Implementando herencia</title> + + <para> + Una subclase puede a su vez observar la primera y segunda regla. Hereda su + propiedad identificadora de la superclase, <literal>Cat</literal>. + </para> + + <programlisting><![CDATA[package eg; + +public class DomesticCat extends Cat { + private String name; + + public String getName() { + return name; + } + protected void setName(String name) { + this.name=name; + } +}]]></programlisting> + </sect1> + + <sect1 id="persistent-classes-equalshashcode" revision="1"> + <title>Implementando <literal>equals()</literal> y <literal>hashCode()</literal></title> + + + <para> + Tienes que sobrescribir los métodos <literal>equals()</literal> y <literal>hashCode()</literal> + si : + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + piensas poner instancias de clases persistentes en un <literal>Set</literal> + (la forma recomendada de representar asociaciones multivaluadas) + <emphasis>y</emphasis> + </para> + </listitem> + <listitem> + <para> + piensas usar reasociación de instancias separadas. + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate garantiza la equivalencia de identidad persistente (fila de base de datos) y + identidad Java sólo dentro del ámbito de una sesión en particular. + De modo que en el momento que mezclamos instancias recuperadas en sesiones diferentes, + debemos implementar <literal>equals()</literal> y <literal>hashCode()</literal> si + deseamos tener una semántica significativa de <literal>Set</literal>s. + </para> + + <para> + La forma más obvia es implementar <literal>equals()</literal>/<literal>hashCode()</literal> + comparando el valor identificador de ambos objetos. Si el valor es el mismo, ambos deben ser + la misma fila de base de datos, por lo tanto son iguales (si ambos son agregados a un + <literal>Set</literal>, sólo tendremos un elemento en el <literal>Set</literal>). + Desafortunadamente, no podemos usar este enfoque con identificadores generados! Hibernate sólo + asignará valores identificadores a objetos que son persistentes, una instancia recién + creada no tendrá ningún valor identificador! Además, si una instancia no está + salvada y está actualmente en un <literal>Set</literal>, salvarla asignará un + valor identificador al objeto. Si <literal>equals()</literal> and <literal>hashCode()</literal> + están basados en el valor identificador, el código hash podría cambiar, + rompiendo el contrato de <literal>Set</literal>. Ver el sitio web de Hibernate para una + discusión completa de este problema. Observa que esto no es una incidencia de Hibernate, + sino la semántica normal de Java de identidad de objeto e igualdad. + </para> + + <para> + Recomendamos implementar <literal>equals()</literal> y <literal>hashCode()</literal> + usando <emphasis>igualdad de clave de negocio (Business key equality)</emphasis>. + Igualdad de clave de negocio significa que el método <literal>equals()</literal> + compara sólo las propiedades que forman la clave de negocio, una clave que podría + identificar nuestra instancia en el mundo real (una clave candidata + <emphasis>natural</emphasis>): + </para> + + <programlisting><![CDATA[public class Cat { + + ... + public boolean equals(Object other) { + if (this == other) return true; + if ( !(other instanceof Cat) ) return false; + + final Cat cat = (Cat) other; + + if ( !cat.getLitterId().equals( getLitterId() ) ) return false; + if ( !cat.getMother().equals( getMother() ) ) return false; + + return true; + } + + public int hashCode() { + int result; + result = getMother().hashCode(); + result = 29 * result + getLitterId(); + return result; + } + +}]]></programlisting> + + <para> + Nota que una clave de negocio no tiene que ser tan sólida como + una clave primaria candidata de base de datos (ver + <xref linkend="transactions-basics-identity"/>). Las propiedades inmutables o + únicas son usualmente buenas candidatas para una clave de negocio. + </para> + + </sect1> + + <sect1 id="persistent-classes-dynamicmodels"> + <title>Modelos dinámicos</title> + + <para> + <emphasis>Ten en cuenta que las siguientes funcionalidades están + consideradas actualmente experimentales y pueden cambiar en el futuro + cercano.</emphasis> + </para> + + <para> + Las entidades persistentes no necesariamente tienen que estar representadas + como clases POJO o como objetos JavaBean en tiempo de ejecución. Hibernate + soporta además modelos dinámicos (usando <literal>Map</literal>s de + <literal>Map</literal>s en tiempo de ejecución) y la representación + de entidades como árboles de DOM4J. Con este enfoque no escribes clases + persistentes, sólo ficheros de mapeo. + </para> + + <para> + Por defecto, Hibernate funciona en modo POJO normal. Puedes establecer una + representación de entidad por defecto para una <literal>SessionFactory</literal> + en particular usando la opción de configuración + <literal>default_entity_mode</literal> + (ver <xref linkend="configuration-optional-properties"/>). + </para> + + <para> + Los siguientes ejemplos demuestran la representación usando + <literal>Map</literal>s. Primero, en el fichero de mapeo, + tiene que declararse un <literal>entity-name</literal> en vez de + (o como agregado a) un nombre de clase: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class entity-name="Customer"> + + <id name="id" + type="long" + column="ID"> + <generator class="sequence"/> + </id> + + <property name="name" + column="NAME" + type="string"/> + + <property name="address" + column="ADDRESS" + type="string"/> + + <many-to-one name="organization" + column="ORGANIZATION_ID" + class="Organization"/> + + <bag name="orders" + inverse="true" + lazy="false" + cascade="all"> + <key column="CUSTOMER_ID"/> + <one-to-many class="Order"/> + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Ten en cuenta que aunque las asociaciones se declaran usando nombres + de clase objetivo, el tipo objetivo de una asociación puede + ser además una entidad dinámica en vez de un POJO. + </para> + + <para> + Después de establecer el modo de entidad por defecto a + <literal>dynamic-map</literal> para la <literal>SessionFactory</literal>, + podemos trabajar en tiempo de ejecución con <literal>Map</literal>s + de <literal>Map</literal>s: + </para> + + <programlisting><![CDATA[Session s = openSession(); +Transaction tx = s.beginTransaction(); +Session s = openSession(); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); + +// Create an organization +Map foobar = new HashMap(); +foobar.put("name", "Foobar Inc."); + +// Link both +david.put("organization", foobar); + +// Save both +s.save("Customer", david); +s.save("Organization", foobar); + +tx.commit(); +s.close();]]></programlisting> + + <para> + Las ventajas de un mapeo dinámico es rápido tiempo de ciclo + de prototipado sin la necesidad de implementación de clases de entidad. + Sin embargo, pierdes chequeo de tipos en tiempo de compilación y + muy probablemente tratarás con muchas excepciones en tiempo de ejecución. + Gracias al mapeo de Hibernate, el esquema de base de datos puede estar facilmente + sano y normalizado, permitiendo agregar una implementación apropiada del + modelo de dominio más tarde. + </para> + + <para> + Los modos de representación de entidad pueden ser establecidos + por <literal>Session</literal>: + </para> + + <programlisting><![CDATA[Session dynamicSession = pojoSession.getSession(EntityMode.MAP); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); +dynamicSession.save("Customer", david); +... +dynamicSession.flush(); +dynamicSession.close() +... +// Continue on pojoSession +]]></programlisting> + + + <para> + Por favor, ten en cuenta que la llamada a <literal>getSession()</literal> + usando un <literal>EntityMode</literal> está en la API de + <literal>Session</literal>, no en la de <literal>SessionFactory</literal>. + De esta forma, la nueva <literal>Session</literal> comparte la conexión + JDBC, transacción y otra información de contexto. Esto significa + que no tienes que llamar a <literal>flush()</literal> ni a <literal>close()</literal> + en la <literal>Session</literal> secundaria, y tembién dejar el manejo + de la transacción y de la conexión a la unidad de trabajo primaria. + </para> + + <para> + Puede encontrarse más información sobre las capacidades de + representación XML en <xref linkend="xml"/>. + </para> + + </sect1> + + <para> + PORHACER: Documentar el framework de extensiones del usuario en los paquetes + de propiedad y proxies. + </para> + +</chapter> + Added: core/trunk/documentation/manual/es-ES/src/main/docbook/content/preface.xml =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/preface.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/preface.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,112 @@ +<?xml version='1.0'?> + +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + + <preface id="preface" revision="2"> + <title>Prefacio</title> + + + <para> + Trabajar con software orientado a objetos y una base de datos relacional puede ser + incómodo y consumir tiempo en los entornos de empresa de hoy. Hibernate es una + herramienta de mapeo objeto/relacional para entornos Java. El término mapeo + objeto/relacional (MOR) hace referencia a la técnica de mapear una + representación de datos desde un modelo de objetos a un modelo de datos relacional + con un esquema basado en SQL. + </para> + + <para> + Hibernate no sólo se encarga de mapear de clases Java a tablas de base de datos + (y de tipos de datos de Java a tipos de datos SQL), sino que también provee + facilidades de consulta y recuperación de datos y puede reducir significativamente + el tiempo de desarrollo que de otra forma se gasta en el manejo de los datos en SQL y JDBC. + </para> + + <para> + La meta de Hibernate es relevar al desarrollador del 95 por ciento de las tareas comunes + relacionadas a la programación de la persistencia de los datos. + Hibernate puede no ser la mejor solución para aplicaciones que usan solamente + procedimientos almacenados para implementar la lógica de negocio en la base de + datos, es mas útil con modelos de dominio orientados a objetos y lógica de + negocio en middle-tier basada en Java. Sin embargo, Hibernate ciertamente puede ayudarte + a quitar o encapsular código SQL específico de vendedor y ayudará + con la tarea común de traducción de resultados desde una representación + tabular a un grafo de objetos. + </para> + + <para> + Si eres nuevo en Hibernate y lo del Mapeo Objeto/Relacional o incluso en Java, + sigue por favor estos pasos: + </para> + + <orderedlist> + <listitem> + <para> + Lee <xref linkend="quickstart"/> para un tutorial de 30 minutos, usando Tomcat. + </para> + </listitem> + <listitem> + <para> + Lee <xref linkend="architecture"/> para entender los entornos en los que + puede ser usado Hibernate. + </para> + </listitem> + <listitem> + <para> + Dale una mirada al directorio <literal>eg/</literal> en la distribución + de Hibernate, contiene una aplicación independiente simple. + Copia tu driver JDBC al directorio <literal>lib/</literal> y edita + <literal>etc/hibernate.properties</literal>, especificando los valores + correctos para tu base de datos. Desde línea de comandos en el + directorio de la distribución, tipea <literal>ant eg</literal> + (usando Ant), o bajo Windows, tipea <literal>build eg</literal>. + </para> + </listitem> + <listitem> + <para> + Usa esta documentación de referencia como tu fuente de información + primaria. Ten en consideración leer <emphasis>Java Persistence with Hibernate</emphasis> + (http://www.manning.com/bauer2) si necesitas mas ayuda con el diseño + de aplicaciones o si prefieres un tutorial paso a paso. + Visita también http://caveatemptor.hibernate.org y descarga la aplicación + de ejemplo para Java Persistence with Hibernate. + </para> + </listitem> + <listitem> + <para> + Los FAQs son respondidos en el sitio web de Hibernate. + </para> + </listitem> + <listitem> + <para> + En el sitio web de Hibernate hay enlaces a demos de terceros, ejemplos + y tutoriales. + </para> + </listitem> + <listitem> + <para> + El Area de Comunidad en el sitio web de Hibernate es una buena fuente + de patrones de diseño y varias soluciones de integración + (Tomcat, JBoss, Struts, EJB, etc.). + </para> + </listitem> + </orderedlist> + + <para> + Si tienes preguntas, usa el foro de usuarios enlazado en el sitio web de Hibernate. + También proveemos un sistema de seguimiento JIRA para reportes de defectos y + peticiones de nuevas características. + Si estas interesado en el desarrollo de Hibernate, únete a la lista de correo + de desarrolladores. Si estas interesado en traducir esta documentación a tu + lenguaje, contáctanos en la lista de correo de desarrolladores. + </para> + + <para> + A través de JBoss Inc. (see http://www.hibernate.org/SupportTraining/) hay + disponibilidad de soporte comercial de desarrollo, soporte de producción y + entrenamiento en Hibernate. + Hibernate es un proyecto de la suite de productos de código abierto + JBoss Professional. + </para> + + </preface> \ No newline at end of file Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_criteria.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/query_criteria.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_criteria.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_criteria.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,431 @@ +<chapter id="querycriteria"> + <title>Consultas por Criterios</title> + + <para> + Acompaña a Hibernate una API de consultas por criterios intuitiva y extensible. + </para> + + <sect1 id="querycriteria-creating"> + <title>Creando una instancia de <literal>Criteria</literal></title> + + <para> + La interface <literal>org.hibernate.Criteria</literal> representa una consulta contra + una clase persistente en particular. La <literal>Session</literal> es una fábrica de instancias + de <literal>Criteria</literal>. + </para> + + <programlisting><![CDATA[Criteria crit = sess.createCriteria(Cat.class); +crit.setMaxResults(50); +List cats = crit.list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-narrowing"> + <title>Estrechando el conjunto resultado</title> + + <para> + Un criterio individual de consulta es una instancia de la interface + <literal>org.hibernate.criterion.Criterion</literal>. La clase + <literal>org.hibernate.criterion.Restrictions</literal> define métodos de fábrica para obtener ciertos tipos + prefabricados de <literal>Criterion</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.between("weight", minWeight, maxWeight) ) + .list();]]></programlisting> + + <para> + Las restricciones pueden ser agrupadas lógicamente. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.or( + Restrictions.eq( "age", new Integer(0) ), + Restrictions.isNull("age") + ) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) ) + .add( Restrictions.disjunction() + .add( Restrictions.isNull("age") ) + .add( Restrictions.eq("age", new Integer(0) ) ) + .add( Restrictions.eq("age", new Integer(1) ) ) + .add( Restrictions.eq("age", new Integer(2) ) ) + ) ) + .list();]]></programlisting> + + <para> + Hay un gran rango de tipos de criterio prefabricados (subclases de <literal>Restrictions</literal>), + pero uno que es especialmente útil te deja especificar SQL directamente. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.sql("lower({alias}.name) like lower(?)", "Fritz%", Hibernate.STRING) ) + .list();]]></programlisting> + + <para> + El sitio <literal>{alias}</literal> será remplazado por el alias de fila de la entidad consultada. + </para> + + <para> + Un enfoque alternativo para obtener un criterio es tomarlo de una instancia de + <literal>Property</literal>. Puedes crear una <literal>Property</literal> llamando a + <literal>Property.forName()</literal>. + </para> + + <programlisting><![CDATA[ +Property age = Property.forName("age"); +List cats = sess.createCriteria(Cat.class) + .add( Restrictions.disjunction() + .add( age.isNull() ) + .add( age.eq( new Integer(0) ) ) + .add( age.eq( new Integer(1) ) ) + .add( age.eq( new Integer(2) ) ) + ) ) + .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-ordering"> + <title>Ordenando los resultados</title> + + <para> + Puedes ordenar los resultados usando <literal>org.hibernate.criterion.Order</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") + .addOrder( Order.asc("name") ) + .addOrder( Order.desc("age") ) + .setMaxResults(50) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Property.forName("name").like("F%") ) + .addOrder( Property.forName("name").asc() ) + .addOrder( Property.forName("age").desc() ) + .setMaxResults(50) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-associations"> + <title>Asociaciones</title> + + <para> + Puedes especificar fácilmente restricciones sobre las entidades relacionadas al navegar asociaciones + usando <literal>createCriteria()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") + .createCriteria("kittens") + .add( Restrictions.like("name", "F%") + .list();]]></programlisting> + + <para> + nota que el segundo <literal>createCriteria()</literal> devuelve una nueva instancia de + <literal>Criteria</literal>, que hace referencia a los elementos de la colección + <literal>kittens</literal>. + </para> + + <para> + La siguiente forma alternativa es útil en ciertas circunstancias. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createAlias("kittens", "kt") + .createAlias("mate", "mt") + .add( Restrictions.eqProperty("kt.name", "mt.name") ) + .list();]]></programlisting> + + <para> + (<literal>createAlias()</literal> no crea una nueva instancia de + <literal>Criteria</literal>.) + </para> + + <para> + ¡Observa que las colecciones de gatitos tenidas por las instancias de <literal>Cat</literal> devueltas + por las dos consultas previas <emphasis>no</emphasis> están prefiltradas por los criterios! Si deseas + recuperar sólo los gatitos que emparejen los criterios, debes usar <literal>returnMaps()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createCriteria("kittens", "kt") + .add( Restrictions.eq("name", "F%") ) + .returnMaps() + .list(); +Iterator iter = cats.iterator(); +while ( iter.hasNext() ) { + Map map = (Map) iter.next(); + Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS); + Cat kitten = (Cat) map.get("kt"); +}]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-dynamicfetching" revision="1"> + <title>Recuperación dinámica de asociaciones</title> + + <para> + Puedes especificar la semántica de recuperación de asociaciones en tiempo de ejecución usando + <literal>setFetchMode()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .setFetchMode("mate", FetchMode.EAGER) + .setFetchMode("kittens", FetchMode.EAGER) + .list();]]></programlisting> + + <para> + Esta consulta recuperará tanto <literal>mate</literal> como <literal>kittens</literal> por + unión exterior (outer join). Ver <xref linkend="performance-fetching"/> para más información. + </para> + + </sect1> + + <sect1 id="querycriteria-examples"> + <title>Consultas por ejemplos</title> + + <para> + La clase <literal>org.hibernate.criterion.Example</literal> te permite construir un criterio de consulta + a partir de una instancia dada. + </para> + + <programlisting><![CDATA[Cat cat = new Cat(); +cat.setSex('F'); +cat.setColor(Color.BLACK); +List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .list();]]></programlisting> + + <para> + Las propiedades de versión, los identificadores y las asociaciones son ignorados. Por defecto, + las propiedades valuadas a nulo son excluídas. + </para> + + <para> + Puedes ajustar cómo se aplica el <literal>Example</literal>. + </para> + + <programlisting><![CDATA[Example example = Example.create(cat) + .excludeZeroes() //exclude zero valued properties + .excludeProperty("color") //exclude the property named "color" + .ignoreCase() //perform case insensitive string comparisons + .enableLike(); //use like for string comparisons +List results = session.createCriteria(Cat.class) + .add(example) + .list();]]></programlisting> + + <para> + Puedes incluso usar ejemplos para colocar criterios sobre objetos asociados. + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .createCriteria("mate") + .add( Example.create( cat.getMate() ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-projection"> + <title>Proyecciones, agregación y agrupamiento</title> + <para> + La clase <literal>org.hibernate.criterion.Projections</literal> es una fábrica de instancias de + <literal>Projection</literal>. Aplicamos una proyección a una consulta llamando a + <literal>setProjection()</literal>. + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.rowCount() ) + .add( Restrictions.eq("color", Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount() ) + .add( Projections.avg("weight") ) + .add( Projections.max("weight") ) + .add( Projections.groupProperty("color") ) + ) + .list();]]></programlisting> + + <para> + No es necesario ningún "group by" explícito en una consulta por criterios. + Ciertos tipos de proyecciones son definidos para ser <emphasis>proyecciones agrupadas</emphasis>, + que además aparecen en la cláusula SQL <literal>group by</literal>. + </para> + + <para> + Puede opcionalmente asignarse un alias a una proyección, de modo que el valor proyectado pueda + ser referido en restricciones u ordenamientos. Aquí hay dos formas diferentes de hacer esto: + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.alias( Projections.groupProperty("color"), "colr" ) ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.groupProperty("color").as("colr") ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <para> + Los métodos <literal>alias()</literal> y <literal>as()</literal> simplemente envuelven una instancia + de proyección en otra instancia de <literal>Projection</literal> con alias. Como un atajo, puedes asignar + un alias cuando agregas la proyección a una lista de proyecciones: + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount(), "catCountByColor" ) + .add( Projections.avg("weight"), "avgWeight" ) + .add( Projections.max("weight"), "maxWeight" ) + .add( Projections.groupProperty("color"), "color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Domestic.class, "cat") + .createAlias("kittens", "kit") + .setProjection( Projections.projectionList() + .add( Projections.property("cat.name"), "catName" ) + .add( Projections.property("kit.name"), "kitName" ) + ) + .addOrder( Order.asc("catName") ) + .addOrder( Order.asc("kitName") ) + .list();]]></programlisting> + + <para> + Puedes también usar <literal>Property.forName()</literal> para expresar proyecciones: + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Property.forName("name") ) + .add( Property.forName("color").eq(Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount().as("catCountByColor") ) + .add( Property.forName("weight").avg().as("avgWeight") ) + .add( Property.forName("weight").max().as("maxWeight") ) + .add( Property.forName("color").group().as("color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-detachedqueries"> + <title>Consultas y subconsultas separadas</title> + <para> + La clase <literal>DetachedCriteria</literal> te deja crear una consulta fuera del ámbito de una sesión, + y entonces ejecutarla luego usando alguna <literal>Session</literal> arbitraria. + </para> + + <programlisting><![CDATA[DetachedCriteria query = DetachedCriteria.forClass(Cat.class) + .add( Property.forName("sex").eq('F') ); + +Session session = ....; +Transaction txn = session.beginTransaction(); +List results = query.getExecutableCriteria(session).setMaxResults(100).list(); +txn.commit(); +session.close();]]></programlisting> + + <para> + También una <literal>DetachedCriteria</literal> puede usarse para expresar una subconsulta. + Las instancias de Criterion implicando subconsultas pueden obtenerse vía <literal>Subqueries</literal> o + <literal>Property</literal>. + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeight = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight").avg() ); +session.createCriteria(Cat.class) + .add( Property.forName("weight").gt(avgWeight) ) + .list();]]></programlisting> + + <programlisting><![CDATA[DetachedCriteria weights = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight") ); +session.createCriteria(Cat.class) + .add( Subqueries.geAll("weight", weights) ) + .list();]]></programlisting> + + <para> + Incluso son posibles las subconsultas correlacionadas: + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeightForSex = DetachedCriteria.forClass(Cat.class, "cat2") + .setProjection( Property.forName("weight").avg() ) + .add( Property.forName("cat2.sex").eqProperty("cat.sex") ); +session.createCriteria(Cat.class, "cat") + .add( Property.forName("weight").gt(avgWeightForSex) ) + .list();]]></programlisting> + + </sect1> + +  + + <sect1 id="query-criteria-naturalid"> + <title>Consultas por identificador natural</title> + + <para> + Para la mayoría de consultas, incluyendo las consultas por criterios, el caché de consulta no es + muy eficiente, debido a que la invalidación del caché de consulta ocurre demasiado frecuentemente. + Sin embargo, hay un tipo especial de consulta donde podemos optimizar el algoritmo de invalidación + de caché: búsquedas por una clave natural constante. En algunas aplicaciones, este tipo de consulta, + ocurre frecuentemente. La API de criterios brinda especial provisión para este caso de uso. + </para> + + <para> + Primero, debes mapear la clave natural de tu entidad usando + <literal><natural-id></literal>, y habilitar el uso del caché de segundo nivel. + </para> + + <programlisting><![CDATA[<class name="User"> + <cache usage="read-write"/> + <id name="id"> + <generator class="increment"/> + </id> + <natural-id> + <property name="name"/> + <property name="org"/> + </natural-id> + <property name="password"/> +</class>]]></programlisting> + + <para> + Nota que esta funcionalidad no está pensada para uso con entidades con claves naturales + <emphasis>mutable</emphasis>. + </para> + + <para> + Seguido, habilita el caché de consulta de Hibernate. + </para> + + <para> + Ahora, <literal>Restrictions.naturalId()</literal> nos permite hacer uso de el algoritmo de caché + más eficiente. + </para> + + <programlisting><![CDATA[session.createCriteria(User.class) + .add( Restrictions.naturalId() + .set("name", "gavin") + .set("org", "hb") + ).setCacheable(true) + .uniqueResult();]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_hql.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/query_hql.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_hql.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_hql.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,1107 @@ +<chapter id="queryhql"> + <title>HQL: El Lenguaje de Consulta de Hibernate</title> + + <para> + Hibernate está equipado con un lenguaje de consulta extremadamente potente que + (intencionalmente en absoluto) se parece muchísimo a SQL. Pero no te engañes por la sintaxis; + HQL es completamente orientado a objetos, entendiendo nociones como herencia, polimorfismo + y asociación. + </para> + + <sect1 id="queryhql-casesensitivity"> + <title>Sensibilidad a Mayúsculas</title> + + <para> + Las consultas son insensibles a mayúsculas, excepto para nombres de clases Java y propiedades. De modo que + <literal>SeLeCT</literal> es lo mismo que <literal>sELEct</literal> e igual a <literal>SELECT</literal>, + pero <literal>org.hibernate.eg.FOO</literal> no lo es a <literal>org.hibernate.eg.Foo</literal> y + <literal>foo.barSet</literal> no es igual a <literal>foo.BARSET</literal>. + </para> + + <para> + Este manual usa palabras clave HQL en minúsculas. Algunos usuarios encuentran las consultas con + palabras clave en mayúsculas más leíbles, pero encontramos esta convención fea cuando se encaja + en código Java. + </para> + + </sect1> + + <sect1 id="queryhql-from"> + <title>La cláusula from</title> + + <para> + La consulta más simple posible de Hibernate es de la forma: + </para> + + <programlisting><![CDATA[from eg.Cat]]></programlisting> + + <para> + que simplemente devuelve todas las instancias de la clase <literal>eg.Cat</literal>. + Usualmente no necesitamos cualificar el nombre de la clase, ya que <literal>auto-import</literal> + está por defecto. De modo que casi siempre escribimos solamente: + </para> + + <programlisting><![CDATA[from Cat]]></programlisting> + + <para> + La mayoría del tiempo, necesitarás asignar un <emphasis>alias</emphasis>, ya que querrás referirte al + <literal>Cat</literal> en otras partes de la consulta. + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + Esta consulta asigna el alias <literal>cat</literal> a las instancias de <literal>Cat</literal>, + de modo que podríamos usar ese alias luego en la consulta. La palabra clave <literal>as</literal> + es opcional; también podríamos escribir: + </para> + + <programlisting><![CDATA[from Cat cat]]></programlisting> + + <para> + Pueden aparecer múltiples clases, resultando en un producto cartesiano o unión "cruzada" (cross join). + </para> + + <programlisting><![CDATA[from Formula, Parameter]]></programlisting> + <programlisting><![CDATA[from Formula as form, Parameter as param]]></programlisting> + + <para> + Se considera buena práctica el nombrar los alias de consulta usando una inicial en minúsculas, + consistente con los estándares de nombrado de Java para variables locales + (por ejemplo, <literal>domesticCat</literal>). + </para> + + </sect1> + + <sect1 id="queryhql-joins" revision="1"> + <title>Asociaciones y uniones (joins)</title> + + <para> + Podemos también asignar aliases a entidades asociadas, e incluso a elementos de una colección de valores, + usando una <literal>join</literal>. + </para> + + <programlisting><![CDATA[from Cat as cat + inner join cat.mate as mate + left outer join cat.kittens as kitten]]></programlisting> + + <programlisting><![CDATA[from Cat as cat left join cat.mate.kittens as kittens]]></programlisting> + + <programlisting><![CDATA[from Formula form full join form.parameter param]]></programlisting> + + <para> + Los tipos de join soportados son prestados de ANSI SQL + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>inner join</literal> + </para> + </listitem> + <listitem> + <para> + <literal>left outer join</literal> + </para> + </listitem> + <listitem> + <para> + <literal>right outer join</literal> + </para> + </listitem> + <listitem> + <para> + <literal>full join</literal> (no útil usualmente) + </para> + </listitem> + </itemizedlist> + + <para> + Las construcciones <literal>inner join</literal>, <literal>left outer join</literal> y + <literal>right outer join</literal> pueden ser abreviadas. + </para> + + <programlisting><![CDATA[from Cat as cat + join cat.mate as mate + left join cat.kittens as kitten]]></programlisting> + + <para> + Puedes proveer condiciones de unión extra usando la palabra clave <literal>with</literal> de HQL. + </para> + + <programlisting><![CDATA[from Cat as cat + left join cat.kittens as kitten + with kitten.bodyWeight > 10.0]]></programlisting> + + <para> + En adición, un "fetch" join permite a las asociaciones o colecciones de valores ser inicializadas + junto a sus objetos padres, usando una sola selección. Esto es particularmente útil en el case de una + colección. Efectivamente sobrescribe el outer join y las declaraciones perezosas (lazy) del fichero + de mapeo para asociaciones y colecciones. Ver <xref linkend="performance-fetching"/> para más + información. + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens]]></programlisting> + + <para> + Usualmente a un fetch join no se necesita asignársele un alias, porque los objetos asociados no deben + ser usados en la cláusula <literal>where</literal> (ni en cualquier otra cláusula). Además, los objetos + asociados no son devueltos directamente en los resultados de consulta. En cambio, pueden ser accedidos + vía el objeto padre. La única razón por la que necesitaríamos un alias es estamos uniendo recursivamente + otra colección: + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens child + left join fetch child.kittens]]></programlisting> + + <para> + Nota que la construcción <literal>fetch</literal> no puede usarse en consultas llamadas usando + <literal>scroll()</literal> o <literal>iterate()</literal>. Ni debe usarse <literal>fetch</literal> + junto con <literal>setMaxResults()</literal> o <literal>setFirstResult()</literal>. Tampoco puede usarse + <literal>fetch</literal> junto a una condición <literal>with</literal> ad hoc. Es posible crear + un producto cartesiano trayendo por join más de una colección en una colección, así que ten cuidado en + este caso. Traer por join múltiples roles de colección también da a veces resultados inesperados para mapeos + de bag, así que sé cuidadoso sobre cómo formular tus consultas en este caso. Finalmente, nota que + <literal>full join fetch</literal> y <literal>right join fetch</literal> no son significativos. + </para> + + <para> + Si estás usando recuperación perezosa a nivel de propiedad (con instrumentación de bytecode), es posible + forzar a Hibernate a traer las propiedades perezosas inmediatamente (en la primera consulta) usando + <literal>fetch all properties</literal>. + </para> + + <programlisting><![CDATA[from Document fetch all properties order by name]]></programlisting> + <programlisting><![CDATA[from Document doc fetch all properties where lower(doc.name) like '%cats%']]></programlisting> + + </sect1> + + <sect1 id="queryhql-select"> + <title>La cláusula select</title> + + <para> + La cláusula <literal>select</literal> escoge qué objetos y propiedades devolver in el conjunto resultado + de la consulta. Considera: + </para> + + <programlisting><![CDATA[select mate +from Cat as cat + inner join cat.mate as mate]]></programlisting> + + <para> + La consulta seleccionará <literal>mate</literal>s de otros <literal>Cat</literal>s. + Realmente, puedes expresar esta consulta en un forma más compacta como: + </para> + + <programlisting><![CDATA[select cat.mate from Cat cat]]></programlisting> + + <para> + Las consultas pueden devolver propiedades de cualquier tipo de valor incluyendo propiedades de + tipo componente: + </para> + + <programlisting><![CDATA[select cat.name from DomesticCat cat +where cat.name like 'fri%']]></programlisting> + + <programlisting><![CDATA[select cust.name.firstName from Customer as cust]]></programlisting> + + <para> + Las consultas pueden devolver múltiples objetos y/o propiedades como un array de tipo + <literal>Object[]</literal>, + </para> + + <programlisting><![CDATA[select mother, offspr, mate.name +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + o como una <literal>List</literal>, + </para> + + <programlisting><![CDATA[select new list(mother, offspr, mate.name) +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + o como un objeto real Java de tipo seguro, + </para> + + <programlisting><![CDATA[select new Family(mother, mate, offspr) +from DomesticCat as mother + join mother.mate as mate + left join mother.kittens as offspr]]></programlisting> + + <para> + asumiendo que la clase <literal>Family</literal> tiene un constructor apropiado. + </para> + + <para> + Puedes asignar aliases para seleccionar expresiones usando <literal>as</literal>: + </para> + + <programlisting><![CDATA[select max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n +from Cat cat]]></programlisting> + + <para> + Esto es lo más útil cuando se usa junto con <literal>select new map</literal>: + </para> + + <programlisting><![CDATA[select new map( max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n ) +from Cat cat]]></programlisting> + + <para> + Esta consulta devuelve un <literal>Map</literal> de aliases a valores seleccionados. + </para> + + </sect1> + + <sect1 id="queryhql-aggregation"> + <title>Funciones de agregación</title> + + <para> + Las consultas HQL pueden incluso devolver resultados de funciones de agregación sobre propiedades: + </para> + + <programlisting><![CDATA[select avg(cat.weight), sum(cat.weight), max(cat.weight), count(cat) +from Cat cat]]></programlisting> + + + + <para> + Las funciones de agregación soportadas son + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>avg(...), sum(...), min(...), max(...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(*)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(...), count(distinct ...), count(all...)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Puedes usar operadores aritméticos, concatenación, y funciones SQL reconocidas en la cláusula select: + </para> + + <programlisting><![CDATA[select cat.weight + sum(kitten.weight) +from Cat cat + join cat.kittens kitten +group by cat.id, cat.weight]]></programlisting> + + <programlisting><![CDATA[select firstName||' '||initial||' '||upper(lastName) from Person]]></programlisting> + + <para> + Las palabras clave <literal>distinct</literal> y <literal>all</literal> pueden ser usadas y tienen las misma + semántica que en SQL. + </para> + + <programlisting><![CDATA[select distinct cat.name from Cat cat + +select count(distinct cat.name), count(cat) from Cat cat]]></programlisting> + + </sect1> + + <sect1 id="queryhql-polymorphism"> + <title>Consultas polimórficas</title> + + <para> + Una consulta como: + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + devuelve instancias no sólo de <literal>Cat</literal>, sino también de subclases como + <literal>DomesticCat</literal>. Las consultas de Hibernate pueden mencionar <emphasis>cualquier</emphasis> + clase o interface Java en la cláusula <literal>from</literal>. La consulta devolverá instancias de todas + las clases persistentes que extiendan esa clase o implementen la interface. La siguiente consulta devolvería + todos los objetos persistentes. + </para> + + <programlisting><![CDATA[from java.lang.Object o]]></programlisting> + + <para> + La interface <literal>Named</literal> podría ser implementada por varias clases persistentes: + </para> + + <programlisting><![CDATA[from Named n, Named m where n.name = m.name]]></programlisting> + + <para> + Nota que estas dos últimas consultas requerirán más de un <literal>SELECT</literal> SQL. Esto significa + que la cláusula <literal>order by</literal> no ordenará correctamente todo el conjunto resultado. + (Significa además que no puedes llamar estas consulta usando <literal>Query.scroll()</literal>.) + </para> + + </sect1> + + <sect1 id="queryhql-where"> + <title>La cláusula where</title> + + <para> + La cláusula where te permite estrechar la lista de instancias devueltas. Si no existe ningún alias. + puedes referirte a las propiedades por nombre: + </para> + + <programlisting><![CDATA[from Cat where name='Fritz']]></programlisting> + + <para> + Si existe un alias, usan un nombre cualificado de propiedad: + </para> + + <programlisting><![CDATA[from Cat as cat where cat.name='Fritz']]></programlisting> + + <para> + devuelve las instancias de <literal>Cat</literal> llamadas 'Fritz'. + </para> + + <programlisting><![CDATA[select foo +from Foo foo, Bar bar +where foo.startDate = bar.date]]></programlisting> + + <para> + devolverá todas las instancias de <literal>Foo</literal> para las cuales exista una instancia + de <literal>bar</literal> con una propiedad <literal>date</literal> igual a la propiedad + <literal>startDate</literal> del <literal>Foo</literal>. Las expresiones de ruta compuestas hacen + la cláusula <literal>where</literal> extremadamente potente. Considera: + </para> + + <programlisting><![CDATA[from Cat cat where cat.mate.name is not null]]></programlisting> + + <para> + Esta consulta se traduce en una consulta SQL con una unión de tabla (interna). Si fueses a escribir algo como + </para> + + <programlisting><![CDATA[from Foo foo +where foo.bar.baz.customer.address.city is not null]]></programlisting> + + <para> + terminarías con una consulta que requeriría cuatro uniones de tablas en SQL. + </para> + + <para> + El operador <literal>=</literal> puede ser usado para comparar no sólo propiedades, sino también instancias: + </para> + + <programlisting><![CDATA[from Cat cat, Cat rival where cat.mate = rival.mate]]></programlisting> + + <programlisting><![CDATA[select cat, mate +from Cat cat, Cat mate +where cat.mate = mate]]></programlisting> + + <para> + La propiedad especial (en minúsculas) <literal>id</literal> puede ser usada para referenciar el identificador + único de un objeto. (También puedes usar su nombre de propiedad.) + </para> + + <programlisting><![CDATA[from Cat as cat where cat.id = 123 + +from Cat as cat where cat.mate.id = 69]]></programlisting> + + <para> + La segunda consulta es eficiente. ¡No se requiere ninguna unión de tablas! + </para> + + <para> + También pueden ser usadas las propiedades de identificadores compuestos. Supón que <literal>Person</literal> + tiene un identificador compuesto consistente en <literal>country</literal> y <literal>medicareNumber</literal>. + </para> + + <programlisting><![CDATA[from bank.Person person +where person.id.country = 'AU' + and person.id.medicareNumber = 123456]]></programlisting> + + <programlisting><![CDATA[from bank.Account account +where account.owner.id.country = 'AU' + and account.owner.id.medicareNumber = 123456]]></programlisting> + + <para> + Una vez más, la segunda consulta no requiere ninguna unión de tablas. + </para> + + <para> + Asimismo, la propiedad especial <literal>class</literal> acccede al valor discriminador de una instancia en + el caso de persistencia polimórfica. Un nombre de clase Java embebido en la cláusula where será + traducido a su valor discriminador. + </para> + + <programlisting><![CDATA[from Cat cat where cat.class = DomesticCat]]></programlisting> + + <para> + Puedes también especificar propiedades de componentes o tipos compuestos de usuario (y de componentes + de componentes, etc). Nunca intentes usar una expresión de ruta que termine en una propiedad de tipo + componente (al contrario de una propiedad de un componente). Por ejemplo, si <literal>store.owner</literal> + es una entidad con un componente <literal>address</literal> + </para> + + <programlisting><![CDATA[store.owner.address.city // okay +store.owner.address // error!]]></programlisting> + + <para> + Un tipo "any" tiene las propiedades especiales <literal>id</literal> y <literal>class</literal>, + permiténdonos expresar un join en la siguiente forma (donde <literal>AuditLog.item</literal> es una + propiedad mapeada con <literal><any></literal>). + </para> + + <programlisting><![CDATA[from AuditLog log, Payment payment +where log.item.class = 'Payment' and log.item.id = payment.id]]></programlisting> + + <para> + Nota que <literal>log.item.class</literal> y <literal>payment.class</literal> harían referencia a + los valores de columnas de base de datos completamente diferentes en la consulta anterior. + </para> + + </sect1> + + <sect1 id="queryhql-expressions"> + <title>Expresiones</title> + + <para> + Las expresiones permitidas en la cláusula <literal>where</literal> incluyen la mayoría del tipo de cosas + que podrías escribir en SQL: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + operadores matemáticos <literal>+, -, *, /</literal> + </para> + </listitem> + <listitem> + <para> + operadores de comparación binarios <literal>=, >=, <=, <>, !=, like</literal> + </para> + </listitem> + <listitem> + <para> + operadores lógicos <literal>and, or, not</literal> + </para> + </listitem> + <listitem> + <para> + Paréntesis <literal>( )</literal>, indicando agrupación + </para> + </listitem> + <listitem> + <para> + <literal>in</literal>, + <literal>not in</literal>, + <literal>between</literal>, + <literal>is null</literal>, + <literal>is not null</literal>, + <literal>is empty</literal>, + <literal>is not empty</literal>, + <literal>member of</literal> y + <literal>not member of</literal> + </para> + </listitem> + <listitem> + <para> + Caso "simple", <literal>case ... when ... then ... else ... end</literal>, + y caso "buscado", <literal>case when ... then ... else ... end</literal> + </para> + </listitem> + <listitem> + <para> + concatenación de cadenas <literal>...||...</literal> o <literal>concat(...,...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>current_date()</literal>, <literal>current_time()</literal>, + <literal>current_timestamp()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>second(...)</literal>, <literal>minute(...)</literal>, + <literal>hour(...)</literal>, <literal>day(...)</literal>, + <literal>month(...)</literal>, <literal>year(...)</literal>, + </para> + </listitem> + <listitem> + <para> + Cualquier función u operador definido por EJB-QL 3.0: <literal>substring(), trim(), + lower(), upper(), length(), locate(), abs(), sqrt(), bit_length(), mod()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>coalesce()</literal> y <literal>nullif()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>str()</literal> para convertir valores numéricos o temporales a una cadena legible. + </para> + </listitem> + <listitem> + <para> + <literal>cast(... as ...)</literal>, donde el segundo argumento es el nombre de un tipo Hibernate + , y <literal>extract(... from ...)</literal> si <literal>cast()</literal> y + <literal>extract()</literal> fuesen soportados por la base de datos subyacente. + </para> + </listitem> + + + <listitem> + <para> + la función <literal>index()</literal> de HQL, que se aplica a alias de una colección + indexada unida. + </para> + </listitem> + <listitem> + <para> + funciones de HQL que tomen expresiones de ruta valuadas en colecciones: <literal>size(), + minelement(), maxelement(), minindex(), maxindex()</literal>, junto a las funciones especiales + <literal>elements()</literal> and <literal>indices</literal> que pueden ser cuantificadas usando + <literal>some, all, exists, any, in</literal>. + </para> + </listitem> + + <listitem> + <para> + Cualquier función escalar SQL soportada por la base de datos como <literal>sign()</literal>, + <literal>trunc()</literal>, <literal>rtrim()</literal>, <literal>sin()</literal> + </para> + </listitem> + <listitem> + <para> + parámetros posicionales JDBC <literal>?</literal> + </para> + </listitem> + <listitem> + <para> + parámetros con nombre <literal>:name</literal>, <literal>:start_date</literal>, <literal>:x1</literal> + </para> + </listitem> + <listitem> + <para> + literales SQL <literal>'foo'</literal>, <literal>69</literal>, <literal>6.66E+2</literal>, + <literal>'1970-01-01 10:00:01.0'</literal> + </para> + </listitem> + <listitem> + <para> + constantes Java <literal>public static final</literal> <literal>eg.Color.TABBY</literal> + </para> + </listitem> + </itemizedlist> + + <para> + <literal>in</literal> y <literal>between</literal> pueden usarse como sigue: + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + y pueden escribirse las formas negadas + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + Asimismo, <literal>is null</literal> y <literal>is not null</literal> pueden ser usadas para comprobar + valores nulos. + </para> + + <para> + Los booleanos pueden ser fácilmente usados en expresiones declarando substituciones de consulta HQL + en la configuración de Hibernate: + </para> + + <programlisting><![CDATA[<property name="hibernate.query.substitutions">true 1, false 0</property>]]></programlisting> + + <para> + Esto remplazará las palabras clave <literal>true</literal> y <literal>false</literal> con los literales + <literal>1</literal> y <literal>0</literal> en el SQL traducido de este HQL: + </para> + + <programlisting><![CDATA[from Cat cat where cat.alive = true]]></programlisting> + + <para> + Puedes comprobar el tamaño de una colección con la propiedad especial <literal>size</literal>, o la función + especial <literal>size()</literal>. + </para> + + <programlisting><![CDATA[from Cat cat where cat.kittens.size > 0]]></programlisting> + + <programlisting><![CDATA[from Cat cat where size(cat.kittens) > 0]]></programlisting> + + <para> + Para colecciones indexadas, puedes referirte a los índices máximo y mínimo usando las funciones + <literal>minindex</literal> y <literal>maxindex</literal>. Similarmente, puedes referirte a los elementos + máximo y mínimo de una colección de tipo básico usando las funciones + <literal>minelement</literal> y <literal>maxelement</literal>. + </para> + + <programlisting><![CDATA[from Calendar cal where maxelement(cal.holidays) > current_date]]></programlisting> + + <programlisting><![CDATA[from Order order where maxindex(order.items) > 100]]></programlisting> + + <programlisting><![CDATA[from Order order where minelement(order.items) > 10000]]></programlisting> + + <para> + Las funciones SQL <literal>any, some, all, exists, in</literal> están soportadas cuando se les pasa + el conjunto de elementos o índices de una colección (funciones <literal>elements</literal> y + <literal>indices</literal>) o el resultado de una subconsulta (ver debajo). + </para> + + <programlisting><![CDATA[select mother from Cat as mother, Cat as kit +where kit in elements(foo.kittens)]]></programlisting> + + <programlisting><![CDATA[select p from NameList list, Person p +where p.name = some elements(list.names)]]></programlisting> + + <programlisting><![CDATA[from Cat cat where exists elements(cat.kittens)]]></programlisting> + + <programlisting><![CDATA[from Player p where 3 > all elements(p.scores)]]></programlisting> + + <programlisting><![CDATA[from Show show where 'fizard' in indices(show.acts)]]></programlisting> + + <para> + Nota que estas construcciones - <literal>size</literal>, <literal>elements</literal>, + <literal>indices</literal>, <literal>minindex</literal>, <literal>maxindex</literal>, + <literal>minelement</literal>, <literal>maxelement</literal> - pueden ser usadas solamente + en la cláusula where en Hibernate3. + </para> + + <para> + Los elementos de colecciones indexadas (arrays, listas, mapas) pueden ser referidos por índice + (en una cláusula where solamente): + </para> + + <programlisting><![CDATA[from Order order where order.items[0].id = 1234]]></programlisting> + + <programlisting><![CDATA[select person from Person person, Calendar calendar +where calendar.holidays['national day'] = person.birthDay + and person.nationality.calendar = calendar]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ order.deliveredItemIndices[0] ] = item and order.id = 11]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ maxindex(order.items) ] = item and order.id = 11]]></programlisting> + + <para> + La expresión dentro de <literal>[]</literal> puede incluso ser una expresión aritmética. + </para> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ size(order.items) - 1 ] = item]]></programlisting> + + <para> + HQL provee además el función prefabricada <literal>index()</literal>, para elementos de una + asociación uno-a-muchos o colección de valores. + </para> + + <programlisting><![CDATA[select item, index(item) from Order order + join order.items item +where index(item) < 5]]></programlisting> + + <para> + Pueden usarse las funciones SQL escalares soportadas por la base de datos subyacente + </para> + + <programlisting><![CDATA[from DomesticCat cat where upper(cat.name) like 'FRI%']]></programlisting> + + <para> + Si aún no estás convencido de todo esto, piensa cuánto más largo y menos leíble sería la siguiente + consulta en SQL: + </para> + + <programlisting><![CDATA[select cust +from Product prod, + Store store + inner join store.customers cust +where prod.name = 'widget' + and store.location.name in ( 'Melbourne', 'Sydney' ) + and prod = all elements(cust.currentOrder.lineItems)]]></programlisting> + + <para> + <emphasis>Ayuda:</emphasis> algo como + </para> + + <programlisting><![CDATA[SELECT cust.name, cust.address, cust.phone, cust.id, cust.current_order +FROM customers cust, + stores store, + locations loc, + store_customers sc, + product prod +WHERE prod.name = 'widget' + AND store.loc_id = loc.id + AND loc.name IN ( 'Melbourne', 'Sydney' ) + AND sc.store_id = store.id + AND sc.cust_id = cust.id + AND prod.id = ALL( + SELECT item.prod_id + FROM line_items item, orders o + WHERE item.order_id = o.id + AND cust.current_order = o.id + )]]></programlisting> + + </sect1> + + <sect1 id="queryhql-ordering"> + <title>La cláusula order by</title> + + <para> + La lista devuelta por una consulta puede ser ordenada por cualquier propiedad de una clase devuelta + o componentes: + </para> + + <programlisting><![CDATA[from DomesticCat cat +order by cat.name asc, cat.weight desc, cat.birthdate]]></programlisting> + + <para> + Los <literal>asc</literal> o <literal>desc</literal> opcionales indican ordenamiento ascendente o + descendente respectivamente. + </para> + </sect1> + + <sect1 id="queryhql-grouping"> + <title>La cláusula group by</title> + + <para> + Una consulta que devuelve valores agregados puede ser agrupada por cualquier propiedad de una clase + devuelta o componentes: + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color]]></programlisting> + + <programlisting><![CDATA[select foo.id, avg(name), max(name) +from Foo foo join foo.names name +group by foo.id]]></programlisting> + + <para> + Se permite también una cláusula <literal>having</literal>. + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color +having cat.color in (eg.Color.TABBY, eg.Color.BLACK)]]></programlisting> + + <para> + Las funciones y funciones de agregación SQL están permitidas en las cláusulas + <literal>having</literal> y <literal>order by</literal>, si están soportadas por la base de datos + subyacente (por ejemplo, no en MySQL). + </para> + + <programlisting><![CDATA[select cat +from Cat cat + join cat.kittens kitten +group by cat +having avg(kitten.weight) > 100 +order by count(kitten) asc, sum(kitten.weight) desc]]></programlisting> + + <para> + Nota que ni la cláusula <literal>group by</literal> ni la cláusula <literal>order by</literal> pueden + contener expresiones aritméticas. + </para> + + </sect1> + + <sect1 id="queryhql-subqueries"> + <title>Subconsultas</title> + + <para> + Para bases de datos que soportan subconsultas, Hibernate soporta subconsultas dentro de consultas. Una + subconsulta debe ser encerrada entre paréntesis (frecuentemente por una llamada a una función de agregación + SQL). Incluso se permiten subconsultas correlacionadas (subconsultas que hacen referencia a un alias en la + consulta exterior). + </para> + + <programlisting><![CDATA[from Cat as fatcat +where fatcat.weight > ( + select avg(cat.weight) from DomesticCat cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name = some ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[from Cat as cat +where not exists ( + from Cat as mate where mate.mate = cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name not in ( + select name.nickName from Name as name +)]]></programlisting> + + <para> + Para las subconsultas con más de una expresión en la lista de selección, puedes usar un constructor + de tuplas: + </para> + + <programlisting><![CDATA[from Cat as cat +where not ( cat.name, cat.color ) in ( + select cat.name, cat.color from DomesticCat cat +)]]></programlisting> + + <para> + Nota que en algunas bases de datos (pero no en Oracle o HSQL), puedes usar constructores de tuplar en + otros contextos, por ejemplo al consultar componentes o tipos de usuario compuestos: + </para> + + <programlisting><![CDATA[from Person where name = ('Gavin', 'A', 'King')]]></programlisting> + + <para> + Que es equivalente a la más verborrágica: + </para> + + <programlisting><![CDATA[from Person where name.first = 'Gavin' and name.initial = 'A' and name.last = 'King')]]></programlisting> + + <para> + Existen dos buenas razones por las cuales podrías no querer hacer este tipo de cosa: primero, no es + completamente portable entre plataformas de base de datos; segundo, la consulta ahora es dependiente + del orden de propiedades en el documento de mapeo. + </para> + + </sect1> + + <sect1 id="queryhql-examples"> + <title>Ejemplos de HQL</title> + + <para> + Las consultas de Hibernate pueden ser abolutamente potentes y complejas, De hecho, el poder del lenguaje + de consulta es uno de los puntos principales de venta de Hibernate. He aquí algunos consultas de ejemplo + muy similares a consultas que he usado en un proyecto reciente. ¡Nota que la mayoría de las consultas + que escribirás som mucho más simples que estas! + </para> + + <para> + La siguiente consulta devuelve el order id, número de items y valor total de la orden para todas + las ordenes inpagas de un cliente en particular y valor total mínimo dados, ordenando los resultados + por valor total. Al determinar los precios, usa el catálogo actual. La consulta SQL resultante, + contra las tablas <literal>ORDER</literal>, <literal>ORDER_LINE</literal>, <literal>PRODUCT</literal>, + <literal>CATALOG</literal> and <literal>PRICE</literal> tiene cuatro joins interiores y una subselect + (no correlacionada). + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog.effectiveDate < sysdate + and catalog.effectiveDate >= all ( + select cat.effectiveDate + from Catalog as cat + where cat.effectiveDate < sysdate + ) +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + ¡Qué monstruo! Realmente, en la vida real, no estoy muy afilado en subconsultas, de modo que mi + consulta fue realmente algo como esto: + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog = :currentCatalog +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + La próxima consulta cuenta el número de pagos en cada estado, excluyendo todos los pagos + en el estado <literal>AWAITING_APPROVAL</literal> donde el estado más reciente fue hecho por el + usuario actual. Se traduce en una consulta SQL con dos joins interiores y una subselect + correlacionada contra las tablas <literal>PAYMENT</literal>, <literal>PAYMENT_STATUS</literal> y + <literal>PAYMENT_STATUS_CHANGE</literal>. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status + join payment.statusChanges as statusChange +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or ( + statusChange.timeStamp = ( + select max(change.timeStamp) + from PaymentStatusChange change + where change.payment = payment + ) + and statusChange.user <> :currentUser + ) +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + Si hubiese mapeado la colección <literal>statusChanges</literal> como una lista, en vez de un conjunto, + la consulta habría sido mucho más simple de escribir. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or payment.statusChanges[ maxIndex(payment.statusChanges) ].user <> :currentUser +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + La próxima consulta usa la función <literal>isNull()</literal> de MS SQL Server para devolver + todas las cuentas y pagos inpagos de la organización a la que pertenece el usuario actual. + Se traduce en una consulta SQL con tres joins interiores, un join exterior y una subconsulta + contra las tablas <literal>ACCOUNT</literal>, <literal>PAYMENT</literal>, <literal>PAYMENT_STATUS</literal>, + <literal>ACCOUNT_TYPE</literal>, <literal>ORGANIZATION</literal> y <literal>ORG_USER</literal>. + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + left outer join account.payments as payment +where :currentUser in elements(account.holder.users) + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + <para> + Para algunas bases de datos, necesitaríamos eliminar la subselect (correlacionada). + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + join account.holder.users as user + left outer join account.payments as payment +where :currentUser = user + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + </sect1> + + <sect1 id="queryhql-bulk"> + <title>Sentencias UPDATE y DELETE masivas</title> + + <para> + HQL soporta ahora sentencias UPDATE y DELETE en HQL. + Ver <xref linkend="batch-direct"/> para detalles. + </para> + </sect1> + + <sect1 id="queryhql-tipstricks"> + <title>Consejos y Trucos</title> + + <para> + Puedes contar el número de resultados de una consulta sin devolverlos realmente: + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue()]]></programlisting> + + <para> + Para ordenar un resultado por el tamaño de una colección, usa la siguiente consulta: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +order by count(msg)]]></programlisting> + + <para> + Si tu base de datos soporta subselects, puedes colocar una condición sobre el tamaño de selección + en la cláusula where de tu consulta: + </para> + + <programlisting><![CDATA[from User usr where size(usr.messages) >= 1]]></programlisting> + + <para> + Si tu base de datos no soporta subselects, usa la siguiente consulta: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User usr.name + join usr.messages msg +group by usr.id, usr.name +having count(msg) >= 1]]></programlisting> + + <para> + Como esta solución no puede devolver un <literal>User</literal> con cero mensajes debido a la unión interior, + la siguiente forma es también útil: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +having count(msg) = 0]]></programlisting> + + <para> + Las propiedades de un JavaBean pueden ser ligadas al parámetros de consulta con nombre: + </para> + + <programlisting><![CDATA[Query q = s.createQuery("from foo Foo as foo where foo.name=:name and foo.size=:size"); +q.setProperties(fooBean); // fooBean has getName() and getSize() +List foos = q.list();]]></programlisting> + + <para> + Las colecciones son paginables usando la interface <literal>Query</literal> con un filtro: + </para> + + <programlisting><![CDATA[Query q = s.createFilter( collection, "" ); // the trivial filter +q.setMaxResults(PAGE_SIZE); +q.setFirstResult(PAGE_SIZE * pageNumber); +List page = q.list();]]></programlisting> + + <para> + Los elementos de colección pueden ser ordenados o agrupados usando un filtro de consulta: + </para> + + <programlisting><![CDATA[Collection orderedCollection = s.filter( collection, "order by this.amount" ); +Collection counts = s.filter( collection, "select this.type, count(this) group by this.type" );]]></programlisting> + + <para> + Puedes hallar el tamaño de una colección sin inicializarla: + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue();]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_sql.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/query_sql.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_sql.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/query_sql.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,477 @@ +<chapter id="querysql" revision="2"> + <title>SQL Nativo</title> + + <para> + Puedes también expresar consultas en el dialecto SQL nativo de tu base de datos. Esto es útil si quieres + utilizar aspectos específicos de base de datos tal como consejos (hints) de consulta o la palabra clave + <literal>CONNECT</literal> en Oracle. Provee además una clara ruta de migración desde una aplicación + basada en SQL/JDBC directo a Hibernate. + </para> + + <para> + Hibernate3 te permite especificar SQL escrito a mano (incluyendo procedimientos almacenados) para todas + las operaciones de creación, actualización, borrado y carga. + </para> + + <sect1 id="querysql-creating"> + <title>Creando una <literal>Query</literal> de SQL nativo</title> + + <para> + Las consultas SQL se controlan por medio de la interface <literal>SQLQuery</literal>, que se obtiene + llamando a <literal>Session.createSQLQuery()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createSQLQuery("select {cat.*} from cats cat") + .addEntity("cat", Cat.class) + .setMaxResults(50) + .list();]]></programlisting> + + <para> + Esta consulta especificada: + </para> + + <itemizedlist> + <listitem> + <para> + la cadena de consulta SQL, con un lugar para que Hibernate inyecte los alias de columnas + </para> + </listitem> + <listitem> + <para> + la entidad devuelta por la consulta, y sus alias de tablas SQL + </para> + </listitem> + </itemizedlist> + + <para> + El método <literal>addEntity()</literal> asocia alias de tablas SQL con clases de entidad, + y determina la forma del conjunto resultado de la consulta. + </para> + + <para> + El método <literal>addJoin()</literal> puede ser usado para cargar asociaciones a otras entidades y + colecciones. + </para> + + <programlisting><![CDATA[List cats = sess.createSQLQuery( + "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id" + ) + .addEntity("cat", Cat.class) + .addJoin("kitten", "cat.kittens") + .list();]]></programlisting> + + <para> + Una consulta SQL nativa podría devolver un valor escalar simple o una combinación de escalares y entidades. + </para> + + <programlisting><![CDATA[Double max = (Double) sess.createSQLQuery("select max(cat.weight) as maxWeight from cats cat") + .addScalar("maxWeight", Hibernate.DOUBLE); + .uniqueResult();]]></programlisting> + + + </sect1> + + <sect1 id="querysql-aliasreferences"> + <title>Alias y referencias de propiedad</title> + + <para> + La notación <literal>{cat.*}</literal> usada arriba es un atajo para "todas las propiedades". + Alternativamente, puedes listar las columnas explícitamente, pero incluso en este caso dejamos + que Hibernate inyecte los alias de columnas SQL para cada propiedad. El lugar para un alias de columna + es sólo el nombre de propiedad cualificado por el alias de la tabla. En el siguiente ejemplo, + recuperamos <literal>Cat</literal>s de una tabla diferente (<literal>cat_log</literal>) a una + declarada en los metadatos de mapeo. Nota que podríamos incluso usar los alias de propiedad en la + cláusula where si quisieramos. + </para> + <para> + La sintáxis <literal>{}</literal> <emphasis>no</emphasis> es requerida para consultas con nombre. + Ver <xref linkend="querysql-namedqueries"/> + </para> + + <programlisting><![CDATA[String sql = "select cat.originalId as {cat.id}, " + + "cat.mateid as {cat.mate}, cat.sex as {cat.sex}, " + + "cat.weight*10 as {cat.weight}, cat.name as {cat.name} " + + "from cat_log cat where {cat.mate} = :catId" + +List loggedCats = sess.createSQLQuery(sql) + .addEntity("cat", Cat.class) + .setLong("catId", catId) + .list();]]></programlisting> + + <para> + <emphasis>Nota:</emphasis> si listas cada propiedad explícitamente, ¡debes incluir todas las + propiedades de la clase <emphasis>y sus subclases</emphasis>! + </para> + + </sect1> + + <sect1 id="querysql-namedqueries" revision="2"> + <title>Consultas SQL con nombre</title> + + <para> + Las consultas SQL con nombre pueden definirse en el documento de mapeo y llamadas exactamente + en la misma forma en que a una consulta HQL con nombre. En este caso, <emphasis>no</emphasis> + necesitamos llamar a <literal>addEntity()</literal>. + </para> + + <programlisting><![CDATA[<sql-query name="persons"> + <return alias="person" class="eg.Person"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex} + FROM PERSON person + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <programlisting><![CDATA[List people = sess.getNamedQuery("persons") + .setString("namePattern", namePattern) + .setMaxResults(50) + .list();]]></programlisting> + + <para> + Los elementos <literal><return-join></literal> y <literal><load-collection></literal> + se usan para unir asociaciones y definir consultas que inicialicen colecciones, respectivamente. + </para> + + <programlisting><![CDATA[<sql-query name="personsWith"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <para> + Una consulta SQL con nombre puede devolver un valor escalar. Debes especificar el alias de columna y + tipo Hibernate usando el elementp <literal><return-scalar></literal>: + </para> + + <programlisting><![CDATA[<sql-query name="mySqlQuery"> + <return-scalar column="name" type="string"/> + <return-scalar column="age" type="long"/> + SELECT p.NAME AS name, + p.AGE AS age, + FROM PERSON p WHERE p.NAME LIKE 'Hiber%' +</sql-query>]]></programlisting> + + <sect2 id="propertyresults"> + <title>Usando return-property para especificar explícitamente nombres de columna/alias</title> + + <para> + Con <literal><return-property></literal> puedes decirle explícitamente a Hibernate qué + alias de columna usar, en vez de usar la sintáxis <literal>{}</literal> para dejar que Hibernate + inyecte sus propios alias. + </para> + + <programlisting><![CDATA[<sql-query name="mySqlQuery"> + <return alias="person" class="eg.Person"> + <return-property name="name" column="myName"/> + <return-property name="age" column="myAge"/> + <return-property name="sex" column="mySex"/> + </return> + SELECT person.NAME AS myName, + person.AGE AS myAge, + person.SEX AS mySex, + FROM PERSON person WHERE person.NAME LIKE :name +</sql-query> +]]></programlisting> + + <para> + <literal><return-property></literal> también trabaja con múltiples columnas. Esto resuelve una + limitación de la sintáxis <literal>{}</literal>, la cual no puede permitir un control fino de propiedades + multi-columna. + </para> + + <programlisting><![CDATA[<sql-query name="organizationCurrentEmployments"> + <return alias="emp" class="Employment"> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + <return-property name="endDate" column="myEndDate"/> + </return> + SELECT EMPLOYEE AS {emp.employee}, EMPLOYER AS {emp.employer}, + STARTDATE AS {emp.startDate}, ENDDATE AS {emp.endDate}, + REGIONCODE as {emp.regionCode}, EID AS {emp.id}, VALUE, CURRENCY + FROM EMPLOYMENT + WHERE EMPLOYER = :id AND ENDDATE IS NULL + ORDER BY STARTDATE ASC +</sql-query>]]></programlisting> + + <para> + Nota que en este ejemplo hemos usado <literal><return-property></literal> en combinación con + la sintáxis <literal>{}</literal> para inyección, permitiendo a los usuarios elejir cómo quieren + referirse a las columnas y propiedades. + </para> + + <para> + Si tu mapeo tiene un discriminador debes usar <literal><return-discriminator></literal> + para especificar la columna discriminadora. + </para> + </sect2> + + <sect2 id="sp_query"> + <title>Usando procedimientos almacenados para consultar</title> + + <para> + Hibernate3 introduce soporte para consultas vía procedimientos almacenados. Los procedimientos + almacenados deben devolver un conjunto resultado como el primer parámetro de salida para ser + capaces de funcionar con Hibernate. Un ejemplo de uno procedimiento almacenado en Oracle 9 + o superior es así: + </para> + + <programlisting><![CDATA[CREATE OR REPLACE FUNCTION selectAllEmployments + RETURN SYS_REFCURSOR +AS + st_cursor SYS_REFCURSOR; +BEGIN + OPEN st_cursor FOR + SELECT EMPLOYEE, EMPLOYER, + STARTDATE, ENDDATE, + REGIONCODE, EID, VALUE, CURRENCY + FROM EMPLOYMENT; + RETURN st_cursor; + END;]]></programlisting> + + <para> + Para usar esta consulta en Hibernate necesitas mapearla por medio de una consulta con nombre. + </para> + + <programlisting><![CDATA[<sql-query name="selectAllEmployees_SP" callable="true"> + <return alias="emp" class="Employment"> + <return-property name="employee" column="EMPLOYEE"/> + <return-property name="employer" column="EMPLOYER"/> + <return-property name="startDate" column="STARTDATE"/> + <return-property name="endDate" column="ENDDATE"/> + <return-property name="regionCode" column="REGIONCODE"/> + <return-property name="id" column="EID"/> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + </return> + { ? = call selectAllEmployments() } +</sql-query>]]></programlisting> + + <para> + Nota que los procedimientos almacenados sólo devuelven escalares y entidades. + No están soportados <literal><return-join></literal> y <literal><load-collection></literal>. + </para> + + <sect3 id="querysql-limits-storedprocedures"> + <title>Reglas/limitaciones para usar procedimientos almacenados</title> + + <para> + Para usar procedimientos almacenados con Hibernate los procedimientos tienen que seguir algunas reglas. + Si no siguen esas reglas no son usables por Hibernate. Si aún quisieras usar estos procedimientos + tendrías que ejecutarlos por medio de <literal>session.connection()</literal>. Las reglas son + diferentes para cada base de datos, ya que los vendedores de base de datos tienen diferentes + semánticas/sintáxis de procedimientos almacenados. + </para> + + <para> + Las consultas de procedimientos almacenados no pueden ser paginadas con + <literal>setFirstResult()/setMaxResults()</literal>. + </para> + + <para> + Para Oracle se aplican las siguientes reglas: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + El procedimiento debe devolver un conjunto resultado. Esto se hace devolviendo un + <literal>SYS_REFCURSOR</literal> en Oracle 9 o 10. En Oracle necesitas definir un + tipo <literal>REF CURSOR</literal>. + </para> + </listitem> + <listitem> + <para> + La forma recomendada es <literal>{ ? = call procName(<parameters>) }</literal> o + <literal>{ ? = call procName }</literal> (esto es más una regla de Oracle que una regla de Hibernate). + </para> + </listitem> + </itemizedlist> + + <para> + Para Sybase o MS SQL server se aplican las siguientes reglas: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + El procedimiento debe devolver un conjunto resultado. Nota que ya que estos servidores pueden + y devolverán múltiples conjuntos resultados y cuentas de actualización, Hibernate iterará + los resultados y tomará el primer resultado que sea un conjunto resultado como su valor + a devolver. Todo lo demás será descartado. + </para> + </listitem> + <listitem> + <para> + Si habilitas <literal>SET NOCOUNT ON</literal> en tu procedimiento será probablemente más + eficiente, pero esto no es un requerimiento. + </para> + </listitem> + </itemizedlist> + </sect3> + </sect2> + + </sect1> + + <sect1 id="querysql-cud"> + <title>SQL personalizado para crear, actualizar y borrar</title> + + <para> + Hibernate3 puede usar sentencias SQL personalizadas para las operaciones de + crear, actualizar y borrar. Los persistidores de clases y colecciones en Hibernate + ya contienen un conjunto de cadenas generadas en tiempo de configuración (insertsql, + deletesql, updatesql, etc.). Las etiquetas de mapeo <literal><sql-insert></literal>, + <literal><sql-delete></literal>, y <literal><sql-update></literal> sobrescriben + estas cadenas: + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert>INSERT INTO PERSON (NAME, ID) VALUES ( UPPER(?), ? )</sql-insert> + <sql-update>UPDATE PERSON SET NAME=UPPER(?) WHERE ID=?</sql-update> + <sql-delete>DELETE FROM PERSON WHERE ID=?</sql-delete> +</class>]]></programlisting> + + <para> + El SQL se ejecuta directamente en tu base de datos, de modo que eres libre de usar cualquier + dialecto que quieras. Esto reducirá, por supuesto, la portabilidad de tu mapeo si usas SQL + específico de la base de datos. + </para> + + <para> + Los procedimientos almacenados son soportados si está establecido el atributo + <literal>callable</literal>: + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert callable="true">{call createPerson (?, ?)}</sql-insert> + <sql-delete callable="true">{? = call deletePerson (?)}</sql-delete> + <sql-update callable="true">{? = call updatePerson (?, ?)}</sql-update> +</class>]]></programlisting> + + <para> + El orden de los parámetros posicionales son actualmente vitales, ya que deben estar en la + misma secuencia en que las espera Hibernate. + </para> + + <para> + Puedes ver el orden esperado habilitando el registro de depuración para el nivel + <literal>org.hibernate.persister.entity</literal>. Con este nivel habilitado, Hibernate + imprimirá el SQL estático que se usa para crear, actualizar, borrar, etc. las entidades. + (Para ver la secuencia esperada, recuerda no incluir tu SQL personalizado en los ficheros + de mapeo ya que sobrescribirán el sql estático generado por Hibernate.) + </para> + + <para> + Los procedimientos almacenados son, en la mayoría de los casos (léase, mejor hacerlo que no hacerlo), + obligados a devolver el número de filas insertadas/actualizadas/borradas, ya que Hibernate tiene algunas + comprobaciones en tiempo de ejecución del éxito de la sentencia. Hibernate siempre registra el primer + parámetro de la sentencia como un parámetro de salida numérico para las operaciones CUD: + </para> + + <programlisting><![CDATA[CREATE OR REPLACE FUNCTION updatePerson (uid IN NUMBER, uname IN VARCHAR2) + RETURN NUMBER IS +BEGIN + + update PERSON + set + NAME = uname, + where + ID = uid; + + return SQL%ROWCOUNT; + +END updatePerson;]]></programlisting> + + + </sect1> + + <sect1 id="querysql-load"> + <title>SQL personalizado para carga</title> + + <para> + Puedes también declarar tu propias consultas SQL (o HQL) para cargar entidades: + </para> + + <programlisting><![CDATA[<sql-query name="person"> + <return alias="pers" class="Person" lock-mode="upgrade"/> + SELECT NAME AS {pers.name}, ID AS {pers.id} + FROM PERSON + WHERE ID=? + FOR UPDATE +</sql-query>]]></programlisting> + + <para> + Esto es sólo una declaración de consulta con nombrem como se ha discutido anteriormente. + Puedes hacer referencia a esta consulta con nombre en un mapeo de clase: + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <loader query-ref="person"/> +</class>]]></programlisting> + + <para> + Esto incluso funciona con procedimientos almacenados. + </para> + + <para> + Puedes incluso definit una consulta para la carga de colecciones: + </para> + +<programlisting><![CDATA[<set name="employments" inverse="true"> + <key/> + <one-to-many class="Employment"/> + <loader query-ref="employments"/> +</set>]]></programlisting> + + <programlisting><![CDATA[<sql-query name="employments"> + <load-collection alias="emp" role="Person.employments"/> + SELECT {emp.*} + FROM EMPLOYMENT emp + WHERE EMPLOYER = :id + ORDER BY STARTDATE ASC, EMPLOYEE ASC +</sql-query>]]></programlisting> + + <para> + Podrías incluso definir un cargador de entidades que cargue una colección por + recuperación por unión (join fetching): + </para> + + <programlisting><![CDATA[<sql-query name="person"> + <return alias="pers" class="Person"/> + <return-join alias="emp" property="pers.employments"/> + SELECT NAME AS {pers.*}, {emp.*} + FROM PERSON pers + LEFT OUTER JOIN EMPLOYMENT emp + ON pers.ID = emp.PERSON_ID + WHERE ID=? +</sql-query>]]></programlisting> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/quickstart.xml (from rev 12891, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/quickstart.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/quickstart.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/quickstart.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,666 @@ +<chapter id="quickstart"> + <title>Comienzo rápido con Tomcat</title> + + <sect1 id="quickstart-intro" revision="2"> + <title>Empezando con Hibernate</title> + + <para> + Este tutorial explica una instalación de Hibernate con el + contenedor de servlets Apache Tomcat (hemos usado la versión 4.1, + las diferencias con la 5.0 deben ser mínimas) para una aplicación + basada en web. Hibernate trabaja bien en un entorno manejado con + todos los servidores de aplicaciones J2EE importantes, o incluso en aplicaciones + Java independientes. El sistema de base de datos es sólo una cuestión + de cambiar la configuración del dialecto SQL de Hibernate y las + propiedades de conexión. + </para> + + <para> + Primero, tenemos que copiar todas las bibliotecas requeridas a la instalación + de Tomcat. Usamos un contexto web separado (<literal>webapps/quickstart</literal>) + para este tutorial, de modo que tenemos que considerar tanto la ruta de búsqueda + de bibliotecas global (<literal>TOMCAT/common/lib</literal>) como también + el cargador de clases a nivel de contexto en <literal>webapps/quickstart/WEB-INF/lib</literal> + (para ficheros JAR) y <literal>webapps/quickstart/WEB-INF/classes</literal>. + Nos referiremos a ambos niveles de cargador de clases como el classpath global y el classpath + de contexto, respectivamente. + </para> + + <para> + Ahora, copia las bibliotecas a los dos classpaths: + </para> + + <orderedlist> + <listitem> + <para> + Copia el driver JDBC para la base de datos al classpath global. Esto se + requiere para el software de pool de conexiones DBCP que se distribuye + con Tomcat. Hibernate usa conexiones JDBC para ejecutar SQL sobre la base de + datos, de modo que, o bien tienes que proveer conexiones JDBC en pool, + o bien configurar Hibernate para que use uno de los pools soportados + directamente (C3P0, Proxool). Para este tutorial, copia la biblioteca + <literal>pg74jdbc3.jar</literal> (para PostgreSQL 7.4 y JDK 1.4) al + classpath del cargador global. Si quisieras usar una base de datos diferente, + simplemente copia su apropiado driver JDBC. + </para> + </listitem> + <listitem> + <para> + Nunca copies nada más dentro de la ruta del cargador de clases global + en Tomcat, o tendrás problemas con varias herramientas, incluyendo + Log4J, commons-logging y otras. Siempre usa el classpath de contexto para + cada aplicación web, esto es, copia las bibliotecas a + <literal>WEB-INF/lib</literal> y tus propias clases y ficheros de + configuración/propiedades a <literal>WEB-INF/classes</literal>. + Ambos directorios están a nivel del classpath de contexto por defecto. + </para> + </listitem> + <listitem> + <para> + Hibernate está empaquetado como una biblioteca JAR. El fichero + <literal>hibernate3.jar</literal> debe ser copiado en el classpath de contexto + junto a las otras clases de la aplicación. Hibernate requiere algunas + bibliotecas de terceros en tiempo de ejecución; éstas vienen + incluídas con la distribución de Hibernate en el directorio + <literal>lib/</literal>. Ver <xref linkend="3rdpartylibs"/>. Copia las + bibliotecas de terceros requeridas al classpath de contexto. + </para> + </listitem> + </orderedlist> + + <table frame="topbot" id="3rdpartylibs"> + <title> + Bibliotecas de terceros de Hibernate + </title> + <tgroup cols="2" rowsep="1" colsep="1"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="2*"/> + <thead> + <row> + <entry align="center"> + Biblioteca + </entry> + <entry align="center"> + Descripción + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + antlr (requerida) + </entry> + <entry> + Hibernate usa ANTLR para producir analizadores de consultas, + esta biblioteca también se necesita en tiempo de ejecución. + </entry> + </row> + <row> + <entry> + dom4j (requerida) + </entry> + <entry> + Hibernate usa dom4j para analizar ficheros de configuración + XML y ficheros de metadatos de mapeo XML. + </entry> + </row> + <row> + <entry> + CGLIB, asm (requerida) + </entry> + <entry> + Hibernate usa la biblioteca de generación de código + para aumentar las clases en tiempo de ejecución + (en combinación con reflección Java). + </entry> + </row> + <row> + <entry> + Commons Collections, Commons Logging (requeridas) + </entry> + <entry> + Hibernate usa varias bibliotecas de utilidad del proyecto + Jakarta Commons de Apache. + </entry> + </row> + <row> + <entry> + EHCache (requerida) + </entry> + <entry> + Hibernate puede usar varios provedores de caché para + el caché de segundo nivel. EHCache es el provedor de + caché por defecto si no se cambia en la configuración. + </entry> + </row> + <row> + <entry> + Log4j (opcional) + </entry> + <entry> + Hibernate usa la API de Commons Logging, que a su vez puede + usar Log4J como el mecanismo de logging subyacente. Si la + biblioteca Log4J está disponible en el directorio de + bibliotecas del contexto, Commons Logging usará Log4J + y la configuración <literal>log4j.properties</literal> + en el classpath de contexto. Un fichero de propiedades de ejemplo + para Log4J se incluye con la distribución de Hibernate. + Así que copia log4j.jar y el fichero de configuración + (de <literal>src/</literal>) a tu classpath de contexto si quieres + ver que ocurre tras escénas. + </entry> + </row> + <row> + <entry> + ¿Requerida o no? + </entry> + <entry> + Echa una mirada al fichero <literal>lib/README.txt</literal> en la + distribución de Hibernate. Esta es una lista actualizada + de bibliotecas de terceros distribuídas con Hibernate. + Encontrarás listadas ahí todas las bibliotecas + requeridas y opcionales (Observa que "buildtame required" significa + aquí para la construcción de Hibernate, no de tu + aplicación). + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Ahora instalamos el pooling y modo compartido de conexiones de base de datos + tanto en Tomcat como Hibernate. Esto significa que Tomcat proveerá + conexiones JDBC en pool (usando su funcionalidad prefabricada de pooling DBCP). + Hibernate pide esas conexiones a través de JNDI. Alternativamente, + puedes dejar que Hibernate maneje el pool de conexiones. Tomcat liga su pool + de conexiones a JNDI; agregamos una declaración de recurso al fichero + de configuración principal de Tomcat, <literal>TOMCAT/conf/server.xml</literal>: + </para> + + <programlisting><![CDATA[<Context path="/quickstart" docBase="quickstart"> + <Resource name="jdbc/quickstart" scope="Shareable" type="javax.sql.DataSource"/> + <ResourceParams name="jdbc/quickstart"> + <parameter> + <name>factory</name> + <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> + </parameter> + +  + <parameter> + <name>url</name> + <value>jdbc:postgresql://localhost/quickstart</value> + </parameter> + <parameter> + <name>driverClassName</name><value>org.postgresql.Driver</value> + </parameter> + <parameter> + <name>username</name> + <value>quickstart</value> + </parameter> + <parameter> + <name>password</name> + <value>secret</value> + </parameter> + +  + <parameter> + <name>maxWait</name> + <value>3000</value> + </parameter> + <parameter> + <name>maxIdle</name> + <value>100</value> + </parameter> + <parameter> + <name>maxActive</name> + <value>10</value> + </parameter> + </ResourceParams> +</Context>]]></programlisting> + + <para> + El contexto que configuramos en este ejemplo se llama <literal>quickstart</literal>, + su base es el directorio <literal>TOMCAT/webapp/quickstart</literal>. Para acceder + a cualquier servlet, llama a la ruta <literal>http://localhost:8080/quickstart</literal> + en tu navegador (por supuesto, agregando el nombre del servlet como se mapee en tu + <literal>web.xml</literal>). Puedes también ir más allá y crear + ahora un servlet simple que tenga un método <literal>process()</literal> + vacío. + </para> + + <para> + Tomcat provee ahora conexiones a través de JNDI en + <literal>java:comp/env/jdbc/quickstart</literal>. Si tienes problemas obteniendo + el pool de conexiones en ejecución, refiérete a la documentación + de Tomcat. Si obtienes mensajes de excepción del driver JDBC, intenta instalar + primero el pool de conexiones JDBC sin Hibernate. Hay disponibles en la Web + tutoriales de Tomcat y JDBC. + </para> + + <para> + Tu próximo paso es configurar Hibernate. Hibernate tiene que saber cómo + debe obtener conexiones JDBC. Usamos la configuración de Hibernate basada en XML. + El otro enfoque, usando un ficheros de propiedad, es casi equivalente pero pierde unas + pocas funcionalidades que sí permite la sintaxis XML. El fichero de configuración + XML se ubica en el classpath de contexto (<literal>WEB-INF/classes</literal>), como + <literal>hibernate.cfg.xml</literal>: + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <session-factory> + + <property name="connection.datasource">java:comp/env/jdbc/quickstart</property> + <property name="show_sql">false</property> + <property name="dialect">org.hibernate.dialect.PostgreSQLDialect</property> + +  + <mapping resource="Cat.hbm.xml"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + Desactivamos el registro (logging) de comandos SQL y decimos a Hibernate + qué dialecto SQL de base de datos se usa y dónde obtener + conexiones JDBC (declarando la dirección JNDI del pool ligado a + Tomcat). El dialecto es una configuración requerida, las bases de + datos difieren en su interpretación del "estándar" de SQL. + Hibernate cuidará de las diferencias y viene con dialectos incluídos + para todas las principales bases de datos comerciales y de código + abierto. + </para> + + <para> + Una <literal>SessionFactory</literal> es el concepto de Hibernate + de un almacén de datos solo. Pueden usarse múltiples + bases de datos creando múltiples ficheros de configuración + XML y creando múltiples objetos <literal>Configuration</literal> + y <literal>SessionFactory</literal> en tu aplicación. + </para> + + <para> + El último elemento del <literal>hibernate.cfg.xml</literal> + declara <literal>Cat.hbm.xml</literal> como el nombre de un fichero + de mapeo XML para la clase persistente <literal>Cat</literal>. Este + fichero contiene los metadatos para el mapeo de la clase POJO + <literal>Cat</literal> a una tabla (o tablas) de base de datos. + Volveremos a este fichero pronto. Escribamos primero la clase POJO + y luego declaremos los metadatos de mapeo para ella. + </para> + + </sect1> + + <sect1 id="quickstart-persistentclass" revision="1"> + <title>Primera clase persistente</title> + + <para> + Hibernate trabaja mejor con el modelo de programación de los + Viejos Objetos Planos de Java (POJOs, a veces llamados Ordinarios Objetos Planos de Java) + para clases persistentes. Un POJO es como un JavaBean, con las propiedades + de la clase accesible vía métodos getter y setter, + encapsulando la representación interna de la interfaz publicamente + visible (Hibernate puede también acceder a los campos directamente, si se + necesita): + </para> + + <programlisting><![CDATA[package org.hibernate.examples.quickstart; + +public class Cat { + + private String id; + private String name; + private char sex; + private float weight; + + public Cat() { + } + + public String getId() { + return id; + } + + private void setId(String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public char getSex() { + return sex; + } + + public void setSex(char sex) { + this.sex = sex; + } + + public float getWeight() { + return weight; + } + + public void setWeight(float weight) { + this.weight = weight; + } + +}]]></programlisting> + + <para> + Hibernate no está restringido en su uso de tipos de propiedad, todos + los tipos y tipos primitivos del JDK de Java (como <literal>String</literal>, + <literal>char</literal> y <literal>Date</literal>) pueden ser mapeados, incluyendo + clases del framework de colecciones de Java. Puedes mapearlos como valores, + colecciones de valores, o asociaciones a otras entidades. El <literal>id</literal> + es una propiedad especial que representa el identificador de base de datos (clave + primaria) de la clase. Es altamente recomendado para entidades como un + <literal>Cat</literal>. Hibernate puede usar identificadores sólo + internamente, pero perderíamos algo de la flexibilidad en nuestra + arquitectura de aplicación. + </para> + + <para> + No tiene que implementarse ninguna interface especial para las clases persistentes + ni tienes que subclasear de una clase persistente raíz en especial. Hibernate + tampoco requiere ningún procesamiento en tiempo de construcción, + como manipulación del byte-code. Se basa solamente en reflección de Java + y aumentación de clases en tiempo de ejecución (a través de CGLIB). + De modo que, sin ninguna dependencia de la clase POJO en Hibernate, podemos mapearla + a una tabla de base de datos. + </para> + + </sect1> + + <sect1 id="quickstart-mapping" revision="1"> + <title>Mapeando el gato</title> + + <para> + El fichero de mapeo <literal>Cat.hbm.xml</literal> contiene los + metadatos requeridos para el mapeo objeto/relacional. Los metadatos + incluyen la declaración de clases persistentes y el mapeo de + propiedades (a columnas y relaciones de claves foráneas a otras + entidades) a tablas de base de datos. + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping> + + <class name="org.hibernate.examples.quickstart.Cat" table="CAT"> + +  + <id name="id" type="string" unsaved-value="null" > + <column name="CAT_ID" sql-type="char(32)" not-null="true"/> + <generator class="uuid.hex"/> + </id> + +  + <property name="name"> + <column name="NAME" length="16" not-null="true"/> + </property> + + <property name="sex"/> + + <property name="weight"/> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Cada clase persistente debe tener un atributo identificador (realmente, + sólo las clases que representen entidades, no las clases dependientes + de tipo-valor, que son mapeadas como componentes de una entidad). Esta propiedad + es usada para distinguir los objetos persistentes: Dos gatos son iguales si + <literal>catA.getId().equals(catB.getId())</literal> es verdadero. Este concepto + se llama <emphasis>identidad de base de datos (database identity)</emphasis>. + Hibernate viene empaquetado con varios generadores de identificador para diferentes + escenarios (incluyendo generadores nativos para secuencias de base de datos, tablas + de identificadores alto/bajo, e identificadores asignados por aplicación). + Usamos el generador UUID (recomendado sólo para pruebas, pues deben + preferirse las claves enteras delegadas generadas por la base de datos) y + también especificamos la columna <literal>CAT_ID</literal> de la tabla + <literal>CAT</literal> para el valor identificador generado por Hibernate + (como una clave primaria de la tabla). + </para> + + <para> + Todas las demás propiedades de <literal>Cat</literal> son mapeadas a la + misma tabla. En el caso de la propiedad <literal>name</literal>, la hemos mapeado + con una declaración explícita de columna de base de datos. Esto es + especialmente útil cuando el esquema de base de datos es generado + automáticamente (como sentencias DDL de SQL) desde la declaración + de mapeo con la herramienta <emphasis>SchemaExport</emphasis> de Hibernate. + Todas las demás propiedades son mapeadas usando la configuración + por defecto de Hibernate, que es lo que necesitas la mayoría del tiempo. + La tabla <literal>CAT</literal> en la base de datos se ve así como: + </para> + + <programlisting><![CDATA[ Columna | Tipo | Modificadores +--------+-----------------------+----------- + cat_id | character(32) | not null + name | character varying(16) | not null + sex | character(1) | + weight | real | +Indexes: cat_pkey primary key btree (cat_id)]]></programlisting> + + <para> + Ahora debes crear esta tabla manualmente en tu base de datos, y luego leer el + <xref linkend="toolsetguide"/> si quieres automatizar este paso con la + herramienta <literal>hbm2ddl</literal>. Esta herramienta puede crear un + DDL SQL completo, incluyendo definición de tablas, restricciones + personalizadas de tipo de columnas, restricciones de unicidad e índices. + </para> + + </sect1> + + <sect1 id="quickstart-playingwithcats" revision="2"> + <title>Jugando con gatos</title> + + <para> + Ahora estamos listos para comenzar la <literal>Session</literal> de Hibernate. + Es el <emphasis>manejador de persistencia</emphasis> que usamos para almacenar + y traer <literal>Cat</literal>s hacia y desde la base de datos. Pero primero, + tenemos que obtener una <literal>Session</literal> (unidad de trabajo de Hibernate) + de la <literal>SessionFactory</literal>: + </para> + + <programlisting><![CDATA[SessionFactory sessionFactory = + new Configuration().configure().buildSessionFactory();]]></programlisting> + + <para> + La llamada a <literal>configure()</literal> carga el fichero de + configuración <literal>hibernate.cfg.xml</literal> e + inicializa la instancia de <literal>Configuration</literal>. + Puedes establecer otras propiedades (e incluso cambiar los metadatos de mapeo) + accediendo a la <literal>Configuration</literal> <emphasis>antes</emphasis> + que construyas la <literal>SessionFactory</literal> (que es inmutable). + ¿Dónde creamos la <literal>SessionFactory</literal> y cómo + accedemos a ella en nuestra aplicación? + </para> + + <para> + Una <literal>SessionFactory</literal> usualmente se construye una vez, + por ejemplo, al arrancar con un servlet <emphasis>load-on-startup</emphasis>. + Esto significa también que no debes mantenerla en una variable de instancia + en tus servlets, sino en alguna otro sitio. Además, necesitamos algún + tipo de <emphasis>Singleton</emphasis>, de modo que podamos acceder a la + <literal>SessionFactory</literal> fácilmente en el código de + aplicación. El siguiente enfoque mostrado resuelve ambos problemas: + configuración de arranque y fácil acceso a una + <literal>SessionFactory</literal>. + </para> + + <para> + Implementamos una clase de ayuda <literal>HibernateUtil</literal>: + </para> + + <programlisting><![CDATA[import org.hibernate.*; +import org.hibernate.cfg.*; + +public class HibernateUtil { + + private static Logger log = LoggerFactory.getLogger(HibernateUtil.class); + + private static final SessionFactory sessionFactory; + + static { + try { + // Create the SessionFactory + sessionFactory = new Configuration().configure().buildSessionFactory(); + } catch (Throwable ex) { + // Make sure you log the exception, as it might be swallowed + log.error("Initial SessionFactory creation failed.", ex); + throw new ExceptionInInitializerError(ex); + } + } + + public static final ThreadLocal session = new ThreadLocal(); + + public static Session currentSession() { + Session s = (Session) session.get(); + // Open a new Session, if this Thread has none yet + if (s == null) { + s = sessionFactory.openSession(); + session.set(s); + } + return s; + } + + public static void closeSession() { + Session s = (Session) session.get(); + if (s != null) + s.close(); + session.set(null); + } +}]]></programlisting> + + <para> + Esta clase no sólo cuida de la <literal>SessionFactory</literal> + con su inicializador static, sino que además tiene una variable + <literal>ThreadLocal</literal> que tiene la <literal>Session</literal> + para la hebra actual. Asegúrate de entender el concepto Java de una + variable local a una hebra antes de intentar usar esta ayuda. Una clase + <literal>HibernateUtil</literal> más compleja y potente puede + encontrarse en <literal>CaveatEmptor</literal>, http://caveatemptor.hibernate.org/ + </para> + + <para> + Una <literal>SessionFactory</literal> es segura entre hebras, muchas hebras pueden + acceder a ella concurrentemente y pedirle <literal>Session</literal>s. Una + <literal>Session</literal> no es un objeto seguro entre hebras que representa + una sola unidad-de-trabajo con la base de datos. Las <literal>Session</literal>s + se abren desde una <literal>SessionFactory</literal> y son cerradas cuando + todo el trabajo está completo. Un ejemplo en el método + <literal>process()</literal> de tu servlet podría parecerse a esto + (sin manejo de excepciones): + </para> + + <programlisting><![CDATA[Session session = HibernateUtil.currentSession(); +Transaction tx = session.beginTransaction(); + +Cat princess = new Cat(); +princess.setName("Princess"); +princess.setSex('F'); +princess.setWeight(7.4f); + +session.save(princess); + +tx.commit(); +HibernateUtil.closeSession();]]></programlisting> + + <para> + En una <literal>Session</literal>, cada operación de base de datos + ocurre dentro de una transacción que aísla las operaciones + de base de datos (incluso operaciones de sólo lectura). + Usamos la API de <literal>Transaction</literal> de Hibernate para + abstraer de la estrategia de transacciones subyacente (en nuestro caso, + transacciones JDBC). Esto permite que nuestro código sea desplegado + con transacciones manejadas por contenedor (usando JTA) sin cambio alguno. + </para> + + <para> + Observa que puedes llamar <literal>HibernateUtil.currentSession();</literal> + tantas veces como quieras, siempre obtendrás la <literal>Session</literal> + actual de esta hebra. Tienes que asegurarte que la <literal>Session</literal> + sea cerrada después que se complete tu unidad-de-trabajo, ya sea en + código de tu servlet o en un filtro de servlet antes que la respuesta HTTP + sea enviada. El bonito efecto colateral de la segunda opción es la + fácil inicialización perezosa: la <literal>Session</literal> todavía + está abierta cuando se dibuja la vista, de modo que Hibernate puede cargar + objetos no inicializados mientras navegas tu actual grafo de objetos. + </para> + + <para> + Hibernate tiene varios métodos que pueden ser usados para traer + objetos desde la base de datos. La forma más flexible es usando + el Lenguaje de Consulta de Hibernate (Hibernate Query Language o HQL), + que es una extensión orientada a objetos de SQL fácil de + aprender: + </para> + + <programlisting><![CDATA[Transaction tx = session.beginTransaction(); + +Query query = session.createQuery("select c from Cat as c where c.sex = :sex"); +query.setCharacter("sex", 'F'); +for (Iterator it = query.iterate(); it.hasNext();) { + Cat cat = (Cat) it.next(); + out.println("Female Cat: " + cat.getName() ); +} + +tx.commit();]]></programlisting> + + <para> + Hibernate también ofrece una API <emphasis>consulta por criterios</emphasis> + orientada a objetos que puede ser usada para formular consultas de tipo seguro. + Por supuesto, Hibernate usa <literal>PreparedStatement</literal>s y ligado de + parámetros para toda la comunicación SQL con la base de datos. + También puedes usar la funcionalidad de consulta SQL directa de Hibernate + u obtener una conexión plana de JDBC de una <literal>Session</literal> + en casos raros. + </para> + + </sect1> + + <sect1 id="quickstart-summary" revision="1"> + <title>Finalmente</title> + + <para> + Rasguñamos solamente la superficie de Hibernate en este pequeño + tutorial. Por favor, observa que no incluimos ningún código + específico de servlet en nuestros ejemplos. Tienes que crear un servlet + por tí mismo e insertar el código de Hibernate como lo veas + ubicado. + </para> + + <para> + Ten en mente que Hibernate, como capa de acceso a datos, está firmemente + integrado dentro de tu aplicación. Usualmente, todas las otras capas dependen + del mecanismo de persistencia. Asegúrate de entender las implicaciones + de este diseño. + </para> + + <para> + Para un ejemplo de aplicación más compleja, ver + http://caveatemptor.hibernate.org/ y echa una mirada a los + otros tutoriales con links en http://www.hibernate.org/Documentation + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/session_api.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/session_api.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/session_api.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/session_api.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,1224 @@ +<chapter id="objectstate"> + <title>Trabajando con objetos</title> + + <para> + Hibernate es una solución completa de mapeo objeto/relacional que no sólo + abstrae al desarrollador de los detalles del sistema de manejo de base datos + subyacente, sino que además ofrece <emphasis>manejo de estado</emphasis> de + objetos. Esto es, al contrario del manejo de <literal>sentencias</literal> + SQL en capas comunes de persistencia JDBC/SQL, una vista de la persistencia + en aplicaciones Java muy natural y orientada a objetos. + </para> + + <para> + En otras palabras, los desarroladores de aplicaciones Hibernate deben siempre + pensar en el <emphasis>estado</emphasis> de sus objetos, y no necesariamente + en la ejecución de sentencias SQL. Esta parte es cuidada por Hibernate y es + sólo relevante para el desarrollador de la aplicación al afinar el rendimiento + del sistema. + </para> + + <sect1 id="objectstate-overview"> + <title>Estados de objeto de Hibernate</title> + + <para> + Hibernate define y soporta los siguientes estados de objeto: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Transitorio</emphasis> - un objeto es transitorio si ha sido + recién instanciado usando el operador <literal>new</literal>, y no está + asociado a una <literal>Session</literal> de Hibernate. No tiene una + representación persistente en la base de datos y no se le ha asignado un + valor identificador. Las instancias transitorias serán destruídas por el + recolector de basura si la aplicación no mantiene más una referencia. + Usa la <literal>Session</literal> de Hibernate para hacer un objeto + persistente (y deja que Hibernate cuide de las sentencias SQL que necesitan + ejecutarse para esta transición). + </para> + </listitem> + <listitem> + <para> + <emphasis>Persistente</emphasis> - una instancia persistente tiene una + representación en la base de datos y un valor identificador. Puede haber + sido salvado o cargado, sin embargo, está por definición en el ámbito de + una <literal>Session</literal>. Hibernate detectará cualquier cambio hecho + a un objeto en estado persistentey sincronizará el estado con la base de + datos cuando se complete la unidad de trabajo. Los desarrolladores no ejecutan + sentencias <literal>UPDATE</literal> manuales, o sentencias <literal>DELETE</literal> + cuando un objeto debe ser hecho transitorio. + </para> + </listitem> + <listitem> + <para> + <emphasis>Separado (detached)</emphasis> - una instancia separada es un objeto + que ha sido hecho persistente, pero su <literal>Session</literal> ha sido cerrada. + La referencia al objeto todavía es válida, por supuesto, y la instancia separada + podría incluso ser modificada en este estado. Una instancia separada puede ser + re-unida a una nueva <literal>Session</literal> en un punto posterior en el tiempo, + haciéndola persistente de nuevo (con todas las modificaciones). Este aspecto + habilita un modelo de programación para unidades de trabajo de ejecución larga + que requieren tiempo-para-pensar del usuario. Las llamamos <emphasis>transaccciones + de aplicación</emphasis>, es decir, una unidad de trabajo desde el punto de vista + del usuario. + </para> + </listitem> + </itemizedlist> + + <para> + Discutiremos ahora los estados y transiciones de estados (y los métodos de Hibernate que + disparan una transición) en más detalle: + </para> + + </sect1> + + <sect1 id="objectstate-makingpersistent" revision="1"> + <title>Haciendo los objetos persistentes</title> + + <para> + Las instancias recién instanciadas de una clase persistente son consideradas + <emphasis>transitorias</emphasis> por Hibernate. Podemos hacer una instancia + transitoria <emphasis>persistente</emphasis> asociándola con una sesión: + </para> + + <programlisting><![CDATA[DomesticCat fritz = new DomesticCat(); +fritz.setColor(Color.GINGER); +fritz.setSex('M'); +fritz.setName("Fritz"); +Long generatedId = (Long) sess.save(fritz);]]></programlisting> + + <para> + Si <literal>Cat</literal> tiene un identificador generado, el identificador es + generado y asignado al <literal>cat</literal> cuando se llama a <literal>save()</literal>. + Si <literal>Cat</literal> tiene un identificador <literal>assigned</literal>, + o una clave compuesta, el identificador debe ser asignado a la instancia de + <literal>cat</literal> antes de llamar a <literal>save()</literal>. Puedes también + usar <literal>persist()</literal> en vez de <literal>save()</literal>, con la semántica + definida en el temprano borrador de EJB3. + </para> + + <para> + Alternativamente, puedes asignar el identificador usando una versión sobrecargada + de <literal>save()</literal>. + </para> + +<programlisting><![CDATA[DomesticCat pk = new DomesticCat(); +pk.setColor(Color.TABBY); +pk.setSex('F'); +pk.setName("PK"); +pk.setKittens( new HashSet() ); +pk.addKitten(fritz); +sess.save( pk, new Long(1234) );]]></programlisting> + + <para> + Si el objeto que haces persistente tiene objetos asociados (por ejemplo, + la colección <literal>kittens</literal> en el ejemplo anterior), estos + objetos pueden ser hechos persistentes en cualquier orden que quieras + a menos que tengas una restricción <literal>NOT NULL</literal> sobre una + columna clave foránea. Nunca hay riesgo de violar restricciones de clave + foránea. Sin embargo, podrías violar una restricción <literal>NOT NULL</literal> + si llamas a <literal>save()</literal> sobre objetos en orden erróneo. + </para> + + <para> + Usualmente no te preocupas con este detalle, pues muy probablemente usarás + la funcionalidad de <emphasis>persistencia transitiva</emphasis> de Hibernate + para salvar los objetos asociados automáticamente. Entonces, ni siquiera ocurren + violaciones de restricciones <literal>NOT NULL</literal> - Hibernate cuidará de todo. + La persistencia transitiva se discute más adelante en este capítulo. + </para> + + </sect1> + + <sect1 id="objectstate-loading"> + <title>Cargando un objeto</title> + + <para> + Los métodos <literal>load()</literal> de <literal>Session</literal> te brindan + una forma de traer una instancia persistente si ya saves su identificador. + <literal>load()</literal> toma un objeto clase y cargará el estado dentro de + una instancia recién instanciada de esta clase, en estado persistente. + </para> + + <programlisting><![CDATA[Cat fritz = (Cat) sess.load(Cat.class, generatedId);]]></programlisting> + +<programlisting><![CDATA[// you need to wrap primitive identifiers +long id = 1234; +DomesticCat pk = (DomesticCat) sess.load( DomesticCat.class, new Long(id) );]]></programlisting> + + <para> + Alternativamente, puedes cargar estado dentro de una instancia dada: + </para> + +<programlisting><![CDATA[Cat cat = new DomesticCat(); +// load pk's state into cat +sess.load( cat, new Long(pkId) ); +Set kittens = cat.getKittens();]]></programlisting> + + <para> + Nota que <literal>load()</literal> lanzará una excepción irrecuperable si no + hay una fila correspondiente en base de datos. Si la clase es mapeada con un + proxy, <literal>load()</literal> sólo devuelve un proxy no inicializado y no + llamará realmente a la base de datos hasta que invoques un método del proxy. + Este comportamiento es muy útil si deseas crear una asociación a un objeto + sin cargarlo realmente de la base de datos. Permite además que múltiples + instancias sean cargadas como un lote si se define <literal>batch-size</literal> + para el mapeo de la clase. + </para> + + <para> + Si no tienes certeza que exista una fila correspondiente, debes usar el + método <literal>get()</literal>, que llama a la base de datos inmediatamente + y devuelve nulo si no existe una fila correspondiente. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id); +if (cat==null) { + cat = new Cat(); + sess.save(cat, id); +} +return cat;]]></programlisting> + + <para> + Puedes incluso cargar un objeto usando un <literal>SELECT ... FOR UPDATE</literal> de SQL, + usando un <literal>LockMode</literal>. Ver la documentación de la API para más + información. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id, LockMode.UPGRADE);]]></programlisting> + + <para> + Ten en cuenta que <emphasis>ninguna</emphasis> instancia asociada o colección contenida es + selecciona <literal>FOR UPDATE</literal>, a menos que decidas especificar + <literal>lock</literal> o <literal>all</literal> como un estilo de cascada para la + asociación. + </para> + + <para> + Es posible volver a cargar un objeto y todas sus colecciones en cualquier momento, + usando el método <literal>refresh()</literal>. Esto es útil cuando se usan disparadores de + base de datos para inicializar algunas de las propiedades del objeto. + </para> + + <programlisting><![CDATA[sess.save(cat); +sess.flush(); //force the SQL INSERT +sess.refresh(cat); //re-read the state (after the trigger executes)]]></programlisting> + + <para> + Una cuestión importante aparece usualmente en este punto: ¿Cuánto carga Hibernate de + la base de datos y cuántos <literal>SELECT</literal>s de SQL usará? Esto depende de la + <emphasis>estrategia de recuperación</emphasis> y se explica en <xref linkend="performance-fetching"/>. + </para> + + </sect1> + + <sect1 id="objectstate-querying" revision="1"> + <title>Consultando</title> + + <para> + Si no sabes los identificadores de los objetos que estás buscando, + necesitas una consulta. Hibernate soporta un lenguaje de consulta + orientado a objetos (HQL) fácil de usar pero potente. Para la creación + de consultas programáticas, Hibernate soporta una funcionalidad sofisticada + de consulta de Criteria y Example (QBC and QBE). También puedes expresar tu + consulta en el SQL nativo de tu base de datos, con soporte opcional de Hibernate + para la conversión del conjunto resultado en objetos. + </para> + + <sect2 id="objectstate-querying-executing"> + <title>Ejecutando consultas</title> + + <para> + Las consultas HQL y SQL nativas son representadas con una instancia de + <literal>org.hibernate.Query</literal>. Esta interface ofrece métodos para + la ligación de parámetros, manejo del conjunto resultado, y para la + ejecución de la consulta real. Siempre obtienes una <literal>Query</literal> + usando la <literal>Session</literal> actual: + </para> + + <programlisting><![CDATA[List cats = session.createQuery( + "from Cat as cat where cat.birthdate < ?") + .setDate(0, date) + .list(); + +List mothers = session.createQuery( + "select mother from Cat as cat join cat.mother as mother where cat.name = ?") + .setString(0, name) + .list(); + +List kittens = session.createQuery( + "from Cat as cat where cat.mother = ?") + .setEntity(0, pk) + .list(); + +Cat mother = (Cat) session.createQuery( + "select cat.mother from Cat as cat where cat = ?") + .setEntity(0, izi) + .uniqueResult();]]></programlisting> + + <para> + Una consulta se ejecuta usualmente invocando a <literal>list()</literal>, + el resultado de la consulta será cargado completamente dentro de una + colección en memoria. Las instancias de entidad traídas por una consulta + están en estado persistente. El método <literal>uniqueResult()</literal> + ofrece un atajo si sabes que tu consulta devolverá sólo un objeto. + </para> + + <sect3 id="objectstate-querying-executing-iterate"> + <title>Iterando los resultados</title> + + <para> + Ocasionalmente, podrías ser capaz de lograr mejor rendimiento al ejecutar la consulta + usando el método <literal>iterate()</literal>. Esto sólo será en el caso que esperes + que las instancias reales de entidad devueltas por la consulta estén ya en la sesión + o caché de segundo nivel. Si todavía no están en caché, <literal>iterate()</literal> + será más lento que <literal>list()</literal> y podría requerir muchas llamadas a la + base de datos para una consulta simple, usualmente <emphasis>1</emphasis> para la + selección inicial que solamente devuelve identificadores, y <emphasis>n</emphasis> + selecciones adicionales para inicializar las instancias reales. + </para> + + <programlisting><![CDATA[// fetch ids +Iterator iter = sess.createQuery("from eg.Qux q order by q.likeliness").iterate(); +while ( iter.hasNext() ) { + Qux qux = (Qux) iter.next(); // fetch the object + // something we couldnt express in the query + if ( qux.calculateComplicatedAlgorithm() ) { + // delete the current instance + iter.remove(); + // dont need to process the rest + break; + } +}]]></programlisting> + </sect3> + + <sect3 id="objectstate-querying-executing-tuples"> + <title>Consultas que devuelven tuplas</title> + + <para> + Las consultas de Hibernate a veces devuelven tuplas de objetos, en cuyo caso + cada tupla se devuelve como un array: + </para> + + <programlisting><![CDATA[Iterator kittensAndMothers = sess.createQuery( + "select kitten, mother from Cat kitten join kitten.mother mother") + .list() + .iterator(); + +while ( kittensAndMothers.hasNext() ) { + Object[] tuple = (Object[]) kittensAndMothers.next(); + Cat kitten = (Cat) tuple[0]; + Cat mother = (Cat) tuple[1]; + .... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-scalar"> + <title>Resultados escalares</title> + + <para> + Las consultas pueden especificar una propiedad de una clase en la cláusula + <literal>select</literal>. Pueden incluso llamar a funciones de agregación SQL. + Las propiedades o agregaciones son considerados resultados "escalares" + (y no entidades en estado persistente). + </para> + + <programlisting><![CDATA[Iterator results = sess.createQuery( + "select cat.color, min(cat.birthdate), count(cat) from Cat cat " + + "group by cat.color") + .list() + .iterator(); + +while ( results.hasNext() ) { + Object[] row = results.next(); + Color type = (Color) row[0]; + Date oldest = (Date) row[1]; + Integer count = (Integer) row[2]; + ..... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-parameters"> + <title>Ligación de parámetros</title> + + <para> + Se proveen métodos en <literal>Query</literal> para ligar valores a + parámetros con nombre o parámetros <literal>?</literal> de estilo JDBC. + <emphasis>Al contrario de JDBC, Hibernate numera los parámetros desde cero.</emphasis> + Los parámetros con nombre son identificadores de la forma <literal>:name</literal> + en la cadena de la consulta. Las ventajas de los parámetros con nombre son: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + los parámetros con nombre son insensibles al orden en que aparecen + en la cadena de consulta + </para> + </listitem> + <listitem> + <para> + pueden aparecer múltiples veces en la misma consulta + </para> + </listitem> + <listitem> + <para> + son auto-documentados + </para> + </listitem> + </itemizedlist> + + <programlisting><![CDATA[//named parameter (preferred) +Query q = sess.createQuery("from DomesticCat cat where cat.name = :name"); +q.setString("name", "Fritz"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//positional parameter +Query q = sess.createQuery("from DomesticCat cat where cat.name = ?"); +q.setString(0, "Izi"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//named parameter list +List names = new ArrayList(); +names.add("Izi"); +names.add("Fritz"); +Query q = sess.createQuery("from DomesticCat cat where cat.name in (:namesList)"); +q.setParameterList("namesList", names); +List cats = q.list();]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-pagination"> + <title>Paginación</title> + + <para> + Si necesitas especificar límites sobre tu conjunto resultado (el número máximo de filas + que quieras traer y/o la primera fila que quieras traer) debes usar los métodos de la + interface <literal>Query</literal>: + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("from DomesticCat cat"); +q.setFirstResult(20); +q.setMaxResults(10); +List cats = q.list();]]></programlisting> + + <para> + Hibernate sabe cómo traducir este límite de consulta al SQL nativo de tu + DBMS. + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-scrolling"> + <title>Iteración scrollable</title> + + <para> + Si tu driver JDBC soporta <literal>ResultSet</literal>s scrollables, la + interface <literal>Query</literal> puede ser usada para obtener un objeto + <literal>ScrollableResults</literal>, que permite una navegación flexible + de los resultados de consulta. + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("select cat.name, cat from DomesticCat cat " + + "order by cat.name"); +ScrollableResults cats = q.scroll(); +if ( cats.first() ) { + + // find the first name on each page of an alphabetical list of cats by name + firstNamesOfPages = new ArrayList(); + do { + String name = cats.getString(0); + firstNamesOfPages.add(name); + } + while ( cats.scroll(PAGE_SIZE) ); + + // Now get the first page of cats + pageOfCats = new ArrayList(); + cats.beforeFirst(); + int i=0; + while( ( PAGE_SIZE > i++ ) && cats.next() ) pageOfCats.add( cats.get(1) ); + +} +cats.close()]]></programlisting> + + <para> + Nota que se requiere una conexión de base de datos abierta (y cursor) para esta + funcionalidad, usa <literal>setMaxResult()</literal>/<literal>setFirstResult()</literal> + si necesitas la funcionalidad de paginación fuera de línea. + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-named"> + <title>Externalizando consultas con nombre</title> + + <para> + Puedes además definir consultas con nombre en el documento de mapeo. + (Recuerda usar una sección <literal>CDATA</literal> si tu consulta + contiene caracteres que puedan ser interpretados como etiquetado.) + </para> + + <programlisting><![CDATA[<query name="eg.DomesticCat.by.name.and.minimum.weight"><![CDATA[ + from eg.DomesticCat as cat + where cat.name = ? + and cat.weight > ? +] ]></query>]]></programlisting> + + <para> + La ligación de parámetros y ejecución se hace programáticamente: + </para> + + <programlisting><![CDATA[Query q = sess.getNamedQuery("eg.DomesticCat.by.name.and.minimum.weight"); +q.setString(0, name); +q.setInt(1, minWeight); +List cats = q.list();]]></programlisting> + + <para> + Nota que el código real del programa es independiente del lenguaje de consulta + usado; puedes además definir consultas SQL nativas en metadatos, o migrar + consultas existentes a Hibernate colocándolas en ficheros de mapeo. + </para> + + </sect3> + + </sect2> + + <sect2 id="objectstate-filtering" revision="1"> + <title>Filtrando colecciones</title> + <para> + Un <emphasis>filtro</emphasis> de colección es un tipo especial de consulta que puede ser + aplicado a una colección persistente o array. La cadena de consulta puede referirse a + <literal>this</literal>, significando el elemento de colección actual. + </para> + + <programlisting><![CDATA[Collection blackKittens = session.createFilter( + pk.getKittens(), + "where this.color = ?") + .setParameter( Color.BLACK, Hibernate.custom(ColorUserType.class) ) + .list() +);]]></programlisting> + + <para> + La colección devuelta es considerada un bag, y es una copia de la colección + dada. La colección original no es modificada (esto es contrario a la implicación + del nombre "filtro", pero consistente con el comportamiento esperado). + </para> + + <para> + Observa que los filtros no requieren una cláusula <literal>from</literal> (aunque pueden + tener uno si se requiere). Los filtros no están limitados a devolver los elementos de + colección por sí mismos. + </para> + + <programlisting><![CDATA[Collection blackKittenMates = session.createFilter( + pk.getKittens(), + "select this.mate where this.color = eg.Color.BLACK.intValue") + .list();]]></programlisting> + + <para> + Incluso una consulta de filtro vacío es útil, por ejemplo, para cargar un + subconjunto de elementos en una colección enorme: + </para> + + <programlisting><![CDATA[Collection tenKittens = session.createFilter( + mother.getKittens(), "") + .setFirstResult(0).setMaxResults(10) + .list();]]></programlisting> + + </sect2> + + <sect2 id="objecstate-querying-criteria" revision="1"> + <title>Consultas de criterios</title> + + <para> + HQL es extremadamente potente pero algunos desarrolladores prefieren construir + consultas dinámicamente usando una API orientada a objetos, en vez construir + cadenas de consulta. Hibernate provee una API intuitiva de consulta <literal>Criteria</literal> + para estos casos: + </para> + + <programlisting><![CDATA[Criteria crit = session.createCriteria(Cat.class); +crit.add( Restrictions.eq( "color", eg.Color.BLACK ) ); +crit.setMaxResults(10); +List cats = crit.list();]]></programlisting> + + <para> + Las APIs de <literal>Criteria</literal> y la asociada <literal>Example</literal> + son discutidas en más detalle en <xref linkend="querycriteria"/>. + </para> + + </sect2> + + <sect2 id="objectstate-querying-nativesql" revision="2"> + <title>Consultas en SQL nativo</title> + + <para> + Puedes expresar una consulta en SQL, usando <literal>createSQLQuery()</literal> y + dejando que Hibernate cuide del mapeo de los conjuntos resultado a objetos. + Nota que puedes llamar en cualquier momento a <literal>session.connection()</literal> y + usar la <literal>Connection</literal> JDBC directamente. Si eliges usar la API de + Hibernate, debes encerrar los alias de SQL entre llaves: + </para> + + <programlisting><![CDATA[List cats = session.createSQLQuery("SELECT {cat.*} FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list();]]></programlisting> + + <programlisting><![CDATA[List cats = session.createSQLQuery( + "SELECT {cat}.ID AS {cat.id}, {cat}.SEX AS {cat.sex}, " + + "{cat}.MATE AS {cat.mate}, {cat}.SUBCLASS AS {cat.class}, ... " + + "FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list()]]></programlisting> + + <para> + Las consultas SQL pueden contener parámetros con nombre y posicionales, al igual que + las consultas de Hibernate. Puede encontrarse más información sobre consultas en SQL + nativo en <xref linkend="querysql"/>. + </para> + + </sect2> + + </sect1> + + <sect1 id="objectstate-modifying" revision="1"> + <title>Modificando objetos persistentes</title> + + <para> + Las <emphasis>instancias persistentes transaccionales</emphasis> (es decir, objetos cargados, + creados o consultados por la <literal>Session</literal>) pueden ser manipulados por la + aplicación y cualquier cambio al estado persistente será persistido cuando la <literal>Session</literal> + sea <emphasis>limpiada (flushed)</emphasis> (discutido más adelante en este capítulo). No hay + necesidad de llamar un método en particular (como <literal>update()</literal>, que tiene un + propósito diferente) para hacer persistentes tus modificaciones. De modo que la forma más + directa de actualizar el estado de un objeto es cargarlo con <literal>load()</literal>, + y entonces manipularlo directamente, mientras la <literal>Session</literal> está abierta: + </para> + + <programlisting><![CDATA[DomesticCat cat = (DomesticCat) sess.load( Cat.class, new Long(69) ); +cat.setName("PK"); +sess.flush(); // changes to cat are automatically detected and persisted]]></programlisting> + + <para> + A veces este modelo de programación es ineficiente pues podría requerir una + <literal>SELECT</literal> de SQL (para cargar un objeto) y un <literal>UPDATE</literal> + de SQL (para hacer persistentes sus datos actualizados) en la misma sesión. Por lo tanto, + Hibernate ofrece un enfoque alternativo, usando instancias separadas (detached). + </para> + + <para> + <emphasis>Nota que Hibernate no ofreve su propia API para ejecución directa de + sentencias <literal>UPDATE</literal> o <literal>DELETE</literal>. Hibernate es un + servicio de <emphasis>gestión de estado</emphasis>, no tienes que pensar en + <literal>sentencias</literal> para usarlo. JDBC es una API perfecta para ejecutar + sentencias SQL; puedes obtener una <literal>Connection</literal> JDBC en cualquier + momento llamando a <literal>session.connection()</literal>. Además, la noción de + operaciones masivas entra en conflicto con el mapeo objeto/relacional en aplicaciones + en línea orientadas al procesamiento de transacciones. Versiones futuras de Hibernate + pueden, sin embargo, proveer funciones de operación masiva especiales. Ver + <xref linkend="batch"/> por algunos trucos de operación en lote (batch) posibles. + </emphasis> + </para> + + </sect1> + + <sect1 id="objectstate-detached" revision="2"> + <title>Modificando objetos separados</title> + + <para> + Muchas aplicaciones necesitan recuperar un objeto en una transacción, enviarla + a la capa de UI para su manipulación, y entonces salvar los cambios en una nueva + transacción. Las aplicaciones que usan este tipo de enfoque en un entorno de + alta concurrencia usualmente usan datos versionados para asegurar el aislamiento + de la unidad de trabajo "larga". + </para> + + <para> + Hibernate soporta este modelo al proveer re-unión de instancias separadas usando + los métodos <literal>Session.update()</literal> o <literal>Session.merge()</literal>: + </para> + + <programlisting><![CDATA[// in the first session +Cat cat = (Cat) firstSession.load(Cat.class, catId); +Cat potentialMate = new Cat(); +firstSession.save(potentialMate); + +// in a higher layer of the application +cat.setMate(potentialMate); + +// later, in a new session +secondSession.update(cat); // update cat +secondSession.update(mate); // update mate]]></programlisting> + + <para> + Si el <literal>Cat</literal> con identificador <literal>catId</literal> ya hubiera + sido cargado por <literal>secondSession</literal> cuando la aplicación intentó + volver a unirlo, se habría lanzado una excepción. + </para> + + <para> + Usa <literal>update()</literal> si no estás seguro que la sesión tenga + una instancia ya persistente con el mismo identificador, y <literal>merge()</literal> + si quieres fusionar tus modificaciones en cualquier momento sin consideración del + estado de la sesión. En otras palabras, <literal>update()</literal> es usualmente + el primer método que llamarías en una sesión fresca, asegurando que la re-unión de + tus instancias separadas es la primera operación que se ejecuta. + </para> + + <para> + La aplicación debe actualizar individualmente las instancias separadas alcanzables + por la instancia separada dada llamando a <literal>update()</literal>, si y + <emphasis>sólo</emphasis> si quiere que sus estados sean también actualizados. + Esto puede, por supuesto, ser automatizado usando <emphasis>persistencia transitiva</emphasis>, + ver <xref linkend="objectstate-transitive"/>. + </para> + + <para> + El método <literal>lock()</literal> también permite a una aplicación reasociar + un objeto con una sesión nueva. Sin embargo, la instancia separada no puede + haber sido modificada! + </para> + + <programlisting><![CDATA[//just reassociate: +sess.lock(fritz, LockMode.NONE); +//do a version check, then reassociate: +sess.lock(izi, LockMode.READ); +//do a version check, using SELECT ... FOR UPDATE, then reassociate: +sess.lock(pk, LockMode.UPGRADE);]]></programlisting> + + <para> + Nota que <literal>lock()</literal> puede ser usado con varios <literal>LockMode</literal>s, + ver la documentación de la API y el capítulo sobre manejo de transacciones para más + información. La re-unión no es el único caso de uso para <literal>lock()</literal>. + </para> + + <para> + Se discuten otros modelos para unidades de trabajo largas en <xref linkend="transactions-optimistic"/>. + </para> + + </sect1> + + <sect1 id="objectstate-saveorupdate"> + <title>Detección automática de estado</title> + + <para> + Los usuarios de Hibernate han pedido un método de propósito general que bien + salve una instancia transitoria generando un identificador nuevo, o bien + actualice/reúna las instancias separadas asociadas con su identificador actual. + El método <literal>saveOrUpdate()</literal> implementa esta funcionalidad. + </para> + + <programlisting><![CDATA[// in the first session +Cat cat = (Cat) firstSession.load(Cat.class, catID); + +// in a higher tier of the application +Cat mate = new Cat(); +cat.setMate(mate); + +// later, in a new session +secondSession.saveOrUpdate(cat); // update existing state (cat has a non-null id) +secondSession.saveOrUpdate(mate); // save the new instance (mate has a null id)]]></programlisting> + + <para> + El uso y semántica de <literal>saveOrUpdate()</literal> parece ser confuso para + usuarios nuevos. Primeramente, en tanto no estés intentando usar instancias de una + sesión en otra sesión nueva, no debes necesitar usar <literal>update()</literal>, + <literal>saveOrUpdate()</literal>, o <literal>merge()</literal>. Algunas aplicaciones + enteras nunca usarán ninguno de estos métodos. + </para> + + <para> + Usualmente <literal>update()</literal> o <literal>saveOrUpdate()</literal> se usan en + el siguiente escenario: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + la aplicación carga un objeto en la primera sesión + </para> + </listitem> + <listitem> + <para> + el objeto es pasado a la capa de UI + </para> + </listitem> + <listitem> + <para> + se hacen algunas modificaciones al objeto + </para> + </listitem> + <listitem> + <para> + el objeto se pasa abajo de regreso a la capa de negocio + </para> + </listitem> + <listitem> + <para> + la aplicación hace estas modificaciones persistentes llamando + a <literal>update()</literal> en una segunda sesión + </para> + </listitem> + </itemizedlist> + + <para> + <literal>saveOrUpdate()</literal> hace lo siguiente: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + si el objeto ya es persistente en esta sesión, no hace nada + </para> + </listitem> + <listitem> + <para> + si otro objeto asociado con la sesión tiene el mismo identificador, + lanza una excepción + </para> + </listitem> + <listitem> + <para> + si el objeto no tiene ninguna propiedad identificadora, lo salva llamando a + <literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + si el identificador del objeto tiene el valor asignado a un objeto recién + instanciado, lo salva llamando a <literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + si el objeto está versionado (por un <literal><version></literal> o + <literal><timestamp></literal>), y el valor de la propiedad de versión + es el mismo valor asignado a una objeto recién instanciado, lo salva llamando + a <literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + en cualquier otro caso se actualiza el objeto llamando a <literal>update()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + y <literal>merge()</literal> es muy diferente: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + si existe una instancia persistente con el mismo identificador asignado actualmente con la + sesión, copia el estado del objeto dado en la instancia persistente + </para> + </listitem> + <listitem> + <para> + si no existe ninguna instancia persistente actualmente asociada a la sesión, + intente cargarla de la base de datos, o crear una nueva instancia persistente + </para> + </listitem> + <listitem> + <para> + la instancia persistente es devuelta + </para> + </listitem> + <listitem> + <para> + la instancia dada no resulta ser asociada a la sesión, permanece separada + </para> + </listitem> + </itemizedlist> + + </sect1> + + <sect1 id="objectstate-deleting" revision="1"> + <title>Borrando objetos persistentes</title> + + <para> + <literal>Session.delete()</literal> quitará el estado de un objeto de la base de datos. + Por supuesto, tu aplicación podría tener aún una referencia a un objeto borrado. Lo mejor + es pensar en <literal>delete()</literal> como hacer transitoria una instancia persistente. + </para> + + <programlisting><![CDATA[sess.delete(cat);]]></programlisting> + + <para> + Puedes borrar los objetos en el orden que gustes, sin riesgo de violaciones + de restricción de clave foránea. Aún es posible violar una restricción + <literal>NOT NULL</literal> sobre una columna clave foránea borrando objetos + en un orden erróneo, por ejemplo, si borras el padre, pero olvidas borrar los + hijos. + </para> + + </sect1> + + <sect1 id="objectstate-replicating" revision="1"> + <title>Replicando objetos entre dos almacénes de datos diferentes</title> + + <para> + Es ocasionalmente útil ser capaz de tomar un grafo de instancias persistentes + y hacerlas persistentes en un almacén de datos diferente, sin regenerar los valores + identificadores. + </para> + + <programlisting><![CDATA[//retrieve a cat from one database +Session session1 = factory1.openSession(); +Transaction tx1 = session1.beginTransaction(); +Cat cat = session1.get(Cat.class, catId); +tx1.commit(); +session1.close(); + +//reconcile with a second database +Session session2 = factory2.openSession(); +Transaction tx2 = session2.beginTransaction(); +session2.replicate(cat, ReplicationMode.LATEST_VERSION); +tx2.commit(); +session2.close();]]></programlisting> + + <para> + El <literal>ReplicationMode</literal> determina cómo <literal>replicate()</literal> + tratará los conflictos con filas existentes en la base de datos. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ReplicationMode.IGNORE</literal> - ignora el objeto cuando existe una fila + de base de datos con el mismo identificador + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.OVERWRITE</literal> - sobrescribe cualquier fila de base de + datos existente con el mismo identificador + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.EXCEPTION</literal> - lanza una excepción si existe una fila + de base de datos con el mismo identificador + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.LATEST_VERSION</literal> - sobrescribe la fila si su número + de versión es anterior al número de versión del objeto, o en caso contrario ignora el objeto + </para> + </listitem> + </itemizedlist> + + <para> + Los casos de uso para esta funcionalidad incluyen reconciliar datos ingresados en + instancias diferentes de bases de datos, actualizar información de configuración de + sistema durante actualizaciones de producto, deshacer cambios producidos durante + transacciones no-ACID y más. + </para> + + </sect1> + + <sect1 id="objectstate-flushing"> + <title>Limpiando (flushing) la sesión</title> + + <para> + Cada tanto, la <literal>Session</literal> ejecutará las sentencias SQL necesarias para + sincronizar el estado de la conexión JDBC con el estado de los objetos mantenidos en menoria. + Este proceso, <emphasis>limpieza (flush)</emphasis>, ocurre por defecto en los siguientes + puntos + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + antes de algunas ejecuciones de consulta + </para> + </listitem> + <listitem> + <para> + desde <literal>org.hibernate.Transaction.commit()</literal> + </para> + </listitem> + <listitem> + <para> + desde <literal>Session.flush()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Las sentencias SQL son liberadas en el siguiente orden + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + todas las inserciones de entidades, en el mismo orden que los objetos + correspondientes fueron salvados usando <literal>Session.save()</literal> + </para> + </listitem> + <listitem> + <para> + todas las actualizaciones de entidades + </para> + </listitem> + <listitem> + <para> + todas los borrados de colecciones + </para> + </listitem> + <listitem> + <para> + todos los borrados, actualizaciones e inserciones de elementos de colección + </para> + </listitem> + <listitem> + <para> + todas las inserciones de colecciones + </para> + </listitem> + <listitem> + <para> + todos los borrados de entidades, en el mismo orden que los objetos + correspondientes fueron borrados usando <literal>Session.delete()</literal> + </para> + </listitem> + </orderedlist> + + <para> + (Una excepción es que los objetos que usan generación de ID <literal>native</literal> + se insertan cuando son salvados.) + </para> + + <para> + Excepto cuando llamas explícitamente a <literal>flush()</literal>, no hay en absoluto + garantías sobre <emphasis>cuándo</emphasis> la <literal>Session</literal> ejecuta las + llamadas JDBC. sólo sobre el <emphasis>orden</emphasis> en que son ejecutadas. Sin embargo, + Hibernate garantiza que los métodos <literal>Query.list(..)</literal> nunca devolverán datos + añejos o erróneos. + </para> + + <para> + Es posible cambiar el comportamiento por defecto de modo que la limpieza (flush) + ocurra menos frecuentemente. La clase <literal>FlushMode</literal> tres modos + diferentes: sólo en tiempo de compromiso (y sólo cuando se use la API de + <literal>Transaction</literal> de Hibernate), limpieza automática usando la rutina + explicada, o nunca limpiar a menos que se llame a <literal>flush()</literal> + explícitamente. El último modo es útil para unidades de trabajo largas, donde una + <literal>Session</literal> se mantiene abierta y desconectada por largo tiempo + (ver <xref linkend="transactions-optimistic-longsession"/>). + </para> + + <programlisting><![CDATA[sess = sf.openSession(); +Transaction tx = sess.beginTransaction(); +sess.setFlushMode(FlushMode.COMMIT); // allow queries to return stale state + +Cat izi = (Cat) sess.load(Cat.class, id); +izi.setName(iznizi); + +// might return stale data +sess.find("from Cat as cat left outer join cat.kittens kitten"); + +// change to izi is not flushed! +... +tx.commit(); // flush occurs]]></programlisting> + + <para> + Durante la limpieza, puede ocurrir una excepción (por ejemplo, si una operación DML + violase una restricción). Ya que el manejo de excepciones implica alguna comprensión + del comportamiento transaccional de Hibernate, lo discutimos en <xref linkend="transactions"/>. + </para> + + </sect1> + + <sect1 id="objectstate-transitive"> + <title>Persistencia transitiva</title> + + <para> + Es absolutamente incómodo dalvar, borrar, o reunir objetos individuales, + especialmente si tratas con un grafo de objetos asociados. Un caso común es + una relación padre/hijo. Considera el siguiente ejemplo: + </para> + + <para> + Si los hijos en una relación padre/hijo pudieran ser tipificados en valor + (por ejemplo, una colección de direcciones o cadenas), sus ciclos de vida + dependerían del padre y se requeriría ninguna otra acción para el tratamiento + en "cascada" de cambios de estado. Cuando el padre es salvado, los objetos hijo + tipificados en valor son salvados también, cuando se borra el padre, se borran + los hijos, etc. Esto funciona incluso para operaciones como el retiro de un + hijo de la colección. Hibernate detectará esto y, ya que los objetos tipificados + en valor no pueden tener referencias compartidas, borrará el hijo de la base + de datos. + </para> + + <para> + Ahora considera el mismo escenario con los objetos padre e hijos siendo entidades, + no tipos de valor (por ejemplo, categorías e ítems, o gatos padre e hijos). + Las entidades tienen su propio ciclo de vida, soportan referencias compartidas + (de modo que quitar una entidad de una colección no significa que sea borrada), + y no hay por defecto ningún tratamiento en "cascada" de estado de una entidad + a otras entidades asociadas. Hibernate no implementa <emphasis>persistencia por + alcance</emphasis>. + </para> + + <para> + Para cada operación básica de la sesión de Hibernate - incluyendo <literal>persist(), merge(), + saveOrUpdate(), delete(), lock(), refresh(), evict(), replicate()</literal> - hay un estilo + de cascada correspondiente. Respectivamente, los estilos de cascada se llaman <literal>create, + merge, save-update, delete, lock, refresh, evict, replicate</literal>. Si quieres que una + operación sea tratada en cascada a lo largo de una asociación, debes indicar eso en el + documento de mapeo. Por ejemplo: + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist"/>]]></programlisting> + + <para> + Los estilos de cascada pueden combinarse: + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist,delete,lock"/>]]></programlisting> + + <para> + Puedes incluso usar <literal>cascade="all"</literal> para especificar que <emphasis>todas</emphasis> + las operaciones deben ser tratadas en cascada a lo largo de la asociación. El por defecto + <literal>cascade="none"</literal> especifica que ninguna operación será tratada en cascada. + </para> + + <para> + Un estilo de cascada especial, <literal>delete-orphan</literal>, se aplica sólo a + asociaciones uno-a-muchos, e indica que la operación <literal>delete()</literal> debe + aplicarse a cualquier objeto hijo que sea quitado de la asociación. + </para> + + + <para> + Recomendaciones: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Usualmente no tiene sentido habilitar el tratamiento en cascada a una asociación + <literal><many-to-one></literal> o <literal><many-to-many></literal>. + El tratamiento en cascada es frecuentemente útil para las asociaciones + <literal><one-to-one></literal> y <literal><one-to-many></literal>. + associations. + </para> + </listitem> + <listitem> + <para> + Si la esperanza de vida de los objetos hijos está ligada a la eesperanza de + vida del objeto padre, házlo un <emphasis>objeto de ciclo de vida</emphasis> + especificando <literal>cascade="all,delete-orphan"</literal>. + </para> + </listitem> + <listitem> + <para> + En otro caso, puede que no necesites tratamiento en cascada en absoluto. Pero + si piensas que estarás trabajando frecuentemente con padre e hijos juntos en la + misma transacción, y quieres ahorrarte algo de tipeo, considera usar + <literal>cascade="persist,merge,save-update"</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + Mapear una asociación (ya sea una asociación monovaluada, o una colección) con + <literal>cascade="all"</literal> marca la asociación como una relación del estilo + <emphasis>padre/hijo</emphasis> donde save/update/delete en el padre resulta + en save/update/delete del hijo o hijos. + </para> + <para> + Además, una mera referencia a un hijo desde un padre persistente resultará en + un save/update del hijo. Esta metáfora está incompleta, sin embargo. Un hijo + que deje de ser referenciado por su padre <emphasis>no</emphasis> es borrado + automáticamente, excepto en el caso de una asociación <literal><one-to-many></literal> + mapeada con <literal>cascade="delete-orphan"</literal>. La semántica precisa de + las operaciones en cascada para una relación padre/hijo es: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Si un padre le es pasado a <literal>persist()</literal>, todos los hijos le son + pasados a <literal>persist()</literal> + </para> + </listitem> + <listitem> + <para> + Si un padre le es pasado a <literal>merge()</literal>, todos los hijos le son + pasados a <literal>merge()</literal> + </para> + </listitem> + <listitem> + <para> + Si un padre le es pasado a <literal>save()</literal>, <literal>update()</literal> o + <literal>saveOrUpdate()</literal>, todos los hijos le son pasados a <literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + Si un hijo transitorio o separado se vuelve referenciado por un padre + persistente, le es pasado a <literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + Si un padre es borrado, todos los hijos le son pasados a <literal>delete()</literal> + </para> + </listitem> + <listitem> + <para> + Si un hijo deja de ser referenciado por un padre persistente, + <emphasis>no ocurre nada especial</emphasis> - la aplicación debe + borrar explícitamente el hijo de ser necesario - a menos que + <literal>cascade="delete-orphan"</literal>, en cuyo caso el hijo + "huérfano" es borrado. + </para> + </listitem> + </itemizedlist> + + </sect1> + + <sect1 id="objectstate-metadata"> + <title>Usando metadatos</title> + + <para> + Hibernate requiere de un modelo de meta-nivel muy rico de todas las entidades y tipos de valor. + De vez en cuando, este modelo es muy útil para la aplicación misma. Por ejemplo, la aplicación + podría usar los metadatos de Hibernate para implementar un algoritmo "inteligente" de copia + en profundidad que entienda qué objetos deben ser copiados (por ejemplo, tipo de valor mutables) + y cuáles no (por ejemplo, tipos de valor inmutables y, posiblemente, entidades asociadas). + </para> + <para> + Hibernate expone los metadatos vía las interfaces <literal>ClassMetadata</literal> y + <literal>CollectionMetadata</literal> y la jerarquía <literal>Type</literal>. Las instancias + de las interfaces de metadatos pueden obtenerse de <literal>SessionFactory</literal>. + </para> + + <programlisting><![CDATA[Cat fritz = ......; +ClassMetadata catMeta = sessionfactory.getClassMetadata(Cat.class); + +Object[] propertyValues = catMeta.getPropertyValues(fritz); +String[] propertyNames = catMeta.getPropertyNames(); +Type[] propertyTypes = catMeta.getPropertyTypes(); + +// get a Map of all properties which are not collections or associations +Map namedValues = new HashMap(); +for ( int i=0; i<propertyNames.length; i++ ) { + if ( !propertyTypes[i].isEntityType() && !propertyTypes[i].isCollectionType() ) { + namedValues.put( propertyNames[i], propertyValues[i] ); + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/toolset_guide.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/toolset_guide.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/toolset_guide.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/toolset_guide.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,459 @@ +<chapter id="toolsetguide" revision="2"> + <title>Guía del Conjunto de Herramientas</title> + + <para> + La ingeniería de ida y vuelta con Hibernate es posible usando un conjunto de plugins de Eclipse, + herramientas de línea de comandos, así como tareas de Ant. + </para> + + <para> + Las <emphasis>Herramientas de Hibernate</emphasis> actualmente incluyen plugins para la IDE de + Eclipse así como tareas de Ant para la ingeniería inversa de bases de datos existentes: + </para> + + <itemizedlist> + <listitem><para> + <emphasis>Editor de Mapeo:</emphasis> Un editor de ficheros de mapeo XML, que soporta autocompleción + y resaltado de sintáxis. Soporta también autocompleción semántica de nombres de clases y nombres de + campos/propiedades, haciéndolo mucho más versátil que un editor de XML normal. + </para></listitem> + <listitem><para> + <emphasis>Consola:</emphasis> La consola es una nueva vista en Eclipse. Además de la vista de + árbol de tus configuraciones de consola, tienes también una vista interactiva de tus clases + persistentes y sus relaciones. La console te permite ejecutar consultas HQL contra tu base de datos y + navegar el resultado directamente en Eclipse. + </para></listitem> + <listitem><para> + <emphasis>Asistentes de Desarrollo:</emphasis> Se proveen muchos asistentes con las herramientas + de Eclipse. Puedes usar un asistente para generar rápidamente ficheros de configuración de Hibernate + (cfg.xml), o incluso puedes haceruna ingeniería inversa completa de un esquema de base de datos existente + en ficheros de código de POJO y ficheros de mapeo de Hibernate. El asistente de ingeniería inversa soporta + plantillas personalizables. + </para></listitem> + <listitem><para> + <emphasis>Tareas de Ant:</emphasis> + </para></listitem> + + </itemizedlist> + + <para> + Por favor refiérete al paquete <emphasis>Herramientas de Hibernate</emphasis> y su documentación para + más información. + </para> + + <para> + Sin embargo, el paquete principal de Hibernate viene incluyendo una herramienta integrada + (puede ser usada incluso "dentro" de Hibernate on-the-fly): <emphasis>SchemaExport</emphasis> + también conocido como <literal>hbm2ddl</literal>. + </para> + + <sect1 id="toolsetguide-s1" revision="2"> + <title>Generación automática de esquemas</title> + + <para> + Una utilidad de Hibernate puede generar DDL desde tus ficheros de mapeo. El esquema generado incluye + restricciones de integridad referencial (claves primarias y foráneas) para las tablas de entidades y + colecciones. Las tablas y secuencias también son creadas para los generadores de identificadores mapeados. + </para> + + <para> + <emphasis>Debes</emphasis> especificar un <literal>Dialecto</literal> SQL vía la propiedad + <literal>hibernate.dialect</literal> al usar esta herramienta, ya que el DDL es altamente específico del + vendedor. + </para> + + <para> + First, customize your mapping files to improve the generated schema. + </para> + + <sect2 id="toolsetguide-s1-2" revision="1"> + <title>Personalizando el esquema</title> + + <para> + Muchos elementos de mapeo de Hibernate definen un atributo opcional llamado <literal>length</literal>. + Con este atributo puedes establecer el tamaño de una columna. (O, para tipos de datos + numéricos/decimales, la precisión.) + </para> + + <para> + Algunas etiquetas también aceptan un atributo <literal>not-null</literal> (para generar una restricción + <literal>NOT NULL</literal> en columnas de tablas) y y un atributo <literal>unique</literal> (para generar + restricciones <literal>UNIQUE</literal> en columnas de tablas). + </para> + + <para> + Algunas etiquetas aceptan un atributo <literal>index</literal> para especificar el nombre de un índice + para esa columna. Se puede usar un atributo <literal>unique-key</literal> para agrupar columnas en una + restricción de clave de una sola unidad. Actualmente, el valor especificado del atributo + <literal>unique-key</literal> <emphasis>no</emphasis> es usado para nombrar la restricción, sólo para + agrupar las columnas en el fichero de mapeo. + </para> + + <para> + Ejemplos: + </para> + + <programlisting><![CDATA[<property name="foo" type="string" length="64" not-null="true"/> + +<many-to-one name="bar" foreign-key="fk_foo_bar" not-null="true"/> + +<element column="serial_number" type="long" not-null="true" unique="true"/>]]></programlisting> + + <para> + Alternativamente, estos elementos aceptan tambíen un elemento hijo <literal><column></literal>. + Esto es particularmente útil para tipos multicolumnas: + </para> + + <programlisting><![CDATA[<property name="foo" type="string"> + <column name="foo" length="64" not-null="true" sql-type="text"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<property name="bar" type="my.customtypes.MultiColumnType"/> + <column name="fee" not-null="true" index="bar_idx"/> + <column name="fi" not-null="true" index="bar_idx"/> + <column name="fo" not-null="true" index="bar_idx"/> +</property>]]></programlisting> + + <para> + El atributo <literal>sql-type</literal> permite al usuario sobrescribir el mapeo por defecto de + tipo Hibernate a tipo de datos SQL. + </para> + + <para> + El atributo <literal>check</literal> te permite especificar una comprobación de restricción. + </para> + + <programlisting><![CDATA[<property name="foo" type="integer"> + <column name="foo" check="foo > 10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<class name="Foo" table="foos" check="bar < 100.0"> + ... + <property name="bar" type="float"/> +</class>]]></programlisting> + + + <table frame="topbot" id="schemattributes-summary" revision="2"> + <title>Resumen</title> + <tgroup cols="3"> + <colspec colwidth="1*"/> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>Atributo</entry> + <entry>Valores</entry> + <entry>Interpretación</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>length</literal></entry> + <entry>number</entry> + <entry>largo de columna/precisión decimal</entry> + </row> + <row> + <entry><literal>not-null</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>especifica que la columna debe ser no nulable</entry> + </row> + <row> + <entry><literal>unique</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>especifica que la columna debe tener una restricción de unicidad</entry> + </row> + <row> + <entry><literal>index</literal></entry> + <entry><literal>index_name</literal></entry> + <entry>especifica el nombre de un índice (multicolumna)</entry> + </row> + <row> + <entry><literal>unique-key</literal></entry> + <entry><literal>unique_key_name</literal></entry> + <entry>especifica el nombre de una restricción de unicidad multicolumna</entry> + </row> + <row> + <entry><literal>foreign-key</literal></entry> + <entry><literal>foreign_key_name</literal></entry> + <entry> + especifica el nombre de la restricción de clave foránea generada por una + asociación, úsalo en los elementos de mapeo <one-to-one>, <many-to-one>, + <key>, y <many-to-many>. Nota que los lados + <literal>inverse="true"</literal> no serán considerados por + <literal>SchemaExport</literal>. + </entry> + </row> + <row> + <entry><literal>sql-type</literal></entry> + <entry><literal>column_type</literal></entry> + <entry> + sobrescribe el tipo de columna por defecto (sólo atributo del elemento + <literal><column></literal>) + </entry> + </row> + <row> + <entry><literal>check</literal></entry> + <entry>expresión SQL</entry> + <entry> + crea una restricción de comprobación SQL en columna o tabla + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + El elemento <literal><comment></literal> te permite especificar un comentario para el esquema + generado. + </para> + + <programlisting><![CDATA[<class name="Customer" table="CurCust"> + <comment>Current customers only</comment> + ... +</class>]]></programlisting> + + <programlisting><![CDATA[<property name="balance"> + <column name="bal"> + <comment>Balance in USD</comment> + </column> +</property>]]></programlisting> + + <para> + Esto resulta en una sentencia <literal>comment on table</literal> o <literal>comment on column</literal> + en el DDL generado (donde esté soportado). + </para> + + </sect2> + + <sect2 id="toolsetguide-s1-3"> + <title>Ejecutando la herramienta</title> + + <para> + La herramienta <literal>SchemaExport</literal> escribe un guión DDL a la salida estándar y/o + ejecuta las sentencias DDL. + </para> + + <para> + <literal>java -cp </literal><emphasis>classpaths_de_hibernate</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaExport</literal> <emphasis>opciones ficheros_de_mapeo</emphasis> + </para> + + <table frame="topbot"> + <title>Opciones de Línea de Comandos de <literal>SchemaExport</literal></title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Opción</entry> + <entry>Descripción</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>no enviar a salida estándar el guión</entry> + </row> + <row> + <entry><literal>--drop</literal></entry> + <entry>sólo desechar las tablas</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>no exportar a la base de datos</entry> + </row> + <row> + <entry><literal>--output=my_schema.ddl</literal></entry> + <entry>enviar la salida del guión ddl a un fichero</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>lee la configuración de Hibernate de un fichero XML</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>lee las propiedades de base de datos de un fichero</entry> + </row> + <row> + <entry><literal>--format</literal></entry> + <entry>formatea agradablemente el SQL generado en el guión</entry> + </row> + <row> + <entry><literal>--delimiter=x</literal></entry> + <entry>establece un delimitador de fin de línea para el guión</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Puedes incluso encajar <literal>SchemaExport</literal> en tu aplicación: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaExport(cfg).create(false, true);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-4"> + <title>Propiedades</title> + + <para> + Las propiedades de base de datos pueden especificarse + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para>como propiedades de sistema con <literal>-D</literal><emphasis><property></emphasis></para> + </listitem> + <listitem> + <para>en <literal>hibernate.properties</literal></para> + </listitem> + <listitem> + <para>en un fichero de propiedades mencionado con <literal>--properties</literal></para> + </listitem> + </itemizedlist> + + <para> + Las propiedades necesarias son: + </para> + + <table frame="topbot"> + <title>Propiedades de Conexión de SchemaExport</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Nombre de Propiedad</entry> + <entry>Descripción</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>hibernate.connection.driver_class</literal></entry> + <entry>clase del driver jdbc</entry> + </row> + <row> + <entry><literal>hibernate.connection.url</literal></entry> + <entry>url de jdbc</entry> + </row> + <row> + <entry><literal>hibernate.connection.username</literal></entry> + <entry>usuario de base de datos</entry> + </row> + <row> + <entry><literal>hibernate.connection.password</literal></entry> + <entry>contraseña de usuario</entry> + </row> + <row> + <entry><literal>hibernate.dialect</literal></entry> + <entry>dialecto</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="toolsetguide-s1-5"> + <title>Usando Ant</title> + + <para> + Puedes llamar a <literal>SchemaExport</literal> desde tu guión de construcción de Ant: + </para> + + <programlisting><![CDATA[<target name="schemaexport"> + <taskdef name="schemaexport" + classname="org.hibernate.tool.hbm2ddl.SchemaExportTask" + classpathref="class.path"/> + + <schemaexport + properties="hibernate.properties" + quiet="no" + text="no" + drop="no" + delimiter=";" + output="schema-export.sql"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaexport> +</target>]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-6"> + <title>Actualizaciones incrementales de esquema</title> + + <para> + La herramienta <literal>SchemaUpdate</literal> actualizará un esquema existente con cambios + "incrementales". Nota que <literal>SchemaUpdate</literal> depende fuertemente de la API de metadatos + de JDBC, de modo que no funcionará con todos los drivers JDBC. + </para> + + <para> + <literal>java -cp </literal><emphasis>classpaths_de_hibernate</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaUpdate</literal> <emphasis>opciones ficheros_de_mapeo</emphasis> + </para> + + <table frame="topbot"> + <title>Opciones de Línea de Comandos de <literal>SchemaUpdate</literal></title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Opción</entry> + <entry>Descripción</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>no enviar a salida estándar el guión</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>lee las propiedades de base de datos de un fichero</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Puedes encajar <literal>SchemaUpdate</literal> en tu aplicación: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaUpdate(cfg).execute(false);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-7"> + <title>Usando Ant para actualizaciones incrementales de esquema</title> + + <para> + Puedes llamar a <literal>SchemaUpdate</literal> desde el guión de Ant: + </para> + + <programlisting><![CDATA[<target name="schemaupdate"> + <taskdef name="schemaupdate" + classname="org.hibernate.tool.hbm2ddl.SchemaUpdateTask" + classpathref="class.path"/> + + <schemaupdate + properties="hibernate.properties" + quiet="no"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaupdate> +</target>]]></programlisting> + + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/transactions.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/transactions.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/transactions.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/transactions.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,925 @@ +<chapter id="transactions" revision="1"> + <title>Transacciones y Concurrencia</title> + + <para> + El punto más importante sobre Hibernate y el control de concurrencia es que muy fácil + de comprender. Hibernate usa directamente conexiones JDBC y recursos JTA sin agregar + ningún comportamiento de bloqueo adicional. Recomendamos altamente que gastes algo de + tiempo con la especificación de JDBC, ANSI, y el aislamiento de transacciones de tu sistema + de gestión de base de datos. Hibernate sólo añade versionado automático pero no bloquea + objetos en memoria ni cambia el nivel de aislamiento de tus transacciones de base de datos. + Básicamente, usa Hibernate como usarías JDBC directo (o JTA/CMT) con tus recursos de base de + datos. + </para> + + <para> + Sin embargo, además del versionado automático, Hibernate ofrece una API (menor) para + bloqueo pesimista de filas, usando la sintáxis <literal>SELECT FOR UPDATE</literal>. + Esta API se discute más adelante en este capítulo: + </para> + + <para> + Comenzamos la discusión del control de concurrencia en Hibernate con la granularidad + de <literal>Configuration</literal>, <literal>SessionFactory</literal>, y + <literal>Session</literal>, así como la base de datos y las transacciones de aplicación + largas. + </para> + + <sect1 id="transactions-basics"> + <title>Ámbitos de sesión y de transacción</title> + + <para> + Una <literal>SessionFactory</literal> es un objeto seguro entre hebras caro-de-crear + pensado para ser compartido por todas las hebras de la aplicación. Es creado una sola vez, + usualmente en el arranque de la aplicación, a partir de una instancia de <literal>Configuration</literal>. + </para> + + <para> + Una <literal>Session</literal> es un objeto barato, inseguro entre hebras que debe + ser usado una sola vez, para un solo proceso de negocio, una sola unidad de trabajo, + y luego descartado. Una <literal>Session</literal> no obtendrá una <literal>Connection</literal> + JDBC (o un <literal>Datasource</literal>) a menos que sea necesario, de modo que puedas + abrir y cerrar seguramente una <literal>Session</literal> incluso si no estás seguro + que se necesitará acceso a los datos para servir una petición en particular. (Esto se + vuelve importante en cuanto estés implementando alguno de los siguientes patrones usando + intercepción de peticiones). + </para> + + <para> + Para completar este cuadro tienes que pensar también en las transacciones de base de + datos. Una transacción de base de datos tiene que ser tan corta como sea posible, para + reducir la contención de bloqueos en la base de datos. Las transacciones largas de base de + datos prevendrán a tu aplicación de escalar a una carga altamente concurrente. + </para> + + <para> + ¿Qué es el ámbito de una unidad de trabajo? ¿Puede una sola <literal>Session</literal> de Hibernate + extenderse a través de varias transacciones de base de datos o es ésta una relación uno-a-uno + de ámbitos? ¿Cuándo debes abrir y cerrar una <literal>Session</literal> y cómo demarcas los + límites de la transacción de base de datos? + </para> + + <sect2 id="transactions-basics-uow"> + <title>Unidad de trabajo</title> + + <para> + Primero, no uses el antipatrón <emphasis>sesión-por-operación</emphasis>, esto es, + ¡no abras y cierres una <literal>Session</literal> para cada simple llamada a la base + de datos en una sola hebra! Por supuesto, lo mismo es verdad para transacciones de base de + datos. Las llamadas a base de datos en una aplicación se hacen usando una secuencia + prevista, que están agrupadas dentro de unidades de trabajo atómicas. (Nota que esto + también significa que el auto-commit después de cada una de las sentencias SQL es inútil + en una aplicación, este modo está pensado para trabajo ad-hoc de consola SQL. + Hibernate deshabilita, o espera que el servidor de aplicaciones lo haga, el modo + auto-commit inmediatamente.) + </para> + + <para> + El patrón más común en una aplicación mutiusuario cliente/servidor es + <emphasis>sesión-por-petición</emphasis>. En este modelo, una petición del cliente + es enviada al servidor (en donde se ejecuta la capa de persistencia de Hibernate), + se abre una nueva <literal>Session</literal> de Hibernate, y todas las operaciones + de base de datos se ejecutan en esta unidad de trabajo. Una vez completado el trabajo + (y se ha preparado la respuesta para el cliente) la sesión es limpiada y cerrada. + Podrías usar una sola transacción de base de datos para servir a petición del cliente, + comenzándola y comprometiéndola cuando abres y cierras la <literal>Session</literal>. + La relación entre las dos es uno-a-uno y este modelo es a la medida perfecta de muchas + aplicaciones. + </para> + + <para> + El desafío yace en la implementación: no sólo tienen que comenzarse y terminarse correctamente + la <literal>Session</literal> y la transacción, sino que además tienen que estar accesibles + para las operaciones de acceso a datos. La demarcación de una unidad de trabajo se implementa + idealmente usando un interceptor que se ejecuta cuando una petición llama al servidor y anter que + la respuesta sea enviada (es decir, un <literal>ServletFilter</literal>). Recomendamos ligar la + <literal>Session</literal> a la hebra que atiende la petición, usando una variable + <literal>ThreadLocal</literal>. Esto permite un fácil acceso (como acceder a una variable static) + en tódo el código que se ejecuta en esta hebra. Dependiendo del mecanismo de demarcación de + transacciones de base de datos que elijas, podrías mantener también el contexto de la transacción + en una variable <literal>ThreadLocal</literal>. Los patrones de implementación para esto son + conocidos como <emphasis>Sesión Local de Hebra (ThreadLocal Session)</emphasis> y + <emphasis>Sesión Abierta en Vista (Open Session in View)</emphasis>. Puedes extender fácilmente + la clase de ayuda <literal>HibernateUtil</literal> mostrada anteriormente para encontrar + una forma de implementar un interceptor e instalarlo en tu entorno. Ver el sitio web de Hibernate + para consejos y ejemplos. + </para> + + </sect2> + + <sect2 id="transactions-basics-apptx"> + <title>Transacciones de aplicación</title> + + <para> + El patrón sesión-por-petición no es el único concepto útil que puedes usar para diseñar unidades + de trabajo. Muchos procesos de negocio requiere una serie completa de interacciones con el + usuario intercaladas con accesos a base de datos. En aplicaciones web y de empresa no es aceptable + que una transacción de base de datos se extienda a través de la interacción de un usuario. + Considera el siguiente ejemplo: + </para> + + <itemizedlist> + <listitem> + <para> + Se abre la primera pantalla de un diálogo, los datos vistos por el usuario han sido + cargados en una <literal>Session</literal> y transacción de base de datos particular. + El usuario es libre de modificar los objetos. + </para> + </listitem> + <listitem> + <para> + El usuario hace click en "Salvar" después de 5 minutos y espera que sus modificaciones + sean hechas persistentes. También espera que él sea la única persona editando esta + información y que no puede ocurrir ninguna modificación en conflicto. + </para> + </listitem> + </itemizedlist> + + <para> + Llamamos a esto unidad de trabajo, desde el punto de vista del usuario, una larga + <emphasis>transacción de aplicación</emphasis> ejecutándose. Hay muchas formas en + que puedes implementar esto en tu aplicación. + </para> + + <para> + Una primera implementación ingenua podría mantener abierta la <literal>Session</literal> + y la transacción de base de datos durante el tiempo de pensar del usuario, con bloqueos + tomados en la base de datos para prevenir la modificación concurrente, y para garantizar + aislamiento y atomicidad. Esto es, por supuesto, un antipatrón, ya que la contención de + bloqueo no permitiría a la aplicación escalar con el número de usuarios concurrentes. + </para> + + <para> + Claramente, tenemos que usar muchas transacciones de base de datos para implementar la transacción + de aplicación. En este caso, mantener el aislamiento de los procesos de negocio se vuelve una + responsabilidad parcial de la capa de aplicación. Una sola transacción de aplicación usualmente + abarca varias transacciones de base de datos. Será atómica si sólo una de estas transacciones de + base de datos (la última) almacena los datos actualizados, todas las otras simplemente leen datos + (por ejemplo, en un diálogo estilo-asistente abarcando muchos ciclos petición/respuesta). + Esto es más fácil de implementar de lo que suena, especialmente si usas las funcionalidades de + Hibernate: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Versionado Automático</emphasis> - Hibernate puede llevar un control automático de + concurrencia optimista por ti, puede detectar automáticamente si una modificación concurrente + ha ocurrido durante el tiempo de pensar del usuario. + </para> + </listitem> + <listitem> + <para> + <emphasis>Objetos Separados</emphasis> - Si decides usar el ya discutido patrón + de <emphasis>sesión-por-petición</emphasis>, todas las instancias cargadas estarán + en estado separado durante el tiempo de pensar del usuario. Hibernate te permite + volver a unir los objetos y hacer persistentes las modificaciones. El patrón se + llama <emphasis>sesión-por-petición-con-objetos-separados</emphasis>. Se usa + versionado automático para aislar las modificaciones concurrentes. + </para> + </listitem> + <listitem> + <para> + <emphasis>Sesión Larga</emphasis> - La <literal>Session</literal> de Hibernate puede ser + desconectada de la conexión JDBC subyacente después que se haya sido comprometida la + transacción de base de datos, y reconectada cuando ocurra una nueva petición del cliente. + Este patrón es conocido como <emphasis>sesión-por-transacción-de-aplicación</emphasis> + y hace la re-unión innecesaria. Para aislar las modificaciones concurrentes se usa el + versionado automático. + </para> + </listitem> + </itemizedlist> + + <para> + Tanto <emphasis>sesión-por-petición-con-objetos-separados</emphasis> como + <emphasis>sesión-por-transacción-de-aplicación</emphasis>, ambas tienen + ventajas y desventajas, las discutimos más adelante en este capítulo en el contexto + del control optimista de concurrencia. + </para> + + </sect2> + + <sect2 id="transactions-basics-identity"> + <title>Considerando la identidad del objeto</title> + + <para> + Una aplicación puede acceder concurrentemente a el mismo estado persistente en dos + <literal>Session</literal>s diferentes. Sin embargo, una instancia de una clase + persistente nunca se comparte entre dos instancias de <literal>Session</literal>. + Por lo tanto existen dos nociones diferentes de identidad: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>Identidad de Base de Datos</term> + <listitem> + <para> + <literal>foo.getId().equals( bar.getId() )</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Identidad JVM</term> + <listitem> + <para> + <literal>foo==bar</literal> + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Entonces para objetos unidos a una <literal>Session</literal> <emphasis>en particular</emphasis> + (es decir en el ámbito de una <literal>Session</literal>) las dos nociones son equivalentes, y + la identidad JVM para la identidad de base de datos está garantizada por Hibernate. Sin embargo, + mientras la aplicación acceda concurrentemente al "mismo" (identidad persistente) objeto de negocio + en dos sesiones diferentes, las dos instancias serán realmente "diferentes" (identidad JVM). + Los conflictos se resuelven (con versionado automático) en tiempo de limpieza (flush) usando un + enfoque optimista. + </para> + + <para> + Este enfoque deja que Hibernate y la base de datos se preocupen sobre la concurrencia. Además + provee la mejor escalabilidad, ya que garantizando la identidad un unidades de trabajo monohebra + no se necesitan bloqueos caros u otros medios de sincronización. La aplicación nunca necesita + sincronizar sobre ningún objeto de negocio, siempre que se apegue a una sola hebra por + <literal>Session</literal>. Dentro de una <literal>Session</literal> la aplicación puede usar + con seguridad <literal>==</literal> para comparar objetos. + </para> + + <para> + Sin embargo, una aplicación que usa <literal>==</literal> fuera de una <literal>Session</literal>, + podría ver resultados inesperados. Esto podría ocurrir incluso en sitios algo inesperados, + por ejemplo, si pones dos instancias separadas dentro del mismo <literal>Set</literal>. + Ambas podrían tener la misma identidad de base de datos (es decir, representar la misma fila), + pero la identidad JVM, por definición, no está garantizada para las instancias en estado separado. + El desarrollador tiene que sobrescribir los métodos <literal>equals()</literal> y + <literal>hashCode()</literal> en las clases persistentes e implementar su propia noción de igualdad + de objetos. Hay una advertencia: Nunca uses el identificador de base de datos para implementar + la igualdad, usa una clave de negocio, una combinación de atributos únicos, usualmente inmutables. + El identificador de base de datos cambiará si un objeto transitorio es hecho persistente. + Si la instancia transitoria (usualmente junta a instancias separadas) es mantenida en un + <literal>Set</literal>, cambiar el código hash rompe el contrato del <literal>Set</literal>. + Los atributos para las claves de negocio no tienen que ser tan estables como las claves primarias + de base de datos, sólo tienes que garantizar estabilidad en tanto los objetos estén en el mismo + <literal>Set</literal>. Mira el sitio web de Hibernate para una discusión más cuidadosa de este + tema. Nota también que éste no es un tema de Hibernate, sino simplemente cómo la identidad y la igualdad + de los objetos Java tiene que ser implementada. + </para> + + </sect2> + + <sect2 id="transactions-basics-issues"> + <title>Temas comunes</title> + + <para> + Nunca uses los antipatrones <emphasis>sesión-por-sesión-de-usuario</emphasis> o + <emphasis>sesión-por-aplicación</emphasis> (por supuesto, hay raras excepciones a esta + regla). Nota que algunis de los siguientes temas podrían también aparecer con los patrones + recomendados. Asegúrate que entiendes las implicaciones antes de tomar una decisión de + diseño: + </para> + + <itemizedlist> + <listitem> + <para> + Una <literal>Session</literal> no es segura entre hebras. Las cosas que se suponen + que funcionan concurrentemente, como peticiones HTTP, beans de sesión, o workers de + Swing, provocarán condiciones de competencia si una instancia de <literal>Session</literal> + fuese compartida. Si guardas tu <literal>Session</literal> de Hibernate en tu + <literal>HttpSession</literal> (discutido más adelante), debes considerar sincronizar + el acceso a tu sesión HTTP. De otro modo, un usuario que hace click lo suficientemente + rápido puede llegar a usar la misma <literal>Session</literal> en dos hebras ejecutándose + concurrentemente. + </para> + </listitem> + <listitem> + <para> + Una excepción lanzada por Hibernate significa que tienes que deshacer (rollback) tu + transacción de base de datos y cerrar la <literal>Session</literal> inmediatamente + (discutido en más detalle luego). Si tu <literal>Session</literal> está ligada a la + aplicación, tienes que parar la aplicación. Deshacer (rollback) la transacción de base + de datos no pone a tus objetos de vuelta al estado en que estaban al comienzo de la + transacción. Esto significa que el estado de la base de datos y los objetos de negocio + quedan fuera de sincronía. Usualmente esto no es un problema, pues las excepciones no + son recuperables y tienes que volver a comenzar después del rollback de todos modos. + </para> + </listitem> + <listitem> + <para> + La <literal>Session</literal> pone en caché todo objeto que esté en estado persistente + (vigilado y chequeado por estado sucio por Hibernate). Esto significa que crece sin + fin hasta que obtienes una OutOfMemoryException, si la mantienes abierta por un largo + tiempo o simplemente cargas demasiados datos. Una solución para esto es llamar a + <literal>clear()</literal> y <literal>evict()</literal> para gestionar el caché de la + <literal>Session</literal>, pero probalemente debas considerar un procedimiento almacenado + si necesitas operaciones de datos masivas. Se muestran algunas soluciones en + <xref linkend="batch"/>. Mantener una <literal>Session</literal> abierta por la duración + de una sesión de usuario significa también una alta probabilidad de datos añejos. + </para> + </listitem> + </itemizedlist> + + </sect2> + + </sect1> + + <sect1 id="transactions-demarcation"> + <title>Demarcación de la transacción de base de datos</title> + + <para> + Los límites de las transacciones de base de datos (o sistema) son siempre necesarios. Ninguna comunicación + con la base de datos puede darse fuera de una transacción de base de datos (esto parece confundir muchos + desarrolladores acostumbrados al modo auto-commit). Siempre usa límites de transacción claros, incluso + para las operaciones de sólo lectura. Dependiendo del nivel de aislamiento y las capacidades de base de + datos, esto podría o no ser requerido, pero no hay un merma si siempre demarcas explícitamente + las transacciones. + </para> + + <para> + Una aplicación Hibernate puede ejecutarse en entornos no manejados (es decir, como independiente, + Web simple, o aplicaciones Swing) y entornos manejados J2EE. En un entorno no manejado, Hibernate es + usualmente responsable de su propio pool de conexiones de base de datos. El desarrollador de aplicaciones + tiene que establecer manualmente los límites de transacción, en otras palabras, hacer begin, commit, o + rollback las transacciones de base de datos por sí mismo. Un entorno manejado usualmente provee transacciones + gestionadas por contenedor, con el ensamble de transacción definido declarativamente en descriptores de + despliegue de beans de sesión EJB, por ejemplo. La demarcación programática de transacciones no es más + necesario, incluso limpiar (flush) la <literal>Session</literal> es hecho automáticamente. + </para> + + <para> + Sin embargo, frecuentemente es deseable mantener portable tu capa de persistencia. Hibernate ofrece + una API de envoltura llamada <literal>Transaction</literal> que se traduce al sistema de transacciones + nativo de tu entorno de despliegue. Esta API es realmente opcional, pero recomendamos fuertemente su uso + salvo que estés en un bean de sesión CMT. + </para> + + <para> + Usualmente, finalizar una <literal>Session</literal> implica cuatro fases distintas: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + limpiar (flush) la sesión + </para> + </listitem> + <listitem> + <para> + comprometer la transacción + </para> + </listitem> + <listitem> + <para> + cerrar la sesión + </para> + </listitem> + <listitem> + <para> + manejar excepciones + </para> + </listitem> + </itemizedlist> + + <para> + Limpiar la sesión ha sido discutido anteriormente, tendremos ahora una mirada más de cerca + a la demarcación de transacciones y manejo de excepciones en sendos entornos manejado y no manejados. + </para> + + + <sect2 id="transactions-demarcation-nonmanaged"> + <title>Entorno no manejado</title> + + <para> + Si una capa de persistencia Hibernate se ejecuta en un entorno no manejado, las conexiones + de base de datos son manejadas usualmente por el mecanismo de pooling de Hibernate. El idioma + manejo de sesión/transacción se ve así: + </para> + + <programlisting><![CDATA[//Non-managed environment idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + No tienes que limpiar con <literal>flush()</literal> la <literal>Session</literal> explícitamente - + la llamada a <literal>commit()</literal> automáticamente dispara la sincronización. + </para> + + <para> + Una llamada a <literal>close()</literal> marca el fin de una sesión. La principal implicación + de <literal>close()</literal> es que la conexión JDBC será abandonada por la sesión. + </para> + + <para> + Este código Java es portable y se ejecuta tanto en entornos no manejados como en entornos JTA. + </para> + + <para> + Muy probablemente nunca veas este idioma en código de negocio en una aplicación normal; + las excepciones fatales (sistema) deben siempre ser capturadas en la "cima". En otras palabras, + el código que ejecuta las llamadas de Hibernate (en la capa de persistencia) y el código que + maneja <literal>RuntimeException</literal> (y usualmente sólo puede limpiar y salir) están en + capas diferentes. Esto puede ser un desafío de diseñarlo tú mismo y debes usar los servicios + de contenedor J2EE/EJB en cuanto estuviesen disponibles. El manejo de excepciones se dicute + más adelante en este capítulo. + </para> + + <para> + Nota que debes seleccionar <literal>org.hibernate.transaction.JDBCTransactionFactory</literal> + (que es el por defecto). + </para> + + </sect2> + + <sect2 id="transactions-demarcation-jta"> + <title>Usando JTA</title> + + <para> + Si tu capa de persistencia se ejecuta en un servidor de aplicaciones (por ejemplo, detrás + de beans de sesión EJB), cada conexión de datasource obtenida por Hibernate será parte + automáticamente de la transacción JTA global. Hibernate ofrece dos estrategias para esta + integración. + </para> + + <para> + Si usas transacciones gestionadas-por-bean (BMT) Hibernate le dirá al servidor de aplicaciones + que comience y finalice una transacción BMT si usas la API de <literal>Transaction</literal>. + De modo que, el código de gestión de la transacción es idéntico al de un entorno no manejado. + </para> + + <programlisting><![CDATA[// BMT idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + Con CMT, la demarcación de la transacción se hace en descriptores de despliegue de beans de sesión, + no programáticamente. Si no quieres limpiar (flush) y cerrar manualmente la <literal>Session</literal> + por ti mismo, solamente establece <literal>hibernate.transaction.flush_before_completion</literal> a + <literal>true</literal>, <literal>hibernate.connection.release_mode</literal> a + <literal>after_statement</literal> o <literal>auto</literal> y + <literal>hibernate.transaction.auto_close_session</literal> a <literal>true</literal>. Hibernate + limpiará y cerrará entonces automáticamente la <literal>Session</literal> para ti. Lo único que resta + es deshacer (rollback) la transacción cuando ocurra una excepción. Afortunadamente, en un bean CMT, + incluso esto ocurre automáticamente, ya que una <literal>RuntimeException</literal> no manejada + disparada por un método de un bean de sesión le dice al contenedor que ponga a deshacer la transacción + global. <emphasis>Esto significa que, en CMT, no necesitas usar en absoluto la API de + <literal>Transaction</literal> de Hibernate.</emphasis> + </para> + + <para> + Nota que debes elegir <literal>org.hibernate.transaction.JTATransactionFactory</literal> en un + bean de sesión BMT, y <literal>org.hibernate.transaction.CMTTransactionFactory</literal> en un + bean de sesión CMT, cuando configures la fábrica de transacciones de Hibernate. Recuerda además + establecer <literal>org.hibernate.transaction.manager_lookup_class</literal>. + </para> + + <para> + Si trabajas en un entorno CMT, y usas limpieza (flushing) y cierre automáticos de la sesión, + podrías querer también usar la misma sesión en diferentes partes de tu código. Típicamente, + en un entorno no manejado, usarías una variable <literal>ThreadLocal</literal> para tener la sesión, + pero una sola petición de EJB puede ejecutarse en diferentes hebras (por ejemplo, un bean de sesión + llamando a otro bean de sesión). Si no quieres molestarte en pasar tu <literal>Session</literal> + por alrededor, la <literal>SessionFactory</literal> provee el método + <literal>getCurrentSession()</literal>, que devuelve una sesión que está pegada al contexto de + transacción JTA. ¡Esta es la forma más fácil de integrar Hibernate en una aplicación! + La sesión "actual" siempre tiene habilitados limpieza, cierre y liberación de conexión automáticos + (sin importar la configuración de las propiedades anteriores). Nuestra idioma de gestión de + sesión/transacción se reduce a: + </para> + + <programlisting><![CDATA[// CMT idiom +Session sess = factory.getCurrentSession(); + +// do some work +... + +]]></programlisting> + + <para> + En otras palabras, todo lo que tienes que hacer en un entorno manejado, es llamar a + <literal>SessionFactory.getCurrentSession()</literal>, hacer tu trabajo de acceso a datos, + y dejar el resto al contenedor. Los límites de transacción se establecen declarativamente + en los descriptores de despliegue de tu bean de sesión. El ciclo de vida de la sesión es + manejado completamente por Hibernate. + </para> + + <para> + Existe una advertencia al uso del modo de liberación de conexión <literal>after_statement</literal>. + Debido a una limitación tonta de la especificación de JTA, no es posible para Hibernate + limpiar automáticamente ningún <literal>ScrollableResults</literal> no cerrado ni + instancias de <literal>Iterator</literal> devueltas por <literal>scroll()</literal> o + <literal>iterate()</literal>. <emphasis>Debes</emphasis> liberar el cursor de base de datos + subyacente llamando a <literal>ScrollableResults.close()</literal> o + <literal>Hibernate.close(Iterator)</literal> explícitamente desde un bloque <literal>finally</literal>. + (Por supuesto, la mayoría de las aplicaciones pueden evitarlo fácilmente no usando en absoluto ningún + <literal>scroll()</literal> o <literal>iterate()</literal> desde el código CMT.) + </para> + + </sect2> + + <sect2 id="transactions-demarcation-exceptions"> + <title>Manejo de excepciones</title> + + <para> + Si la <literal>Session</literal> lanza una excepción (incluyendo cualquier + <literal>SQLException</literal>), debes inmediatamente deshacer (rollback) la + transacción de base de datos, llamar a <literal>Session.close()</literal> y + descartar la instancia de <literal>Session</literal>. Ciertos métodos de + <literal>Session</literal> <emphasis>no</emphasis> dejarán la sesión en un + estado consistente. Ninguna excepción lanzada por Hibernate puede ser tratada + como recuperable. Asegúrate que la <literal>Session</literal> sea cerrada llamando + a <literal>close()</literal> en un bloque <literal>finally</literal>. + </para> + + <para> + La <literal>HibernateException</literal>, que envuelve la mayoría de los errores que + pueden ocurrir en la capa de persistencia de Hibernate, en una excepción no chequeada + (no lo era en versiones anteriores de Hibernate). En nuestra opinión, no debemos forzar + al desarrollador de aplicaciones a capturar una excepción irrecuperable en una capa baja. + En la mayoría de los sistemas, las excepciones no chequeadas y fatales son manejadas + en uno de los primeros cuadros de la pila de llamadas a métodos (es decir, en las capas + más altas) y se presenta un mensaje de error al usuario de la aplicación (o se toma alguna + otra acción apropiada). Nota que Hibernate podría también lanzar otras excepciones no chequeadas + que no sean una <literal>HibernateException</literal>. Una vez más, no son recuperables y debe + tomarse una acción apropiada. + </para> + + <para> + Hibernate envuelve <literal>SQLException</literal>s lanzadas mientras se interactúa con la base + de datos en una <literal>JDBCException</literal>. De hecho, Hibernate intentará convertir la excepción + en una subclase de <literal>JDBCException</literal> más significativa. La <literal>SQLException</literal> + está siempre disponible vía <literal>JDBCException.getCause()</literal>. Hibernate convierte la + <literal>SQLException</literal> en una subclase de <literal>JDBCException</literal> apropiada usando + el <literal>SQLExceptionConverter</literal> adjunto a la <literal>SessionFactory</literal>. Por defecto, + el <literal>SQLExceptionConverter</literal> está definido para el dialecto configurado; sin embargo, + es también posible enchufar una implementación personalizada (ver los javadocs de la clase + <literal>SQLExceptionConverterFactory</literal> para los detalles). Los subtipos estándar de + <literal>JDBCException</literal> son: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>JDBCConnectionException</literal> - indica un error con la comunicación JDBC subyacente. + </para> + </listitem> + <listitem> + <para> + <literal>SQLGrammarException</literal> - indica un problema de gramática o sintáxis con el + SQL publicado. + </para> + </listitem> + <listitem> + <para> + <literal>ConstraintViolationException</literal> - indica alguna forma de violación de restricción + de integridad. + </para> + </listitem> + <listitem> + <para> + <literal>LockAcquisitionException</literal> - indica un error adquiriendo un nivel de bloqueo + necesario para realizar una operación solicitada. + </para> + </listitem> + <listitem> + <para> + <literal>GenericJDBCException</literal> - una excepción genérica que no cayó en ninguna de las + otras categorías. + </para> + </listitem> + </itemizedlist> + + + </sect2> + + </sect1> + + <sect1 id="transactions-optimistic"> + <title>Control optimista de concurrencia</title> + + <para> + El único enfoque que es consistente con alta concurrencia y alta escalabilidad es el control + optimista de concurrencia con versionamiento. El chuequeo de versión usa números de versión, + o timestamps, para detectar actualizaciones en conflicto (y para prevenir actualizaciones perdidas). + Hibernate provee para tres enfoques posibles de escribir código de aplicación que use concurrencia + optimista. Los casos de uso que hemos mostrado están en el contexto de transacciones de aplicación + largas pero el chequeo de versiones tiene además el beneficio de prevenir actualizaciones perdidas + en transacciones de base de datos solas. + </para> + + <sect2 id="transactions-optimistic-manual"> + <title>Chequeo de versiones de aplicación</title> + + <para> + En una implementación sin mucha ayuda de Hibernate, cada interacción con la base de datos ocurre en una + nueva <literal>Session</literal> y el desarrollador es responsable de recargar todas las intancias + persistentes desde la base de datos antes de manipularlas. Este enfoque fuerza a la aplicación a + realizar su propio chequeo de versiones para asegurar el aislamiento de transacciones de base de datos. + Es el enfoque más similar a los EJBs de entidad. + </para> + + <programlisting><![CDATA[// foo is an instance loaded by a previous Session +session = factory.openSession(); +Transaction t = session.beginTransaction(); +int oldVersion = foo.getVersion(); +session.load( foo, foo.getKey() ); // load the current state +if ( oldVersion != foo.getVersion() ) throw new StaleObjectStateException(); +foo.setProperty("bar"); +t.commit(); +session.close();]]></programlisting> + + <para> + La propiedad <literal>version</literal> se mapea usando <literal><version></literal>, + e Hibernate la incrementará automáticamente durante la limpieza si la entidad está sucia. + </para> + + <para> + Por supuesto, si estás operando un entorno de baja-concurrencia-de-datos y no requieres + chequeo de versiones, puedes usar este enfoque y simplemente saltar el chequeo de versiones. + En ese caso, <emphasis>el último compromiso (commit) gana</emphasis> será la estrategia por + defecto para tus transacciones de aplicación largas. Ten en mente que esto podría confundir + a los usuarios de la aplicación, pues podrían experimentar actualizaciones perdidas sin + mensajes de error ni chance de fusionar los cambios conflictivos. + </para> + + <para> + Claramente, el chequeo manual de versiones es factible solamente en circunstancias muy triviales, + y no es práctico para la mayoría de aplicaciones. Frecuentemente, no sólo intancias solas, sino grafos + completos de objetos modificados tienen que ser chequeados. Hibernate ofrece chequeo de versiones + automático con el paradigma de diseño de <literal>Session</literal> larga o de instancias separadas. + </para> + + </sect2> + + <sect2 id="transactions-optimistic-longsession"> + <title>Sesión larga y versionado automático</title> + + <para> + Una sola instancia de <literal>Session</literal> y sus instancias persistentes + son usadas para toda la transacción de aplicación. Hibernate chequea las versiones + de instancia en el momento de limpieza (flush), lanzando una excepción si se detecta + una modificación concurrente. Concierne al desarrollador capturar y manejar esta excepción + (las opciones comunes son la oportunidad del usuario de fusionar los cambios, o recomenzar el + proceso de negocio sin datos añejos). + </para> + + <para> + La <literal>Session</literal> se desconecta de cualquier conexión JDBC subyacente + al esperar por una interacción del usuario. Este enfoque es el más eficiente en términos + de acceso a base de datos. La aplicación no necesita tratar por sí misma con el chequeo de + versiones, ni re-uniendo instancias separadas, ni tiene que recargar instancias en cada + transacción de base de datos. + </para> + + <programlisting><![CDATA[// foo is an instance loaded earlier by the Session +session.reconnect(); // Obtain a new JDBC connection +Transaction t = session.beginTransaction(); +foo.setProperty("bar"); +t.commit(); // End database transaction, flushing the change and checking the version +session.disconnect(); // Return JDBC connection ]]></programlisting> + + <para> + El objeto <literal>foo</literal> todavía conoce en qué <literal>Session</literal> fue cargado. + <literal>Session.reconnect()</literal> obtiene una nueva conexión (o puedes proveer una) y + reasume la sesión. El método <literal>Session.disconnect()</literal> desconectará la sesión + de la conexión JDBC y la devolverá la conexión al pool (a menos que hayas provisto la conexión). + Después de la reconexión, para forzar un chequeo de versión en datos que no estés actualizando, + puedes llamar a <literal>Session.lock()</literal> con <literal>LockMode.READ</literal> sobre + cualquier objeto que pudiese haber sido actualizado por otra transacción. No necesitas bloquear + ningún dato que <emphasis>sí estés</emphasis> actualizando. + </para> + + <para> + Si las llamadas explícitas a <literal>disconnect()</literal> y <literal>reconnect()</literal> + son muy onerosas, puedes usar en cambio <literal>hibernate.connection.release_mode</literal>. + </para> + + <para> + Este patrón es problemático si la <literal>Session</literal> es demasiado grande para ser almacenada + durante el tiempo de pensar del usuario, por ejemplo, una <literal>HttpSession</literal> debe + mantenerse tan pequeña como sea posible. Ya que la <literal>Session</literal> es también el caché + (obligatorio) de primer nivel y contiene todos los objetos cargados, podemos probablemente cargar + esta estrategia sólo para unos pocos ciclos petición/respuesta. Esto está de hecho recomendado, ya que + la <literal>Session</literal> tendrá pronto también datos añejos. + </para> + + <para> + Nota también que debes mantener la <literal>Session</literal> desconectada próxima a la capa + de persistencia. En otras palabras, usa una sesión de EJB con estado para tener la + <literal>Session</literal> y no transferirla a la capa web para almacenarla en la + <literal>HttpSession</literal> (ni incluso serializarla a una capa separada). + </para> + + </sect2> + + <sect2 id="transactions-optimistic-detached"> + <title>Objetos separados y versionado automático</title> + + <para> + Cada interacción con el almacén persistente ocurre en una nueva <literal>Session</literal>. + Sin embargo, las mismas instancias persistentes son reusadas para cada interacción con la base de + datos. La aplicación manipula el estado de las instancias separadas originalmente cargadas en otra + <literal>Session</literal> y luego las readjunta usando <literal>Session.update()</literal>, + <literal>Session.saveOrUpdate()</literal>, o <literal>Session.merge()</literal>. + </para> + + <programlisting><![CDATA[// foo is an instance loaded by a previous Session +foo.setProperty("bar"); +session = factory.openSession(); +Transaction t = session.beginTransaction(); +session.saveOrUpdate(foo); // Use merge() if "foo" might have been loaded already +t.commit(); +session.close();]]></programlisting> + + <para> + De nuevo, Hibernate chequeará las versiones de instancia durante la limpieza (flush), + lanzando una excepción si ocurrieron actualizaciones en conflicto. + </para> + + <para> + Puedes también llamar a <literal>lock()</literal> en vez de <literal>update()</literal> + y usar <literal>LockMode.READ</literal> (realizando un chequeo de versión, puenteando + todos los cachés) si estás seguro que el objeto no ha sido modificado. + </para> + + </sect2> + + <sect2 id="transactions-optimistic-customizing"> + <title>Personalizando el versionado automático</title> + + <para> + Puedes deshabilitar el incremento de versión automático de Hibernate para propiedades en particular + y colecciones estableciendo el atributo de mapeo <literal>optimistic-lock</literal> a + <literal>false</literal>. Hibernate entonces no incrementará ya más las versiones si la propiedad está + sucia. + </para> + + <para> + Los esquemas de base de datos heredados son frecuentemente estáticos y no pueden ser modificados. + U otras aplicaciones podrían también acceder la misma base de datos y no saber cómo manejar los números + de versión ni incluso timestamps. En ambos casos, el versionado no puede confiarse a una columna en + particular en una tabla. Para forzar un chequeo de versiones sin un mapeo de propiedad de versión o + timestamp, con una comparación del estado de todos los campos en una fila, activa + <literal>optimistic-lock="all"</literal> en el mapeo de <literal><class></literal>. + Nota que esto conceptualmente funciona solamente si Hibernate puede comparar el estado viejo y nuevo, + es decir, si usas una sola <literal>Session</literal> larga y no + sesión-por-petición-con-instancias-separadas. + </para> + + <para> + A veces las modificaciones concurrentes pueden permitirse, en cuanto los cambios que hayan sido + hechos no se traslapen. Si estableces <literal>optimistic-lock="dirty"</literal> al mapear la + <literal><class></literal>, Hibernate sólo comparará los campos sucios durante la limpieza. + </para> + + <para> + En ambos casos, con columnas de versión/timestamp dedicadas o con comparación de campos + completa/sucios, Hibernate usa una sola sentencia <literal>UPDATE</literal> + (con una cláusula <literal>WHERE</literal> apropiada) por entidad para ejecutar el chequeo + de versiones y actualizar la información. Si usas persistencia transitiva para la re-unión + en cascada de entidades asociadas, Hibernate podría ejecutar actualizaciones innecesarias. + Esto usualmente no es un problema, pero podrían ejecutarse disparadores (triggers) + <emphasis>on update</emphasis> en la base de datos incluso cuando no se haya hecho ningún cambio + a las instancias separadas. Puedes personalizar este comportamiento estableciendo + <literal>select-before-update="true"</literal> en el mapeo de <literal><class></literal>, + forzando a Hibernate a <literal>SELECT</literal> la instancia para asegurar que las actualizaciones + realmente ocurran, antes de actualizar la fila. + </para> + + </sect2> + + </sect1> + + <sect1 id="transactions-locking"> + <title>Bloqueo pesimista</title> + + <para> + No se pretende que los usuarios gasten mucho tiempo preocupándose de las estrategias de bloqueo. + Usualmente es suficiente con especificar un nivel de aislamiento para las conexiones JDBC y entonces + simplemente dejar que la base de datos haga todo el trabajo. Sin embargo, los usuarios avanzados pueden + a veces obtener bloqueos exclusivos pesimistas, o reobtener bloqueos al comienzo de una nueva + transacción. + </para> + + <para> + ¡Hibernate siempre usará el mecanismo de bloqueo de la base de datos, nunca bloqueo + de objetos en memoria! + </para> + + <para> + La clase <literal>LockMode</literal> define los diferentes niveles de bloqueo que pueden ser adquiridos + por Hibernate. Un bloqueo se obtiene por los siguientes mecanismos: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>LockMode.WRITE</literal> se adquiere automáticamente cuando Hibernate actualiza o + inserta una fila. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.UPGRADE</literal> puede ser adquirido bajo petición explícita del usuario + usando <literal>SELECT ... FOR UPDATE</literal> en base de datos que soporten esa sintáxis. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.UPGRADE_NOWAIT</literal> puede ser adquirido bajo petición explícita del usuario + usando un <literal>SELECT ... FOR UPDATE NOWAIT</literal> bajo Oracle. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.READ</literal> es adquirido automáticamente cuando Hibernate lee datos + bajo los niveles de aislamiento Repeatable Read o Serializable. Puede ser readquirido por + pedido explícito del usuario. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.NONE</literal> representa la ausencia de un bloqueo. Todos los objetos se pasan + a este modo de bloqueo al final de una <literal>Transaction</literal>. Los objetos asociados con una + sesión vía una llamada a <literal>update()</literal> o <literal>saveOrUpdate()</literal> también + comienzan en este modo de bloqueo. + </para> + </listitem> + </itemizedlist> + + <para> + La "petición explícita del usuario" se expresa en una de las siguientes formas: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Una llamada a <literal>Session.load()</literal>, especificando un <literal>LockMode</literal>. + </para> + </listitem> + <listitem> + <para> + Una llamada a <literal>Session.lock()</literal>. + </para> + </listitem> + <listitem> + <para> + Una llamada a <literal>Query.setLockMode()</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + Si se llama a <literal>Session.load()</literal> con <literal>UPGRADE</literal> o + <literal>UPGRADE_NOWAIT</literal>, y el objeto pedido no ha sido aún cargado por la sesión, el objeto es + cargado usando <literal>SELECT ... FOR UPDATE</literal>. Si se llama a <literal>load()</literal> para + un objeto que ya esté cargado con un bloqueo menos restrictivo que el pedido, Hibernate llama a + <literal>lock()</literal> para ese objeto. + </para> + + <para> + <literal>Session.lock()</literal> realiza un chequeo de número de versión si el modo de bloqueo especificado + es <literal>READ</literal>, <literal>UPGRADE</literal> o <literal>UPGRADE_NOWAIT</literal>. (En el caso de + <literal>UPGRADE</literal> o <literal>UPGRADE_NOWAIT</literal>, se usa + <literal>SELECT ... FOR UPDATE</literal>.) + </para> + + <para> + Si la base de datos no soporta el modo de bloqueo solicitado, Hibernate usará un modo alternativo + apropiado (en vez de lanzar una excepción). Esto asegura que las aplicaciones serán portables. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/tutorial.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/tutorial.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/tutorial.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/tutorial.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,1270 @@ +<chapter id="tutorial"> + <title>Introducción a Hibernate</title> + + <sect1 id="tutorial-intro"> + <title>Prefacio</title> + + <para> + Este capítulo es un tutorial introductorio de Hibernate. Comenzamos con + una aplicación simple de línea de comandos usando un base de datos + en-memoria y desarrollándola en fácil para entender los pasos. + </para> + + <para> + Este tutorial está concebido para usuarios nuevos de Hibernate pero + requiere conocimiento en Java y SQL. Está basado en un tutorial de + Michael Gloegl. Las bibliotecas de terceros que mencionamos son para JDK 1.4 + y 5.0. Podrías necesitar otras para JDK 1.3. + </para> + + </sect1> + + <sect1 id="tutorial-firstapp"> + <title>Parte 1 - La primera Aplicación Hibernate</title> + + <para> + Primero, crearemos una aplicación simple de Hibenate basada en consola. + Usamos usamos una base de datos en-memoria (HSQL DB), de modo que no necesitamos + instalar ningún servidor de base de datos. + </para> + + <para> + Asumamos que necesitamos una aplicación pequeña de base de datos que + pueda almacenar eventos que queremos atender, e información acerca de los + hostales de estos eventos. + </para> + + <para> + La primera cosa que hacemos, es armar nuestro directorio de desarrollo y poner + en él todas las bibliotecas Java que necesitamos. Descarga la distribución + de Hibernate del sitio web de Hibernate. Extrae el paquete y coloca todas las + bibliotecas requeridas encontradas en <literal>/lib</literal> dentro del directorio + <literal>/lib</literal> de nuestro nuevo directorio de desarrollo de trabajo. + Debe asemejarse a esto: + </para> + + <programlisting><![CDATA[. ++lib + antlr.jar + cglib-full.jar + asm.jar + asm-attrs.jars + commons-collections.jar + commons-logging.jar + ehcache.jar + hibernate3.jar + jta.jar + dom4j.jar + log4j.jar ]]></programlisting> + + <para> + Este es el conjunto mínimo de bibliotecas requeridas para Hibernate (observa que + también hemos copiado hibernate3.jar, el fichero principal). Ver el fichero + <literal>README.txt</literal> en el directorio <literal>lib/</literal> de la distribución + de Hibernate para más información sobre bibliotecas de terceros requeridas y + opcionales. (Realmente, Log4J no es requerida aunque preferida por muchos desarrolladores). + </para> + + <para> + Por siguiente, creamos una clase que represente el evento que queremos + almacenar en base de datos. + </para> + + <sect2 id="tutorial-firstapp-firstclass"> + <title>La primera clase</title> + + <para> + Nuestra primera clase persistente es un JavaBean simple con algunas propiedades: + </para> + + <programlisting><![CDATA[import java.util.Date; + +public class Event { + private Long id; + + private String title; + private Date date; + + Event() {} + + public Long getId() { + return id; + } + + private void setId(Long id) { + this.id = id; + } + + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public String getTitle() { + return title; + } + + public void setTitle(String title) { + this.title = title; + } +}]]></programlisting> + + <para> + Puedes ver que esta clase usa las convenciones de nombrado estándar de JavaBean + para métodos getter y setter de propiedad, así como visibilidad privada + para los campos. Esto es un diseño recomendado, aunque no requerido. Hibernate + también puede acceder a los campos directamente; el beneficio de los métodos + de acceso es la robustez para la refactorización. + </para> + + <para> + La propiedad <literal>id</literal> tiene un valor único de identificador para + un evento en particular. Todas las clase de entidad persistentes ( también hay + clases dependientes menos importantes) necesitarán una propiedad identificadora + similar si queremos usar el conjunto completo de funcionalidades de Hibernate. De hecho, + la mayoría de las aplicaciones (esp. aplicaciones web) necesitan distinguir + objetos por identificador, de modo que debes considerar esto como un aspecto en vez de una + limitación. Sin embargo, usualmente no manipulamos la identidad de un objeto, por + lo tanto el método setter debe ser privado. Sólo Hibernate asignará + identificadores cuando un objeto sea salvado. Puedes ver que Hibernate puede acceder a + métodos de acceso públicos, privados y protegidos, tanto como directamente a + campos (públicos, privados y protegidos). La elección está en ti, + y puedes ajustarla a tu diseño de aplicación. + </para> + + <para> + El constructor sin argumentos es un requerimiento para todas las clases persistentes. + Hibernate tiene que crear objetos para ti, usando reflección Java. El constructor + puede ser privado, sin embargo, la visibilidad de paquete es requerida para la generación + de proxies en tiempo de ejecución y la recuperación de datos sin + instrumentación del bytecode. + </para> + + <para> + Coloca este fichero de código Java en un directorio llamado <literal>src</literal> + en la carpeta de desarrollo. El directorio ahora debe verse como esto: + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + Event.java]]></programlisting> + + <para> + En el próximo paso, le decimos a Hibernate sobre esta clase persistente. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-mapping"> + <title>El fichero de mapeo</title> + + <para> + Hibernate necesita saber cómo cargar y almacenar objetos de la + clase persistente. Aquí es donde el fichero de mapeo de Hibernate + entra en juego. El fichero de mapeo le dice a Hibernate a qué tabla en + la base de datos tiene que acceder, y qué columnas en esta tabla debe usar. + </para> + + <para> + La estructura básica de un fichero de mapeo se parece a esto: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping> +[...] +</hibernate-mapping>]]></programlisting> + + <para> + Observa que el DTD de Hibernate es muy sofisticado. Puedes usarlo para + autocompleción de los elementos y atributos XML de mapeo en tu + editor o IDE. Debes también abrir el fichero DTD en tu editor de + texto. Es la forma más fácil para tener un panorama de todos + los elementos y atributos y ver los valores por defectos, así como + algunos comentarios. Nota que Hibernate no cargará el fichero DTD de + la web, sino que primero buscará en el classpath de la aplicación. + El fichero DTD está incluído en <literal>hibernate3.jar</literal> + así como también en el directorio <literal>src/</literal> de la + distribución de Hibernate. + </para> + + <para> + Omitiremos la declaración de DTD en futuros ejemplos para acortar + el código. Por supuesto, no es opcional. + </para> + + <para> + Entre las dos etiquetas <literal>hibernate-mapping</literal>, incluye + un elemento <literal>class</literal>. Todas las clases de entidad + persistentes (de nuevo, podría haber más adelante clases + dependientes, que no sean entidades de-primera-clase) necesitan dicho mapeo + a una tabla en la base de datos SQL: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Event" table="EVENTS"> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Hasta ahora dijimos a Hibernate cómo persistir y cargar el objeto + de clase <literal>Event</literal> a la tabla <literal>EVENTS</literal>, + cada instancia representada por una fila en esta tabla. Ahora continuamos con + un mapeo de la propiedad de identificado único a la clave primaria + de la tabla. Además, como no queremos cuidar del manejo de este identificador, + configuramos la estrategia de generación de identificadores para una columna + clave primaria delegada: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="increment"/> + </id> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + El elemento <literal>id</literal> el la declaración de la propiedad + identificadora, <literal>name="id"</literal> declara el nombre de la + propiedad Java. Hibernate usará los métodos getter y setter + para acceder a la propiedad. El attributo de columna dice a Hibernate cuál + columna de la tabla <literal>EVENTS</literal> usamos para esta clave primaria. + El elemento anidado <literal>generator</literal> especifica la estrategia de + generación de identificadores, en este caso usamos <literal>increment</literal>, + que es un método muy simple de incremento de número en-memoria + útil mayormente para testeo (y tutoriales). Hibernate también + soporta identificadores generados por base de datos, globalmente únicos, + así como también asignados por aplicación (o cualquier + estrategia para la que hayas escrito una extensión). + </para> + + <para> + Finalmente incluímos declaraciones para las propiedades persistentes + de la clases en el fichero de mapeo. Por defecto, ninguna propiedad de la clase + se considera persistente: + </para> + + <programlisting><![CDATA[ +<hibernate-mapping> + + <class name="Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="increment"/> + </id> + <property name="date" type="timestamp" column="EVENT_DATE"/> + <property name="title"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Al igual que con el elemento <literal>id</literal>, el atributo <literal>name</literal> + del elemento <literal>property</literal> dice a Hibernate cáles métodos + getter y setter usar. + </para> + + <para> + ¿Por qué el mapeo de la propiedad <literal>date</literal> + incluye el atributo <literal>column</literal>, pero el de la de + <literal>title</literal> no? Sin el atributo <literal>column</literal> + Hibernate usa por defecto el nombre de propiedad como nombre de columna. + Esto funciona bien para <literal>title</literal>. Sin embargo, + However, <literal>date</literal> es una palabra reservada en la + mayoría de las bases de datos, así que mejor la mapeamos + a un nombre diferente. + </para> + + <para> + La próxima cosa interesante es que el mapeo de <literal>title</literal> + carece de un atributo <literal>type</literal>. Los tipos que declaramos y usamos + en el fichero de mapeo no son, como podrías esperar, tipos de datos Java. + Tampoco son tipos de base de datos SQL. Estos tipos son los llamados así + <emphasis>Tipos de mapeo de Hibernate</emphasis>, convertidores que pueden + traducir de tipos Java a SQL y vice versa. De nuevo, Hibernate intentará + determinar la conversión y el mapeo mismo de tipo correctos si el atributo + <literal>type</literal> no estuviese presente en el mapeo. En algunos casos esta + detección automática (usando reflección en la clase Java) + puede no tener lo que esperas o necesitas. Este es el caso de la propiedad + <literal>date</literal>. Hibernate no puede saber is la propiedad mapeará + a una columna <literal>date</literal>, <literal>timestamp</literal> o + <literal>time</literal>. Declaramos que queremos preservar la información + completa de fecha y hora mapeando la propiedad con un <literal>timestamp</literal>. + </para> + + <para> + Este fichero de mapeo debe ser salvado como <literal>Event.hbm.xml</literal>, + justo en el directorio próximo al fichero de código fuente de + la clase Java <literal>Event</literal>. El nombrado de los ficheros de mapeo + puede ser arbitrario, sin embargo, el sufijo <literal>hbm.xml</literal> se ha + vuelto una convención el la comunidad de desarrolladores de Hibernate. + La estructura de directorio debe ahora verse como esto: + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + Event.java + Event.hbm.xml]]></programlisting> + + <para> + Continuamos con la configuración principal de Hibernate. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-configuration"> + <title>Configuración de Hibernate</title> + + <para> + Tenemos ahora una clase persistente y su fichero de mapeo en su sitio. Es momento de + configurar Hibernate. Antes que hagamos esto, necesitaremos una base de datos. + HSQL DB, un DBMS SQL en-memoria basado en Java, puede ser descargado del sitio web + de HSQL DB. Realmente, de esta descarga sólo necesitas el <literal>hsqldb.jar</literal>. + Coloca este fichero en el directorio <literal>lib/</literal> de la carpeta de desarrollo. + </para> + + <para> + Crea un directorio llamado <literal>data</literal> en la raíz del directorio de + desarrollo. Allí es donde HSQL DB almacenará sus ficheros de datos. + </para> + + <para> + Hibernate es la capa en tu aplicación que se conecta a esta base de datos, + de modo que necesita información de conexión. Las conexiones se hacen + a través de un pool de conexiones JDBC, que tambén tenemos que configurar. + La distribución de Hibernate contiene muchas herramientas de pooling de conexiones + JDBC de código abierto, pero para este tutorial usaremos el pool de conexiones + prefabricado dentro de Hibernate. Observa que tienes que copiar la biblioteca requerida + en tu classpath y usar diferentes configuraciones de pooling de conexiones si quieres + usar un software de pooling JDBC de terceros de calidad de producción. + </para> + + <para> + Para la configuración de Hibernate, podemos usar un fichero + <literal>hibernate.properties</literal> simple, un fichero <literal>hibernate.cfg.xml</literal> + ligeramente más sofisticado, o incluso una configuración completamente + programática. La mayoría de los usuarios prefieren el fichero de + configuración XML: + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <session-factory> + +  + <property name="connection.driver_class">org.hsqldb.jdbcDriver</property> + <property name="connection.url">jdbc:hsqldb:data/tutorial</property> + <property name="connection.username">sa</property> + <property name="connection.password"></property> + +  + <property name="connection.pool_size">1</property> + +  + <property name="dialect">org.hibernate.dialect.HSQLDialect</property> + +  + <property name="show_sql">true</property> + +  + <property name="hbm2ddl.auto">create</property> + + <mapping resource="Event.hbm.xml"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + Observa que esta configuración XML usa un DTD diferente. + Configuramos la <literal>SessionFactory</literal> de Hibernate, una + fábrica global responsable de una base de datos en particular. + Si tienes varias bases de datos, usa varias configuraciones + <literal><session-factory></literal> , usualmente en varios + ficheros de configuración (para un arranque más fácil). + </para> + + <para> + Los primeros cuatro elementos <literal>property</literal> contienen la configuración + necesaria para la conexión JDBC. El elemento de dialecto <literal>property</literal> + especifica la variante de SQL en particular que genera Hibernate. La opción + <literal>hbm2ddl.auto</literal> activa la generación automática de esquemas + de base de datos, directamente en la base de datos. Esto, por supuesto, puede desactivarse + (quitando la opción config) o redirigido a un fichero con la ayuda de la tarea + de Ant <literal>SchemaExport</literal>. Finalmente, agregamos el(los) fichero(s) de mapeo + para clases persistentes. + </para> + + <para> + Copia este fichero dentro del directorio de código fuente, de modo que + termine ubicado en la raiíz del classpath. Hibernate busca automáticamente + un fichero llamado <literal>hibernate.cfg.xml</literal> en la raíz del classpath + al arrancar. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-ant"> + <title>Construyendo con Ant</title> + + <para> + Construiremos ahora el tutorial con Ant. Necesitarás tener Ant instalado. + Obténlo de <ulink url="http://ant.apache.org/bindownload.cgi">Página + de descarga de Ant</ulink>. No se cubrirá aquí cómo instalar Ant. + Por favor refiérete al <ulink url="http://ant.apache.org/manual/index.html"> + Manual de Ant</ulink>. Después que hayas instalado Ant, podemos comenzar a + crear el buildfile. Será llamado <literal>build.xml</literal> y colocado + directamente en el directorio de desarrollo. + </para> + + <note> + <title>Reparar Ant</title> + <para> + Observa que la distribución de Ant está por defecto rota + (como se describe en el FAQ de Ant) y tiene que ser reparado por ti, + por ejemplo, si quisieras usar JUnit desde dentro de tu fichero de construcción. + Para hacer que funcione la tarea de JUnit (no lo necesitaremos en este tutorial), + copia junit.jar a <literal>ANT_HOME/lib</literal> o quita el trozo de plugin + <literal>ANT_HOME/lib/ant-junit.jar</literal>. + </para> + </note> + + <para> + Un fichero de construcción básico se ve como esto: + </para> + + <programlisting><![CDATA[<project name="hibernate-tutorial" default="compile"> + + <property name="sourcedir" value="${basedir}/src"/> + <property name="targetdir" value="${basedir}/bin"/> + <property name="librarydir" value="${basedir}/lib"/> + + <path id="libraries"> + <fileset dir="${librarydir}"> + <include name="*.jar"/> + </fileset> + </path> + + <target name="clean"> + <delete dir="${targetdir}"/> + <mkdir dir="${targetdir}"/> + </target> + + <target name="compile" depends="clean, copy-resources"> + <javac srcdir="${sourcedir}" + destdir="${targetdir}" + classpathref="libraries"/> + </target> + + <target name="copy-resources"> + <copy todir="${targetdir}"> + <fileset dir="${sourcedir}"> + <exclude name="**/*.java"/> + </fileset> + </copy> + </target> + +</project>]]></programlisting> + + <para> + Esto dirá a Ant que agregue todos los ficheros en el directorio lib que terminen con + <literal>.jar</literal> al classpath usado para la compilación. También copiará + todos los ficheros que no sean código Java al directorio objetivo, por ejemplo, + ficheros de configuración y mapeos de Hibernate. Si ahora corres Ant, debes obtener + esta salida: + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant +Buildfile: build.xml + +copy-resources: + [copy] Copying 2 files to C:\hibernateTutorial\bin + +compile: + [javac] Compiling 1 source file to C:\hibernateTutorial\bin + +BUILD SUCCESSFUL +Total time: 1 second ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-firstapp-helpers"> + <title>Arranque y ayudantes</title> + + <para> + Es momento de cargar y almacenar algunos objetos <literal>Event</literal>, + pero primero tenemos que completar la configuración de algún + código de infraestructura. Tenemos que arrancar Hibernate. Este + arranque incluye construir un objeto <literal>SessionFactory</literal> global + y almacenarlo en algún sitio de fácil acceso en el código + de aplicación. Una <literal>SessionFactory</literal> puede abrir nuevas + <literal>Session</literal>'s. Una <literal>Session</literal> representa un unidad + de trabajo mono-hebra. La <literal>SessionFactory</literal> es un objeto global + seguro entre hebras, instanciado una sola vez. + </para> + + <para> + Crearemos una clase de ayuda <literal>HibernateUtil</literal> que cuide del + arranque y haga conveniente el manejo de <literal>Session</literal>. + El así llamado patrón <emphasis>Sesión de Hebra Local + (ThreadLocal Session)</emphasis> es útil aquí; mantenemos la unidad + de trabajo actual asociada a la hebra actual. Echemos una mirada a la implementación: + </para> + + <programlisting><![CDATA[import org.hibernate.*; +import org.hibernate.cfg.*; + +public class HibernateUtil { + + public static final SessionFactory sessionFactory; + + static { + try { + // Create the SessionFactory from hibernate.cfg.xml + sessionFactory = new Configuration().configure().buildSessionFactory(); + } catch (Throwable ex) { + // Make sure you log the exception, as it might be swallowed + System.err.println("Initial SessionFactory creation failed." + ex); + throw new ExceptionInInitializerError(ex); + } + } + + public static final ThreadLocal session = new ThreadLocal(); + + public static Session currentSession() throws HibernateException { + Session s = (Session) session.get(); + // Open a new Session, if this thread has none yet + if (s == null) { + s = sessionFactory.openSession(); + // Store it in the ThreadLocal variable + session.set(s); + } + return s; + } + + public static void closeSession() throws HibernateException { + Session s = (Session) session.get(); + if (s != null) + s.close(); + session.set(null); + } +}]]></programlisting> + + <para> + Esta clase no ólo produce la <literal>SessionFactory</literal> global en + su inicializador static (llamado sólo una vez por la JVM al cargar la clase), + sino que también tiene una variable <literal>ThreadLocal</literal> para + tener la <literal>Session</literal> para la hebra actual. No importa cuándo + llames a <literal>HibernateUtil.currentSession()</literal>, siempre devolverá + la misma unidad de trabajo de Hibernate en la misma hebra. Una llamada a + <literal>HibernateUtil.closeSession()</literal> termina la unidad de trabajo actualmente + asociada a la hebra. + </para> + + <para> + Asegúrate de entender el concepto Java de una variable local a una hebra antes + de usar esta ayuda. Una clase <literal>HibernateUtil</literal> más potente puede + encontrarse en <literal>CaveatEmptor</literal>, http://caveatemptor.hibernate.org/, + así como en el libro "Java Persistence with Hibernate". Observa que esta clase no es necesaria + si despliegas Hibernate en un servidor de aplicaciones J2EE: una <literal>Session</literal> + será automáticamente ligada a la transacción JTA actual, y puedes + buscar la <literal>SessionFactory</literal> a través de JNDI. Si usas JBoss AS, + Hibernate puede ser desplegado como un servicio de sistema manejado y automáticamente + ligará la <literal>SessionFactory</literal> a un nombre JNDI. + </para> + + <para> + Coloca <literal>HibernateUtil.java</literal> en el directorio de fuentes de desarrollo, + junto a <literal>Event.java</literal>: + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + Event.java + Event.hbm.xml + HibernateUtil.java + hibernate.cfg.xml ++data +build.xml]]></programlisting> + + <para> + Esto también debe compilar sin problemas. Finalmente necesitamos configurar + un sistema de logging (registro). Hibernate usa commons logging y te deja la elección + entre Log4J y logging de JDK 1.4. La mayoría de los desarrolladores prefieren + Log4J: copia <literal>log4j.properties</literal> de la distribución de Hibernate + (está en el directorio <literal>etc/</literal>) a tu directorio <literal>src</literal>, + junto a <literal>hibernate.cfg.xml</literal>. Echa una mirada a la configuración de + ejemplo y cambia los ajustes si te gusta tener una salida más verborrágica. + Por defecto, sólo se muestra el mensaje de arranque de Hibernate en la salida. + </para> + + <para> + La infraestructura del tutorial está completa, y estamos listos para hacer + algún trabajo real con Hibernate. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-workingpersistence"> + <title>Cargando y almacenando objetos</title> + + <para> + Finalmente, podemos usar Hibernate para cargar y almacenar objetos. + Escribimos una clase <literal>EventManager</literal> con un método + <literal>main()</literal>: + </para> + + <programlisting><![CDATA[import org.hibernate.Transaction; +import org.hibernate.Session; + +import java.util.Date; + +public class EventManager { + + public static void main(String[] args) { + EventManager mgr = new EventManager(); + + if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); + } + + HibernateUtil.sessionFactory.close(); + } + +}]]></programlisting> + + <para> + Leemos algunos argumentos de la línea de comandos, y si el primer + argumento es "store", creamos y almacenamos un nuevo Event: + </para> + + <programlisting><![CDATA[private void createAndStoreEvent(String title, Date theDate) { + Session session = HibernateUtil.currentSession(); + Transaction tx = session.beginTransaction(); + + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + session.save(theEvent); + + tx.commit(); + HibernateUtil.closeSession(); +}]]></programlisting> + + <para> + Creamos un nuevo objeto <literal>Event</literal>, y se lo damos a Hibernate. + Hibernate cuida ahora del SQL y ejecuta <literal>INSERT</literal>s en la base + de datos. Echemos una mirada al código de manejo de <literal>Session</literal> + y <literal>Transaction</literal> antes de ejecutar esto. + </para> + + <para> + Una <literal>Session</literal> es una sola unidad de trabajo. Podría sorprenderte + que tengamos una API adicional, <literal>Transaction</literal>. Esto implica que una unidad + de trabajo puede ser "más larga" que una sola transacción de base de datos; + imagina una unidad de trabajo que se abarca varios ciclos petición/respuesta HTTP + (por ejemplo, un diálogo asistente) en una aplicación web. Separar las + transacciones de base de datos de "las unidades de trabajo de la aplicación desde + el punto de vista del usuario" es uno de los conceptos básicos de diseño de + Hibernate. Llamamos una unidad de trabajo larga <emphasis>Transacción de + Aplicación</emphasis>, usualmente encapsulando varias transacciones de base de + datos más cortas. Por ahora mantendremos las cosas simples y asumiremos una + granularidad uno-a-uno entre una <literal>Session</literal> y una <literal>Transaction</literal>. + </para> + + <para> + ¿Qué es lo que hacen <literal>Transaction.begin()</literal> y <literal>commit()</literal>? + ¿Dónde está el rollback en caso que algo vaya mal? La API de <literal>Transaction</literal> + de Hibernate es opcional realmente, pero la usamos por conveniencia y portabilidad. Si manejases + la transacción de base de datos por ti mismo (por ejemplo, llamando a + <literal>session.connection.commit()</literal>), ligarías el código a un entorno + de despliegue particular, en este JDBC directo no manejado. Estableciendo la fábrica + de <literal>Transaction</literal> en tu configuración de Hibernate puedes desplegar + tu capa de persistencia en cualquier sitio. Echa una mirada al <xref linkend="transactions"/> + para más información sobre manejo y demarcación de transacciones. + Hemos saltado también cualquier manejo de excepciones y rollback en este ejemplo. + </para> + + <para> + Para ejecutar la primera rutina tenemos que agregar un objetivo llamable al fichero + de construcción de Ant: + </para> + + <programlisting><![CDATA[<target name="run" depends="compile"> + <java fork="true" classname="EventManager" classpathref="libraries"> + <classpath path="${targetdir}"/> + <arg value="${action}"/> + </java> +</target>]]></programlisting> + + <para> + El valor del argumento <literal>action</literal> es establecido por línea de + comandos al llamar al objetivo: + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant run -Daction=store]]></programlisting> + + <para> + Debes ver, después de la compilación, a Hibernate arrancando y, dependiendo + de tu configuración mucha salida de registro (log). Al final encontrarás + la siguiente línea: + </para> + + <programlisting><![CDATA[[java] Hibernate: insert into EVENTS (EVENT_DATE, title, EVENT_ID) values (?, ?, ?)]]></programlisting> + + <para> + Esta es la <literal>INSERT</literal> ejecutada por Hibernate, los signos de preguntas + representan parámetros de ligado JDBC. Para ver los valores ligados como + argumentos, o para reducir la verborragia del registro, chequea tu + <literal>log4j.properties</literal>. + </para> + + <para> + Ahora quisiéramos listar acontecimientos almacenados también, + así que agregamos una opción al método principal: + </para> + + <programlisting><![CDATA[if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); +} +else if (args[0].equals("list")) { + List events = mgr.listEvents(); + for (int i = 0; i < events.size(); i++) { + Event theEvent = (Event) events.get(i); + System.out.println("Event: " + theEvent.getTitle() + + " Time: " + theEvent.getDate()); + } +}]]></programlisting> + + <para> + Agregamos también un nuevo método <literal>listEvents()</literal>: + </para> + + <programlisting><![CDATA[private List listEvents() { + Session session = HibernateUtil.currentSession(); + Transaction tx = session.beginTransaction(); + + List result = session.createQuery("from Event").list(); + + tx.commit(); + session.close(); + + return result; +}]]></programlisting> + + <para> + Lo que hacemos aquí es usar una consulta HQL (Lenguaje de Consulta de Hibernate + o Hibernate Query Language) para cargar todos los objetos <literal>Event</literal> + existentes de la base de datos. Hibernate generará el SQL apropiado, lo enviará + a la base de datosy poblará los objetos <literal>Event</literal> con datos. + Puedes, por supuesto, crear consultas más complejas con HQL. + </para> + + <para> + Si ahora llamas a Ant con <literal>-Daction=list</literal>, debes ver los eventos + que has almacenado hasta ahora. Puede sorprenderte que esto no funcione, al menos + si has seguido este tutorial paso por paso; el resultado siempre estará + vacío. La razon de esto es la opción <literal>hbm2ddl.auto</literal> + en la configuración de Hibernate: Hibernate recreará la base de datos + en cada ejecución. Deshabilítala quitando la opción, y verás + resultados en tu listado después que llames a la acción <literal>store</literal> + unas cuantas veces. La generación y exportación de esquema es útil + mayormente en testeo unitario. + </para> + + </sect2> + + </sect1> + + <sect1 id="tutorial-associations"> + <title>Part 2 - Mapeando asociaciones</title> + + <para> + Hemos mapeado un clase de entidad persistente a una tabla. Construyamos sobre esto y agreguemos + algunas asociaciones de clase. Primero agregaremos personas a nuestra aplicación, + y almacenaremos una lista de eventos en las que participan. + </para> + + <sect2 id="tutorial-associations-mappinguser"> + <title>Mapeando la clase Person</title> + + <para> + El primer corte de la clase <literal>Person</literal> es simple: + </para> + + <programlisting><![CDATA[public class Person { + + private Long id; + private int age; + private String firstname; + private String lastname; + + Person() {} + + // Accessor methods for all properties, private setter for 'id' + +}]]></programlisting> + + <para> + Crea un fichero de mapeo llamado <literal>Person.hbm.xml</literal>: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="increment"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Finalmente, agrega el nuevo mapeo a la configuración de Hibernate: + </para> + + <programlisting><![CDATA[ <mapping resource="Event.hbm.xml"/> + <mapping resource="Person.hbm.xml"/> +]]></programlisting> + + <para> + Crearemos ahora una asociación entre estas dos entidades. Obviamente, + las personas pueden participar en eventos, y los eventos tienen participantes. + Las cuestiones de diseño con que tenemos que tratar son: direccionalidad, + multiplicidad y comportamiento de colección. + </para> + + </sect2> + + <sect2 id="tutorial-associations-unidirset"> + <title>Una asociación unidireccional basada en Set</title> + + <para> + Agregaremos una colección de eventos a la clase <literal>Person</literal>. + De esta forma podemos navegar facilmente a los eventos de una persona en particular, + sin ejecutar una consulta explícita, llamando a <literal>aPerson.getEvents()</literal>. + Usamos una colección Java, un <literal>Set</literal>, porque la colección no + contendrá elementos duplicados y el ordenamiento no nos es relevante. + </para> + + <para> + Hasta ahora hemos diseñado asociaciones unidireccionales multivaluadas, implementadas con un + <literal>Set</literal>. Escribamos el código para esto en las clases Java y luego lo + mapeemos: + </para> + + <programlisting><![CDATA[public class Person { + + private Set events = new HashSet(); + + public Set getEvents() { + return events; + } + + public void setEvents(Set events) { + this.events = events; + } +}]]></programlisting> + + <para> + Antes que mapeemos esta asociación, piensa sobre el otro lado. Claramente, podemos + mantener esto solamente unidireccional. O podemos crear otra colección en el + <literal>Event</literal>, si queremos ser capaces de navegarlos bidireccionalmente; + por ejemplo, <literal>anEvent.getParticipants()</literal>. Esta es una elección + de diseño que recae en ti, pero lo que está claro de esta discusión + es la multiplicidad de la asociación: "multi" valuada a ambos lados, llamamos a esto + una asociación <emphasis>muchos-a-muchos</emphasis>. Por lo tanto, usamos un mapeo + many-to-many de Hibernate: + </para> + + <programlisting><![CDATA[<class name="Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="increment"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + + <set name="events" table="PERSON_EVENT"> + <key column="PERSON_ID"/> + <many-to-many column="EVENT_ID" class="Event"/> + </set> + +</class>]]></programlisting> + + <para> + Hibernate soporta todo tipo de mapeos de colección, siendo el más común + un <literal><set></literal>. Para una asociación muchos-a-muchos (o relación + de entidad <emphasis>n:m</emphasis>), se necesita una tabla de asociación. Cada fila en esta + tabla representa un enlace entre una persona y un evento. Esta tabla se configura con el atributo + <literal>table</literal> del elemento <literal>set</literal>. El nombre de la columna identificadora + en la asociación, para el lado de la persona, se define con el elemento + <literal><key></literal>. El nombre de columna para el lado del evento se define con el atributo + <literal>column</literal> del <literal><many-to-many></literal>. También tienes que decirle + a Hibernate la clase de los objetos en tu colección (correcto: la clase del otro lado de la + colección de referencias). + </para> + + <para> + El esquema de base de datos para este mapeo es, por lo tanto: + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | + |_____________| |__________________| | PERSON | + | | | | |_____________| + | *EVENT_ID | <--> | *EVENT_ID | | | + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | + |_____________| | FIRSTNAME | + | LASTNAME | + |_____________| + ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-associations-working"> + <title>Trabajando la asociación</title> + + <para> + Traigamos alguna gente y eventos juntos en un nuevo método en + <literal>EventManager</literal>: + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + Session session = HibernateUtil.currentSession(); + Transaction tx = session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + Event anEvent = (Event) session.load(Event.class, eventId); + + aPerson.getEvents().add(anEvent); + + tx.commit(); + HibernateUtil.closeSession(); +}]]></programlisting> + + <para> + Después de cargar una <literal>Person</literal> y un <literal>Event</literal>, simplemente + modifica la colección usando sus métodos normales. Como puedes ver, no hay una llamada + explícita a <literal>update()</literal> o <literal>save()</literal>. Hibernate detecta + automáticamente que la colección ha sido modificada y necesita ser salvada. Esto + es llamado <emphasis>chequeo sucio automótico (automatic dirty checking)</emphasis>, y + también puedes intentarlo modificando el nombre de la propiedad de fecha de cualquiera de tus + objetos. Mientras estén en estado <emphasis>persistente</emphasis>, esto es, ligados a una + <literal>Session</literal> de Hibernate particular (es decir, justo han sido cargados o almacenados + en una unidad de trabajo), Hibernate monitoriza cualquier cambio y ejecuta SQL en estilo + escribe-por-detrás. El proceso de sincronización del estado de memoria con la base + de datos, usualmente sólo al final de una unidad de trabajo, + es llamado <emphasis>limpieza (flushing)</emphasis>. + </para> + + <para> + Podrías, por supuesto, cargar persona y evento en unidades de trabajo diferentes. O + modificas un objeto fuera de una <literal>Session</literal>, cuando no está en estado + persistente (si antes era persistente llamamos a este estado <emphasis>separado (detached) + </emphasis>). En código (no muy realista), esto se vería como sigue: + </para> + + <programlisting><![CDATA[ private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.currentSession(); + Transaction tx = session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + Event anEvent = (Event) session.load(Event.class, eventId); + + tx.commit(); + HibernateUtil.closeSession(); + + aPerson.getEvents().add(anEvent); // aPerson is detached + + Session session2 = HibernateUtil.currentSession(); + Transaction tx2 = session.beginTransaction(); + + session2.update(aPerson); // Reattachment of aPerson + + tx2.commit(); + HibernateUtil.closeSession(); + } +]]></programlisting> + + <para> + La llamada a <literal>update</literal> hace a un objeto persistente de nuevo, podrías + decir que la liga a una nueva unidad de trabajo, de modo que cualquier modificación que + le hagas mientras esté separado puede ser salvada a base de datos. + </para> + + <para> + Bueno, esto no es muy usado en nuestra situación actual, pero es un concepto + importante que puedes diseñar en tu propia aplicación. Por ahora, completa + este ejercicio agregando una nueva acción al método main de + <literal>EventManager</literal> y llámala desde la línea de comandos. + Si necesitas los identificadores de una persona o evento, el método + <literal>save()</literal> los devuelve. + </para> + + <para> + Esto fue un ejemplo de una asociación entre dos clases igualmente importantes, dos entidades. + Como se ha mencionado anteriormente, hay otras clases y tipos en un modelo típico, + usualmente "menos importantes". Algunos ya los habrás visto, como un <literal>int</literal> + o un <literal>String</literal>. Llamamos a estas clases <emphasis>tipos de valor (value types)</emphasis>, + y sus instancias <emphasis>dependen</emphasis> de una entidad en particular. Las instancias de estos + tipos no tienen su propia identidad, ni son compartidas entre entidades (dos personas no referencian + el mismo objeto <literal>firstname</literal>, incluso si tuvieran el mismo primer nombre). Por supuesto, + los tipos de valor no sólo pueden encontrarse en el JDK (de hecho, en una aplicación + Hibernate todas las clases del JDK son consideradas tipos de valor), sino que además puedes + escribir por ti mismo clases dependientes, por ejemplo, <literal>Address</literal> o + <literal>MonetaryAmount</literal>. + </para> + + <para> + También puedes diseñar una colección de tipos de valor. Esto es conceptualmente + muy diferente de una colección de referencias a otras entidades, pero se ve casi lo mismo en + Java. + </para> + + </sect2> + + <sect2 id="tutorial-associations-valuecollections"> + <title>Colección de valores</title> + + <para> + Agregamos una colección de objetos tipificados en valor a la entidad <literal>Person</literal>. + Queremos almacenar direcciones de email, de modo que el tipo que usamos es <literal>String</literal>, + y la colección es nuevamente un <literal>Set</literal>: + </para> + <programlisting><![CDATA[private Set emailAddresses = new HashSet(); + +public Set getEmailAddresses() { + return emailAddresses; +} + +public void setEmailAddresses(Set emailAddresses) { + this.emailAddresses = emailAddresses; +}]]></programlisting> + + <para> + El mapeo de este <literal>Set</literal>: + </para> + + <programlisting><![CDATA[<set name="emailAddresses" table="PERSON_EMAIL_ADDR"> + <key column="PERSON_ID"/> + <element type="string" column="EMAIL_ADDR"/> +</set>]]></programlisting> + + <para> + La diferencia comparada con el mapeo anterior es la parte <literal>element</literal>, que le dice + a Hibernate que la colección no contiene referencias a otra entidad, sino una colección + de elementos de tipo <literal>String</literal> (el nombre en minúsculas te dice que es un + tipo/conversor de mapeo de Hibernate). Una vez más, el atributo <literal>table</literal> del + elemento <literal>set</literal> determina el nombre de la tabla para la colección. El elemento + <literal>key</literal> define el nombre de la columna clave foránea en la tabla de colección. + El atributo <literal>column</literal> en el elemento <literal>element</literal> define el nombre de + columna donde realmente serán almacenados los valores <literal>String</literal>. + </para> + + <para> + Echa una mirada al esquema actualizado: + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | ___________________ + |_____________| |__________________| | PERSON | | | + | | | | |_____________| | PERSON_EMAIL_ADDR | + | *EVENT_ID | <--> | *EVENT_ID | | | |___________________| + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | | *EMAIL_ADDR | + |_____________| | FIRSTNAME | |___________________| + | LASTNAME | + |_____________| + ]]></programlisting> + + <para> + Puedes ver que la clave primaria de la tabla de colección es de hecho una clave + compuesta, usando ambas columnas. Esto implica también que no pueden haber + direcciones de email duplicadas por persona, que es exactamente la semántica + que necesitamos para un conjunto en Java. + </para> + + <para> + Puedes ahora intentar y agregar elementos a esta colección, al igual que + hicimos antes enlazando personas y eventos. Es el mismo código en Java. + </para> + + </sect2> + + <sect2 id="tutorial-associations-bidirectional"> + <title>Asociaciones bidireccionales</title> + + <para> + A continuacion vamos a mapear una asociación bidireccional, haciendo que la + asociación entre persona y evento funcione desde ambos lados en Java. Por supuesto, + el esquema de base de datos no cambia; todavía necesitamos multiplicidad muchos-a-muchos. + Una base de datos relacional es más flexible que un lenguaje de programación + de red, así que no necesita nada parecido a una dirección de navegación; + los datos pueden ser vistos y recuperados en cualquier forma posible. + </para> + + <para> + Primero agrega una colección de participantes a la clase de eventos + <literal>Event</literal>: + </para> + + <programlisting><![CDATA[private Set participants = new HashSet(); + +public Set getParticipants() { + return participants; +} + +public void setParticipants(Set participants) { + this.participants = participants; +}]]></programlisting> + + <para> + Ahora mapea este lado de la asociación también, en + <literal>Event.hbm.xml</literal>. + </para> + + <programlisting><![CDATA[<set name="participants" table="PERSON_EVENT" inverse="true"> + <key column="EVENT_ID"/> + <many-to-many column="PERSON_ID" class="Person"/> +</set>]]></programlisting> + + <para> + Como ves, estos son mapeos normales de <literal>set</literal> en ambos documentos de + mapeo. Nota que los nombres de columnas en <literal>key</literal> y + <literal>many-to-many</literal> fueron permutados en ambos documentos de mapeo. Aquí la + adición más importante es el atributo <literal>inverse="true"</literal> en el + elemento <literal>set</literal> del mapeo de colección de <literal>Event</literal>. + </para> + + <para> + Lo que esto significa es que Hibernate debe tomar el otro lado - la clase <literal>Person</literal> - + cuando necesite descubrir información sobre el enlace entre las dos. Esto será mucho + más fácil de entender una vez que veas cómo se crea el enlace bidireccional + entre nuestras dos entidades. + </para> + + </sect2> + + <sect2 id="tutorial-associations-usingbidir"> + <title>Trabajando enlaces bidireccionales</title> + + <para> + Primero, ten en mente que Hhibernate no afecta la semántica normal de Java. ¿Cómo + hemos creado un enlace entre una <literal>Person</literal> y un <literal>Event</literal> en el + ejemplo unidireccional? Hemos agregado una instancia de <literal>Event</literal> a la colección + de referencias de eventos de una instancia de <literal>Person</literal>. De modo que, obviamente, + si queremos que este enlace funcione bidireccionalmente, tenemos que hacer lo mismo del otro lado, + agregando una referencia a <literal>Person</literal> a la colección en un <literal>Event</literal>. + Este "establecer el enlace a ambos lados" es absolutamente necesario y nunca debes olvidar hacerlo. + </para> + + <para> + Muchos desarrolladores programan a la defensiva y crean métodos de + manejo de un enlace para establecer correctamente ambos lados, por ejemplo + en <literal>Person</literal>: + </para> + + <programlisting><![CDATA[protected Set getEvents() { + return events; +} + +protected void setEvents(Set events) { + this.events = events; +} + +public void addToEvent(Event event) { + this.getEvents().add(event); + event.getParticipants().add(this); +} + +public void removeFromEvent(Event event) { + this.getEvents().remove(event); + event.getParticipants().remove(this); +}]]></programlisting> + + <para> + Nota que los métodos get y set para esta colección son ahora protegidos. Esto le + permite a clases en el mismo paquete y a subclases acceder aún a los métodos, pero + previene a cualquier otro de ensuciarse con la colección directamente (bueno, casi). + Probablemente debas hacer lo mismo con la colección al otro lado. + </para> + + <para> + Y ¿qué del atributo de mapeo <literal>inverse</literal>? Para ti, y para Java, un enlace + bidireccional es simplemente cuestión de establecer correctamente las referencias a ambos + lados. Hibernate, sin embargo, no tiene suficiente información para arreglar correctamente + sentencias <literal>INSERT</literal> y <literal>UPDATE</literal> de SQL (para evitar violación + de restricciones), y necesita alguna ayuda para manejar asociaciones bidireccionales apropiadamente. + El hacer un lado de la asociación <literal>inverse</literal> le dice a Hibernate que basicamente + lo ignore, que lo considere un <emphasis>espejo</emphasis> del otro lado. Esto es todo lo necesario para + que Hibernate resuelva todas las incidencias al transformar un modelo de navegación direccional a + un esquema SQL de base de datos. Las reglas que tienes que recordar son directas: Todas las asociaciones + bidireccionales necesitan uno de los lados como <literal>inverse</literal>. En una asociación + uno-a-muchos debe ser el lado-de-muchos. En una asociación muchos-a-muchos, puedes tomar cualquier + lado, no hay diferencia. + </para> + + </sect2> + </sect1> + + <sect1 id="tutorial-summary"> + <title>Summary</title> + + <para> + Este tutorial cubrió los fundamentos de escribir una simple aplicación independiente + de Hibernate. + </para> + + <para> + Si ya te sientes confidente con Hibernate, continúa navegando a través de la + tabla de contenidos de la documentación de referencia para los temas que encuentres + interesantes. Los más consultados son procesamiento transaccional (<xref linkend="transactions"/>), + rendimiento de recuperación (<xref linkend="performance"/>), o el uso de la API + (<xref linkend="objectstate"/>) y las funcionalidades de consulta (<xref linkend="objectstate-querying"/>). + </para> + + <para> + No olvides chequear el sitio web de Hibernate por más (especializados) tutoriales. + </para> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/content/xml.xml (from rev 12794, core/trunk/documentation/manual/es-ES/src/main/docbook/modules/xml.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/content/xml.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/content/xml.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,282 @@ +<chapter id="xml"> + <title>Mapeo XML</title> + + <para><emphasis> + Nota que esta es una funcionalidad experimental en Hibernate 3.0 y está + bajo un desarrollo extremadamente activo. + </emphasis></para> + + <sect1 id="xml-intro" revision="1"> + <title>Trabajando con datos XML</title> + + <para> + Hibernate te permite trabajar con datos XML persistentes en casi la misma forma + que trabajas con POJOs persistentes. Un árbol XML analizado (parsed) puede ser + pensado como sólo otra forma de representar los datos relacionales a nivel de objetos, + en vez de POJOs. + </para> + + <para> + Hibernate soporta dom4j como API para manipular árboles XML. Puedes escribir + consultas que traigan árboles dom4j de la base de datos y tener cualquier modificación + que hagas al árbol sincronizada automáticamente a la base de datos. Puedes incluso tomar + un documento XML, analizarlo usando dom4j, y escribirlo a la base de datos con cualquiera + de las operaciones básicas de Hibernate: <literal>persist(), saveOrUpdate(), merge(), + delete(), replicate()</literal> (la fusión no está aún soportada). + </para> + + <para> + Esta funcionalidad tiene muchas aplicaciones incluyendo la importación/exportación de datos, + externalización de datos de entidad vía JMS o SOAP y reportes basados en XSLT. + </para> + + <para> + Un solo mapeo puede ser usado para mapear simultáneamente las propiedades de una clase y los nodos de un + documento XML a la base de datos, o, si no hay ninguna clase a mapear, puede ser usado para mapear sólo + el XML. + </para> + + <sect2 id="xml-intro-mapping"> + <title>Especificando los mapeos de XML y de clase juntos</title> + + <para> + He aquí un ejemplo de mapear un POJO y XML simultáneamente: + </para> + + <programlisting><![CDATA[<class name="Account" + table="ACCOUNTS" + node="account"> + + <id name="accountId" + column="ACCOUNT_ID" + node="@id"/> + + <many-to-one name="customer" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false"/> + + <property name="balance" + column="BALANCE" + node="balance"/> + + ... + +</class>]]></programlisting> + </sect2> + + <sect2 id="xml-onlyxml"> + <title>Especificando sólo un mapeo XML</title> + + <para> + He aquí un ejemplo donde no hay ninguna clase POJO: + </para> + + <programlisting><![CDATA[<class entity-name="Account" + table="ACCOUNTS" + node="account"> + + <id name="id" + column="ACCOUNT_ID" + node="@id" + type="string"/> + + <many-to-one name="customerId" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false" + entity-name="Customer"/> + + <property name="balance" + column="BALANCE" + node="balance" + type="big_decimal"/> + + ... + +</class>]]></programlisting> + + <para> + Este mapeo te permite acceder a los datos como un árbol dom4j, o como un grafo de pares nombre/valor de + propiedad (<literal>Map</literal>s de Java). Los nombres de propiedades son construcciones puramente + lógicas a las que se puede hacer referencia en consultas HQL. + </para> + + </sect2> + + </sect1> + + <sect1 id="xml-mapping" revision="1"> + <title>Mapeo de metadatos XML</title> + + <para> + Muchos elementos de mapeo de Hibernate aceptan el atributo <literal>node</literal>. Esto te permite espcificar + el nombre de un atributo o elemento XML que contenga los datos de la propiedad o entidad. El formato del + atributo <literal>node</literal> debe ser uno de los siguientes: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para><literal>"element-name"</literal> - mapea al elemento XML mencionado</para> + </listitem> + <listitem> + <para><literal>"@attribute-name"</literal> - mapea al atributo XML mencionado</para> + </listitem> + <listitem> + <para><literal>"."</literal> - mapea al elemento padre</para> + </listitem> + <listitem> + <para> + <literal>"element-name/@attribute-name"</literal> - + mapea al atributo mencionado del elemento mencionado + </para> + </listitem> + </itemizedlist> + + <para> + Para las colecciones y asociaciones monovaluadas, existe un atributo adicional <literal>embed-xml</literal>. + Si <literal>embed-xml="true"</literal>, que es el valor por defecto, el árbol XML para la entidad + asociada (o colección de tipo de valor) será embebida directamente en el árbol XML para la entidad que + posee la asociación. En otro caso, si <literal>embed-xml="false"</literal>, sólo el valor identificador + referenciado aparecerá en el XML para asociaciones de punto único y para las colecciones simplemente + no aparecerá en absoluto. + </para> + + <para> + ¡Debes ser cuidadoso de no dejar <literal>embed-xml="true"</literal> para demasiadas asociaciones, + ya que XML no trata bien la circularidad! + </para> + + <programlisting><![CDATA[<class name="Customer" + table="CUSTOMER" + node="customer"> + + <id name="id" + column="CUST_ID" + node="@id"/> + + <map name="accounts" + node="." + embed-xml="true"> + <key column="CUSTOMER_ID" + not-null="true"/> + <map-key column="SHORT_DESC" + node="@short-desc" + type="string"/> + <one-to-many entity-name="Account" + embed-xml="false" + node="account"/> + </map> + + <component name="name" + node="name"> + <property name="firstName" + node="first-name"/> + <property name="initial" + node="initial"/> + <property name="lastName" + node="last-name"/> + </component> + + ... + +</class>]]></programlisting> + + <para> + en este caso, hemos decidido embeber la colección de ids de cuenta, pero no los datos reales de cuenta. + La siguiente consulta HQL: + </para> + + <programlisting><![CDATA[from Customer c left join fetch c.accounts where c.lastName like :lastName]]></programlisting> + + <para> + devolvería conjuntos de datos como estos: + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account short-desc="Savings">987632567</account> + <account short-desc="Credit Card">985612323</account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + <para> + Si estableces <literal>embed-xml="true"</literal> en el mapeo <literal><one-to-many></literal>, los datos + podrían verse así: + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account id="987632567" short-desc="Savings"> + <customer id="123456789"/> + <balance>100.29</balance> + </account> + <account id="985612323" short-desc="Credit Card"> + <customer id="123456789"/> + <balance>-2370.34</balance> + </account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + </sect1> + + + <sect1 id="xml-manipulation" revision="1"> + <title>Manipulando datos XML</title> + + <para> + Vamos a releer y actualizar documentos XML en la aplicación. Hacemos esto obteniendo una sesión dom4j: + </para> + + <programlisting><![CDATA[Document doc = ....; + +Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +List results = dom4jSession + .createQuery("from Customer c left join fetch c.accounts where c.lastName like :lastName") + .list(); +for ( int i=0; i<results.size(); i++ ) { + //add the customer data to the XML document + Element customer = (Element) results.get(i); + doc.add(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <programlisting><![CDATA[Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +Element cust = (Element) dom4jSession.get("Customer", customerId); +for ( int i=0; i<results.size(); i++ ) { + Element customer = (Element) results.get(i); + //change the customer name in the XML and database + Element name = customer.element("name"); + name.element("first-name").setText(firstName); + name.element("initial").setText(initial); + name.element("last-name").setText(lastName); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + Es extremadamente útil combinar esta funcionalidad con la operación <literal>replicate()</literal> + de Hibernate para implementar la importación/exportación de datos basada en XML. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/AuthorWork.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/AuthorWork.zargo (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.zargo) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/CustomerOrderProduct.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/CustomerOrderProduct.zargo (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.zargo) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/EmployerEmployee.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/EmployerEmployee.zargo (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.zargo) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/full_cream.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/full_cream.svg (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.svg) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/images/full_cream.svg (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/images/full_cream.svg 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,429 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> + +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="354.331" + height="336.614" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,5.25349)" + style="font-size:12;" + id="g659"> + <rect + width="212.257" + height="57.2441" + x="17.9576" + y="100.132" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + transform="matrix(0.743454,0,0,0.482981,6.46949,52.2178)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <rect + width="325.86" + height="63.6537" + x="17.4083" + y="15.194" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="325.86" + height="63.6537" + x="13.6713" + y="12.4966" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + <g + transform="matrix(1.14345,0,0,0.729078,-1.67818,105.325)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <text + x="170.824753" + y="58.402939" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="170.824997" + y="58.402901" + id="tspan360"> +Application</tspan> + </text> + <text + x="178.076340" + y="364.281433" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="178.076004" + y="364.281006" + id="tspan421"> +Database</tspan> + </text> + <text + x="68.605331" + y="138.524582" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="68.605301" + y="138.524994" + id="tspan384"> +SessionFactory</tspan> + </text> + <rect + width="67.0014" + height="101.35" + x="196.927" + y="89.2389" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect387" /> + <rect + width="67.0014" + height="101.35" + x="194.633" + y="86.4389" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect388" /> + <text + x="249.108841" + y="173.885559" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text389"> + <tspan + x="249.108994" + y="173.886002" + id="tspan392"> +Session</tspan> + </text> + <rect + width="73.0355" + height="101.35" + x="270.995" + y="90.0018" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect395" /> + <rect + width="73.0355" + height="101.35" + x="267.869" + y="87.2018" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect396" /> + <text + x="328.593658" + y="174.715622" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text397"> + <tspan + x="328.593994" + y="174.716003" + id="tspan563"> +Transaction</tspan> + </text> + <g + transform="matrix(0.29544,0,0,0.397877,9.70533,103.96)" + style="font-size:12;" + id="g565"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect566" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect567" /> + </g> + <text + x="25.592752" + y="204.497803" + transform="scale(0.823795,0.823795)" + style="font-size:10;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text568"> + <tspan + x="25.592800" + y="204.498001" + id="tspan662"> +TransactionFactory</tspan> + </text> + <g + transform="matrix(0.298082,0,0,0.397877,99.6898,103.96)" + style="font-size:12;" + id="g573"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect574" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect575" /> + </g> + <text + x="134.030670" + y="205.532791" + transform="scale(0.823795,0.823795)" + style="font-size:10;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text576"> + <tspan + x="134.031006" + y="205.533005" + id="tspan664"> +ConnectionProvider</tspan> + </text> + <g + transform="matrix(1.14345,0,0,0.729078,-1.67818,38.9539)" + style="font-size:12;" + id="g587"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect588" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect589" /> + </g> + <rect + width="90.951" + height="44.4829" + x="25.6196" + y="206.028" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect594" /> + <rect + width="90.951" + height="44.4829" + x="24.4229" + y="204.135" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect595" /> + <text + x="85.575645" + y="282.300354" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text596"> + <tspan + x="85.575600" + y="282.299988" + id="tspan607"> +JNDI</tspan> + </text> + <rect + width="90.951" + height="44.4829" + x="236.937" + y="206.791" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect610" /> + <rect + width="90.951" + height="44.4829" + x="235.741" + y="204.898" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect611" /> + <text + x="342.093201" + y="283.226410" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text612"> + <tspan + x="342.092987" + y="283.226013" + id="tspan621"> +JTA</tspan> + </text> + <rect + width="90.951" + height="44.4829" + x="130.134" + y="206.791" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect616" /> + <rect + width="90.951" + height="44.4829" + x="128.937" + y="204.898" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect617" /> + <text + x="212.445343" + y="283.226410" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text618"> + <tspan + x="212.445007" + y="283.226013" + id="tspan623"> +JDBC</tspan> + </text> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,6.19341)" + style="font-size:12;" + id="g637"> + <g + transform="matrix(0.499515,0,0,0.415467,-0.237339,5.61339)" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="33.749969" + y="50.589706" + style="font-size:11;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="33.750000" + y="50.589699" + id="tspan635"> +Transient Objects</tspan> + </text> + </g> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,5.25349)" + style="font-size:12;" + id="g644"> + <g + transform="matrix(0.297486,0,0,0.516482,230.251,36.9178)" + id="g364"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect365" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect366" /> + </g> + <text + x="277.123230" + y="85.155571" + style="font-size:11;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text367"> + <tspan + x="277.122986" + y="85.155602" + id="tspan631"> +Persistent</tspan> + <tspan + x="277.122986" + y="96.155602" + id="tspan633"> +Objects</tspan> + </text> + </g> +</svg> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/hibernate_logo_a.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/hibernate_logo_a.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/lite.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/lite.svg (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.svg) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/images/lite.svg (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/images/lite.svg 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,334 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> + +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="318.898" + height="248.031" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <rect + width="291.837" + height="57.0074" + x="17.3169" + y="18.646" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="291.837" + height="57.0074" + x="13.9703" + y="16.2302" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + <g + transform="matrix(0.326107,0,0,0.765831,9.59261,8.98517)" + style="font-size:12;" + id="g161"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <g + transform="matrix(1.02406,0,0,0.652953,0.223384,39.9254)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <g + transform="matrix(0.449834,0,0,0.338463,-3.15909,9.73319)" + style="font-size:12;" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="302.277679" + y="65.943230" + transform="scale(0.73778,0.73778)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="302.277954" + y="65.943184" + id="tspan360"> +Application</tspan> + </text> + <text + x="36.235924" + y="63.796055" + transform="scale(0.73778,0.73778)" + style="font-size:14;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="36.235950" + y="63.796051" + id="tspan427"> +Transient Objects</tspan> + </text> + <text + x="180.416245" + y="290.543701" + transform="scale(0.73778,0.73778)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="180.415939" + y="290.543549" + id="tspan421"> +Database</tspan> + </text> + <text + x="25.037701" + y="179.154755" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="25.037655" + y="179.154648" + id="tspan384"> +SessionFactory</tspan> + </text> + <g + transform="matrix(0.252763,0,0,0.765831,109.104,8.98517)" + style="font-size:12;" + id="g386"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect387" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect388" /> + </g> + <g + transform="matrix(0.297394,0,0,0.572692,101.502,21.6359)" + style="font-size:12;" + id="g364"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect365" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect366" /> + </g> + <text + x="202.746506" + y="102.992203" + transform="scale(0.73778,0.73778)" + style="font-size:14;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text367"> + <tspan + x="202.746948" + y="102.992249" + id="tspan423"> +Persistent</tspan> + <tspan + x="202.746948" + y="116.992355" + id="tspan425"> +Objects</tspan> + </text> + <text + x="174.458496" + y="180.080795" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text389"> + <tspan + x="174.458618" + y="180.080338" + id="tspan392"> +Session</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,188.675,8.98517)" + style="font-size:12;" + id="g394"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect395" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect396" /> + </g> + <text + x="260.413269" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text397"> + <tspan + x="260.412964" + y="179.154343" + id="tspan400"> +JDBC</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,229.156,8.98517)" + style="font-size:12;" + id="g405"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect406" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect407" /> + </g> + <text + x="320.606903" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text408"> + <tspan + x="320.606964" + y="179.154343" + id="tspan417"> +JNDI</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,269.281,8.98517)" + style="font-size:12;" + id="g411"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect412" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect413" /> + </g> + <text + x="377.096313" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text414"> + <tspan + x="377.096008" + y="179.154999" + id="tspan145"> +JTA</tspan> + </text> +</svg> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/overview.png (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/images/overview.svg (from rev 14074, core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.svg) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/images/overview.svg (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/images/overview.svg 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,250 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> + +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="248.031" + height="248.031" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,-3.02123)" + style="font-size:12;" + id="g158"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="17.3527" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="15.3883" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + </g> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,3.04452)" + style="font-size:12;" + id="g161"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,8.0993)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <g + transform="matrix(0.771934,0,0,0.543505,2.59104,21.1103)" + style="font-size:12;" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="105.392174" + y="56.568123" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="105.392273" + y="56.568146" + id="tspan186"> +Application</tspan> + </text> + <text + x="81.820183" + y="103.149330" + transform="scale(0.771934,0.771934)" + style="font-size:20;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="81.820213" + y="103.149727" + id="tspan206"> +Persistent Objects</tspan> + </text> + <text + x="111.548180" + y="278.927887" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="111.547874" + y="278.927551" + id="tspan200"> +Database</tspan> + </text> + <text + x="94.436180" + y="153.805740" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="94.436180" + y="153.805740" + id="tspan221"> +HIBERNATE</tspan> + </text> + <g + transform="matrix(0.771934,0,0,0.771934,2.59083,1.02261)" + style="font-size:12;" + id="g254"> + <g + transform="translate(4.58374,2.61928)" + id="g176"> + <g + transform="matrix(0.571429,0,0,0.67347,-10.6174,117.093)" + id="g170"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect171" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect172" /> + </g> + <g + transform="matrix(0.571429,0,0,0.67347,138.682,117.093)" + id="g173"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect174" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect175" /> + </g> + </g> + <text + x="47.259438" + y="182.367538" + style="font-weight:bold;stroke-width:1pt;font-family:Courier;" + id="text191"> + <tspan + x="47.259399" + y="182.367996" + id="tspan212"> +hibernate.</tspan> + <tspan + x="47.259399" + y="194.367996" + id="tspan214"> +properties</tspan> + </text> + <text + x="198.523010" + y="188.260941" + style="font-weight:normal;stroke-width:1pt;font-family:helvetica;" + id="text194"> + <tspan + id="tspan195"> +XML Mapping</tspan> + </text> + </g> +</svg> Copied: core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice.xml (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml) =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,52 @@ +<?xml version='1.0'?> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + + +<legalnotice id="Legal_Notice"> + <title>Legal Notice</title> + <para> + <address> + <street>1801 Varsity Drive</street> + <city>Raleigh</city>, <state>NC</state><postcode>27606-2072</postcode><country>USA</country> + <phone>Phone: +1 919 754 3700</phone> + <phone>Phone: 888 733 4281</phone> + <fax>Fax: +1 919 754 3701</fax> + <pob>PO Box 13588</pob><city>Research Triangle Park</city>, <state>NC</state><postcode>27709</postcode><country>USA</country> + </address> + </para> + <para> + Copyright <trademark class="copyright"></trademark> 2007 by Red Hat, Inc. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</ulink>). + </para> + <para> + Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. + </para> + <para> + Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder. + </para> + <para> + Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat, Inc. in the United States and other countries. + </para> + <para> + All other trademarks referenced herein are the property of their respective owners. + </para> + <para> + The GPG fingerprint of the security(a)redhat.com key is: + </para> + <para> + CA 20 86 86 2B D6 9D FC 65 F6 EC C4 21 91 80 CD DB 42 A6 0E + </para> +</legalnotice> \ No newline at end of file Added: core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice2.xml =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice2.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/legal_notice2.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,16 @@ +<?xml version='1.0'?> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<legalnotice id="Legal_Notice"> + <title>Translation-specific Legal Notice</title> + <para> + Advertencia! Esta es una versión traducida del inglés de + la documentacién de referencia de Hibernate. La versión + traducida puede no estar actualizada! Sin embargo, las diferencias + deberían ser sólo menores. Consulta la documentación + de referencia en inglés si estás perdiendo información + o encuentras algún error de traducción. Si quieres colaborar con + una traducción en particular, contáctanos en la lista de correo + de desarrolladores de Hibernate. + </para> +</legalnotice> \ No newline at end of file Deleted: core/trunk/documentation/manual/es-ES/src/main/docbook/master.xml =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/master.xml 2007-10-09 18:28:36 UTC (rev 14074) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/master.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -1,203 +0,0 @@ -<?xml version='1.0' encoding="iso-8859-1"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" - "../support/docbook-dtd/docbookx.dtd" -[ -<!ENTITY quickstart SYSTEM "modules/quickstart.xml"> -<!ENTITY tutorial SYSTEM "modules/tutorial.xml"> -<!ENTITY architecture SYSTEM "modules/architecture.xml"> -<!ENTITY configuration SYSTEM "modules/configuration.xml"> -<!ENTITY persistent-classes SYSTEM "modules/persistent_classes.xml"> -<!ENTITY basic-mapping SYSTEM "modules/basic_mapping.xml"> -<!ENTITY collection-mapping SYSTEM "modules/collection_mapping.xml"> -<!ENTITY association-mapping SYSTEM "modules/association_mapping.xml"> -<!ENTITY component-mapping SYSTEM "modules/component_mapping.xml"> -<!ENTITY inheritance-mapping SYSTEM "modules/inheritance_mapping.xml"> -<!ENTITY session-api SYSTEM "modules/session_api.xml"> -<!ENTITY transactions SYSTEM "modules/transactions.xml"> -<!ENTITY events SYSTEM "modules/events.xml"> -<!ENTITY batch SYSTEM "modules/batch.xml"> -<!ENTITY query-hql SYSTEM "modules/query_hql.xml"> -<!ENTITY query-criteria SYSTEM "modules/query_criteria.xml"> -<!ENTITY query-sql SYSTEM "modules/query_sql.xml"> -<!ENTITY filters SYSTEM "modules/filters.xml"> -<!ENTITY xml SYSTEM "modules/xml.xml"> -<!ENTITY performance SYSTEM "modules/performance.xml"> -<!ENTITY toolset-guide SYSTEM "modules/toolset_guide.xml"> -<!ENTITY example-parentchild SYSTEM "modules/example_parentchild.xml"> -<!ENTITY example-weblog SYSTEM "modules/example_weblog.xml"> -<!ENTITY example-mappings SYSTEM "modules/example_mappings.xml"> -<!ENTITY best-practices SYSTEM "modules/best_practices.xml"> -]> - -<book lang="es"> - - <bookinfo> - <title>HIBERNATE - Persistencia Relacional para Java Idiomático</title> - <subtitle>Documentación de Referencia de Hibernate</subtitle> - <releaseinfo>3.0.5</releaseinfo> - </bookinfo> - - <toc/> - - <preface id="preface" revision="2"> - <title>Prefacio</title> - - <para> - Advertencia! Esta es una versión traducida del inglés de - la documentacién de referencia de Hibernate. La versión - traducida puede no estar actualizada! Sin embargo, las diferencias - deberían ser sólo menores. Consulta la documentación - de referencia en inglés si estás perdiendo información - o encuentras algún error de traducción. Si quieres colaborar con - una traducción en particular, contáctanos en la lista de correo - de desarrolladores de Hibernate. - </para> - - <para> - Traductor(es): Bernardo Antonio Buffa Colomé <kreimer(a)bbs.frc.utn.edu.ar> - - </para> - - <para> - Trabajar con software orientado a objetos y una base de datos relacional puede ser - incómodo y consumir tiempo en los entornos de empresa de hoy. Hibernate es una - herramienta de mapeo objeto/relacional para entornos Java. El término mapeo - objeto/relacional (MOR) hace referencia a la técnica de mapear una - representación de datos desde un modelo de objetos a un modelo de datos relacional - con un esquema basado en SQL. - </para> - - <para> - Hibernate no sólo se encarga de mapear de clases Java a tablas de base de datos - (y de tipos de datos de Java a tipos de datos SQL), sino que también provee - facilidades de consulta y recuperación de datos y puede reducir significativamente - el tiempo de desarrollo que de otra forma se gasta en el manejo de los datos en SQL y JDBC. - </para> - - <para> - La meta de Hibernate es relevar al desarrollador del 95 por ciento de las tareas comunes - relacionadas a la programación de la persistencia de los datos. - Hibernate puede no ser la mejor solución para aplicaciones que usan solamente - procedimientos almacenados para implementar la lógica de negocio en la base de - datos, es mas útil con modelos de dominio orientados a objetos y lógica de - negocio en middle-tier basada en Java. Sin embargo, Hibernate ciertamente puede ayudarte - a quitar o encapsular código SQL específico de vendedor y ayudará - con la tarea común de traducción de resultados desde una representación - tabular a un grafo de objetos. - </para> - - <para> - Si eres nuevo en Hibernate y lo del Mapeo Objeto/Relacional o incluso en Java, - sigue por favor estos pasos: - </para> - - <orderedlist> - <listitem> - <para> - Lee <xref linkend="quickstart"/> para un tutorial de 30 minutos, usando Tomcat. - </para> - </listitem> - <listitem> - <para> - Lee <xref linkend="architecture"/> para entender los entornos en los que - puede ser usado Hibernate. - </para> - </listitem> - <listitem> - <para> - Dale una mirada al directorio <literal>eg/</literal> en la distribución - de Hibernate, contiene una aplicación independiente simple. - Copia tu driver JDBC al directorio <literal>lib/</literal> y edita - <literal>etc/hibernate.properties</literal>, especificando los valores - correctos para tu base de datos. Desde línea de comandos en el - directorio de la distribución, tipea <literal>ant eg</literal> - (usando Ant), o bajo Windows, tipea <literal>build eg</literal>. - </para> - </listitem> - <listitem> - <para> - Usa esta documentación de referencia como tu fuente de información - primaria. Ten en consideración leer <emphasis>Java Persistence with Hibernate</emphasis> - (http://www.manning.com/bauer2) si necesitas mas ayuda con el diseño - de aplicaciones o si prefieres un tutorial paso a paso. - Visita también http://caveatemptor.hibernate.org y descarga la aplicación - de ejemplo para Java Persistence with Hibernate. - </para> - </listitem> - <listitem> - <para> - Los FAQs son respondidos en el sitio web de Hibernate. - </para> - </listitem> - <listitem> - <para> - En el sitio web de Hibernate hay enlaces a demos de terceros, ejemplos - y tutoriales. - </para> - </listitem> - <listitem> - <para> - El Area de Comunidad en el sitio web de Hibernate es una buena fuente - de patrones de diseño y varias soluciones de integración - (Tomcat, JBoss, Struts, EJB, etc.). - </para> - </listitem> - </orderedlist> - - <para> - Si tienes preguntas, usa el foro de usuarios enlazado en el sitio web de Hibernate. - También proveemos un sistema de seguimiento JIRA para reportes de defectos y - peticiones de nuevas características. - Si estas interesado en el desarrollo de Hibernate, únete a la lista de correo - de desarrolladores. Si estas interesado en traducir esta documentación a tu - lenguaje, contáctanos en la lista de correo de desarrolladores. - </para> - - <para> - A través de JBoss Inc. (see http://www.hibernate.org/SupportTraining/) hay - disponibilidad de soporte comercial de desarrollo, soporte de producción y - entrenamiento en Hibernate. - Hibernate es un proyecto de la suite de productos de código abierto - JBoss Professional. - </para> - - </preface> - - &quickstart; - &tutorial; - &architecture; - - &configuration; - - &persistent-classes; - - &basic-mapping; - &collection-mapping; - &association-mapping; - &component-mapping; - &inheritance-mapping; - - &session-api; - &transactions; - &events; - &batch; - - &query-hql; - &query-criteria; - &query-sql; - &filters; - &xml; - - &performance; - - &toolset-guide; - - &example-parentchild; - &example-weblog; - &example-mappings; - - &best-practices; - -</book> - Added: core/trunk/documentation/manual/es-ES/src/main/docbook/translators.xml =================================================================== --- core/trunk/documentation/manual/es-ES/src/main/docbook/translators.xml (rev 0) +++ core/trunk/documentation/manual/es-ES/src/main/docbook/translators.xml 2007-10-09 18:45:36 UTC (rev 14075) @@ -0,0 +1,10 @@ +<?xml version='1.0'?> + +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<authorgroup id="AuthorGroup"> + <othercredit class="translator"> + <othername><![CDATA[Bernardo Antonio Buffa Colom&#x00e9]]></othername> + <email>kreimer(a)bbs.frc.utn.edu.ar</email> + </othercredit> +</authorgroup> \ No newline at end of file

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14074 - in core/trunk/documentation/manual/fr-FR/src/main: docbook and 2 other directories.

by hibernate-commits＠lists.jboss.org

Author: steve.ebersole(a)jboss.com Date: 2007-10-09 14:28:36 -0400 (Tue, 09 Oct 2007) New Revision: 14074 Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/Hibernate_Reference.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/architecture.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/association_mapping.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/basic_mapping.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/batch.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/best_practices.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/collection_mapping.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/component_mapping.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/configuration.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/events.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_mappings.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_parentchild.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_weblog.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/filters.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/inheritance_mapping.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/performance.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/persistent_classes.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/preface.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_criteria.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_hql.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_sql.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/session_api.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/toolset_guide.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/transactions.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/tutorial.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/content/xml.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/images/ core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.zargo core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.zargo core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.zargo core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.svg core/trunk/documentation/manual/fr-FR/src/main/docbook/images/hibernate_logo_a.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.svg core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.png core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.svg core/trunk/documentation/manual/fr-FR/src/main/docbook/legal_notice.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/translators.xml Removed: core/trunk/documentation/manual/fr-FR/src/main/docbook/master.xml core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/ core/trunk/documentation/manual/fr-FR/src/main/resources/ Log: new docbook layout (prep for translations migration to PO) Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/Hibernate_Reference.xml =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/Hibernate_Reference.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/Hibernate_Reference.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,72 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY versionNumber "3.3.0.alpha1"> + <!ENTITY copyrightYear "2004"> + <!ENTITY copyrightHolder "Red Hat Middleware, LLC."> +]> + +<book> + + <bookinfo> + <title>HIBERNATE - Persistance relationnelle en Java standard</title> + <subtitle>Documentation de r�f�rence d'Hibernate</subtitle> + <releaseinfo>&versionNumber;</releaseinfo> + <productnumber>&versionNumber;</productnumber> + <issuenum>1</issuenum> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/hibernate_logo_a.png" align="center" /> + </imageobject> + <imageobject role="html"> + <imagedata fileref="images/hibernate_logo_a.png" depth="3cm" /> + </imageobject> + </mediaobject> + <copyright> + <year>&copyrightYear;</year> + <holder>&copyrightHolder;</holder> + </copyright> + <xi:include href="translators.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </bookinfo> + + <toc/> + + <xi:include href="content/preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/tutorial.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/persistent_classes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/basic_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/collection_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/association_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/component_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/inheritance_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/session_api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/transactions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/batch.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/query_hql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_criteria.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_sql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/filters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/xml.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/performance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/toolset_guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/example_parentchild.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_weblog.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_mappings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/best_practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</book> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/architecture.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/architecture.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/architecture.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/architecture.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,366 @@ +<?xml version="1.0" encoding="iso-8859-1"?> + +<chapter id="architecture"> + + <title>Architecture</title> + + <sect1 id="architecture-overview" revision="1"> + <title>G�n�ralit�s</title> + + <para> + Voici une vue (tr�s) haut niveau de l'architecture d'Hibernate : + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/overview.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/overview.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + Ce diagramme montre Hibernate utilisant une base de donn�es et des donn�es + de configuration pour fournir un service de persistance (et des objets + persistants) � l'application. + </para> + + <para> + Nous aimerions d�crire une vue plus d�taill�e de l'architecture. Malheureusement, + Hibernate est flexible et supporte diff�rentes approches. Nous allons en + montrer les deux extr�mes. L'architecture l�g�re laisse l'application fournir + ses propres connexions JDBC et g�rer ses propres transactions. Cette approche + utilise le minimum des APIs Hibernate : + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/lite.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/lite.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + L'architecture la plus compl�te abstrait l'application des APIs JDBC/JTA + sous-jacentes et laisse Hibernate s'occuper des d�tails. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/full_cream.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/full_cream.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + Voici quelques d�finitions des objets des diagrammes : + + <variablelist spacing="compact"> + <varlistentry> + <term>SessionFactory (<literal>org.hibernate.SessionFactory</literal>)</term> + <listitem> + <para> + Un cache threadsafe (immuable) des mappings vers une (et une seule) base + de donn�es. Une factory (fabrique) de <literal>Session</literal> et un client + de <literal>ConnectionProvider</literal>. Peut contenir un cache optionnel de + donn�es (de second niveau) qui est r�utilisable entre les diff�rentes transactions + que cela soit au sein du m�me processus (JVLM) ou par plusieurs n�uds d'un cluster. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Session (<literal>org.hibernate.Session</literal>)</term> + <listitem> + <para> + Un objet mono-thread�, � dur�e de vie courte, qui repr�sente une conversation + entre l'application et l'entrep�t de persistance. Encapsule une connexion JDBC. + Factory (fabrique) des objets <literal>Transaction</literal>. Contient un cache + (de premier niveau) des objets persistants, ce cache est obligatoire. Il est + utilis� lors de la navigation dans le graphe d'objets ou lors de la r�cup�ration + d'objets par leur identifiant. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Objets et Collections persistants</term> + <listitem> + <para> + Objets mono-thread�s � vie courte contenant l'�tat de persistance + et la fonction m�tier. Ceux-ci sont en g�n�ral les objets de type JavaBean + (ou POJOs) ; la seule particularit� est qu'ils sont associ�s avec une (et + une seule) <literal>Session</literal>. D�s que la <literal>Session</literal> + est ferm�e, ils seront d�tach�s et libres d'�tre utilis�s par n'importe laquelle + des couches de l'application (ie. de et vers la pr�sentation en tant que Data + Transfer Objects - DTO : objet de transfert de donn�es). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Objets et collections transients</term> + <listitem> + <para> + Instances de classes persistantes qui ne sont actuellement pas associ�es � + une <literal>Session</literal>. Elles ont pu �tre instanci�es par l'application + et ne pas avoir (encore) �t� persist�es ou elle ont pu �tre instanci�es par + une <literal>Session</literal> ferm�e. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Transaction (<literal>org.hibernate.Transaction</literal>)</term> + <listitem> + <para> + (Optionnel) Un objet mono-thread� � vie courte utilis� par l'application + pour d�finir une unit� de travail atomique. Abstrait l'application des + transactions sous-jacentes qu'elles soient JDBC, JTA ou CORBA. Une + <literal>Session</literal> peut fournir plusieurs <literal>Transaction</literal>s + dans certains cas. Toutefois, la d�limitation des transactions, via l'API d'Hibernate + ou par la <literal>Transaction</literal> sous-jacente, n'est jamais optionnelle! + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ConnectionProvider (<literal>org.hibernate.connection.ConnectionProvider</literal>)</term> + <listitem> + <para> + (Optionnel) Une fabrique de (pool de) connexions JDBC. Abstrait l'application + de la <literal>Datasource</literal> ou du <literal>DriverManager</literal> sous-jacent. + Non expos� � l'application, mais peut �tre �tendu/impl�ment� par le d�veloppeur. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>TransactionFactory (<literal>org.hibernate.TransactionFactory</literal>)</term> + <listitem> + <para> + (Optionnel) Une fabrique d'instances de <literal>Transaction</literal>. Non + expos� � l'application, mais peut �tre �tendu/impl�ment� par le d�veloppeur. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Interfaces d'extension</emphasis></term> + <listitem> + <para> + Hibernate fournit de nombreuses interfaces d'extensions optionnelles que + vous pouvez impl�menter pour personnaliser le comportement de votre couche de persistance. + Reportez vous � la documentation de l'API pour plus de d�tails. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + Dans une architecture l�g�re, l'application n'aura pas � utiliser les APIs + <literal>Transaction</literal>/<literal>TransactionFactory</literal> + et/ou n'utilisera pas les APIs <literal>ConnectionProvider</literal> + pour utiliser JTA ou JDBC. + </para> + </sect1> + + <sect1 id="architecture-states" revision="1"> + <title>Etats des instances</title> + <para> + Une instance d'une classe persistante peut �tre dans l'un des trois �tats suivants, + d�finis par rapport � un <emphasis>contexte de persistance</emphasis>. + L'objet <literal>Session</literal> d'hibernate correspond � ce concept de + contexte de persistance : + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>passager (transient)</term> + <listitem> + <para> + L'instance n'est pas et n'a jamais �t� associ�e � un contexte + de persistance. Elle ne poss�de pas d'identit� persistante (valeur de cl� primaire) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>persistant</term> + <listitem> + <para> + L'instance est associ�e au contexte de persistance. + Elle poss�de une identit� persistante (valeur de cl� primaire) + et, peut-�tre, un enregistrement correspondant dans la base. + Pour un contexte de persistance particulier, Hibernate + <emphasis>garantit</emphasis> que l'identit� persistante + est �quivalente � l'identit� Java (emplacement m�moire de l'objet) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>d�tach�</term> + <listitem> + <para> + L'instance a �t� associ�e au contexte de persistance mais ce + contexte a �t� ferm�, ou l'instance a �t� s�rialis�e vers un + autre processus. Elle poss�de une identit� persistante et + peut-�tre un enregistrement correspondant dans la base. + Pour des instances d�tach�es, Hibernate ne donne aucune + garantie sur la relation entre l'identit� persistante et + l'identit� Java. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 id="architecture-jmx" revision="1"> + <title>Int�gration JMX</title> + <para> + JMX est le standard J2EE de gestion des composants Java. + Hibernate peut �tre g�r� via un service JMX standard. Nous fournissons une impl�mentation + d'un MBean dans la distribution : <literal>org.hibernate.jmx.HibernateService</literal>. + </para> + + <para> + Pour avoir un exemple sur la mani�re de d�ployer Hibernate en tant que service JMX dans le + serveur d'application JBoss Application Server, r�f�rez vous au guide utilisateur JBoss (JBoss User Guide). + Si vous d�ployez Hibernate via JMX sur JBoss AS, vous aurez �galement les b�n�fices suivants : + </para> + <itemizedlist> + <listitem> + <para> + <emphasis>Gestion de la session :</emphasis> Le cycle de vie de la <literal>Session</literal> + Hibernate peut �tre automatiquement limit�e � la port�e d'une transaction JTA. + Cela signifie que vous n'avez plus besoin d'ouvrir et de fermer la <literal>Session</literal> + manuellement, cela devient le travail de l'intercepteur EJB de JBoss. Vous n'avez + pas non plus � vous occuper des d�marcations des transactions dans votre code (sauf + si vous voulez �crire une couche de persistance qui soit portable, dans ce cas vous + pouvez utiliser l'API optionnelle <literal>Transaction</literal> d'Hibernate). + Vous appelez l'<literal>HibernateContext</literal> pour acc�der � la <literal>Session</literal>. + </para> + </listitem> + <listitem> + <para> + <emphasis>D�ploiement HAR :</emphasis> Habituellement vous d�ployez le service JMX + Hibernate en utilisant le descripteur de d�ploiement de JBoss (dans un fichier EAR et/ou un SAR), + il supporte toutes les options de configuration usuelles d'une <literal>SessionFactory</literal> + Hibernate. Cependant, vous devez toujours nommer tous vos fichiers de mapping dans le + descripteur de d�ploiement. Si vous d�cidez d'utiliser le d�ploiement optionnel sous forme + de HAR, JBoss d�tectera automatiquement tous vos fichiers de mapping dans votre fichier HAR. + </para> + </listitem> + </itemizedlist> + + <para> + Consultez le guide d'utilisation de JBoss AS pour plus d'informations sur ces options. + </para> + + <para> + Les statistiques pendant l'ex�cution d'Hibernate (au runtime) sont une + autre fonctionnalit� disponible en tant que service JMX. Voyez pour cela + <xref linkend="configuration-optional-statistics"/>. + </para> + </sect1> + + <sect1 id="architecture-jca" revision="1"> + <title>Support JCA</title> + <para> + Hibernate peut aussi �tre configur� en tant que connecteur JCA. R�f�rez-vous au site + web pour de plus amples d�tails. Il est important de noter que le support JCA d'Hibernate + est encore consid�r� comme exp�rimental. + </para> + </sect1> + + <sect1 id="architecture-current-session" revision="1"> + <title>Sessions Contextuelles</title> + <para> + Certaines applications utilisant Hibernate ont besoin d'une sorte de session "contextuelle", o� + une session est li�e � la port�e d'un contexte particulier. Cependant, les applications ne d�finissent + pas toutes la notion de contexte de la m�me mani�re, et diff�rents contextes d�finissent diff�rentes + port�es � la notion de "courant". Les applications � base d'Hibernate, versions pr�c�dentes � la 3.0 + utilisaient g�n�ralement un principe maison de sessions contextuelles bas�es sur le <literal>ThreadLocal</literal>, + ainsi que sur des classes utilitaires comme <literal>HibernateUtil</literal>, ou utilisaient des + framework tiers (comme Spring ou Pico) qui fournissaient des sessions contextuelles bas�es sur + l'utilisation de proxy/interception. + </para> + <para> + A partir de la version 3.0.1, Hibernate a ajout� la m�thode <literal>SessionFactory.getCurrentSession()</literal>. + Initialement, cela demandait l'usage de transactions <literal>JTA</literal>, o� la + transaction <literal>JTA</literal> d�finissait la port�e et le contexte de la session courante. + L'�quipe Hibernate pense que, �tant donn�e la maturit� des impl�mentations de <literal>JTA TransactionManager</literal> , + la plupart (sinon toutes) des applications devraient utiliser la gestion des transactions par <literal>JTA</literal> + qu'elles soient ou non d�ploy�es dans un conteneur <literal>J2EE</literal>. Par cons�quent, + vous devriez toujours contextualiser vos sessions, si vous en avez besoin, via la m�thode bas�e sur JTA. + </para> + <para> + Cependant, depuis la version 3.1, la logique derri�re + <literal>SessionFactory.getCurrentSession()</literal> est d�sormais branchable. + A cette fin, une nouvelle interface d'extension (<literal>org.hibernate.context.CurrentSessionContext</literal>) + et un nouveau param�tre de configuration (<literal>hibernate.current_session_context_class</literal>) + ont �t� ajout�s pour permettre de configurer d'autres moyens de d�finir la port�e et le contexte des + sessions courantes. + </para> + <para> + Allez voir les Javadocs de l'interface <literal>org.hibernate.context.CurrentSessionContext</literal> + pour une description d�taill�e de son contrat. Elle d�finit une seule m�thode, + <literal>currentSession()</literal>, depuis laquelle l'impl�mentation est responsable + de traquer la session courante du contexte. Hibernate fournit deux impl�mentation + de cette interface. + </para> + + <itemizedlist> + <listitem> + <para> + <literal>org.hibernate.context.JTASessionContext</literal> - les sessions courantes sont + associ�es � une transaction <literal>JTA</literal>. La logique est la m�me que + l'ancienne approche bas�e sur JTA. Voir les javadocs pour les d�tails. + </para> + </listitem> + <listitem> + <para> + <literal>org.hibernate.context.ThreadLocalSessionContext</literal> - les sessions + courantes sont associ�es au thread d'ex�cution. Voir les javadocs pour les d�tails. + </para> + </listitem> + </itemizedlist> + + <para> + Les deux impl�mentations fournissent un mod�le de programmation de type "une session - une transaction + � la base de donn�es", aussi connu sous le nom de <emphasis>session-per-request</emphasis>. + Le d�but et la fin d'une session Hibernate sont d�finis par la dur�e d'une transaction de base de donn�es. + Si vous utilisez une d�marcation programmatique de la transaction (par exemple sous J2SE ou JTA/UserTransaction/BMT), + nous vous conseillons d'utiliser l'API Hibernate <literal>Transaction</literal> pour masquer le syst�me + de transaction utilis�. Si vous ex�cutez sous un conteneur EJB qui supporte CMT, vous n'avez besoin d'aucune + op�rations de d�marcations de session ou transaction dans votre code puisque tout + est g�r� de mani�re d�clarative. R�f�rez vous � <xref linkend="transactions"/> pour plus d'informations + et des exemples de code. + </para> + + <para> + Le param�tre de configuration <literal>hibernate.current_session_context_class</literal> + d�finit quelle impl�mentation de <literal>org.hibernate.context.CurrentSessionContext</literal> + doit �tre utilis�e. Notez que pour assurer la compatibilit� avec les versions pr�c�dentes, si + ce param�tre n'est pas d�fini mais qu'un <literal>org.hibernate.transaction.TransactionManagerLookup</literal> + est configur�, Hibernate utilisera le <literal>org.hibernate.context.JTASessionContext</literal>. + La valeur de ce param�tre devrait juste nommer la classe d'impl�mentation � utiliser, + pour les deux impl�mentations fournies, il y a cependant deux alias correspondant: "jta" et "thread". + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/association_mapping.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/association_mapping.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/association_mapping.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/association_mapping.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,623 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="associations"> + + <title>Mapper les associations</title> + + <sect1 id="assoc-intro" revision="1"> + <title>Introduction</title> + + <para> + Correctement mapper les associations est souvent la t�che la plus difficile. + Dans cette section nous traiterons les cas classiques les uns apr�s les autres. + Nous commencerons d'abbord par les mappings unidirectionnels, puis nous aborderons + la question des mappings bidirectionnels. Nous illustrerons tous nos exemples + avec les classes <literal>Person</literal> et <literal>Address</literal>. + </para> + + <para> + Nous utiliserons deux crit�res pour classer les associations : le premier + sera de savoir si l'association est b�ti sur une table suppl�mentaire d'association + et le deuxieme sera bas� sur la multiplicit� de cette association. + </para> + + <para> + Autoriser une cl� �trang�re nulle est consid�r� comme un mauvais choix dans + la construction d'un mod�le de donn�es. Nous supposerons donc que dans tous + les exemples qui vont suivre on aura interdit la valeur nulle pour les cl�s + �trang�res. Attention, ceci ne veut pas dire que Hibernate ne supporte pas + les cl�s �trang�res pouvant prendre des valeurs nulles, les exemples qui suivent + continueront de fonctionner si vous d�cidiez ne plus imposer la contrainte + de non-nullit� sur les cl�s �trang�res. + </para> + + </sect1> + + <sect1 id="assoc-unidirectional" revision="1"> + <title>Association unidirectionnelle</title> + + <sect2 id="assoc-unidirectional-m21" > + <title>plusieurs � un</title> + + <para> + Une <emphasis>association plusieurs-�-un (many-to-one) unidirectionnelle </emphasis> + est le type que l'on rencontre le plus souvent dans les associations unidirectionnelles. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + + </sect2> + + <sect2 id="assoc-unidirectional-121"> + <title>un � un</title> + + <para> + une <emphasis>association un-�-un (one-to-one) sur une cl� �trang�re</emphasis> + est presque identique. La seule diff�rence est sur la contrainte d'unicit� que + l'on impose � cette colonne. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + Une <emphasis>association un-�-un (one-to-one) unidirectionnelle sur une cl� primaire</emphasis> + utilise un g�n�rateur d'identifiant particulier. (Remarquez que nous avons invers� le sens de cette + association dans cet exemple.) + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-12m"> + <title>un � plusieurs</title> + + <para> + Une <emphasis>association un-�-plusieurs (one-to-many) unidirectionnelle sur une + cl� �trang�re</emphasis> est vraiment inhabituelle, et n'est pas vraiment recommand�e. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses"> + <key column="personId" + not-null="true"/> + <one-to-many class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( addressId bigint not null primary key, personId bigint not null ) + ]]></programlisting> + + <para> + Nous pensons qu'il est pr�f�rable d'utiliser une table de jointure pour ce type d'association. + </para> + + </sect2> + + </sect1> + + <sect1 id="assoc-unidirectional-join" revision="1"> + <title>Associations unidirectionnelles avec tables de jointure</title> + + <sect2 id="assoc-unidirectional-join-12m"> + <title>un � plusieurs</title> + + <para> + Une <emphasis>association unidirectionnelle un-�-plusieurs (one-to-many) avec + une table de jointure</emphasis> est un bien meilleur choix. + Remarquez qu'en sp�cifiant <literal>unique="true"</literal>, + on a chang� la multiplicit� plusieurs-�-plusieurs (many-to-many) pour + un-�-plusieurs (one-to-many). + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m21"> + <title>plusieurs � un</title> + + <para> + Une <emphasis>assiociation plusieurs-�-un (many-to-one) unidirectionnelle sur + une table de jointure</emphasis> est tr�s fr�quente quand l'association est optionnelle. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-121"> + <title>un � un</title> + + <para> + Une <emphasis>association unidirectionnelle un-�-un (one-to-one) sur une table + de jointure</emphasis> est extr�mement rare mais envisageable. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m2m"> + <title>plusieurs � plusieurs</title> + + <para> + Finallement, nous avons <emphasis>l'association unidirectionnelle plusieurs-�-plusieurs (many-to-many)</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional" revision="1"> + <title>Associations bidirectionnelles</title> + + <sect2 id="assoc-bidirectional-m21" revision="2"> + <title>un � plusieurs / plusieurs � un</title> + + <para> + Une <emphasis>association bidirectionnelle plusieurs � un (many-to-one)</emphasis> + est le type d'association que l'on rencontre le plus souvent. (c'est la fa�on standard de cr�er + des relations parents/enfants.) + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true"> + <key column="addressId"/> + <one-to-many class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + Si vous utilisez une <literal>List</literal> (ou toute autre collection index�e) vous devez + param�trer la colonne <literal>key</literal> de la cl� �trang�re � <literal>not null</literal>, + et laisser Hibernate g�rer l'association depuis l'extr�mit� collection pour maintenir l'index + de chaque �l�ment (rendant l'autre extr�mit� virtuellement inverse en param�trant + <literal>update="false"</literal> et <literal>insert="false"</literal>): + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"/> + ... + <many-to-one name="address" + column="addressId" + not-null="true" + insert="false" + update="false"/> +</class> + +<class name="Address"> + <id name="id"/> + ... + <list name="people"> + <key column="addressId" not-null="true"/> + <list-index column="peopleIdx"/> + <one-to-many class="Person"/> + </list> +</class>]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-121"> + <title>Un � un</title> + + <para> + Une <emphasis>association bidirectionnelle un � un (one-to-one) sur une cl� �trang�re</emphasis> + est aussi tr�s fr�quente. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <one-to-one name="person" + property-ref="address"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + Une <emphasis>association bidirectionnelle un-�-un (one-to-one) sur une cl� primaire</emphasis> + utilise un g�n�rateur particulier d'id. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <one-to-one name="address"/> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" + constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional-join" revision="1"> + <title>Associations bidirectionnelles avec table de jointure</title> + + <sect2 id="assoc-bidirectional-join-12m"> + <title>un � plusieurs / plusieurs � un</title> + + <para> + Une <emphasis>association bidirectionnelle un-�-plusieurs (one-to-many) sur une table de jointure </emphasis>. + Remarquez que <literal>inverse="true"</literal> peut s'appliquer sur les deux extr�mit�s de l' + association, sur la collection, ou sur la jointure. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" + table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + inverse="true" + optional="true"> + <key column="addressId"/> + <many-to-one name="person" + column="personId" + not-null="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-121"> + <title>Un � un</title> + + <para> + Une <emphasis>association bidirectionnelle un-�-un (one-to-one) sur une table de jointure</emphasis> + est extr�mement rare mais envisageable. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true" + inverse="true"> + <key column="addressId" + unique="true"/> + <many-to-one name="person" + column="personId" + not-null="true" + unique="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-m2m" revision="1"> + <title>plusieurs � plusieurs</title> + + <para> + Finallement nous avons <emphasis>l'association bidirectionnelle plusieurs � plusieurs</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true" table="PersonAddress"> + <key column="addressId"/> + <many-to-many column="personId" + class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-complex"> + <title>Des mappings plus complexes</title> + + <para> + Des associations encore plus complexes sont <emphasis>extr�mement</emphasis> rares. + Hibernate permet de g�rer des situations plus complexes en utilisant des + parties SQL dans les fichiers de mapping. Par exemple, si une table + avec l'historiques des informations d'un compte d�finit les colonnes + <literal>accountNumber</literal>, <literal>effectiveEndDate</literal> + et <literal>effectiveStartDate</literal>, mapp�es de telle sorte: + </para> + + <programlisting><![CDATA[<properties name="currentAccountKey"> + <property name="accountNumber" type="string" not-null="true"/> + <property name="currentAccount" type="boolean"> + <formula>case when effectiveEndDate is null then 1 else 0 end</formula> + </property> +</properties> +<property name="effectiveEndDate" type="date"/> +<property name="effectiveStateDate" type="date" not-null="true"/>]]></programlisting> + + <para> + alors nous pouvons mapper une association � l'instance <emphasis>courante</emphasis> + (celle avec une <literal>effectiveEndDate</literal>) nulle en utilisant: + </para> + + <programlisting><![CDATA[<many-to-one name="currentAccountInfo" + property-ref="currentAccountKey" + class="AccountInfo"> + <column name="accountNumber"/> + <formula>'1'</formula> +</many-to-one>]]></programlisting> + + <para> + Dans un exemple plus complexe, imaginez qu'une association entre + <literal>Employee</literal> et <literal>Organization</literal> est g�r�e + dans une table <literal>Employment</literal> pleines de donn�es historiques. + Dans ce cas, une association vers l'employeur <emphasis>le plus r�cent</emphasis> + (celui avec la <literal>startDate</literal> la plus r�cente) pourrait �tre mapp�e comme cela: + </para> + + <programlisting><![CDATA[<join> + <key column="employeeId"/> + <subselect> + select employeeId, orgId + from Employments + group by orgId + having startDate = max(startDate) + </subselect> + <many-to-one name="mostRecentEmployer" + class="Organization" + column="orgId"/> +</join>]]></programlisting> + + <para> + Vous pouvez �tre cr�atif grace � ces possibilit�s, mais il est g�n�ralement plus pratique + d'utiliser des requ�tes HQL ou criteria dans ce genre de situation. + </para> + + </sect1> + + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/basic_mapping.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/basic_mapping.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/basic_mapping.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/basic_mapping.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,3117 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<chapter id="mapping"> + <title>Mapping O/R basique</title> + <sect1 id="mapping-declaration" revision="1"> + <title>D�claration de Mapping</title> + <para> + Les mappings Objet/relationnel sont g�n�ralement d�finis dans un document XML. + Le document de mapping est con�u pour �tre lisible et �ditable � la main. + Le langage de mapping est Java-centrique, c'est � dire que les mappings sont construits + � partir des d�clarations des classes persistantes et non des d�clarations des tables. + </para> + <para> + Remarquez que m�me si beaucoup d'utilisateurs de Hibernate pr�f�rent �crire les + fichiers de mappings � la main, plusieurs outils existent pour g�n�rer ce document, + notamment XDoclet, Middlegen et AndroMDA. + </para> + <para>D�marrons avec un exemple de mapping :</para> + <programlisting id="mapping-declaration-ex1" revision="1"><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" + table="cats" + discriminator-value="C"> + + <id name="id"> + <generator class="native"/> + </id> + + <discriminator column="subclass" + type="character"/> + + <property name="weight"/> + + <property name="birthdate" + type="date" + not-null="true" + update="false"/> + + <property name="color" + type="eg.types.ColorUserType" + not-null="true" + update="false"/> + + <property name="sex" + not-null="true" + update="false"/> + + <property name="litterId" + column="litterId" + update="false"/> + + <many-to-one name="mother" + column="mother_id" + update="false"/> + + <set name="kittens" + inverse="true" + order-by="litter_id"> + <key column="mother_id"/> + <one-to-many class="Cat"/> + </set> + + <subclass name="DomesticCat" + discriminator-value="D"> + + <property name="name" + type="string"/> + + </subclass> + + </class> + + <class name="Dog"> +  + </class> + +</hibernate-mapping>]]></programlisting> + <para> + Etudions le contenu du document de mapping. Nous d�crirons uniquement + les �l�ments et attributs du document utilis�s par Hibernate � l'ex�cution. + Le document de mapping contient aussi des attributs et �l�ments optionnels + qui agissent sur le sch�ma de base de donn�es export� par l'outil de + g�n�ration de sch�ma. (Par exemple l'attribut <literal>not-null</literal>.) + </para> + <sect2 id="mapping-declaration-doctype" revision="2"> + <title>Doctype</title> + <para> + Tous les mappings XML devraient utiliser le doctype indiqu�. + Ce fichier est pr�sent � l'URL ci-dessus, dans le r�pertoire + <literal>hibernate-x.x.x/src/org/hibernate</literal> ou dans <literal>hibernate3.jar</literal>. + Hibernate va toujours chercher la DTD dans son classpath en premier lieu. Si vous constatez + des recherches de la DTD sur Internet, v�rifiez votre d�claration de DTD par rapport + au contenu de votre classpath. + </para> + </sect2> + <sect2 id="mapping-declaration-mapping" revision="3"> + <title>hibernate-mapping</title> + <para> + Cet �l�ment a plusieurs attributs optionnels. Les attributs <literal>schema</literal> et <literal>catalog</literal> + indiquent que les tables r�f�renc�es par ce mapping appartiennent au sch�ma nomm� et/ou au catalogue. + S'ils sont sp�cifi�s, les noms de tables seront qualifi�s par les noms de sch�ma et catalogue. + L'attribut <literal>default-cascade</literal> indique quel type de cascade sera utlis� par d�faut + pour les propri�t�s et collections qui ne pr�cisent pas l'attribut <literal>cascade</literal>. + L'attribut <literal>auto-import</literal> nous permet d'utiliser par d�faut des noms de classes + non qualifi�s dans le langage de requ�te. + </para> + <programlistingco> + <areaspec> + <area id="hm1" coords="2 55"/> + <area id="hm2" coords="3 55"/> + <area id="hm3" coords="4 55"/> + <area id="hm4" coords="5 55"/> + <area id="hm5" coords="6 55"/> + <area id="hm6" coords="7 55"/> + <area id="hm7" coords="8 55"/> + </areaspec> + <programlisting><![CDATA[<hibernate-mapping + schema="schemaName" + catalog="catalogName" + default-cascade="cascade_style" + default-access="field|property|ClassName" + default-lazy="true|false" + auto-import="true|false" + package="package.name" + />]]></programlisting> + <calloutlist> + <callout arearefs="hm1"> + <para> + <literal>schema</literal> (optionnel) : Le nom d'un sch�ma de base de donn�es. + </para> + </callout> + <callout arearefs="hm2"> + <para> + <literal>catalog</literal> (optionnel) : Le nom d'un catalogue de base de donn�es. + </para> + </callout> + <callout arearefs="hm3"> + <para> + <literal>default-cascade</literal> (optionnel - par d�faut vaut : <literal>none</literal>) : + Un type de cascade par d�faut. + </para> + </callout> + <callout arearefs="hm4"> + <para> + <literal>default-access</literal> (optionnel - par d�faut vaut : <literal>property</literal>) : + Comment hibernate acc�dera aux propri�t�s. On peut aussi + red�finir sa propre impl�mentation de <literal>PropertyAccessor</literal>. + </para> + </callout> + <callout arearefs="hm5"> + <para> + <literal>default-lazy</literal> (optionnel - par d�faut vaut : <literal>true</literal>) : + Valeur par d�faut pour un attribut <literal>lazy</literal> + non sp�cifi� : celui des mappings de classes et de collection. + </para> + </callout> + <callout arearefs="hm6"> + <para> + <literal>auto-import</literal> (optionnel - par d�faut vaut : <literal>true</literal>) : + Sp�cifie si l'on peut utiliser des noms de classes + non qualifi�s (des classes de ce mapping) dans le langage de requ�te. + </para> + </callout> + <callout arearefs="hm7"> + <para> + <literal>package</literal> (optionnel) : Pr�fixe de package par d�faut pour + les noms de classe non qualifi�s du document de mapping. + + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Si deux classes poss�dent le m�me nom de classe (non qualifi�), vous devez indiquer + <literal>auto-import="false"</literal>. Hibernate lancera une exception + si vous essayez d'assigner � deux classes le m�me nom import�. + </para> + <para> + Notez que l'�l�ment <literal>hibernate-mapping</literal> vous permet d'imbriquer plusieurs mappings de + <literal><class></literal> persistantes, comme dans l'exemple ci-dessus. + Cependant la bonne pratique (ce qui est attendu par certains outils) est + de mapper une seule classe (ou une seule hi�rarchie de classes) + par fichier de mapping et de nommer ce fichier d'apr�s le nom de la superclasse, par exemple + <literal>Cat.hbm.xml</literal>, <literal>Dog.hbm.xml</literal>, ou en cas d'h�ritage, + <literal>Animal.hbm.xml</literal>. + </para> + </sect2> + <sect2 id="mapping-declaration-class" revision="3"> + <title>class</title> + <para> + D�clarez une classe persistante avec l'�l�ment <literal>class</literal> : + </para> + <programlistingco> + <areaspec> + <area id="class1" coords="2 55"/> + <area id="class2" coords="3 55"/> + <area id="class3" coords="4 55"/> + <area id="class4" coords="5 55"/> + <area id="class5" coords="6 55"/> + <area id="class6" coords="7 55"/> + <area id="class7" coords="8 55"/> + <area id="class8" coords="9 55"/> + <area id="class9" coords="10 55"/> + <area id="class10" coords="11 55"/> + <area id="class11" coords="12 55"/> + <area id="class12" coords="13 55"/> + <area id="class13" coords="14 55"/> + <area id="class14" coords="15 55"/> + <area id="class15" coords="16 55"/> + <area id="class16" coords="17 55"/> + <area id="class17" coords="18 55"/> + <area id="class18" coords="19 55"/> + <area id="class19" coords="20 55"/> + <area id="class20" coords="21 55"/> + <area id="class21" coords="22 55"/> + </areaspec> + <programlisting><![CDATA[<class + name="ClassName" + table="tableName" + discriminator-value="discriminator_value" + mutable="true|false" + schema="owner" + catalog="catalog" + proxy="ProxyInterface" + dynamic-update="true|false" + dynamic-insert="true|false" + select-before-update="true|false" + polymorphism="implicit|explicit" + where="arbitrary sql where condition" + persister="PersisterClass" + batch-size="N" + optimistic-lock="none|version|dirty|all" + lazy="true|false" + entity-name="EntityName" + catalog="catalog" + check="arbitrary sql check condition" + rowid="rowid" + subselect="SQL expression" + abstract="true|false" + entity-name="EntityName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="class1"> + <para> + <literal>name</literal> (optionnel) : Le nom Java complet de la classe (ou interface) persistante. + Si cet attribut est absent, il est suppos� que ce mapping ne se rapporte pas � une entit� POJO. + </para> + </callout> + <callout arearefs="class2"> + <para> + <literal>table</literal> (optionnel - par d�faut le nom (non-qualifi�) de la classe) : Le + nom de sa table en base de donn�es. + </para> + </callout> + <callout arearefs="class3"> + <para> + <literal>discriminator-value</literal> (optionnel - par d�faut le nom de la classe) : + Une valeur permettant de distinguer les sous-classes dans le cas de l'utilisation du polymorphisme. + Les valeurs <literal>null</literal> et <literal>not null</literal> sont autoris�es. + </para> + </callout> + <callout arearefs="class4"> + <para> + <literal>mutable</literal> (optionnel, vaut <literal>true</literal> par d�faut) : Sp�cifie + que des instances de la classe sont (ou non) immuables. + </para> + </callout> + <callout arearefs="class5"> + <para> + <literal>schema</literal> (optionnel) : Surcharge le nom de sch�ma sp�cifi� par + l'�l�ment racine <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="class6"> + <para> + <literal>catalog</literal> (optionnel) : Surcharge le nom du catalogue sp�cifi� par + l'�l�ment racine <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="class7"> + <para> + <literal>proxy</literal> (optionnel) : Sp�cifie une interface � utiliser pour l'initialisation diff�r�e (lazy loading) + des proxies. Vous pouvez indiquer le nom de la classe elle-m�me. + </para> + </callout> + <callout arearefs="class8"> + <para> + <literal>dynamic-update</literal> (optionnel, par d�faut � <literal>false</literal>) : + Sp�cifie que les <literal>UPDATE</literal> SQL doivent �tre g�n�r�s � l'ex�cution et contenir + uniquement les colonnes dont les valeurs ont �t� modifi�es. + </para> + </callout> + <callout arearefs="class9"> + <para> + <literal>dynamic-insert</literal> (optionnel, par d�faut � <literal>false</literal>): + Sp�cifie que les <literal>INSERT</literal> SQL doivent �tre g�n�r�s � l'ex�cution et ne contenir + que les colonnes dont les valeurs sont non nulles. + </para> + </callout> + <callout arearefs="class10"> + <para> + <literal>select-before-update</literal> (optionnel, par d�faut � <literal>false</literal>): + Sp�cifie que Hibernate ne doit <emphasis>jamais</emphasis> ex�cuter un <literal>UPDATE</literal> SQL + sans �tre certain qu'un objet a �t� r�ellement modifi�. Dans certains cas, (en r�alit�, seulement + quand un objet transient a �t� associ� � une nouvelle session par <literal>update()</literal>), + cela signifie que Hibernate ex�cutera un <literal>SELECT</literal> SQL pour s'assurer qu'un + <literal>UPDATE</literal> SQL est v�ritablement n�cessaire. + </para> + </callout> + <callout arearefs="class11"> + <para> + <literal>polymorphism</literal> (optionnel, vaut <literal>implicit</literal> par d�faut) : + D�termine si, pour cette classe, une requ�te polymorphique implicite ou explicite est utilis�e. + </para> + </callout> + <callout arearefs="class12"> + <para> + <literal>where</literal> (optionnel) sp�cifie une clause SQL <literal>WHERE</literal> + � utiliser lorsque l'on r�cup�re des objets de cette classe. + </para> + </callout> + <callout arearefs="class13"> + <para> + <literal>persister</literal> (optionnel) : Sp�cifie un <literal>ClassPersister</literal> particulier. + </para> + </callout> + <callout arearefs="class14"> + <para> + <literal>batch-size</literal> (optionnel, par d�faut = <literal>1</literal>) : sp�cifie une taille de batch + pour remplir les instances de cette classe par identifiant en une seule requ�te. + </para> + </callout> + <callout arearefs="class15"> + <para> + <literal>optimistic-lock</literal> (optionnel, par d�faut = <literal>version</literal>) : + D�termine la strat�gie de verrou optimiste. + </para> + </callout> + <callout arearefs="class16"> + <para> + <literal>lazy</literal> (optionnel) : D�clarer <literal>lazy="true"</literal> est un raccourci + pour sp�cifier le nom de la classe comme �tant l'interface <literal>proxy</literal>. + </para> + </callout> + <callout arearefs="class17"> + <para> + <literal>entity-name</literal> (optionnel) : Hibernate3 permet � une classe d'�tre + mapp�e plusieurs fois (potentiellement � plusieurs tables), et permet aux mappings d'entit� d'�tre + repr�sent�s par des Maps ou du XML au niveau Java. Dans ces cas, vous devez indiquer un nom explicite arbitraire pour + les entit�s. Voir <xref linkend="persistent-classes-dynamicmodels"/> et <xref linkend="xml"/> + pour plus d'informations. + </para> + </callout> + <callout arearefs="class18"> + <para> + <literal>catalog</literal> (optionnel) : The name of a database catalog used for this + class and its table. + </para> + </callout> + <callout arearefs="class19"> + <para> + <literal>check</literal> (optionnel) : expression SQL utilis�e pour g�n�rer une contrainte + de v�rification multi-lignes pour la g�n�ration automatique de sch�ma. + </para> + </callout> + <callout arearefs="class20"> + <para> + <literal>rowid</literal> (optionnel) : Hibernate peut utiliser des ROWID sur les bases de + donn�es qui utilisent ce m�canisme. Par exemple avec Oracle, Hibernate peut utiliser la colonne additionnelle + <literal>rowid</literal> pour des mises � jour rapides si cette option vaut <literal>rowid</literal>. Un ROWID repr�sente + la localisation physique d'un tuple enregistr�. + </para> + </callout> + <callout arearefs="class21"> + <para> + <literal>subselect</literal> (optionnel) : Permet de mapper une entit� immuable en lecture-seule + sur un sous-select de base de donn�es. Utile pour avoir une vue au lieu d'une table en base, mais � �viter. Voir plus bas + pour plus d'information. + </para> + </callout> + <callout arearefs="class22"> + <para> + <literal>abstract</literal> (optionnel) : Utilis� pour marquer des superclasses abstraites dans + des hi�rarchies de <literal><union-subclass></literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Il est tout � fait possible d'utiliser une interface comme nom + de classe persistante. Vous devez alors d�clarer les classes impl�mentant + cette interface en utilisant l'�l�ment <literal><subclass></literal>. + Vous pouvez faire persister toute classe interne <emphasis>static</emphasis>. + Vous devez alors sp�cifier le nom de la classe par la notation habituelle + des classes internes c'est � dire <literal>eg.Foo$Bar</literal>. + </para> + <para> + Les classes immuables, <literal>mutable="false"</literal>, ne peuvent + pas �tre modifi�es ou supprim�es par l'application. Cela permet + � Hibernate de faire quelques optimisations mineures sur les performances. + </para> + <para> + L'attribut optionnnel <literal>proxy</literal> permet les intialisations + diff�r�es des instances persistantes de la classe. Hibernate retournera + initialement des proxies CGLIB qui impl�mentent l'interface nomm�e. + Le v�ritable objet persistant ne sera charg� que lorsque une m�thode du proxy + sera appel�e. Voir plus bas le paragraphe abordant les proxies et le chargement diff�r� (lazy initialization). + </para> + <para> + Le polymorphisme <emphasis>implicite</emphasis> + signifie que les instances de la classe seront retourn�es par une + requ�te qui utilise les noms de la classe ou de chacune de ses + superclasses ou encore des interfaces impl�ment�es par cette classe + ou ses superclasses. Les instances des classes filles seront retourn�es + par une requ�te qui utilise le nom de la classe elle m�me. Le polymorphisme + <emphasis>explicite</emphasis> signifie que les instances de la classe + ne seront retourn�es que par une requ�te qui utilise explicitement + son nom et que seules les instances des classes filles d�clar�es dans les �l�ments + <literal><subclass></literal> ou <literal><joined-subclass></literal> + seront retourn�es. Dans la majorit�s des cas la valeur par d�faut, + <literal>polymorphism="implicit"</literal>, + est appropri�e. Le polymorphisme explicite est utile lorsque deux + classes diff�rentes sont mapp�es � la m�me table (ceci permet d'�crire + une classe "l�g�re" qui ne contient qu'une partie des colonnes de + la table - voir la partie design pattern du site communautaire). + </para> + <para> + L'attribut <literal>persister</literal> vous permet de customiser + la strat�gie utilis�e pour la classe. Vous pouvez, par exemple, sp�cifier + votre propre sous-classe de <literal>org.hibernate.persister.EntityPersister</literal> ou + vous pourriez aussi cr�er une nouvelle impl�mentation de l'interface <literal>org.hibernate.persister.ClassPersister</literal> + qui proposerait une persistance via, par exemple, des appels de proc�dures + stock�es, de la s�rialisation vers des fichiers plats ou un annuaire LDAP. + Voir <literal>org.hibernate.test.CustomPersister</literal> pour un exemple simple (d'une "persistance" + vers une <literal>Hashtable</literal>). + </para> + <para> + Notez que les param�tres <literal>dynamic-update</literal> et <literal>dynamic-insert</literal> + ne sont pas h�rit�s par les sous-classes et peuvent donc �tre sp�cifi�s + pour les �l�ments <literal><subclass></literal> ou <literal><joined-subclass></literal> + Ces param�tres peuvent am�liorer les performances dans certains cas, + mais peuvent aussi les amoindrir. A utiliser en connaissance de causes. + </para> + <para> + L'utilisation de <literal>select-before-update</literal> va g�n�ralement + faire baisser les performances. Ce param�tre est pratique + pour pr�venir l'appel inutile d'un trigger sur modification quand on + r�attache un graphe d'instances � une <literal>Session</literal>. + </para> + <para> + Si vous utilisez le <literal>dynamic-update</literal>, les diff�rentes + strat�gies de verrouillage optimiste (optimistic locking) sont les suivantes: + </para> + <itemizedlist> + <listitem> + <para> + <literal>version</literal> v�rifie les colonnes version/timestamp + </para> + </listitem> + <listitem> + <para> + <literal>all</literal> v�rifie toutes les colonnes + </para> + </listitem> + <listitem> + <para> + <literal>dirty</literal> v�rifie les colonnes modifi�es, permettant des updates concurrents + </para> + </listitem> + <listitem> + <para> + <literal>none</literal> pas de verrouillage optimiste + </para> + </listitem> + </itemizedlist> + <para> + Nous encourageons <emphasis>tr�s</emphasis> fortement l'utilisation + de colonnes de version/timestamp pour le verrouillage optimiste + avec Hibernate. C'est la meilleure strat�gie en regard des performances + et la seule qui g�re correctement les modifications sur les objets d�tach�s + (c'est � dire lorsqu'on utilise <literal>Session.merge()</literal>). + </para> + <para> + Il n'y a pas de diff�rence entre table et vue pour le mapping Hibernate, + tant que c'est transparent au niveau base de donn�es (remarquez + que certaines BDD ne supportent pas les vues correctement, notamment + pour les updates). Vous rencontrerez peut-�tre des cas o� vous + souhaitez utiliser une vue mais ne pouvez pas en cr�er sur votre BDD + (par exemple � cause de sch�mas anciens et fig�s). Dans ces cas, + vous pouvez mapper une entit� immuable en lecture seule sur un sous-select SQL donn�: + </para> + <programlisting><![CDATA[<class name="Summary"> + <subselect> + select item.name, max(bid.amount), count(*) + from item + join bid on bid.item_id = item.id + group by item.name + </subselect> + <synchronize table="item"/> + <synchronize table="bid"/> + <id name="name"/> + ... +</class>]]></programlisting> + <para> + D�clarez les tables � synchroniser avec cette entit� pour assurer + que le flush automatique se produise correctement, + et pour que les requ�tes sur l'entit� d�riv�e ne renvoient pas des donn�es p�rim�es. + Le lit�ral <literal><subselect></literal> est disponible + comme attribut ou comme �l�ment de mapping. + </para> + </sect2> + <sect2 id="mapping-declaration-id" revision="4"> + <title>id</title> + <para> + Les classes mapp�es <emphasis>doivent</emphasis> d�clarer la + clef primaire de la table en base de donn�es. + La plupart des classes auront aussi une propri�t� de type + javabean pr�sentant l'identifiant unique d'une instance. + L'�l�ment <literal><id></literal> sert � d�finir le + mapping entre cette propri�t� et la clef primaire en base. + </para> + <programlistingco> + <areaspec> + <area id="id1" coords="2 65"/> + <area id="id2" coords="3 65"/> + <area id="id3" coords="4 65"/> + <area id="id4" coords="5 65"/> + <area id="id5" coords="6 65"/> + </areaspec> + <programlisting><![CDATA[<id + name="propertyName" + type="typename" + column="column_name" + unsaved-value="null|any|none|undefined|id_value" + access="field|property|ClassName"> + + <generator class="generatorClass"/> +</id>]]></programlisting> + <calloutlist> + <callout arearefs="id1"> + <para> + <literal>name</literal> (optionnel) : Nom de la propri�t� qui sert d'identifiant. + </para> + </callout> + <callout arearefs="id2"> + <para> + <literal>type</literal> (optionnel) : Nom indiquant le type Hibernate. + </para> + </callout> + <callout arearefs="id3"> + <para> + <literal>column</literal> (optionnel - le nom de la propri�t� est pris par d�faut) : Nom de la clef primaire. + </para> + </callout> + <callout arearefs="id4"> + <para> + <literal>unsaved-value</literal> (optionnel - par d�faut une valeur "bien choisie") : + Une valeur de la propri�t� d'identifiant qui indique que l'instance est nouvellement + instanci�e (non sauvegard�e), et qui la distingue des instances <literal>transient</literal>s qui ont + �t� sauvegard�es ou charg�es dans une session pr�c�dente. + </para> + </callout> + <callout arearefs="id5"> + <para> + <literal>access</literal> (optionnel - par d�faut <literal>property</literal>) : La strat�gie que doit utiliser Hibernate + pour acc�der aux valeurs des propri�t�s. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Si l'attribut <literal>name</literal> est absent, Hibernate consid�re que la classe ne poss�de pas de propri�t� identifiant. + </para> + <para> + L'attribut <literal>unsaved-value</literal> est important ! Si + l'identifiant de votre classe n'a pas une valeur par d�faut compatible avec + le comportement standard de Java (z�ro ou null), vous devez alors pr�ciser la valeur par d�faut. + </para> + <para> + La d�claration alternative <literal><composite-id></literal> + permet l'accc�s aux donn�es d'anciens syst�mes qui utilisent des + clefs compos�es. Son utilisation est fortement d�conseill�e pour d'autres cas. + </para> + <sect3 id="mapping-declaration-id-generator" revision="2"> + <title>Generator</title> + <para> + L'�l�ment fils <literal><generator></literal> nomme une classe Java utilis�e pour g�n�rer + les identifiants uniques pour les instances des classes persistantes. Si des param�tres sont requis + pour configurer ou initialiser l'instance du g�n�rateur, ils sont pass�s en utilisant l'�l�ment <literal><param></literal>. + </para> + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="org.hibernate.id.TableHiLoGenerator"> + <param name="table">uid_table</param> + <param name="column">next_hi_value_column</param> + </generator> +</id>]]></programlisting> + <para> + Tous les g�n�rateurs doivent impl�menter l'interface <literal>org.hibernate.id.IdentifierGenerator</literal>. + C'est une interface tr�s simple ; certaines applications peuvent proposer leur propre impl�mentations sp�cialis�es. + Cependant, Hibernate propose une s�rie d'impl�mentations int�gr�es. Il existe des noms raccourcis pour les g�n�rateurs int�gr�s : + <variablelist> + <varlistentry> + <term> + <literal>increment</literal> + </term> + <listitem> + <para> + G�n�re des identifiants de type <literal>long</literal>, <literal>short</literal> ou + <literal>int</literal> qui ne sont uniques que si aucun autre processus n'ins�re de donn�es dans la m�me table. + <emphasis>Ne pas utiliser en environnement clusteris�.</emphasis> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>identity</literal> + </term> + <listitem> + <para> + Utilisation de la colonne identity de DB2, MySQL, MS SQL Server, Sybase et + HypersonicSQL. L'identifiant renvoy� est de type <literal>long</literal>, + <literal>short</literal> ou <literal>int</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>sequence</literal> + </term> + <listitem> + <para> + Utilisation des s�quences dans DB2, PostgreSQL, Oracle, SAP DB, McKoi ou d'un g�n�rateur dans Interbase. + L'identifiant renvoy� est de type <literal>long</literal>, + <literal>short</literal> ou <literal>int</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>hilo</literal> + </term> + <listitem> + <para id="mapping-declaration-id-hilodescription" revision="1"> + Utilise un algorithme hi/lo pour g�n�rer de fa�on efficace des identifiants de type + <literal>long</literal>, <literal>short</literal> ou <literal>int</literal>, + en prenant comme source de valeur "hi" une table et une colonne (par d�faut + <literal>hibernate_unique_key</literal> et + <literal>next_hi</literal> respectivement). L'algorithme hi/lo g�n�re des identifiants uniques + pour une base de donn�es particuli�re seulement. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>seqhilo</literal> + </term> + <listitem> + <para> + Utilise un algorithme hi/lo pour g�n�rer efficacement des identifiants de type <literal>long</literal>, <literal>short</literal> ou <literal>int</literal>, + �tant donn� un nom de s�quence en base. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>uuid</literal> + </term> + <listitem> + <para> + Utilise un algorithme de type UUID 128 bits pour g�n�rer des identifiants de + type string, unique au sein d'un r�seau (l'adresse IP est utilis�e). + Le UUID en cod� en une cha�ne de nombre h�xad�cimaux de longueur 32. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>guid</literal> + </term> + <listitem> + <para> + Utilise une cha�ne GUID g�n�r�e par la base pour MS SQL Server et MySQL. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>native</literal> + </term> + <listitem> + <para> + Choisit <literal>identity</literal>, <literal>sequence</literal> ou + <literal>hilo</literal> selon les possibilit�s offertes par la base de donn�es sous-jacente. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>assigned</literal> + </term> + <listitem> + <para> + Laisse l'application affecter un identifiant � l'objet avant que la m�tode + <literal>save()</literal> soit appel�e. Il s'agit de la strat�gie par d�faut + si aucun <literal><generator></literal> n'est sp�cifi�. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>select</literal> + </term> + <listitem> + <para> + R�cup�re une clef primaire assign�e par un trigger en s�lectionnant + la ligne par une clef unique quelconque. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>foreign</literal> + </term> + <listitem> + <para> + Utilise l'identifiant d'un objet associ�. Habituellement utilis� en conjonction + avec une association <literal><one-to-one></literal> sur la clef primaire. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect3> + <sect3 id="mapping-declaration-id-hilo" revision="1"> + <title>algorithme Hi/lo</title> + <para> + Les g�n�rateurs <literal>hilo</literal> et <literal>seqhilo</literal> proposent deux impl�mentations + alternatives de l'algorithme hi/lo, une approche largement utilis�e pour g�n�rer des identifiants. La + premi�re impl�mentation n�cessite une table "sp�ciale" en base pour h�berger la prochaine valeur "hi" disponible. + La seconde utilise une s�quence de type Oracle (quand la base sous-jacente le propose). + </para> + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="hilo"> + <param name="table">hi_value</param> + <param name="column">next_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="seqhilo"> + <param name="sequence">hi_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + <para> + Malheureusement, vous ne pouvez pas utilisez <literal>hilo</literal> quand vous apportez + votre propre <literal>Connection</literal> � Hibernate. Quand Hibernate utilise une datasource du serveur + d'application pour obtenir des connexions inscrites avec JTA, vous devez correctement configurer + <literal>hibernate.transaction.manager_lookup_class</literal>. + </para> + </sect3> + <sect3 id="mapping-declaration-id-uuid"> + <title>UUID algorithm</title> + <para> + Le contenu du UUID est : adresse IP, date de d�marrage de la JVM (pr�cis au quart de seconde), + l'heure syst�me et un compteur (unique au sein de la JVM). Il n'est pas possible d'obtenir l'adresse + MAC ou une adresse m�moire � partir de Java, c'est donc le mieux que l'on puisse faire sans utiliser JNI. + </para> + </sect3> + <sect3 id="mapping-declaration-id-sequences"> + <title>Colonnes identifiantes et s�quences</title> + <para> + Pour les bases qui impl�mentent les colonnes "identit�" (DB2, MySQL, Sybase, MS SQL), + vous pouvez utiliser la g�n�ration de clef par <literal>identity</literal>. + Pour les bases qui impl�mentent les s�quences (DB2, Oracle, PostgreSQL, Interbase, McKoi, SAP DB) + vous pouvez utiliser la g�n�ration de clef par <literal>sequence</literal>. Ces deux m�thodes n�cessitent + deux requ�tes SQL pour ins�rer un objet. + </para> + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="sequence"> + <param name="sequence">person_id_sequence</param> + </generator> +</id>]]></programlisting> + <programlisting><![CDATA[<id name="id" type="long" column="person_id" unsaved-value="0"> + <generator class="identity"/> +</id>]]></programlisting> + <para>Pour le d�veloppement multi-plateformes, la strat�gie <literal>native</literal> choisira + entre les m�thodes <literal>identity</literal>, <literal>sequence</literal> et + <literal>hilo</literal>, selon les possibilit�s offertes par la base sous-jacente. + </para> + </sect3> + <sect3 id="mapping-declaration-id-assigned"> + <title>Identifiants assign�s</title> + <para> + Si vous souhaitez que l'application assigne des identifiants (par opposition + � la g�n�ration par Hibernate), vous pouvez utiliser le g�n�rateur <literal>assigned</literal>. + Ce g�n�rateur sp�cial utilisera une valeur d'identifiant d�j� utilis� par la propri�t� identifiant l'objet. + Ce g�n�rateur est utilis� quand la clef primaire est une clef naturelle plut�t qu'une clef secondaire. + C'est le comportement par d�faut si vous ne pr�cisez pas d'�l�ment <literal><generator></literal>. + </para> + <para> + Choisir le g�n�rateur <literal>assigned</literal> fait utiliser + <literal>unsaved-value="undefined"</literal> par Hibernate, le for�ant � interroger + la base pour d�terminer si l'instance est transiente ou d�tach�e, � moins d'utiliser + une propri�t� version ou timestamp, ou alors de d�finir + <literal>Interceptor.isUnsaved()</literal>. + </para> + </sect3> + <sect3 id="mapping-declaration-id-select"> + <title>Clefs primaires assign�es par trigger</title> + <para> + Pour les sch�mas de base h�rit�s d'anciens syst�mes uniquement (Hibernate ne g�n�re pas de DDL avec des triggers) + </para> + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="select"> + <param name="key">socialSecurityNumber</param> + </generator> +</id>]]></programlisting> + <para> + Dans l'exemple ci-dessus, <literal>socialSecurityNumber</literal> a une + valeur unique d�finie par la classe en tant que clef naturelle et <literal>person_id</literal> + est une clef secondaire dont la valeur est g�n�r�e par trigger. + </para> + </sect3> + </sect2> + <sect2 id="mapping-declaration-compositeid" revision="3"> + <title>composite-id</title> + <programlisting><![CDATA[<composite-id + name="propertyName" + class="ClassName" + mapped="true|false" + access="field|property|ClassName"> + node="element-name|." + + <key-property name="propertyName" type="typename" column="column_name"/> + <key-many-to-one name="propertyName class="ClassName" column="column_name"/> + ...... +</composite-id>]]></programlisting> + <para> + Pour une table avec clef compos�e, vous pouvez mapper plusieurs attributs de la classe + comme propri�t�s identifiantes. L'�lement <literal><composite-id></literal> accepte + les mappings de propri�t�s <literal><key-property></literal> et les mappings + <literal><key-many-to-one></literal> comme fils. + </para> + <programlisting><![CDATA[<composite-id> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + <para> + Vos classes persistantes <emphasis>doivent</emphasis> surcharger les m�thodes <literal>equals()</literal> + et <literal>hashCode()</literal> pour impl�menter l'�galit� d'identifiant compos�. Elles doivent aussi + implenter l'interface <literal>Serializable</literal>. + </para> + <para> + Malheureusement cette approche sur les identifiants compos�s signifie qu'un objet persistant + est son propre identifiant. Il n'y a pas d'autre moyen pratique de manipuler l'objet que par l'objet lui-m�me. + Vous devez instancier une instance de la classe persistante elle-m�me et peupler ses attributs identifiants + avant de pouvoir appeler la m�thode <literal>load()</literal> pour charger son �tat persistant associ� + � une clef compos�e. Nous appelons cette approche "identifiant compos� <emphasis>embarqu�</emphasis>" + et ne la recommandons pas pour des applications complexes. + </para> + + <para> + Une seconde approche, appel�e identifiant compos� <emphasis>mapp�</emphasis>, + consiste � encapsuler les propri�t�s identifiantes (celles contenues dans <literal><composite-id></literal>) + dans une classe particuli�re. + </para> + + <programlisting><![CDATA[<composite-id class="MedicareId" mapped="true"> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + + <para> + Dans cet exemple, la classe d'identifiant compos�e,<literal>MedicareId</literal> et la classe mapp�e elle-m�me, + poss�dent les propri�t�s <literal>medicareNumber</literal> + et <literal>dependent</literal>. La classe identifiante doit red�finir + <literal>equals()</literal> et <literal>hashCode()</literal> et impl�menter + <literal>Serializable</literal>. Le d�savantage de cette approche est la + duplication du code. + </para> + + <para> + Les attributs suivants servent � configurer un identifiant compos� mapp� : + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mapped</literal> (optionnel, d�faut � <literal>false</literal>) : + indique qu'un identifiant compos� mapp� est utilis�, et que les propri�t�s + contenues font r�f�rence aux deux classes (celle mapp�e et la classe identifiante). + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (optionnel, mais requis pour un identifiant compos� mapp�) : + La classe composant utilis�e comme identifiant compos�. + </para> + </listitem> + </itemizedlist> + <para> + Nous d�crirons une troisi�me approche beaucoup plus efficace ou l'identifiant compos� + est impl�ment� comme une classe composant dans <xref linkend="components-compositeid"/>. + Les attributs d�crits ci dessous, ne s'appliquent que pour cette derni�re approche : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>name</literal> (optionnel, requis pour cette approche) : une propri�t� de type + composant qui contient l'identifiant compos� (voir chapitre 9). + </para> + </listitem> + <listitem> + <para> + <literal>access</literal> (optionnel - d�faut � <literal>property</literal>) : + La strat�gie qu'Hibernate utilisera pour acc�der � la valeur de la propri�t�. + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (optionnel - d�faut au type de la propri�t� d�termin� par r�flexion) : + La classe composant utilis�e comme identifiant (voir prochaine section). + </para> + </listitem> + </itemizedlist> + + <para> + Cette derni�re approche est celle que nous recommandons pour toutes vos applications. + </para> + </sect2> + <sect2 id="mapping-declaration-discriminator" revision="3"> + <title>discriminator</title> + <para> + L'�l�ment <literal><discriminator></literal> est n�cessaire pour la persistance polymorphique + qui utilise la strat�gie de mapping de table par hi�rarchie de classe. La colonne discriminante contient + une valeur marqueur qui permet � la couche de persistance de savoir quelle + sous-classe instancier pour une ligne particuli�re de table en base. Un nombre restreint de types + peuvent �tre utilis�s : + <literal>string</literal>, <literal>character</literal>, <literal>integer</literal>, + <literal>byte</literal>, <literal>short</literal>, <literal>boolean</literal>, + <literal>yes_no</literal>, <literal>true_false</literal>. + </para> + <programlistingco> + <areaspec> + <area id="discriminator1" coords="2 60"/> + <area id="discriminator2" coords="3 60"/> + <area id="discriminator3" coords="4 60"/> + <area id="discriminator4" coords="5 60"/> + <area id="discriminator5" coords="6 60"/> + </areaspec> + <programlisting><![CDATA[<discriminator + column="discriminator_column" + type="discriminator_type" + force="true|false" + insert="true|false" + formula="arbitrary sql expression" +/>]]></programlisting> + <calloutlist> + <callout arearefs="discriminator1"> + <para> + <literal>column</literal> (optionnel - par d�faut � <literal>class</literal>) le + nom de la colonne discriminante. + </para> + </callout> + <callout arearefs="discriminator2"> + <para> + <literal>type</literal> (optionnel - par d�faut � <literal>string</literal>) un nom + indiquant le type Hibernate. + </para> + </callout> + <callout arearefs="discriminator3"> + <para> + <literal>force</literal> (optionnel - par d�faut � <literal>false</literal>) + "oblige" Hibernate � sp�cifier une valeur discriminante autoris�e m�me quand on r�cup�re + toutes les instances de la classe de base. + </para> + </callout> + <callout arearefs="discriminator4"> + <para> + <literal>insert</literal> (optionnel - par d�faut � <literal>true</literal>) + � passer � <literal>false</literal> si la colonne discriminante fait aussi partie + d'un identifiant compos� mapp� (Indique � Hibernate de ne pas inclure la colonne + dans les <literal>INSERT</literal> SQL). + </para> + </callout> + <callout arearefs="discriminator5"> + <para> + <literal>formula</literal> (optionnel) une expression SQL arbitraire qui est ex�cut�e + quand un type doit �tre �valu�. Permet la discrimination bas�e sur le contenu. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Les v�ritables valeurs de la colonne discriminante sont sp�cifi�es par l'attribut + <literal>discriminator-value</literal> des �l�ments <literal><class></literal> et + <literal><subclass></literal>. + </para> + <para> + L'attribut <literal>force</literal> n'est utile que si la table contient des lignes avec des + valeurs "extra" discriminantes qui ne sont pas mapp�es � une classe persistante. Ce ne sera g�n�ralement pas le cas. + </para> + <para> + En utilisant l'attribut <literal>formula</literal> vous pouvez d�clarer une expression SQL arbitraire + qui sera utilis�e pour �valuer le type d'une ligne : + </para> + <programlisting><![CDATA[<discriminator + formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end" + type="integer"/>]]></programlisting> + </sect2> + <sect2 id="mapping-declaration-version" revision="4"> + <title>version (optionnel)</title> + <para> + L'�l�ment <literal><version></literal> est optionnel et indique que la table contient + des donn�es versionn�es. C'est particuli�rement utile si vous avez l'intention d'utiliser + des <emphasis>transactions longues</emphasis> (voir plus-bas). + </para> + <programlistingco> + <areaspec> + <area id="version1" coords="2 60"/> + <area id="version2" coords="3 60"/> + <area id="version3" coords="4 60"/> + <area id="version4" coords="5 60"/> + <area id="version5" coords="6 60"/> + <area id="version6" coords="7 70"/> + <area id="version7" coords="8 70"/> + </areaspec> + <programlisting><![CDATA[<version + column="version_column" + name="propertyName" + type="typename" + access="field|property|ClassName" + unsaved-value="null|negative|undefined" + generated="never|always" + insert="true|false" + node="element-name|@attribute-name|element/@attribute|." +/>]]></programlisting> + <calloutlist> + <callout arearefs="version1"> + <para> + <literal>column</literal> (optionnel - par d�faut �gal au nom de la propri�t�) : Le nom de la colonne + contenant le num�ro de version. + </para> + </callout> + <callout arearefs="version2"> + <para> + <literal>name</literal> : Le nom d'un attribut de la classe persistante. + </para> + </callout> + <callout arearefs="version3"> + <para> + <literal>type</literal> (optionnel - par d�faut � <literal>integer</literal>) : + Le type du num�ro de version. + </para> + </callout> + <callout arearefs="version4"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>) : La strat�gie + � utiliser par Hibernate pour acc�der � la valeur de la propri�t�. + </para> + </callout> + <callout arearefs="version5"> + <para> + <literal>unsaved-value</literal> (optionnel - par d�faut � <literal>undefined</literal>) : + Une valeur de la propri�t� d'identifiant qui indique que l'instance est nouvellement + instanci�e (non sauvegard�e), et qui la distingue des instances d�tach�es qui ont + �t� sauvegard�es ou charg�es dans une session pr�c�dente (<literal>undefined</literal> indique + que la valeur de l'atribut identifiant devrait �tre utilis�). + </para> + </callout> + <callout arearefs="version6"> + <para> + <literal>generated</literal> (optional - d�faut � <literal>never</literal>) : + Indique que la valeur de la propri�t� version est g�n�r�e par la base de donn�es + cf. <xref linkend="mapping-generated">generated properties</xref>. + </para> + </callout> + <callout arearefs="version7"> + <para> + <literal>insert</literal> (optionnel - d�faut � <literal>true</literal>) : + Indique si la colonne de version doit �tre incluse dans les ordres insert. + Peut �tre � <literal>false</literal> si et seulement si la colonne de la + base de donn�es est d�finie avec une valeur par d�faut � <literal>0</literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Les num�ros de version doivent avoir les types Hibernate <literal>long</literal>, <literal>integer</literal>, + <literal>short</literal>, <literal>timestamp</literal> ou <literal>calendar</literal>. + </para> + <para> + Une propri�t� de version ou un timestamp ne doit jamais �tre null pour une instance + d�tach�e, ainsi Hibernate pourra d�tecter toute instance ayant une version ou un timestamp null + comme transient, quelles que soient les strat�gies <literal>unsaved-value</literal> sp�cifi�es. + <emphasis>D�clarer un num�ro de version ou un timestamp "nullable" est un moyen pratique d'�viter + tout probl�me avec les r�attachements transitifs dans Hibernate, particuli�rement utile pour ceux qui + utilisent des identifiants assign�s ou des clefs compos�es !</emphasis> + </para> + </sect2> + <sect2 id="mapping-declaration-timestamp" revision="3" > + <title>timestamp (optionnel)</title> + <para> + L'�l�ment optionnel <literal><timestamp></literal> indique que la table contient des donn�es + horodat�es (timestamp). Cela sert d'alternative � l'utilisation de num�ros de version. Les timestamps (ou horodatage) + sont par nature une impl�mentation moins fiable pour l'optimistic locking. Cependant, l'application + peut parfois utiliser l'horodatage � d'autres fins. + </para> + <programlistingco> + <areaspec> + <area id="timestamp1" coords="2 45"/> + <area id="timestamp2" coords="3 45"/> + <area id="timestamp3" coords="4 45"/> + <area id="timestamp4" coords="5 45"/> + <area id="timestamp5" coords="6 70" /> + <area id="timestamp6" coords="7 70" /> + </areaspec> + <programlisting><![CDATA[<timestamp + column="timestamp_column" + name="propertyName" + access="field|property|ClassName" + unsaved-value="null|undefined" + source="vm|db" + generated="never|always" + node="element-name|@attribute-name|element/@attribute|." +/>]]></programlisting> + <calloutlist> + <callout arearefs="timestamp1"> + <para> + <literal>column</literal> (optionnel - par d�faut � le nom de la propri�t�) : Le nom d'une colonne + contenant le timestamp. + </para> + </callout> + <callout arearefs="timestamp2"> + <para> + <literal>name</literal> : Le nom d'une propri�t� au sens JavaBean de type + <literal>Date</literal> ou <literal>Timestamp</literal> de la classe persistante. + </para> + </callout> + <callout arearefs="timestamp3"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>) : La strat�gie + � utiliser par Hibernate pour acc�der � la valeur de la propri�t�. + </para> + </callout> + <callout arearefs="timestamp4"> + <para> + <literal>unsaved-value</literal> (optionnel - par d�faut � <literal>null</literal>) : + Propri�t� dont la valeur est un num�ro de version qui indique que l'instance est nouvellement + instanci�e (non sauvegard�e), et qui la distingue des instances d�tach�es qui ont + �t� sauvegard�es ou charg�es dans une session pr�c�dente (<literal>undefined</literal> indique + que la valeur de l'attribut identifiant devrait �tre utilis�e). + </para> + </callout> + <callout arearefs="timestamp5"> + <para> + <literal>source</literal> (optionnel - par d�faut � <literal>vm</literal>) : + D'o� Hibernate doit-il r�cup�rer la valeur du timestamp? Depuis la base de donn�es + ou depuis la JVM d'ex�cution? Les valeurs de timestamp de la base de donn�es provoquent + une surcharge puisque Hibernate doit interroger la base pour d�terminer la prochaine valeur + mais cela est plus s�r lorsque vous fonctionnez dans un cluster. Remarquez aussi que + certains des dialectes ne supportent pas cette fonction, et que d'autres l'impl�mentent + mal, provoquant des erreurs de pr�cision (Oracle 8 par exemple). + </para> + </callout> + <callout arearefs="timestamp6"> + <para> + <literal>generated</literal> (optional - d�faut � <literal>never</literal>) : + Indique que la valeur de ce timestamp est g�n�r�e par la base de donn�es + cf. <xref linkend="mapping-generated">generated properties</xref>. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Notez que <literal><timestamp></literal> est �quivalent � + <literal><version type="timestamp"></literal>. + </para> + </sect2> + <sect2 id="mapping-declaration-property" revision="4"> + <title>property</title> + <para> + L'�l�ment <literal><property></literal> d�clare une propri�t� de la classe au sens JavaBean. + </para> + <programlistingco> + <areaspec> + <area id="property1" coords="2 45"/> + <area id="property2" coords="3 45"/> + <area id="property3" coords="4 45"/> + <areaset id="property4-5" coords=""> + <area id="property4" coords="5 45"/> + <area id="property5" coords="6 45"/> + </areaset> + <area id="property6" coords="7 45"/> + <area id="property7" coords="8 45"/> + <area id="property8" coords="9 45"/> + <area id="property9" coords="10 45"/> + <area id="property10" coords="11 45"/> + <area id="property11" coords="12 45"/> + <area id="property12" coords="13 70"/> + </areaspec> + <programlisting><![CDATA[<property + name="propertyName" + column="column_name" + type="typename" + update="true|false" + insert="true|false" + formula="arbitrary SQL expression" + access="field|property|ClassName" + lazy="true|false" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + generated="never|insert|always" + node="element-name|@attribute-name|element/@attribute|." + index="index_name" + unique_key="unique_key_id" + length="L" + precision="P" + scale="S" +/>]]></programlisting> + <calloutlist> + <callout arearefs="property1"> + <para> + <literal>name</literal> : nom de la propri�t�, avec une lettre initiale en minuscule. + </para> + </callout> + <callout arearefs="property2"> + <para> + <literal>column</literal> (optionnel - par d�faut au nom de la propri�t�) : le nom + de la colonne mapp�e. Cela peut aussi �tre indiqu� dans le(s) sous-�l�ment(s) + <literal><column></literal>. + </para> + </callout> + <callout arearefs="property3"> + <para> + <literal>type</literal> (optionnel) : nom indiquant le type Hibernate. + </para> + </callout> + <callout arearefs="property4-5"> + <para> + <literal>update, insert</literal> (optionnel - par d�faut � <literal>true</literal>) : + indique que les colonnes mapp�es devraient �tre incluses dans des <literal>UPDATE</literal> SQL + et/ou des <literal>INSERT</literal>. Mettre les deux � <literal>false</literal> + emp�che la propagation en base de donn�es (utile si vous savez qu'un trigger affectera la valeur � la colonne). + </para> + </callout> + <callout arearefs="property6"> + <para> + <literal>formula</literal> (optionnel) : une expression SQL qui d�finit la valeur pour une propri�t� + <emphasis>calcul�e</emphasis>. Les propri�t�s calcul�es ne poss�de pas leur propre mapping. + </para> + </callout> + <callout arearefs="property7"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>): Strat�gie que Hibernate + doit utiliser pour acc�der � cette valeur. + </para> + </callout> + <callout arearefs="property8"> + <para> + <literal>lazy</literal> (optionnel - par d�faut � <literal>false</literal>): Indique + que cette propri�t� devrait �tre charg�e en diff�r� (lazy loading) quand on acc�de � la variable + d'instance pour la premi�re fois. + </para> + </callout> + <callout arearefs="property9"> + <para> + <literal>unique</literal> (optionnel): G�n�re le DDL d'une contrainte d'unicit� pour les colonnes. + Permet aussi d'en faire la cible d'un <literal>property-ref</literal>. + </para> + </callout> + <callout arearefs="property10"> + <para> + <literal>not-null</literal> (optionnel): G�n�re le DDL d'une contrainte de non nullit� pour les colonnes. + </para> + </callout> + <callout arearefs="property11"> + <para> + <literal>optimistic-lock</literal> (optionnel - par d�faut � <literal>true</literal>): + Indique que les mises � jour de cette propri�t� peuvent ou non n�cessiter l'acquisition + d'un verrou optimiste. En d'autres termes, cela d�termine s'il est n�cessaire d'incr�menter + un num�ro de version quand cette propri�t� est marqu�e obsol�te (dirty). + </para> + </callout> + <callout arearefs="property12"> + <para> + <literal>generated</literal> (optional - d�faut �<literal>never</literal>): + Indique que la valeur de ce timestamp est g�n�r�e par la base de donn�es + cf. <xref linkend="mapping-generated">generated properties</xref>. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + <emphasis>typename</emphasis> peut �tre: + </para> + <orderedlist spacing="compact"> + <listitem> + <para> + Nom d'un type basique Hibernate (ex: <literal>integer, string, character, + date, timestamp, float, binary, serializable, object, blob</literal>). + </para> + </listitem> + <listitem> + <para> + Nom d'une classe Java avec un type basique par d�faut (ex: <literal>int, float, + char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob</literal>). + </para> + </listitem> + <listitem> + <para> + Nom d'une classe Java s�rialisable. + </para> + </listitem> + <listitem> + <para> + Nom d'une classe ayant un type sp�cifique (ex: <literal>com.illflow.type.MyCustomType</literal>). + </para> + </listitem> + </orderedlist> + <para> + Si vous n'indiquez pas un type, Hibernate utlisera la r�flexion sur le nom de la propri�t� + pour tenter de trouver le type Hibernate correct. Hibernate essayera d'interpr�ter + le nom de la classe retourn�e par le getter de la propri�t� en utilisant les r�gles 2, 3, + 4 dans cet ordre. Cependant, ce n'est pas toujours suffisant. Dans certains cas vous aurez + encore besoin de l'attribut <literal>type</literal> (Par exemple, pour distinguer + <literal>Hibernate.DATE</literal> et <literal>Hibernate.TIMESTAMP</literal>, ou pour pr�ciser + un type sp�cifique). + </para> + <para> + L'attribut <literal>access</literal> permet de contr�ler comment Hibernate acc�dera + � la propri�t� � l'ex�cution. Par d�faut, Hibernate utilisera les m�thodes set/get. + Si vous indiquez <literal>access="field"</literal>, Hibernate ignorera les getter/setter + et acc�dera � la propri�t� directement en utilisant la r�flexion. Vous pouvez sp�cifier + votre propre strat�gie d'acc�s aux propri�t� en donnant une classe qui impl�mente l'interface + <literal>org.hibernate.property.PropertyAccessor</literal>. + </para> + <para> + Une fonctionnalit� particuli�rement int�ressante est les propri�t�s d�riv�es. + Ces propri�t�s sont par d�finition en lecture seule, la valeur de la propri�t� est calcul�e au chargement. + Le calcul est d�clar� comme une expression SQL, qui se traduit par une sous-requ�te <literal>SELECT</literal> + dans la requ�te SQL qui charge une instance : + </para> + <programlisting><![CDATA[ +<property name="totalPrice" + formula="( SELECT SUM (li.quantity*p.price) FROM LineItem li, Product p + WHERE li.productId = p.productId + AND li.customerId = customerId + AND li.orderNumber = orderNumber )"/>]]></programlisting> + <para> + Remarquez que vous pouvez r�f�rencer la propre table des entit�s en ne d�clarant pas un + alias sur une colonne particuli�re (<literal>customerId</literal> dans l'exemple donn�). + Notez aussi que vous pouvez utiliser le sous-�l�ment de mapping <literal><formula></literal> + plut�t que d'utiliser l'attribut si vous le souhaitez. + </para> + </sect2> + <sect2 id="mapping-declaration-manytoone" revision="5"> + <title>many-to-one</title> + <para> Une association ordinaire vers une autre classe persistante est d�clar�e en utilisant + un �l�ment <literal>many-to-one</literal>. Le mod�le relationnel est une association + de type many-to-one : une clef �trang�re dans une table r�f�rence la ou les clef(s) primaire(s) dans la table cible. + </para> + <programlistingco> + <areaspec> + <area id="manytoone1" coords="2 60"/> + <area id="manytoone2" coords="3 60"/> + <area id="manytoone3" coords="4 60"/> + <area id="manytoone4" coords="5 60"/> + <area id="manytoone5" coords="6 60"/> + <areaset id="manytoone6-7" coords=""> + <area id="manytoone6" coords="7 60"/> + <area id="manytoone7" coords="8 60"/> + </areaset> + <area id="manytoone8" coords="9 60"/> + <area id="manytoone9" coords="10 60"/> + <area id="manytoone10" coords="11 60"/> + <area id="manytoone11" coords="12 60"/> + <area id="manytoone12" coords="13 60"/> + <area id="manytoone13" coords="14 60"/> + <area id="manytoone14" coords="15 60"/> + <area id="manytoone14" coords="15 70"/> + <area id="manytoone15" coords="16 70"/> + <area id="manytoone16" coords="17 70"/> + </areaspec> + <programlisting><![CDATA[<many-to-one + name="propertyName" + column="column_name" + class="ClassName" + cascade="cascade_style" + fetch="join|select" + update="true|false" + insert="true|false" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + lazy="proxy|no-proxy|false" + not-found="ignore|exception" + entity-name="EntityName" + formula="arbitrary SQL expression" + node="element-name|@attribute-name|element/@attribute|." + embed-xml="true|false" + index="index_name" + unique_key="unique_key_id" + foreign-key="foreign_key_name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="manytoone1"> + <para> + <literal>name</literal> : Nom de la propri�t�. + </para> + </callout> + <callout arearefs="manytoone2"> + <para> + <literal>column</literal> (optionnel) : Le nom de la clef �trang�re. Cela peut �tre + aussi indiqu� avec le sous-�l�ment <literal><column></literal>. + </para> + </callout> + <callout arearefs="manytoone3"> + <para> + <literal>class</literal> (optionnel - par d�faut le type de la propri�t� d�termin� + par r�flexion) : Le nom de la classe associ�e. + </para> + </callout> + <callout arearefs="manytoone4"> + <para> + <literal>cascade</literal> (optionnel) : Indique quelles op�rations doivent + �tre propag�es de l'objet p�re vers les objets associ�s. + </para> + </callout> + <callout arearefs="manytoone5"> + <para> + <literal>fetch</literal> (optionnel - par d�faut � <literal>select</literal>) : + Choisit entre le chargement de type outer-join ou le chargement par select successifs. + </para> + </callout> + <callout arearefs="manytoone6-7"> + <para> + <literal>update, insert</literal> (optionnel - par d�faut � <literal>true</literal>) : + indique que les colonnes mapp�es devraient �tre incluses dans des <literal>UPDATE</literal> SQL + et/ou des <literal>INSERT</literal>. Mettre les deux � <literal>false</literal> + emp�che la propagation en base de donn�es (utile si vous savez qu'un trigger affectera la valeur � la colonne). + </para> + </callout> + <callout arearefs="manytoone8"> + <para> + <literal>property-ref</literal> : (optionnel) Le nom d'une propri�t� de la classe + associ�e qui est li�e � cette clef �trang�re. Si ce n'est pas sp�cifi�, la clef primaire de la + classe associ�e est utilis�e. + </para> + </callout> + <callout arearefs="manytoone9"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>) : La + strat�gie � utiliser par Hibernate pour acc�der � la valeur de cette propri�t�. + </para> + </callout> + <callout arearefs="manytoone10"> + <para> + <literal>unique</literal> (optionnel) : G�n�re le DDL d'une contrainte d'unicit� pour la clef �trang�re. + Permet aussi d'en faire la cible d'un <literal>property-ref</literal>. Cela permet de cr�er une v�ritable + association one-to-one. + </para> + </callout> + <callout arearefs="manytoone11"> + <para> + <literal>not-null</literal> (optionnel) : G�n�re le DDL pour une contrainte de non nullit� pour la clef �trang�re. + </para> + </callout> + <callout arearefs="manytoone12"> + <para> + <literal>optimistic-lock</literal> (optionnel - par d�faut � <literal>true</literal>) : + Indique que les mises � jour de cette propri�t� requi�rent ou non l'acquisition + d'un verrou optimiste. En d'autres termes, d�termine si un incr�ment de version doit + avoir lieu quand la propri�t� est marqu�e obsol�te (dirty). + </para> + </callout> + <callout arearefs="manytoone13"> + <para> + <literal>lazy</literal> (optionnel - par d�faut � <literal>false</literal>) : Indique + que cette propri�t� doit �tre charg�e en diff�r� (lazy loading) au premier acc�s + � la variable d'instance (n�cessite une instrumentation du bytecode lors de la phase + de construction). Remarquez que cela n'influence pas le comportement du proxy + Hibernate - comme l'attribut <literal>lazy</literal> sur des classes ou des mappings + de collections, mais utilise l'interception pour le chargement diff�r�. + <literal>lazy="false"</literal> indique que l'association sera toujours charg�e. + </para> + </callout> + <callout arearefs="manytoone14"> + <para> + <literal>not-found</literal> (optionnel - par d�faut � <literal>exception</literal>) : + Indique comment les clefs �trang�res qui r�f�rencent des lignes manquantes doivent �tre manipul�es : + <literal>ignore</literal> traitera une ligne manquante comme une association nulle. + </para> + </callout> + <callout arearefs="manytoone15"> + <para> + <literal>entity-name</literal> (optionnel) : Le nom de l'entit� de la classe associ�e. + </para> + </callout> + <callout arearefs="manytoone16"> + <para> + <literal>formula</literal> (optionnel) : une expression SQL qui d�finit la valeur + pour une cl� �trang�re calcul�e. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Donner une valeur significative � l'attribut <literal>cascade</literal> autre que + <literal>none</literal> propagera certaines op�rations � l'objet associ�. Les valeurs + significatives sont les noms des op�rations Hibernate basiques, + <literal>persist, merge, delete, save-update, evict, replicate, lock, + refresh</literal>, ainsi que les valeurs sp�ciales <literal>delete-orphan</literal> + et <literal>all</literal> et des combinaisons de noms d'op�rations s�par�es par des virgules, + comme par exemple <literal>cascade="persist,merge,evict"</literal> ou + <literal>cascade="all,delete-orphan"</literal>. Voir <xref linkend="objectstate-transitive"/> + pour une explication compl�te. + Notez que les assocations many-to-one et one-to-one ne supportent pas orphan delete. + </para> + + <para> + Une d�claration <literal>many-to-one</literal> typique est aussi simple que : + </para> + <programlisting><![CDATA[<many-to-one name="product" class="Product" column="PRODUCT_ID"/>]]></programlisting> + <para> + L'attribut <literal>property-ref</literal> devrait �tre utilis� pour mapper seulement des donn�es + provenant d'un ancien syst�me o� les clefs �trang�res font r�f�rence � une clef unique de la table associ�e + et qui n'est pas la clef primaire. C'est un cas de mauvaise conception relationnelle. + Par exemple, supposez que la classe <literal>Product</literal> a un num�ro de s�rie unique qui n'est pas + la clef primaire. (L'attribut <literal>unique</literal> contr�le la g�n�ration DDL par Hibernate avec + l'outil SchemaExport.) + </para> + <programlisting><![CDATA[<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>]]></programlisting> + <para> + Ainsi le mapping pour <literal>OrderItem</literal> peut utiliser : + </para> + <programlisting><![CDATA[<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>]]></programlisting> + <para> + bien que ce ne soit certainement pas encourag�. + </para> + <para> + Si la clef unique r�f�renc�e comprend des propri�t�s multiples de l'entit� associ�e, vous devez mapper + ces propri�t�s � l'int�rieur d'un �l�ment <literal><properties></literal>. + </para> + </sect2> + <sect2 id="mapping-declaration-onetoone" revision="3"> + <title>one-to-one</title> + <para> + Une association one-to-one vers une autre classe persistante est d�clar�e avec l'�l�ment + <literal>one-to-one</literal>. + </para> + <programlistingco> + <areaspec> + <area id="onetoone1" coords="2 60"/> + <area id="onetoone2" coords="3 60"/> + <area id="onetoone3" coords="4 60"/> + <area id="onetoone4" coords="5 60"/> + <area id="onetoone5" coords="6 60"/> + <area id="onetoone6" coords="7 60"/> + <area id="onetoone7" coords="8 60"/> + <area id="onetoone8" coords="9 60"/> + <area id="onetoone9" coords="10 70"/> + <area id="onetoone10" coords="11 70"/> + </areaspec> + <programlisting><![CDATA[<one-to-one + name="propertyName" + class="ClassName" + cascade="cascade_style" + constrained="true|false" + fetch="join|select" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + formula="any SQL expression" + entity-name="EntityName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="onetoone1"> + <para> + <literal>name</literal> : Le nom de la propri�t�. + </para> + </callout> + <callout arearefs="onetoone2"> + <para> + <literal>class</literal> (optionnel - par d�faut du type de la propri�t� + d�termin� par r�flexion) : Le nom de la classe associ�e. + </para> + </callout> + <callout arearefs="onetoone3"> + <para> + <literal>cascade</literal> (optionnel) : Indique quelles op�rations doivent + �tre cascad�es de l'objet p�re vers l'objet associ�. + </para> + </callout> + <callout arearefs="onetoone4"> + <para> + <literal>constrained</literal> (optionnel) : Indique qu'une contrainte de clef �trang�re + sur la clef primaire de la table mapp�e r�f�rence la table de la classe associ�e. + Cette option affecte l'ordre dans lequel chaque <literal>save()</literal> et chaque + <literal>delete()</literal> sont cascad�s et d�termine si l'association peut utiliser un proxy + (aussi utilis� par l'outil d'export de sch�ma). + </para> + </callout> + <callout arearefs="onetoone5"> + <para> + <literal>fetch</literal> (optionnel - par d�faut � <literal>select</literal>) : + Choisit entre r�cup�ration par jointure externe ou select s�quentiel. + </para> + </callout> + <callout arearefs="onetoone6"> + <para> + <literal>property-ref</literal> (optionnel) : Le nom de la propri�t� de la classe associ�e qui est jointe � la clef + primaire de cette classe. Si ce n'est pas sp�cifi�, la clef primaire de la classe associ�e est utilis�e. + </para> + </callout> + <callout arearefs="onetoone7"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>) : + La strat�gie � utiliser par Hibernate pour acc�der � la valeur de la propri�t�. + </para> + </callout> + <callout arearefs="onetoone8"> + <para> + <literal>formula</literal> (optionnel) : Presque toutes les associations one-to-one pointent sur la clef primaire + de l'entit� propri�taire. Dans les rares cas diff�rents, vous devez donner une ou plusieurs + autres colonnes ou expression � joindre par une formule SQL (voir <literal>org.hibernate.test.onetooneformula</literal> pour un exemple). + </para> + </callout> + <callout arearefs="onetoone9"> + <para> + <literal>lazy</literal> (optionnel - par d�faut <literal>proxy</literal>) : + Par d�faut, les associations simples sont soumise � proxy. <literal>lazy="no-proxy"</literal> + sp�cifie que la propri�t� doit �tre charg�e � la demande au premier acc�s � l'instance. + (n�cessite l'intrumentation du bytecode � la construction). + <literal>lazy="false"</literal> indique que l'association sera toujours charg�e + agressivement. <emphasis>Notez que si <literal>constrained="false"</literal>, + l'utilisation de proxy est impossible et Hibernate chargera automatiquement l'association !</emphasis> + </para> + </callout> + <callout arearefs="onetoone10"> + <para> + <literal>entity-name</literal> (optional) : The entity name of the associated class. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Il existe deux types d'associations one-to-one : + </para> + <itemizedlist> + <listitem> + <para> + associations par clef primaire + </para> + </listitem> + <listitem> + <para> + association par clef �trang�re unique + </para> + </listitem> + </itemizedlist> + <para> + Les associations par clef primaire ne n�cessitent pas une colonne suppl�mentaire en table ; si deux lignes sont + li�s par l'association alors les deux lignes de la table partagent la m�me valeur de clef primaire. Donc si vous + voulez que deux objets soient li�s par une association par clef primaire, vous devez faire en sorte qu'on leur + assigne la m�me valeur d'identifiant ! + </para> + <para> + Pour une association par clef primaire, ajoutez les mappings suivants � <literal>Employee</literal> et + <literal>Person</literal>, respectivement. + </para> + <programlisting><![CDATA[<one-to-one name="person" class="Person"/>]]></programlisting> + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" constrained="true"/>]]></programlisting> + <para> + Maintenant, vous devez faire en sorte que les clefs primaires des lignes li�es dans les tables PERSON et EMPLOYEE + sont �gales. On utilise une strat�gie Hibernate sp�ciale de g�n�ration d'identifiants appel�e + <literal>foreign</literal> : + </para> + <programlisting><![CDATA[<class name="person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="foreign"> + <param name="property">employee</param> + </generator> + </id> + ... + <one-to-one name="employee" + class="Employee" + constrained="true"/> +</class>]]></programlisting> + <para> + Une instance fra�chement enregistr�e de <literal>Person</literal> se voit alors assign�e la m�me valeur + de clef primaire que l'instance de <literal>Employee</literal> r�f�renc�e par la propri�t� <literal>employee</literal> + de cette <literal>Person</literal>. + </para> + <para> + Alternativement, une clef �trang�re avec contrainte d'unicit� de <literal>Employee</literal> vers + <literal>Person</literal> peut �tre indiqu�e ainsi : + </para> + <programlisting><![CDATA[<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>]]></programlisting> + <para> + Et cette association peut �tre rendue bidirectionnelle en ajoutant ceci au mapping de <literal>Person</literal> : + </para> + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" property-ref="person"/>]]></programlisting> + </sect2> + + <sect2 id="mapping-declaration-naturalid"> + <title>natural-id</title> + + <programlisting><![CDATA[<natural-id mutable="true|false"/> + <property ... /> + <many-to-one ... /> + ...... +</natural-id>]]></programlisting> + + <para> + Bien que nous recommandions l'utilisation de cl� primaire g�n�r�e, vous devriez toujours + essayer d'identifier des cl� m�tier (naturelles) pour toutes vos entit�s. Une cl� naturelle + est une propri�t� ou une combinaison de propri�t�s uniques et non nulles. Si elle est aussi + immuable, c'est encore mieux. Mappez les propri�t�s de la cl� naturelle dans l'�l�ment + <literal><natural-id></literal>. Hibernate g�n�rera la cl� unique n�cessaire et les contraintes + de non-nullit�, et votre mapping s'auto-documentera. + </para> + + <para> + Nous vous recommandons fortement d'impl�menter <literal>equals()</literal> et + <literal>hashCode()</literal> pour comparer les cl�s naturelles de l'entit�. + </para> + + <para> + Ce mapping n'est pas destin� � �tre utilis� avec des entit�s qui ont des cl�s naturelles. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mutable</literal> (optionel, par d�faut � <literal>false</literal>) : + Par d�faut, les identifiants naturels sont suppos�s �tre immuable (constants). + </para> + </listitem> + </itemizedlist> + + </sect2> + <sect2 id="mapping-declaration-component" revision="2"> + <title>component, dynamic-component</title> + <para> + L'�l�ment <literal><component></literal> mappe les propri�t�s d'un objet fils + aux colonnes d'une classe parente. Les composants peuvent en retour d�clarer leurs propres + propri�t�s, composants ou collections. Voir "Components" plus bas. + </para> + <programlistingco> + <areaspec> + <area id="component1" coords="2 45"/> + <area id="component2" coords="3 45"/> + <area id="component3" coords="4 45"/> + <area id="component4" coords="5 45"/> + <area id="component5" coords="6 45"/> + <area id="component6" coords="7 45"/> + <area id="component7" coords="8 45"/> + <area id="component8" coords="9 45"/> + </areaspec> + <programlisting><![CDATA[<component + name="propertyName" + class="className" + insert="true|false" + update="true|false" + access="field|property|ClassName" + lazy="true|false" + optimistic-lock="true|false" + unique="true|false" +> + + <property ...../> + <many-to-one .... /> + ........ +</component>]]></programlisting> + <calloutlist> + <callout arearefs="component1"> + <para> + <literal>name</literal> : Nom de la propri�t� + </para> + </callout> + <callout arearefs="component2"> + <para> + <literal>class</literal> (optionnel - par d�faut au type de la propri�t� d�termin� par r�flexion) : + le nom de la classe (fille) du composant. + </para> + </callout> + <callout arearefs="component3"> + <para> + <literal>insert</literal> : Est ce que les colonnes mapp�es apparaissent dans les + <literal>INSERT</literal>s ? + </para> + </callout> + <callout arearefs="component4"> + <para> + <literal>update</literal>: Est ce que les colonnes mapp�es apparaissent dans les + <literal>UPDATE</literal>s ? + </para> + </callout> + <callout arearefs="component5"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>) : + La strat�gie que Hibernate doit utiliser pour acc�der � la valeur de cette propri�t�. + </para> + </callout> + <callout arearefs="component6"> + <para> + <literal>lazy</literal> (optionnel - par d�faut � <literal>false</literal>) : + Indique que ce composant doit �tre charg� au premier acc�s + � la variable d'instance (n�cessite une instrumentation du bytecode au moment du build). + </para> + </callout> + <callout arearefs="component7"> + <para> + <literal>optimistic-lock</literal> (optionnel - par d�faut � <literal>true</literal>) : + Indique que les mises � jour sur ce composant n�cessitent ou non l'acquisition d'un + verrou optimiste. En d'autres termes, cela d�termine si une incr�mentation de version + doit avoir lieu quand la propri�t� est marqu�e obsol�te (dirty). + </para> + </callout> + <callout arearefs="component8"> + <para> + <literal>unique</literal> (optionnel - par d�faut � <literal>false</literal>) : + Indique qu'une contrainte d'unicit� existe sur toutes les colonnes mapp�es de ce composant. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Les tags fils <literal><property></literal> mappent les propri�t�s + de la classe fille sur les colonnes de la table. + </para> + <para> + L'�l�ment <literal><component></literal> permet de d�clarer sous-�l�ment <literal><parent></literal> qui associe une propri�t� + de la classe composant comme une r�f�rence arri�re vers l'entit� contenante. + </para> + <para> + L'�l�ment <literal><dynamic-component></literal> permet � une <literal>Map</literal> d'�tre mapp�e + comme un composant, quand les noms de la propri�t� font r�f�rence aux clefs de cette Map, voir + <xref linkend="components-dynamic"/>. + </para> + </sect2> + <sect2 id="mapping-declaration-properties" revision="2"> + <title>properties</title> + <para> + L'�l�ment <literal><properties></literal> permet la d�finition d'un groupement logique nomm� + des propri�t�s d'une classe. L'utilisation la plus importante de cette construction est la possibilit� + pour une combinaison de propri�t�s d'�tre la cible d'un <literal>property-ref</literal>. C'est aussi + un moyen pratique de d�finir une contrainte d'unicit� multi-colonnes. + </para> + <programlistingco> + <areaspec> + <area id="properties1" coords="2 45"/> + <area id="properties2" coords="3 45"/> + <area id="properties3" coords="4 45"/> + <area id="properties4" coords="5 45"/> + <area id="properties5" coords="6 45"/> + </areaspec> + <programlisting><![CDATA[<properties + name="logicalName" + insert="true|false" + update="true|false" + optimistic-lock="true|false" + unique="true|false" +> + + <property ...../> + <many-to-one .... /> + ........ +</properties>]]></programlisting> + <calloutlist> + <callout arearefs="properties1"> + <para> + <literal>name</literal> : Le nom logique d'un regroupement et + <emphasis>non</emphasis> le v�ritable nom d'une propri�t�. + </para> + </callout> + <callout arearefs="properties2"> + <para> + <literal>insert</literal> : Est-ce que les colonnes mapp�es apparaissent dans les + <literal>INSERT</literal>s ? + </para> + </callout> + <callout arearefs="properties3"> + <para> + <literal>update</literal> : Est-ce que les colonnes mapp�es apparaissent dans les + <literal>UPDATE</literal>s ? + </para> + </callout> + <callout arearefs="properties4"> + <para> + <literal>optimistic-lock</literal> (optionnel - par d�faut � <literal>true</literal>) : + Indique que les mises � jour sur ce composant n�cessitent ou non l'acquisition d'un + verrou optimiste. En d'autres termes, cela d�termine si une incr�mentation + de version doit avoir lieu quand la propri�t� est marqu�e obsol�te (dirty). + </para> + </callout> + <callout arearefs="properties5"> + <para> + <literal>unique</literal> (optionnel - par d�faut � <literal>false</literal>) : + Indique qu'une contrainte d'unicit� existe sur toutes les colonnes mapp�es de ce composant. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Par exemple, si nous avons le mapping de <literal><properties></literal> suivant : + </para> + <programlisting><![CDATA[<class name="Person"> + <id name="personNumber"/> + ... + <properties name="name" + unique="true" update="false"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </properties> +</class>]]></programlisting> + <para> + Alors nous pourrions avoir une association sur des donn�es d'un ancien syst�me (legacy) qui font r�f�rence + � cette clef unique de la table <literal>Person</literal> au lieu de la clef primaire : + </para> + <programlisting><![CDATA[<many-to-one name="person" + class="Person" property-ref="name"> + <column name="firstName"/> + <column name="initial"/> + <column name="lastName"/> +</many-to-one>]]></programlisting> + <para> + Nous ne recommandons pas l'utilisation de ce genre de chose en dehors du contexte de mapping de donn�es h�rit�es + d'anciens syst�mes. + </para> + </sect2> + <sect2 id="mapping-declaration-subclass" revision="4"> + <title>subclass</title> + <para> + Pour finir, la persistance polymorphique n�cessite la d�claration de chaque sous-classe de la classe persistante de base. + pour la strat�gie de mapping de type table-per-class-hierarchy, on utilise la d�claration + <literal><subclass></literal>. + </para> + <programlistingco> + <areaspec> + <area id="subclass1" coords="2 55"/> + <area id="subclass2" coords="3 55"/> + <area id="subclass3" coords="4 55"/> + <area id="subclass4" coords="5 55"/> + </areaspec> + <programlisting><![CDATA[<subclass + name="ClassName" + discriminator-value="discriminator_value" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + entity-name="EntityName" + node="element-name" + extends="SuperclassName"> + + <property .... /> + ..... +</subclass>]]></programlisting> + <calloutlist> + <callout arearefs="subclass1"> + <para> + <literal>name</literal> : Le nom complet de la sous-classe. + </para> + </callout> + <callout arearefs="subclass2"> + <para> + <literal>discriminator-value</literal> (optionnel - par d�faut le nom de la classe) : + une valeur qui distingue les diff�rentes sous-classes. + </para> + </callout> + <callout arearefs="subclass3"> + <para> + <literal>proxy</literal> (optionnel) : Indique une classe ou interface � utiliser pour les chargements + � la demande des proxies (lazy). + </para> + </callout> + <callout arearefs="subclass4"> + <para> + <literal>lazy</literal> (optionnel, par d�faut � <literal>true</literal>) : Sp�cifier + <literal>lazy="false"</literal> d�sactive l'utilisation du chargement � la demande (lazy). + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Chaque sous-classe devrait d�clarer ses propres propri�t�s persistantes et sous-classes. + Les propri�t�s <literal><version></literal> et <literal><id></literal> + sont implicitement h�rit�s de la classe de base. Chaque sous-classe dans une hi�rarchie doit + d�finir une unique <literal>discriminator-value</literal>. Si aucune n'est sp�cifi�e, + le nom complet de la classe Java est utilis�. + </para> + <para> + Pour plus d'infos sur le mapping d'h�ritage, voir <xref linkend="inheritance"/>. + </para> + <programlisting><![CDATA[ +<hibernate-mapping> + <subclass name="DomesticCat" extends="Cat" discriminator-value="D"> + <property name="name" type="string"/> + </subclass> +</hibernate-mapping>]]></programlisting> + <para> + Pour des informations sur les mappings d'h�ritage, voir <xref linkend="inheritance"/>. + </para> + </sect2> + <sect2 id="mapping-declaration-joinedsubclass" revision="3"> + <title>joined-subclass</title> + <para> + Une autre fa�on possible de faire est la suivante, chaque sous-classe peut �tre mapp�e vers sa propre table (strat�gie + de mapping de type table-per-subclass). L'�tat h�rit� est r�cup�r� en joignant la table de la super-classe. + L'�l�ment <literal><joined-subclass></literal> est utilis�. + </para> + <programlistingco> + <areaspec> + <area id="joinedsubclass1" coords="2 45"/> + <area id="joinedsubclass2" coords="3 45"/> + <area id="joinedsubclass3" coords="4 45"/> + <area id="joinedsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<joined-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName"> + + <key .... > + + <property .... /> + ..... +</joined-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="joinedsubclass1"> + <para> + <literal>name</literal> : Le nom Java complet de la sous-classe. + </para> + </callout> + <callout arearefs="joinedsubclass2"> + <para> + <literal>table</literal> : Le nom de la table de la sous-classe. + </para> + </callout> + <callout arearefs="joinedsubclass3"> + <para> + <literal>proxy</literal> (optionnel) : Indique une classe ou interface pour le chargement diff�r� des proxies. + </para> + </callout> + <callout arearefs="joinedsubclass4"> + <para> + <literal>lazy</literal> (optionnel, par d�faut � <literal>true</literal>) : Indiquer + <literal>lazy="false"</literal> d�sactive l'utilisation du chargement � la demande. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Aucune colonne discriminante n'est n�cessaire pour cette strat�gie de mapping. Cependant, + chaque sous-classe doit d�clarer une colonne de table contenant l'objet identifiant qui utilise l'�l�ment + <literal><key></literal>. Le mapping au d�but de ce chapitre serait r�-�crit ainsi : + </para> + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" table="CATS"> + <id name="id" column="uid" type="long"> + <generator class="hilo"/> + </id> + <property name="birthdate" type="date"/> + <property name="color" not-null="true"/> + <property name="sex" not-null="true"/> + <property name="weight"/> + <many-to-one name="mate"/> + <set name="kittens"> + <key column="MOTHER"/> + <one-to-many class="Cat"/> + </set> + <joined-subclass name="DomesticCat" table="DOMESTIC_CATS"> + <key column="CAT"/> + <property name="name" type="string"/> + </joined-subclass> + </class> + + <class name="eg.Dog"> +  + </class> + +</hibernate-mapping>]]></programlisting> + <para> + Pour des informations sur les mappings d'h�ritage, voir <xref linkend="inheritance"/>. + </para> + </sect2> + <sect2 id="mapping-declaration-unionsubclass" revision="2"> + <title>union-subclass</title> + <para> + Une troisi�me option est de seulement mapper vers des tables les classes concr�tes + d'une hi�rarchie d'h�ritage, (strat�gie de type table-per-concrete-class) o� + chaque table d�finit tous les �tats persistants de la classe, y compris les �tats h�rit�s. + Dans Hibernate il n'est absolument pas n�cessaire de mapper explicitement de telles hi�rarchies + d'h�ritage. Vous pouvez simplement mapper chaque classe avec une d�claration <literal><class></literal> + diff�rente. Cependant, si vous souhaitez utiliser des associations polymorphiques (c�d une association + vers la superclasse de la hi�rarchie), vous devez utiliser le mapping <literal><union-subclass></literal>. + </para> + <programlistingco> + <areaspec> + <area id="unionsubclass1" coords="2 45"/> + <area id="unionsubclass2" coords="3 45"/> + <area id="unionsubclass3" coords="4 45"/> + <area id="unionsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<union-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + abstract="true|false" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName"> + + <property .... /> + ..... +</union-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="unionsubclass1"> + <para> + <literal>name</literal> : Le nom Java complet de la sous-classe. + </para> + </callout> + <callout arearefs="unionsubclass2"> + <para> + <literal>table</literal> : nom de la table de la sous-classe. + </para> + </callout> + <callout arearefs="unionsubclass3"> + <para> + <literal>proxy</literal> (optionnel) : Indique une classe ou interface pour le chargement diff�r� des proxies. + </para> + </callout> + <callout arearefs="unionsubclass4"> + <para> + <literal>lazy</literal> (optionnel, par d�faut � <literal>true</literal>) : Indiquer + <literal>lazy="false"</literal> d�sactive l'utilisation du chargement � la demande. + </para> + + </callout> + </calloutlist> + </programlistingco> + <para> + Aucune colonne discriminante ou colonne clef n'est requise pour cette strat�gie de mapping. + </para> + <para> + Pour des informations sur les mappings d'h�ritage, voir <xref linkend="inheritance"/>. + </para> + </sect2> + <sect2 id="mapping-declaration-join" revision="3"> + <title>join</title> + <para> + En utilisant l'�l�ment <literal><join></literal>, il est possible de mapper + des propri�t�s d'une classe sur plusieurs tables. + </para> + <programlistingco> + <areaspec> + <area id="join1" coords="2 50"/> + <area id="join2" coords="3 50"/> + <area id="join3" coords="4 50"/> + <area id="join4" coords="5 50"/> + <area id="join5" coords="6 50"/> + <area id="join6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<join + table="tablename" + schema="owner" + catalog="catalog" + fetch="join|select" + inverse="true|false" + optionnel="true|false"> + + <key ... /> + + <property ... /> + ... +</join>]]></programlisting> + <calloutlist> + <callout arearefs="join1"> + <para> + <literal>table</literal> : Le nom de la table jointe. + </para> + </callout> + <callout arearefs="join2"> + <para> + <literal>schema</literal> (optionnel) : court-circuite le nom de sch�ma sp�cifi� par l'�l�ment de base + <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="join3"> + <para> + <literal>catalog</literal> (optionnel) : court-circuite le nom de catalogue sp�cifi� par l'�l�ment de base + <literal><hibernate-mapping></literal>. + </para> + </callout> + <callout arearefs="join4"> + <para> + <literal>fetch</literal> (optionnel - par d�faut � <literal>join</literal>) : + Si positionn� � <literal>join</literal>, Hibernate utilisera une jointure interne pour charger + une <literal>jointure</literal> d�finie par une classe ou ses super-classes et une jointure externe + pour une <literal><jointure></literal> d�finie par une sous-classe. + Si positionn� � <literal>select</literal> alors Hibernate utilisera un select s�quentiel + pour une <literal><jointure></literal> d�finie sur une sous-classe, qui ne sera d�livr�e que + si une ligne se repr�sente une instance de la sous-classe. Les jointures internes seront quand m�me + utilis�es pour charger une <literal><jointure></literal> d�finie par une classe et ses super-classes. + </para> + </callout> + <callout arearefs="join5"> + <para> + <literal>inverse</literal> (optionnel - par d�faut � <literal>false</literal>) : + Si positionn� � true, Hibernate n'essaiera pas d'ins�rer ou de mettre � jour les + propri�t�s d�finies par cette jointure. + </para> + </callout> + <callout arearefs="join6"> + <para> + <literal>optionnel</literal> (optionnel - par d�faut � <literal>false</literal>) : + Si positionn� � true, Hibernate ins�rera une ligne seulement si les propri�t�s d�finies + par cette jointure sont non-nulles et utilisera toujours une jointure externe pour charger les propri�t�s. + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Par exemple, les informations d'adresse pour une personne peuvent �tre mapp�es vers une table + s�par�e (tout en pr�servant des s�mantiques de type valeur pour toutes ses propri�t�s) : + </para> + <programlisting><![CDATA[<class name="Person" + table="PERSON"> + + <id name="id" column="PERSON_ID">...</id> + + <join table="ADDRESS"> + <key column="ADDRESS_ID"/> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </join> + ...]]></programlisting> + <para> + Cette fonctionnalit� est souvent seulement utile pour les mod�les de donn�es + h�rit�s d'anciens syst�mes (legacy), nous recommandons d'utiliser moins de tables que de classes + et un mod�le de domaine � granularit� fine. Cependant, c'est utile + pour passer d'une strat�gie de mapping d'h�ritage � une autre dans une hi�rarchie simple ainsi qu'il est + expliqu� plus tard. + </para> + </sect2> + <sect2 id="mapping-declaration-key"> + <title>key</title> + <para> + Nous avons rencontr� l'�l�ment <literal><key></literal> � plusieurs reprises maintenant. + Il appara�t partout que l'�l�ment de mapping parent d�finit une jointure sur une nouvele table, et + d�finit la clef �trang�re dans la table jointe, ce qui r�f�rence la clef primaire de la table d'origine. + </para> + <programlistingco> + <areaspec> + <area id="key1" coords="2 50"/> + <area id="key2" coords="3 50"/> + <area id="key3" coords="4 50"/> + <area id="key4" coords="5 50"/> + <area id="key5" coords="6 50"/> + <area id="key6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<key + column="columnname" + on-delete="noaction|cascade" + property-ref="propertyName" + not-null="true|false" + update="true|false" + unique="true|false" +/>]]></programlisting> + <calloutlist> + <callout arearefs="key1"> + <para> + <literal>column</literal> (optionnel) : Le nom de la colonne de la clef �trang�re + Cela peut aussi �tre sp�cifi� par l'�l�ment(s) int�gr�(s) <literal><column></literal>. + </para> + </callout> + <callout arearefs="key2"> + <para> + <literal>on-delete</literal> (optionnel, par d�faut � <literal>noaction</literal>) : + Indique si la contrainte de clef �trang�re poss�de la possibilit� au niveau base de donn�es + de suppression en cascade. + </para> + </callout> + <callout arearefs="key3"> + <para> + <literal>property-ref</literal> (optionnel) : Indique que la clef �trang�re fait + r�f�rence � des colonnes qui ne sont pas la clef primaire de la table d'origine + (Pour les donn�es de syst�mes legacy). + </para> + </callout> + <callout arearefs="key4"> + <para> + <literal>not-null</literal> (optionnel) : Indique que les colonnes des clefs �trang�res ne + peuvent pas �tre nulles (c'est implicite si la clef �trang�re fait partie de la clef primaire). + </para> + </callout> + <callout arearefs="key5"> + <para> + <literal>update</literal> (optionnel) : Indique que la clef �trang�re ne devrait jamais �tre mise � jour + (implicite si celle-ci fait partie de la clef primaire). + </para> + </callout> + <callout arearefs="key6"> + <para> + <literal>unique</literal> (optionnel) : Indique que la clef �trang�re doit poss�der une contrainte + d'unicit� (implicite si la clef �trang�re est aussi la clef primaire). + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Nous recommandons pour les syst�mes o� les suppressions doivent �tre performantes de d�finir toutes + les clefs <literal>on-delete="cascade"</literal>, ainsi Hibernate utilisera une contrainte + <literal>ON CASCADE DELETE</literal> au niveau base de donn�es, plut�t que de nombreux + <literal>DELETE</literal> individuels. Attention, cette fonctionnalit� court-circuite la strat�gie + habituelle de verrou optimiste pour les donn�es versionn�es. + </para> + <para> + Les attributs <literal>not-null</literal> et <literal>update</literal> sont utiles pour + mapper une association one-to-many unidirectionnelle. Si vous mappez un one-to-many unidirectionnel + vers une clef �trang�re non nulle, vous <emphasis>devez</emphasis> d�clarer la colonne de la clef + en utilisant <literal><key not-null="true"></literal>. + </para> + </sect2> + <sect2 id="mapping-column" revision="4"> + <title>�l�ments column et formula</title> + <para> + Tout �l�ment de mapping qui accepte un attribut <literal>column</literal> acceptera alternativement + un sous-�l�ment <literal><column></literal>. De fa�on identique, <literal><formula></literal> + est une alternative � l'attribut <literal>formula</literal>. + </para> + <programlisting><![CDATA[<column + name="column_name" + length="N" + precision="N" + scale="N" + not-null="true|false" + unique="true|false" + unique-key="multicolumn_unique_key_name" + index="index_name" + sql-type="sql_type_name" + check="SQL expression"/>]]></programlisting> + <programlisting><![CDATA[<formula>SQL expression</formula>]]></programlisting> + <para> + Les attributs <literal>column</literal> et <literal>formula</literal> peuvent m�me �tre combin�s + au sein d'une m�me propri�t� ou mapping d'association pour exprimer, par exemple, des conditions + de jointure exotiques. + </para> + <programlisting><![CDATA[<many-to-one name="homeAddress" class="Address" + insert="false" update="false"> + <column name="person_id" not-null="true" length="10"/> + <formula>'MAILING'</formula> +</many-to-one>]]></programlisting> + </sect2> + <sect2 id="mapping-declaration-import"> + <title>import</title> + <para> + Supposez que votre application poss�de deux classes persistantes du m�me nom, et vous ne voulez pas pr�ciser + le nom Java complet (packages inclus) dans les queries Hibernate. Les classes peuvent alors �tre "import�es" + explicitement plut�t que de compter sur <literal>auto-import="true"</literal>.Vous pouvez m�me importer + des classes et interfaces qui ne sont pas mapp�es explicitement. + </para> + <programlisting><![CDATA[<import class="java.lang.Object" rename="Universe"/>]]></programlisting> + <programlistingco> + <areaspec> + <area id="import1" coords="2 40"/> + <area id="import2" coords="3 40"/> + </areaspec> + <programlisting><![CDATA[<import + class="ClassName" + rename="ShortName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="import1"> + <para> + <literal>class</literal> : Nom Java complet de la classe. + </para> + </callout> + <callout arearefs="import2"> + <para> + <literal>rename</literal> (optionnel - par d�faut vaut le nom de la classe Java (sans package)) : + Nom pouvant �tre utilis� dans le langage de requ�te. + </para> + </callout> + </calloutlist> + </programlistingco> + </sect2> + <sect2 id="mapping-types-anymapping" revision="2"> + <title>any</title> + <para> + Il existe encore un type de mapping de propri�t�. L'�l�ment de mapping <literal><any></literal> + d�finit une association polymorphique vers des classes de tables multiples. Ce type de mapping requiert + toujours plus d'une colonne. La premi�re colonne contient le type de l'entit� associ�e. Les colonnes + restantes contiennent l'identifiant. il est impossible de sp�cifier une contrainte de clef �trang�re + pour ce type d'association, donc ce n'est certainement pas consid�r� comme le moyen habituel de mapper + des associations (polymorphiques). Vous devriez utiliser cela uniquement dans des cas particuliers + (par exemple des logs d'audit, des donn�es de session utilisateur, etc...). + </para> + <para> + L'attribut <literal>meta-type</literal> permet � l'application de sp�cifier un type personnalis� qui mappe + des valeurs de colonnes de le base de donn�es sur des classes persistantes qui ont un attribut identifiant + du type sp�cifi� par <literal>id-type</literal>. Vous devez sp�cifier le mapping � partir de valeurs du + m�ta-type sur les noms des classes. + </para> + <programlisting><![CDATA[<any name="being" id-type="long" meta-type="string"> + <meta-value value="TBL_ANIMAL" class="Animal"/> + <meta-value value="TBL_HUMAN" class="Human"/> + <meta-value value="TBL_ALIEN" class="Alien"/> + <column name="table_name"/> + <column name="id"/> +</any>]]></programlisting> + <programlistingco> + <areaspec> + <area id="any1" coords="2 50"/> + <area id="any2" coords="3 50"/> + <area id="any3" coords="4 50"/> + <area id="any4" coords="5 50"/> + <area id="any5" coords="6 50"/> + <area id="any6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<any + name="propertyName" + id-type="idtypename" + meta-type="metatypename" + cascade="cascade_style" + access="field|property|ClassName" + optimistic-lock="true|false" +> + <meta-value ... /> + <meta-value ... /> + ..... + <column .... /> + <column .... /> + ..... +</any>]]></programlisting> + <calloutlist> + <callout arearefs="any1"> + <para> + <literal>name</literal> : le nom de la propri�t�. + </para> + </callout> + <callout arearefs="any2"> + <para> + <literal>id-type</literal> : le type identifiant. + </para> + </callout> + <callout arearefs="any3"> + <para> + <literal>meta-type</literal> (optionnel - par d�faut � <literal>string</literal>) : + Tout type permis pour un mapping par discriminateur. + </para> + </callout> + <callout arearefs="any4"> + <para> + <literal>cascade</literal> (optionnel - par d�faut � <literal>none</literal>) : + le style de cascade. + </para> + </callout> + <callout arearefs="any5"> + <para> + <literal>access</literal> (optionnel - par d�faut � <literal>property</literal>) : La strat�gie + � utiliser par Hibernate pour acc�der � cette propri�t�. + </para> + </callout> + <callout arearefs="any6"> + <para> + <literal>optimistic-lock</literal> (optionnel - par d�faut � <literal>true</literal>) : + Indique que les mises � jour sur cette propri�t� n�cessitent ou non l'acquisition d'un + verrou optimiste. En d'autres termes, d�finit si un incr�ment de version doit avoir lieu + quand cette propri�t� est marqu�e dirty. + </para> + </callout> + </calloutlist> + </programlistingco> + </sect2> + </sect1> + <sect1 id="mapping-types"> + <title>Hibernate Types</title> + <sect2 id="mapping-types-entitiesvalues" revision="1"> + <title>Entit�s et valeurs</title> + <para> + Pour comprendre le comportement des diff�rents objets Java par rapport au service + de persistance, nous avons besoin de les classer en deux groupes : + </para> + <para> + Une <emphasis>entit�</emphasis> existe ind�pendamment de tout autre objet poss�dant + une r�f�rence vers l'entit�. Comparez cela avec le mod�le Java habituel o� un objet + est supprim� par le garbage collector d�s qu'il n'est plus r�f�renc�. Les entit�s + doivent �tre explicitement enregistr�es et supprim�es (sauf dans les cas o� + sauvegardes et suppressions sont <emphasis>cascad�es</emphasis> d'une entit� m�re + vers ses enfants). C'est diff�rent du mod�le ODMG de persistance par + atteignabilit� - et correspond mieux � la fa�on dont les objets sont + habituellement utilis�s dans des grands syst�mes. Les entit�s permettent les r�f�rences + circulaires et partag�es. Elles peuvent aussi �tre versionn�es. + </para> + <para> + L'�tat persistant d'une entit� consiste en des r�f�rences vers d'autres entit�s et + instances de types <emphasis>valeurs</emphasis>. Ces valeurs sont des types primitifs, + des collections (et non le contenu d'une collection), des composants de certains objets + immuables. Contrairement aux entit�s, les valeurs (et en particulier les collections et + composants) <emphasis>sont</emphasis> persist�s par atteignabiliit�. Comme les + valeurs (et types primitifs) sont persist�s et supprim�s avec l'entit� qui les contient, + ils ne peuvent pas poss�der leurs propres versions. Les valeurs n'ont pas d'identit� + ind�pendantes, ainsi elles ne peuvent pas �tre partag�es par deux entit�s ou collections. + </para> + <para> + Jusqu'� pr�sent nous avons utilis� le terme "classe persistante" pour parler d'entit�s. + Nous allons continuer � faire ainsi. Cependant, au sens strict, toutes + les classes d�finies par un utilisateur poss�dant un �tat persistant ne sont pas des + entit�s. Un <emphasis>composant</emphasis> est une classe d�finie par un utilisateur + avec les caract�ristiques d'une valeur. Une propri�t� Java de type <literal>java.lang.String</literal> + a aussi les caract�ristiques d'une valeur. + +  + + Given this definition, we can say that all types (classes) provided + by the JDK have value type semantics in Java, while user-defined types may + be mapped with entity or value type semantics. This decision is up to the + application developer. A good hint for an entity class in a domain model are + shared references to a single instance of that class, while composition or + aggregation usually translates to a value type. + </para> + <para> + Nous nous pencherons sur ces deux concepts tout au long de la documentation. + </para> + <para> + Le d�fi est de mapper les type Javas (et la d�finition des d�veloppeurs des + entit�s et valeurs types) sur les types du SQL ou des bases de donn�es. Le pont + entre les deux syst�mes est propos� par Hibernate : pour les entit�s nous utilisons + <literal><class></literal>, <literal><subclass></literal> et ainsi de suite. + Pour les types valeurs nous utilisons <literal><property></literal>, + <literal><component></literal>, etc., habituellement avec un attribut <literal>type</literal>. + La valeur de cet attribut est le nom d'un <emphasis>type de mapping</emphasis> Hibernate. + Hibernate propose de base de nombreux mappings (pour les types de valeurs standards du JDK). + Vous pouvez �crire vos propres types de mappings et impl�menter aussi vos propres strat�gies + de conversion, nous le verrons plus tard. + </para> + <para> + Tous les types propos�s de base par Hibernate � part les collections autorisent la valeur null. + </para> + </sect2> + <sect2 id="mapping-types-basictypes" revision="3"> + <title>Basic value types</title> + <para> + Les <emphasis>types basiques de mapping</emphasis> propos�s de base peuvent grossi�rement �tre + rang�s dans les cat�gories suivantes : + <variablelist> + <varlistentry> + <term> + <literal>integer, long, short, float, double, character, byte, + boolean, yes_no, true_false</literal> + </term> + <listitem> + <para> + Les mappings de type des primitives Java ou leurs classes wrappers (ex: Integer + pour int) vers les types SQL (propri�taires) appropri�s. <literal>boolean, + yes_no</literal>et <literal>true_false</literal> sont tous des alternatives + pour les types Java <literal>boolean</literal> ou <literal>java.lang.Boolean</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>string</literal> + </term> + <listitem> + <para> + Mapping de type de <literal>java.lang.String</literal> vers + <literal>VARCHAR</literal> (ou le <literal>VARCHAR2</literal> Oracle). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>date, time, timestamp</literal> + </term> + <listitem> + <para> + Mappings de type pour <literal>java.util.Date</literal> et ses sous-classes + vers les types SQL <literal>DATE</literal>, <literal>TIME</literal> et + <literal>TIMESTAMP</literal> (ou �quivalent). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>calendar, calendar_date</literal> + </term> + <listitem> + <para> + Mappings de type pour <literal>java.util.Calendar</literal> vers les types SQL + <literal>TIMESTAMP</literal> et <literal>DATE</literal> + (ou �quivalent). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>big_decimal, big_integer</literal> + </term> + <listitem> + <para> + Mappings de type pour <literal>java.math.BigDecimal</literal> et + <literal>java.math.BigInteger</literal> vers <literal>NUMERIC</literal> + (ou le <literal>NUMBER</literal> Oracle). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>locale, timezone, currency</literal> + </term> + <listitem> + <para> + Mappings de type pour <literal>java.util.Locale</literal>, + <literal>java.util.TimeZone</literal> et + <literal>java.util.Currency</literal> + vers <literal>VARCHAR</literal> (ou le <literal>VARCHAR2</literal> Oracle). + Les instances de <literal>Locale</literal> et <literal>Currency</literal> sont + mapp�es sur leurs codes ISO. Les instances de <literal>TimeZone</literal> sont + mapp�es sur leur <literal>ID</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>class</literal> + </term> + <listitem> + <para> + Un type de mapping pour <literal>java.lang.Class</literal> vers + <literal>VARCHAR</literal> (ou le <literal>VARCHAR2</literal> Oracle). + Un objet <literal>Class</literal> est mapp� sur son nom Java complet. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>binary</literal> + </term> + <listitem> + <para> + Mappe les tableaux de bytes vers le type binaire SQL appropri�. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>text</literal> + </term> + <listitem> + <para> + Mappe les longues cha�nes de caract�res Java vers les types SQL + <literal>CLOB</literal> ou <literal>TEXT</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>serializable</literal> + </term> + <listitem> + <para> + Mappe les types Java s�rialisables vers le type SQL binaire appropri�. Vous pouvez + aussi indiquer le type Hibernate <literal>serializable</literal> avec le nom + d'une classe Java s�rialisable ou une interface qui ne soit pas par d�faut un type de base. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>clob, blob</literal> + </term> + <listitem> + <para> + Mappings de type pour les classes JDBC <literal>java.sql.Clob</literal> and + <literal>java.sql.Blob</literal>. Ces types peuvent ne pas convenir pour certaines + applications car un objet blob ou clob peut ne pas �tre r�utilisable en dehors + d'une transaction (de plus l'impl�mentation par les pilotes est moyennement bonne). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>imm_date, imm_time, imm_timestamp, imm_calendar, imm_calendar_date, + imm_serializable, imm_binary</literal> + </term> + <listitem> + <para> + Mappings de type pour ceux qui sont habituellement modifiable, pour lesquels + Hibernate effectue certains optimisations convenant seulement aux types Java immuables, + et l'application les traite comme immuable. + Par exemple, vous ne devriez pas appeler <literal>Date.setTime()</literal> sur une instance + mapp�e sur un <literal>imm_timestamp</literal>. Pour changer la valeur + de la propri�t�, et faire que cette modification soit persist�e, l'application + doit assigner un nouvel (non identique) objet � la propri�t�. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Les identifiants uniques des entit�s et collections peuvent �tre de n'importe quel type de base except� + <literal>binary</literal>, <literal>blob</literal> et <literal>clob</literal> (les identifiants + composites sont aussi permis, voir plus bas). + </para> + <para> + Les types de base des valeurs ont des <literal>Type</literal> constants correspondants d�finis + dans <literal>org.hibernate.Hibernate</literal>. Par exemple, <literal>Hibernate.STRING</literal> + repr�sent� le type <literal>string</literal>. + </para> + </sect2> + <sect2 id="mapping-types-custom" revision="2"> + <title>Types de valeur d�finis par l'utilisateur</title> + <para> + Il est assez facile pour les d�veloppeurs de cr�er leurs propres types de valeurs. Par exemple, + vous pourriez vouloir persister des propri�t�s du type <literal>java.lang.BigInteger</literal> + dans des colonnnes <literal>VARCHAR</literal>. Hibernate ne procure pas par d�faut un type pour cela. + Mais les types que vous pouvez cr�er ne se limitent pas � mapper des propri�t�s (ou �l�ment collection) + � une simple colonne d'une table. Donc, par exemple, vous pourriez avoir une propri�t� Java + <literal>getName()</literal>/<literal>setName()</literal> de type + <literal>java.lang.String</literal> persist�e dans les colonnes + <literal>FIRST_NAME</literal>, <literal>INITIAL</literal>, <literal>SURNAME</literal>. + </para> + <para> + Pour impl�menter votre propre type, vous pouvez soit impl�menter <literal>org.hibernate.UserType</literal> + soit <literal>org.hibernate.CompositeUserType</literal> et d�clarer des propri�t�s utilisant des + noms de classes complets du type. Regardez <literal>org.hibernate.test.DoubleStringType</literal> + pour voir ce qu'il est possible de faire. + </para> + <programlisting><![CDATA[<property name="twoStrings" type="org.hibernate.test.DoubleStringType"> + <column name="first_string"/> + <column name="second_string"/> +</property>]]></programlisting> + <para> + Remarquez l'utilisation des tags <literal><column></literal> pour mapper une propri�t� sur des colonnes + multiples. + </para> + <para> + Les interfaces <literal>CompositeUserType</literal>, <literal>EnhancedUserType</literal>, + <literal>UserCollectionType</literal>, et <literal>UserVersionType</literal> permettent des utilisations + plus sp�cialis�es. + </para> + <para> + Vous pouvez m�me donner des param�tres en indiquant <literal>UserType</literal> dans le fichier + de mapping ; Pour cela, votre <literal>UserType</literal> doit impl�menter l'interface + <literal>org.hibernate.usertype.ParameterizedType</literal>. Pour sp�cifier des param�tres dans + votre type propre, vous pouvez utiliser l'�l�ment <literal><type></literal> dans vos fichiers de mapping. + </para> + <programlisting><![CDATA[<property name="priority"> + <type name="com.mycompany.usertypes.DefaultValueIntegerType"> + <param name="default">0</param> + </type> +</property>]]></programlisting> + <para> + Le <literal>UserType</literal> permet maintenant de r�cup�rer la valeur pour le param�tre nomm� + <literal>default</literal> � partir de l'objet <literal>Properties</literal> qui lui est pass�. + </para> + <para> + Si vous utilisez fr�quemment un <literal>UserType</literal>, cela peut �tre utile de lui d�finir un + nom plus court. Vous pouvez faire cela en utilisant l'�l�ment <literal><typedef></literal>. + Les typedefs permettent d'assigner un nom � votre type propre et peuvent aussi contenir une liste de + valeurs de param�tres par d�faut si ce type est param�tr�. + </para> + <programlisting><![CDATA[<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero"> + <param name="default">0</param> +</typedef>]]></programlisting> + <programlisting><![CDATA[<property name="priority" type="default_zero"/>]]></programlisting> + <para> + Il est aussi possible de red�finir les param�tres par d�faut du typedef au cas par cas en + utilisant des param�tres type sur le mapping de la propri�t�. + </para> + <para> + Bien que le fait que Hibernate propose de base une riche vari�t� de types, et qu'il supporte les composants + signifie que vous aurez tr�s rarement <emphasis>besoin</emphasis> d'utiliser un nouveau type propre, + il est n�anmoins de bonne pratique d'utiliser des types propres pour les classes (non entit�s) qui + apparaissent fr�quemment dans votre application. Par exemple une classe <literal>MonetaryAmount</literal> + est un bon candidat pour un <literal>CompositeUserType</literal> m�me s'il pourrait facilement + �tre mapp� comme un composant. Une motivation pour cela est l'abstraction. Avec un type propre + vos documents de mapping sont � l'abri des changements futurs dans votre fa�on de repr�senter des + valeurs mon�taires. + </para> + </sect2> + </sect1> + + <sect1 id="mapping-entityname"> + <title>Mapper une classe plus d'une fois</title> + <para> + Il est possible de proposer plus d'un mapping par classe persistante. Dans ce cas, vous + devez sp�cifier un <emphasis>nom d'entit�</emphasis> pour lever l'ambiguit� entre les instances + des entit�s mapp�es (par d�faut, le nom de l'entit� est celui de la classe). Hibernate + vous permet de sp�cifier le nom de l'entit� lorsque vous utilisez des objets persistants, lorsque + vous �crivez des requ�tes ou quand vous mappez des associations vers les entit�s nomm�es. + </para> + + <programlisting><![CDATA[<class name="Contract" table="Contracts" + entity-name="CurrentContract"> + ... + <set name="history" inverse="true" + order-by="effectiveEndDate desc"> + <key column="currentContractId"/> + <one-to-many entity-name="HistoricalContract"/> + </set> +</class> + +<class name="Contract" table="ContractHistory" + entity-name="HistoricalContract"> + ... + <many-to-one name="currentContract" + column="currentContractId" + entity-name="CurrentContract"/> +</class>]]></programlisting> + + <para> + Remarquez comment les associations sont d�sormais sp�cifi�es en utilisant + <literal>entity-name</literal> au lieu de <literal>class</literal>. + </para> + + </sect1> + + <sect1 id="mapping-quotedidentifiers"> + <title>SQL quoted identifiers</title> + <para> + Vous pouvez forcer Hibernate � mettre un identifiant entre quotes dans le SQL g�n�r� en mettant le nom + de la table ou de la colonne entre backticks dans le + document de mapping. Hibernate utilisera les bons styles de quotes pour le <literal>Dialect</literal> SQL + (habituellement des doubles quotes, mais des parenth�ses pour SQL server et des backticks pour MySQL). + </para> + <programlisting><![CDATA[<class name="LineItem" table="`Line Item`"> + <id name="id" column="`Item Id`"/><generator class="assigned"/></id> + <property name="itemNumber" column="`Item #`"/> + ... +</class>]]></programlisting> + </sect1> + <sect1 id="mapping-alternatives"> + <title>alternatives Metadata</title> + <para> + XML ne convient pas � tout le monde, il y a donc des moyens alternatifs pour d�finir des metatda + de mappings O/R dans Hibernate. + </para> + <sect2 id="mapping-xdoclet"> + <title>utilisation de XDoclet</title> + <para> + De nombreux utilisateurs de Hibernate pr�f�rent embarquer les informations de mappings + directement au sein du code source en utilisant les tags XDoclet <literal>@hibernate.tags</literal>. + Nous ne couvrons pas cette approche dans ce document cependant, puisque c'est consid�r� comme faisant partie + de XDoclet. Cependant, nous pr�sentons l'exemple suivant de la classe <literal>Cat</literal> avec + des mappings XDoclet. + </para> + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +/** + * @hibernate.class + * table="CATS" + */ +public class Cat { + private Long id; // identifier + private Date birthdate; + private Cat mother; + private Set kittens + private Color color; + private char sex; + private float weight; + + /* + * @hibernate.id + * generator-class="native" + * column="CAT_ID" + */ + public Long getId() { + return id; + } + private void setId(Long id) { + this.id=id; + } + + /** + * @hibernate.many-to-one + * column="PARENT_ID" + */ + public Cat getMother() { + return mother; + } + void setMother(Cat mother) { + this.mother = mother; + } + + /** + * @hibernate.property + * column="BIRTH_DATE" + */ + public Date getBirthdate() { + return birthdate; + } + void setBirthdate(Date date) { + birthdate = date; + } + /** + * @hibernate.property + * column="WEIGHT" + */ + public float getWeight() { + return weight; + } + void setWeight(float weight) { + this.weight = weight; + } + + /** + * @hibernate.property + * column="COLOR" + * not-null="true" + */ + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + /** + * @hibernate.set + * inverse="true" + * order-by="BIRTH_DATE" + * @hibernate.collection-key + * column="PARENT_ID" + * @hibernate.collection-one-to-many + */ + public Set getKittens() { + return kittens; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kittens.add(kitten); + } + + /** + * @hibernate.property + * column="SEX" + * not-null="true" + * update="false" + */ + public char getSex() { + return sex; + } + void setSex(char sex) { + this.sex=sex; + } +}]]></programlisting> + <para> + Voyez le site web de Hibernate pour plus d'exemples sur XDoclet et Hibernate. + </para> + </sect2> + <sect2 id="mapping-annotations" revision="2"> + <title>Utilisation des annotations JDK 5.0</title> + <para> + Le JDK 5.0 introduit des annotations proches de celles de XDoclet au niveau java, qui sont + type-safe et v�rifi�es � la compilation. Ce m�canisme est plus puissant que XDoclet et mieux + support� par les outils et IDE. IntelliJ IDEA, par exemple, supporte l'auto-compl�tion et le + surlignement syntaxique des annotations JDK 5.0. La nouvelle r�vision des sp�cifications des EJB + (JSR-220) utilise les annotations JDK 5.0 comme m�canisme primaire pour les meta-donn�es des beans entit�s. + Hibernate3 impl�mente l'<literal>EntityManager</literal> de la JSR-220 (API de persistance), + le support du mapping de meta-donn�es est disponible via le package <emphasis>Hibernate Annotations</emphasis>, + en tant que module s�par� � t�l�charger. EJB3 (JSR-220) et les m�tadata Hibernate3 sont support�s. + </para> + <para> + Ceci est un exemple d'une classe POJO annot�e comme un EJB entit� : + </para> + <programlisting><![CDATA[@Entity(access = AccessType.FIELD) +public class Customer implements Serializable { + + @Id; + Long id; + + String firstName; + String lastName; + Date birthday; + + @Transient + Integer age; + + @Embedded + private Address homeAddress; + + @OneToMany(cascade=CascadeType.ALL) + @JoinColumn(name="CUSTOMER_ID") + Set<Order> orders; + + // Getter/setter and business methods +}]]></programlisting> + <para> + Notez que le support des annotations JDK 5.0 (et de la JSR-220) est encore en cours et n'est pas termin�. + R�f�rez vous au module Hibernate Annotation pour plus de d�tails. + </para> + </sect2> + </sect1> + + <sect1 id="mapping-generated" revision="1"> + <title>Propri�t�s g�n�r�es</title> + <para> + Les propri�t�s g�n�r�es sont des propri�t�s dont les valeurs sont g�n�r�es par + la base de donn�es. Typiquement, les applications Hibernate avaient besoin d'invoquer + <literal>refresh</literal> sur les instances qui contenaient des propri�t�s pour lesquelles + la base de donn�es g�n�rait des valeurs. Marquer les propri�t�s comme g�n�r�es permet � + l'application de d�l�guer cette responsabilit� � Hibernate. Principalement, � chaque fois + qu'Hibernate r�alise une insertion ou une mise � jour en base de donn�es pour une entit� + marqu�e comme telle, cela provoque imm�diatement un select pour r�cup�rer les valeurs g�n�r�es. + </para> + <para> + Les propri�t�s marqu�es comme g�n�r�es doivent de plus ne pas �tre ins�rables et modifiables + Seuls <xref linkend="mapping-declaration-version">versions</xref>, + <xref linkend="mapping-declaration-timestamp">timestamps</xref>, et + <xref linkend="mapping-declaration-property">simple properties</xref> peuvent �tre marqu�s comme + g�n�r�es. + </para> + <para> + <literal>never</literal> (par d�faut) - indique la valeur de la propri�t� n'est pas g�n�r�e + dans la base de donn�es. + </para> + <para> + <literal>insert</literal> - indique que la valeur de la propri�t� donn�e est + g�n�r�e � l'insertion mais pas lors des futures mises � jour de l'enregistrement. + Les colonnes de type "date de cr�ation" sont le cas d'utilisation typique de cette option. + Notez que m�me les propri�t�s <xref linkend="mapping-declaration-version">version</xref> et + <xref linkend="mapping-declaration-timestamp">timestamp</xref> peuvent �tre + d�clar�es comme g�n�r�es, cette option n'est pas disponible � cet endroit... + </para> + <para> + <literal>always</literal> - indique que la valeur de la propri�t� est g�n�r�e � l'insert + comme aux updates. + </para> + + </sect1> + + <sect1 id="mapping-database-object"> + <title>Objets auxiliaires de la base de donn�es</title> + <para> + Permettent les ordres CREATE et DROP d'objets arbitraire de la base de donn��es, en conjonction avec + les outils Hibernate d'�volutions de sch�ma, pour permettre de d�finir compl�tement + un sch�ma utilisateur au sein des fichiers de mapping Hibernate. Bien que con�u sp�cifiquement + pour cr�er et supprimer des objets tels que des triggers et des proc�dures stock�es, + ou toute commande pouvant �tre ex�cut�e via une m�thode de <literal>java.sql.Statement.execute()</literal> + (ALTERs, INSERTS, etc). Il y a principalement deux modes pour d�finir les objets auxiliaires de base de donn�es... + </para> + <para> + Le premier mode est de lister explicitement les commandes CREATE et DROP dans le fichier + de mapping: + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <create>CREATE TRIGGER my_trigger ...</create> + <drop>DROP TRIGGER my_trigger</drop> + </database-object> +</hibernate-mapping>]]></programlisting> + <para> + Le second mode est de fournir une classe particuli�re qui connait comment construire + les commandes CREATE et DROP. Cette classe particuli�re doit impl�menter l'interface + <literal>org.hibernate.mapping.AuxiliaryDatabaseObject</literal>. + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <definition class="MyTriggerDefinition"/> + </database-object> +</hibernate-mapping>]]></programlisting> + <para> + Additionnellement, ces objets de base de donn�es peuvent �tre optionnellement trait�s + selon l'utilisation de dialectes particuliers.. + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <definition class="MyTriggerDefinition"/> + <dialect-scope name="org.hibernate.dialect.Oracle9Dialect"/> + <dialect-scope name="org.hibernate.dialect.OracleDialect"/> + </database-object> +</hibernate-mapping>]]></programlisting> + </sect1> +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/batch.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/batch.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/batch.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/batch.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,329 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="batch"> + <title>Traitement par paquet</title> + + <para> + Une approche na�ve pour ins�rer 100 000 lignes dans la base de donn�es en utilisant + Hibernate pourrait ressembler � �a : + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); +} +tx.commit(); +session.close();]]></programlisting> + + <para> + Ceci devrait s'�crouler avec une <literal>OutOfMemoryException</literal> quelque + part aux alentours de la 50 000�me ligne. C'est parce qu'Hibernate cache toutes + les instances de <literal>Customer</literal> nouvellement ins�r�es dans le cache + de second niveau. + </para> + + <para> + Dans ce chapitre nous montrerons comment �viter ce probl�me. D'abord, cependant, + si vous faites des traitements par batch, il est absolument critique que vous + activiez l'utilisation ds paquet JDBC (NdT : JDBC batching), si vous avez l'intention + d'obtenir des performances raisonnables. Configurez la taille du paquet JDBC avec un + nombre raisonnable (disons, 10-50) : + </para> + + <programlisting><![CDATA[hibernate.jdbc.batch_size 20]]></programlisting> + + <para> + Vous pourriez aussi vouloir faire cette sorte de travail dans un traitement o� + l'interaction avec le cache de second niveau est compl�tement d�sactiv� : + </para> + + <programlisting><![CDATA[hibernate.cache.use_second_level_cache false]]></programlisting> + + <sect1 id="batch-inserts"> + <title>Insertions en paquet</title> + + <para> + Lorsque vous rendez des nouveaux objets persistants, vous devez r�guli�rement appeler + <literal>flush()</literal> et puis <literal>clear()</literal> sur la session, + pour contr�ler la taille du cache de premier niveau. + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); + if ( i % 20 == 0 ) { //20, m�me taille que la taille du paquet JDBC + //flush un paquet d'insertions et lib�re la m�moire : + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-update" > + <title>Paquet de mises � jour</title> + + <para> + Pour r�cup�rer et mettre � jour des donn�es les m�mes id�es s'appliquent. En plus, + vous avez besoin d'utiliser <literal>scroll()</literal> pour tirer partie des + curseurs c�t� serveur pour les requ�tes qui retournent beaucoup de lignes de donn�es. + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .setCacheMode(CacheMode.IGNORE) + .scroll(ScrollMode.FORWARD_ONLY); +int count=0; +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + if ( ++count % 20 == 0 ) { + //flush un paquet de mises � jour et lib�re la m�moire : + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-statelesssession"> + <title>L'interface StatelessSession</title> + <para> + Alternativement, Hibernate fournit une API orient�e commande qui peut �tre + utilis�e avec des flux de donn�es pour et en provenance de la base de donn�es + sous la forme d'objets d�tach�s. Une <literal>StatelessSession</literal> n'a pas + de contexte de persistance associ� et ne fournit pas beaucoup de s�mantique de + dur�e de vie de haut niveau. En particulier, une session sans �tat n'impl�mente + pas de cache de premier niveau et n'interagit pas non plus avec un cache de + seconde niveau ou un cache de requ�tes. Elle n'impl�mente pas les transactions + ou la v�rification sale automatique (NdT : automatic dirty checking). Les + op�rations r�alis�es avec une session sans �tat ne sont jamais r�percut�es + en cascade sur les instances associ�es. Les collections sont ignor�es par une + session sans �tat. Les op�rations ex�cut�es via une session sans �tat outrepasse + le mod�le d'�v�nements d'Hibernate et les intercepteurs. Les sessions sans �tat sont + vuln�rables aux effets de modification des donn�es, ceci est d� au manque de cache + de premier niveau. Une session sans �tat est une abstraction bas niveau, plus + proche de la couche JDBC sous-jacente. + </para> + + <programlisting><![CDATA[StatelessSession session = sessionFactory.openStatelessSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .scroll(ScrollMode.FORWARD_ONLY); +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + session.update(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + Notez que dans le code de l'exemple, les intances de <literal>Customer</literal> + retourn�es par la requ�te sont imm�diatement d�tach�es. Elles ne sont jamais + associ�es � un contexte de persistance. + </para> + + <para> + Les op�rations <literal>insert()</literal>, <literal>update()</literal> et + <literal>delete()</literal> d�finies par l'interface <literal>StatelessSession</literal> + sont consid�r�es comme des op�rations d'acc�s direct aux lignes de la base de donn�es, + ce qui r�sulte en une ex�cution imm�diate du SQL <literal>INSERT</literal>, <literal>UPDATE</literal> + ou <literal>DELETE</literal> respectif. De l�, elles ont des s�mantiques tres diff�rentes des + op�rations <literal>save()</literal>, <literal>saveOrUpdate()</literal> + et <literal>delete()</literal> d�finies par l'interface <literal>Session</literal>. + </para> + + </sect1> + + <sect1 id="batch-direct" revision="2"> + <title>Op�rations de style DML</title> + + <para> + Comme d�j� discut� avant, le mapping objet/relationnel automatique et transparent + est int�ress� par la gestion de l'�tat de l'objet. Ceci implique que l'�tat de l'objet + est disponible en m�moire, d'o� manipuler (en utilisant des expressions du langage de + manipulation de donn�es - <literal>Data Manipulation Language</literal> (DML) - SQL) + les donn�es directement dans la base n'affectera pas l'�tat en m�moire. Pourtant, Hibernate + fournit des m�thodes pour l'ex�cution d'expression DML de style SQL lesquelles sont + r�alis�es � travers le langage de requ�te d'Hibernate (<xref linkend="queryhql">HQL</xref>). + </para> + + <para> + La pseudo-syntaxe pour les expressions <literal>UPDATE</literal> et <literal>DELETE</literal> + est : <literal>( UPDATE | DELETE ) FROM? EntityName (WHERE where_conditions)?</literal>. + Certains points sont � noter : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Dans la clause from, le mot-clef FROM est optionnel + </para> + </listitem> + <listitem> + <para> + Il ne peut y avoir qu'une seule entit� nomm�e dans la clause from ; elle peut + optionnellement avoir un alias. Si le nom de l'entit� a un alias, alors + n'importe quelle r�f�rence de propri�t� doit �tre qualifi�e en ayant un alias ; + si le nom de l'entit� n'a pas d'alias, alors il est ill�gal pour n'importe quelle + r�f�rence de propri�t� d'�tre qualifi�e. + </para> + </listitem> + <listitem> + <para> + Aucune jointure (implicite ou explicite) ne peut �tre sp�cifi�e dans une requ�te HQL. + Les sous-requ�tes peuvent �tre utilis�es dans la clause where ; les sous-requ�tes, + elles-m�mes, peuvent contenir des jointures. + </para> + </listitem> + <listitem> + <para> + La clause where est aussi optionnelle. + </para> + </listitem> + </itemizedlist> + + <para> + Par exemple, pour ex�cuter un <literal>UPDATE</literal> HQL, utilisez la m�thode + <literal>Query.executeUpdate()</literal> (la m�thode est donn�es pour ceux + qui sont familiers avec <literal>PreparedStatement.executeUpdate()</literal> de + JDBC) : + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlUpdate = "update Customer c set c.name = :newName where c.name = :oldName"; +// ou String hqlUpdate = "update Customer set name = :newName where name = :oldName"; +int updatedEntities = s.createQuery( hqlUpdate ) + .setString( "newName", newName ) + .setString( "oldName", oldName ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + <para> + Pour ex�cuter un <literal>DELETE</literal> HQL, utilisez la m�me m�thode + <literal>Query.executeUpdate()</literal> : + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlDelete = "delete Customer c where c.name = :oldName"; +// or String hqlDelete = "delete Customer where name = :oldName"; +int deletedEntities = s.createQuery( hqlDelete ) + .setString( "oldName", oldName ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + <para> + La valeur du <literal>int</literal> retourn� par la m�thode <literal>Query.executeUpdate()</literal> + indique le nombre d'entit�s affect�es par l'op�ration. Consid�rez que cela peut ou pas + corr�ler le nombre de lignes affect�s dans la base de donn�es. Une op�ration HQL + pourrait entra�ner l'ex�cution de multiples expressions SQL r�elles, pour des classes + filles mapp�es par jointure (NdT: join-subclass), par exemple. Le nombre retourn� + indique le nombre d'entit�s r�elles affect�es par l'expression. Retour � l'exemple de la + classe fille mapp�e par jointure, un effacement d'une des classes filles peut r�ellement + entra�ner des suppressions pas seulement dans la table qui mappe la classe fille, mais + aussi dans la table "racine" et potentillement dans les tables des classes filles plus bas + dans la hi�rarchie d'h�ritage. + </para> + + <para> + La pseudo-syntaxe pour l'expression <literal>INSERT</literal> est : + <literal>INSERT INTO EntityName properties_list select_statement</literal>. Quelques + points sont � noter : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Seule la forme INSERT INTO ... SELECT ... est support�e ; pas la forme INSERT INTO ... VALUES ... . + </para> + <para> + La properties_list est analogue � la <literal>sp�cification de la colonne</literal> + + The properties_list is analogous to the <literal>column speficiation</literal> dans + l'expression SQL <literal>INSERT</literal>. Pour les entit�s impliqu�es dans + un h�ritage mapp�, seules les propri�t�s directement d�finies � ce niveau de classe + donn� peuvent �tre utilis�es dans properties_list. Les propri�t�s de la classe m�re + ne sont pas permises ; et les propri�t�s des classes filles n'ont pas de sens. En + d'autres mots, les expressions <literal>INSERT</literal> par nature non polymorphiques. + </para> + </listitem> + <listitem> + <para> + select_statement peut �tre n'importe quelle requ�te de s�lection HQl valide, avec + l'avertissement que les types de retour doivent correspondre aux types attendus par + l'insertion. Actuellement, c'est v�rifi� durant la compilation de la requ�te plut�t + que la v�rification soit rel�gu�e � la base de donn�es. Notez cependant que cela + pourrait poser des probl�mes entre les <literal>Type</literal>s d'Hibernate qui + sont <emphasis>�quivalents</emphasis> oppos� � <emphasis>�gaux</emphasis>. Cela + pourrait poser des probl�mes avec des disparit�s entre une propri�t� d�finie + comme un <literal>org.hibernate.type.DateType</literal> et une propri�t� d�finie + comme un <literal>org.hibernate.type.TimestampType</literal>, m�me si la base de donn�es + ne ferait pas de distinction ou ne serait pas capable de g�rer la conversion. + </para> + </listitem> + <listitem> + <para> + Pour la propri�te id, l'expression d'insertion vous donne deux options. Vous + pouvez soit sp�cifier explicitement la propri�t� id dans properties_list + (auquel cas sa valeur est extraite de l'expression de s�lection correspondante), + soit l'omettre de properties_list (auquel cas une valeur g�n�r�e est utilis�e). + Cette derni�re option est seulement disponible en utilisant le g�n�rateur d'identifiant + qui op�re dans la base de donn�es ; tenter d'utiliser cette option avec n'importe quel + type de g�n�rateur "en m�moire" causera une exception durant l'analyse. Notez + que pour les buts de cette discussion, les g�n�rateurs "en base" sont consid�r�s + �tre <literal>org.hibernate.id.SequenceGenerator</literal> (et ses classes filles) + et n'importe quelles impl�mentations de + <literal>org.hibernate.id.PostInsertIdentifierGenerator</literal>. + L'exception la plus notable ici est <literal>org.hibernate.id.TableHiLoGenerator</literal>, + qu ne peut pas �tre utilis�e parce qu'il ne propose pas un moyen de d'exposer ses valeurs + par un select. + </para> + </listitem> + <listitem> + <para> + Pour des propri�t�s mapp�es comme <literal>version</literal> ou <literal>timestamp</literal>, + l'expression d'insertion vous donne deux options. Vous pouvez soit sp�cifier la propri�t� dans + properties_list (auquel cas sa valeur est extraite des expressions select correspondantes), + soit l'omettre de properties_list (auquel cas la <literal>valeur de graine</literal> + (NdT : seed value) d�finie par le <literal>org.hibernate.type.VersionType</literal> est utilis�e). + </para> + </listitem> + </itemizedlist> + + <para> + Un exemple d'ex�cution d'une expression <literal>INSERT</literal> HQL : + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlInsert = "insert into DelinquentAccount (id, name) select c.id, c.name from Customer c where ..."; +int createdEntities = s.createQuery( hqlInsert ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/best_practices.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/best_practices.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/best_practices.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/best_practices.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,240 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="best-practices" revision="3"> + <title>Meilleures pratiques</title> + + <variablelist spacing="compact"> + <varlistentry> + <term>D�coupez finement vos classes et mappez les en utilisant <literal><component></literal>.</term> + <listitem> + <para> + Utilisez une classe <literal>Adresse</literal> pour encapsuler <literal>Rue</literal>, + <literal>Region</literal>, <literal>CodePostal</literal>. + Ceci permet la r�utilisation du code et simplifie la maintenance. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>D�clarez des propri�t�s d'identifiants dans les classes persistantes.</term> + <listitem> + <para> + Hibernate rend les propri�t�s d'identifiants optionnelles. Il existe beaucoup de raisons + pour lesquelles vous devriez les utiliser. Nous recommandons que vous utilisiez des identifiants + techniques (g�n�r�s, et sans connotation m�tier). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Identifiez les clefs naturelles.</term> + <listitem> + <para> + Identifiez les clefs naturelles pour toutes les entit�s, et mappez les avec + <literal><natural-id></literal>. Impl�mentez <literal>equals()</literal> et + <literal>hashCode()</literal> pour comparer les propri�t�s qui composent la clef naturelle. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Placez chaque mapping de classe dans son propre fichier.</term> + <listitem> + <para> + N'utilisez pas un unique document de mapping. Mappez <literal>com.eg.Foo</literal> dans + le fichier <literal>com/eg/Foo.hbm.xml</literal>. Cela prend tout son sens lors + d'un travail en �quipe. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Chargez les mappings comme des ressources.</term> + <listitem> + <para> + D�ployez les mappings en m�me temps que les classes qu'ils mappent. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Pensez � externaliser les cha�nes de caract�res.</term> + <listitem> + <para> + Ceci est une bonne habitude si vos requ�tes appellent des fonctions SQL qui ne sont + pas au standard ANSI. Cette externalisation dans les fichiers de mapping rendra votre + application plus portable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Utilisez les variables "bind�es".</term> + <listitem> + <para> + Comme en JDBC, remplacez toujours les valeurs non constantes par "?". N'utilisez jamais + la manipulation des cha�nes de caract�res pour remplacer des valeurs non constantes dans + une requ�te ! Encore mieux, utilisez les param�tres nomm�s dans les requ�tes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Ne g�rez pas vous m�me les connexions JDBC.</term> + <listitem> + <para> + Hibernate laisse l'application g�rer les connexions JDBC. Vous ne devriez g�rer vos connexions + qu'en dernier recours. Si vous ne pouvez pas utiliser les syst�mes de connexions livr�s, + r�fl�chissez � l'id�e de fournir votre propre impl�mentation de <literal>org.hibernate.connection.ConnectionProvider</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Pensez � utiliser les types utilisateurs.</term> + <listitem> + <para> + Supposez que vous ayez une type Java, de telle biblioth�que, qui a besoin d'�tre persist� mais + qui ne fournit pas les accesseurs n�cessaires pour le mapper comme composant. Vous devriez + impl�menter + <literal>org.hibernate.UserType</literal>.Cette approche lib�re le code de l'application + de l'impl�mentation des transformations vers / depuis les types Hibernate. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Utilisez du JDBC pur dans les goulets d'�tranglement.</term> + <listitem> + <para> + Dans certaines parties critiques de votre syst�me d'un point de vue performance, quelques op�rations + peuvent tirer partie d'un appel JDBC natif. + Mais attendez de <emphasis>savoir</emphasis> + que c'est un goulet d'�tranglement. Ne supposez jamais qu'un appel JDBC sera forc�ment plus + rapide. Si vous avez besoin d'utiliser JDBC directement, ouvrez une <literal>Session</literal> + Hibernate et utilisez la connexion SQL sous-jacente. Ainsi vous pourrez utiliser la m�me strat�gie + de transation et la m�me gestion des connexions. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Comprendre le flush de <literal>Session</literal>.</term> + <listitem> + <para> + De temps en temps la Session synchronise ses �tats persistants avec la base de donn�es. + Les performances seront affect�es si ce processus arrive trop souvent. Vous pouvez parfois + minimiser les flush non n�cessaires en d�sactivant le flush automatique ou m�me en changeant + l'ordre des op�rations men�es dans une transaction particuli�re. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Dans une architecture � trois couches, pensez � utiliser <literal>saveOrUpdate()</literal>.</term> + <listitem> + <para> + Quand vous utilisez une architecture � base de servlet / session bean, vous pourriez passer + des objets charg�s dans le bean session vers et depuis la couche servlet / JSP. Utilisez + une nouvelle session pour traiter chaque requ�te. + Utilisez <literal>Session.merge()</literal> ou <literal>Session.saveOrUpdate()</literal> pour + synchroniser les objets avec la base de donn�es. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Dans une architecture � deux couches, pensez � utiliser la d�connexion de session.</term> + <listitem> + <para> + Les transactions de bases de donn�es doivent �tre aussi courtes que possible + pour une meilleure mont�e en charge.Cependant, il est souvent n�cessaire d'impl�menter + de longues <emphasis>transactions applicatives</emphasis>, une simple unit� de travail du point de vue de + l'utilisateur. Une transaction applicative + peut s'�taler sur plusieurs cycles de requ�tes/r�ponses du client. + Il est commun d'utiliser des objets d�tach�s pour impl�menter des transactions applicatives. + Une alternative, extr�mement appropri�e dans une architecture � 2 couches, est de + maintenir un seul contact de persistance ouvert (session) pour toute la dur�e de vie + de la transaction applicative et simplement se d�connecter de la connexion JDBC � la fin de chaque requ�te, + et se reconnecter au d�but de la requ�te suivante. Ne partagez jamais une seule + session avec plus d'une transaction applicative, ou vous travaillerez avec des + donn�es p�rim�es. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Consid�rez que les exceptions ne sont pas rattrapables.</term> + <listitem> + <para> + Il s'agit plus d'une pratique obligatoire que d'une "meilleure pratique". Quand une exception + intervient, il faut faire un rollback de la <literal>Transaction</literal> et + fermer la <literal>Session</literal>. + Sinon, Hibernate ne peut garantir l'int�grit� des �tats persistants en m�moire. En particulier, + n'utilisez pas <literal>Session.load()</literal> pour d�terminer si une instance avec un identifiant + donn� existe en base de donn�es, utilisez <literal>Session.get()</literal> ou un requ�te. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Pr�f�rez le chargement tardif des associations.</term> + <listitem> + <para> + Utilisez le chargement complet avec mod�ration. + Utilisez les proxies et les collections charg�es tardivement + pour la plupart des associations vers des classes qui ne sont pas susceptibles + d'�tre compl�tement retenues dans le cache de second niveau. + Pour les assocations de classes en cache, o� il y a une extr�mement + forte probabilit� que l'�l�ment soit en cache, d�sactivez explicitement le chargement + par jointures ouvertes en utilisant <literal>outer-join="false"</literal>. + Lorsqu'un chargement par jointure ouverte est appropri� pour un cas d'utilisation + particulier, utilisez une requ�te avec un <literal>left join fetch</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Utilisez le pattern <emphasis>d'une ouverture de session dans une vue</emphasis>, + ou une <emphasis>phase d'assemblage</emphasis> disciplin�e pour �viter des probl�mes + avec des donn�es non rapatri�es. + </term> + <listitem> + <para> + Hibernate lib�re les d�veloppeurs de l'�criture fastidieuse des <emphasis>objets de transfert + de donn�es (NdT : Data Transfer Objects)</emphasis> (DTO). Dans une architecture EJB traditionnelle, + les DTOs ont deux buts : premi�rement, ils contournent le probl�me des "entity bean" qui ne sont pas + s�rialisables ; deuxi�mement, ils d�finissent implicitement une phase d'assemblage o� toutes les + donn�es utilis�es par la vue sont rapatri�es et organis�es dans les DTOs avant de retourner sous le + contr�le de la couche de pr�sentation. Hibernate �limine le premier but. Pourtant, vous aurez encore + besoin d'une phase d'assemblage (pensez vos m�thodes m�tier comme ayant un contrat strict avec la + couche de pr�sentation � propos de quelles donn�es sont disponibles dans les objets d�tach�s) + � moins que vous soyez pr�par�s � garder le contexte de + persistance (la session) ouvert � travers tout le processus de rendu de la vue. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Pensez � abstraite votre logique m�tier d'Hibernate.</term> + <listitem> + <para> + Cachez le m�canisme d'acc�s aux donn�es (Hibernate) derri�re une interface. Combinez les patterns + <emphasis>DAO</emphasis> et <emphasis>Thread Local Session</emphasis>. Vous pouvez m�me avoir quelques + classes persist�es par du JDBC pur, associ�es � Hibernate via un <literal>UserType</literal> (ce conseil est + valable pour des applications de taille respectables ; il n'est pas valable pour une application + avec cinq tables). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>N'utilisez pas d'associations de mapping exotiques.</term> + <listitem> + <para> + De bons cas d'utilisation pour de vraies associations plusieurs-vers-plusieurs + sont rares. La plupart du temps vous avez besoin d'informations additionnelles + stock�es dans la table d'association. + Dans ce cas, il est pr�f�rable d'utiliser deux associations un-vers-plusieurs vers une classe + de liaisons interm�diaire. En fait, nous pensons que la plupart des associations sont + de type un-vers-plusieurs ou plusieurs-vers-un, vous devez �tre tr�s attentifs lorsque + vous utilisez autre chose et vous demander si c'est vraiment n�cessaire. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Pr�f�rez les associations bidirectionnelles.</term> + <listitem> + <para> + Les associations unidirectionnelles sont plus difficiles � questionner. + Dans une grande application, la plupart des associations devraient �tre navigables dans les deux directions dans les requ�tes. + </para> + </listitem> + </varlistentry> + </variablelist> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/collection_mapping.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/collection_mapping.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/collection_mapping.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/collection_mapping.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1216 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="collections"> + <title>Mapping des collections</title> + + <sect1 id="collections-persistent" revision="3"> + <title>Collections persistantes</title> + + <para> + Hibernate requiert que les champs contenant des collections persistantes soient d�clar�s + comme des types d'interface, par exemple : + </para> + + <programlisting><![CDATA[public class Product { + private String serialNumber; + private Set parts = new HashSet(); + + public Set getParts() { return parts; } + void setParts(Set parts) { this.parts = parts; } + public String getSerialNumber() { return serialNumber; } + void setSerialNumber(String sn) { serialNumber = sn; } +}]]></programlisting> + + <para> + L'interface r�elle devrait �tre <literal>java.util.Set</literal>, + <literal>java.util.Collection</literal>, <literal>java.util.List</literal>, + <literal>java.util.Map</literal>, <literal>java.util.SortedSet</literal>, + <literal>java.util.SortedMap</literal> ou ... n'importe quoi d'autre ! (O� + "n'importe quoi d'autre" signifie que vous devrez �crire une impl�mentation de + <literal>org.hibernate.usertype.UserCollectionType</literal>.) + </para> + + <para> + Notez comment nous avons initialis� les variables d'instance avec une instance de + <literal>HashSet</literal>. C'est le meilleur moyen pour initialiser les + collections d'instances nouvellement cr��es (non persistantes). Quand + nous fabriquons l'instance persistante - en appelant <literal>persist()</literal>, + par exemple - Hibernate remplacera r�ellement le <literal>HashSet</literal> + avec une instance d'une impl�mentation propre � Hibernate de <literal>Set</literal>. + Prenez garde aux erreurs : + </para> + + <programlisting><![CDATA[Cat cat = new DomesticCat(); +Cat kitten = new DomesticCat(); +.... +Set kittens = new HashSet(); +kittens.add(kitten); +cat.setKittens(kittens); +session.persist(cat); +kittens = cat.getKittens(); // Ok, la collection kittens est un Set +(HashSet) cat.getKittens(); // Erreur !]]></programlisting> + + <para> + Les collections persistantes inject�es par Hibernate se comportent de la m�me mani�re que + <literal>HashMap</literal>, <literal>HashSet</literal>, + <literal>TreeMap</literal>, <literal>TreeSet</literal> ou + <literal>ArrayList</literal>, selon le type de l'interface. + </para> + + <para> + Les instances des collections ont le comportement habituel des types des valeurs. + Elles sont automatiquement persist�es quand elles sont r�f�renc�es par un objet persistant et + automatiquement effac�es quand elles sont d�r�f�renc�es. Si une collection est pass�e + d'un objet persistant � un autre, ses �l�ments pourraient �tre d�plac�s d'une table + � une autre. Deux entit�s ne peuvent pas partager une r�f�rence vers une m�me instance + d'une collection. D� au mod�le relationnel sous-jacent, les propri�t�s contenant des + collections ne supportent pas la s�mantique de la valeur null ; Hibernate ne distingue pas + une r�f�rence vers une collection nulle d'une collection vide. + </para> + + <para> + Vous ne devriez pas vous pr�occuper trop de �a. Utilisez les collections persistantes de + la m�me mani�re que vous utilisez des collections Java ordinaires. Assurez-vous + de comprendre la s�mantique des associations bidirectionnelles (trait�e plus loin). + </para> + + </sect1> + + <sect1 id="collections-mapping" revision="4"> + <title>Mapper une collection</title> + + <para> + L'�l�ment de mapping d'Hibernate utilis� pour mapper une collection d�pend du type de + l'interface. Par exemple, un �l�ment <literal><set></literal> est utilis� + pour mapper des propri�t�s de type <literal>Set</literal>. + </para> + + <programlisting><![CDATA[<class name="Product"> + <id name="serialNumber" column="productSerialNumber"/> + <set name="parts"> + <key column="productSerialNumber" not-null="true"/> + <one-to-many class="Part"/> + </set> +</class>]]></programlisting> + + <para> + � part <literal><set></literal>, il y aussi les �l�ments de mapping + <literal><list></literal>, <literal><map></literal>, + <literal><bag></literal>, <literal><array></literal> et + <literal><primitive-array></literal>. + L'�l�ment <literal><map></literal> est repr�sentatif : + </para> + + <programlistingco> + <areaspec> + <area id="mappingcollection1" coords="2 65"/> + <area id="mappingcollection2" coords="3 65"/> + <area id="mappingcollection3" coords="4 65"/> + <area id="mappingcollection4" coords="5 65"/> + <area id="mappingcollection5" coords="6 65"/> + <area id="mappingcollection6" coords="7 65"/> + <area id="mappingcollection7" coords="8 65"/> + <area id="mappingcollection8" coords="9 65"/> + <area id="mappingcollection9" coords="10 65"/> + <area id="mappingcollection10" coords="11 65"/> + <area id="mappingcollection11" coords="12 65"/> + <area id="mappingcollection12" coords="13 65"/> + <area id="mappingcollection13" coords="14 65"/> + <area id="mappingcollection14" coords="15 65"/> + </areaspec> + <programlisting><![CDATA[<map + name="nomDePropriete" + table="nom_de_table" + schema="nom_du_schema" + lazy="true|extra|false" + inverse="true|false" + cascade="all|none|save-update|delete|all-delete-orphan" + sort="unsorted|natural|ClasseDeComparateur" + order-by="nom_de_column asc|desc" + where="condition sql where quelcconque" + fetch="join|select|subselect" + batch-size="N" + access="field|property|NomDeClasse" + optimistic-lock="true|false" + mutable="true|false" + node="nom-d-element|." + embed-xml="true|false" +> + + <key .... /> + <map-key .... /> + <element .... /> +</map>]]></programlisting> + <calloutlist> + <callout arearefs="mappingcollection1"> + <para> + <literal>name</literal> : le nom de la propri�t� contenant la collection + </para> + </callout> + <callout arearefs="mappingcollection2"> + <para> + <literal>table</literal> (optionnel - par d�faut = nom de la propri�t�) : le + nom de la table de la collection (non utilis� pour les associations one-to-many) + </para> + </callout> + <callout arearefs="mappingcollection3"> + <para> + <literal>schema</literal> (optionnel) : le nom du sch�ma pour surcharger le + sch�ma d�clar� dans l'�l�ment racine + </para> + </callout> + <callout arearefs="mappingcollection4"> + <para> + <literal>lazy</literal> (optionnel - par d�faut = <literal>true</literal>) : + peut �tre utilis� pour d�sactiver l'initialisation tardive et sp�cifier + que l'association est toujours rapport�e, ou pour activer la + r�cup�ration extra-paresseuse (NdT : extra-lazy) o� la plupart des + op�rations n'initialisent pas la collection (appropri� pour de tr�s + grosses collections) + </para> + </callout> + <callout arearefs="mappingcollection5"> + <para> + <literal>inverse</literal> (optionnel - par d�faut = <literal>false</literal>) : + d�finit cette collection comme l'extr�mit� "inverse" de l'association + bidirectionnelle + </para> + </callout> + <callout arearefs="mappingcollection6"> + <para> + <literal>cascade</literal> (optionnel - par d�faut = <literal>none</literal>) : + active les op�rations de cascade vers les entit�s filles + </para> + </callout> + <callout arearefs="mappingcollection7"> + <para> + <literal>sort</literal> (optionnel) : sp�cifie une collection tri�e via un ordre + de tri <literal>naturel</literal>, ou via une classe comparateur donn�e (impl�mentant Comparator) + </para> + </callout> + <callout arearefs="mappingcollection8"> + <para> + <literal>order-by</literal> (optionnel, seulement � partir du JDK1.4) : + sp�cifie une colonne de table + (ou des colonnes) qui d�finit l'ordre d'it�ration de <literal>Map</literal>, <literal>Set</literal> + ou Bag, avec en option <literal>asc</literal> ou <literal>desc</literal> + </para> + </callout> + <callout arearefs="mappingcollection9"> + <para> + <literal>where</literal> (optionnel) : sp�cifie une condition SQL arbitraire <literal>WHERE</literal> + � utiliser au chargement ou � la suppression d'une collection (utile si la collection + ne doit contenir qu'un sous ensemble des donn�es disponibles) + </para> + </callout> + <callout arearefs="mappingcollection10"> + <para> + <literal>fetch</literal> (optionnel, par d�faut = <literal>select</literal>) : + � choisir entre r�cup�ration par jointures externes, r�cup�ration par + selects s�quentiels, et r�cup�ration par sous-selects s�quentiels + </para> + </callout> + <callout arearefs="mappingcollection11"> + <para> + <literal>batch-size</literal> (optionnel, par d�faut = <literal>1</literal>) : une taille + de batch (batch size) utilis�e pour charger plusieurs instances de cette collection en + initialisation tardive + </para> + </callout> + <callout arearefs="mappingcollection12"> + <para> + <literal>access</literal> (optionnel - par d�faut = <literal>property</literal>) : La + strat�gie qu'Hibernate doit utiliser pour acc�der � la valeur de la propri�t� + </para> + </callout> + <callout arearefs="mappingcollection13"> + <para> + <literal>optimistic-lock</literal> (optionnel - par d�faut = <literal>true</literal>) : + sp�cifie que changer l'�tat de la collection entra�ne l'incr�mentation + de la version appartenant � l'entit� (Pour une association un vers plusieurs, + il est souvent raisonnable de d�sactiver ce param�tre) + </para> + </callout> + <callout arearefs="mappingcollection14"> + <para> + <literal>mutable</literal> (optionnel - par d�faut = <literal>true</literal>) : + une valeur � <literal>false</literal> sp�cifie que les �l�ments de la + collection ne changent jamais (une optimisation mineure dans certains cas) + </para> + </callout> + </calloutlist> + </programlistingco> + + <sect2 id="collections-foreignkeys" > + <title>Les clefs �trang�res d'une collection</title> + + <para> + Les instances d'une collection sont distingu�es dans la base par la clef �trang�re + de l'entit� qui poss�de la collection. Cette clef �trang�re est r�f�renc�e comme la(es) + <emphasis>colonne(s) de la clef de la collection</emphasis> de la table de la collection. + La colonne de la clef de la collection est mapp�e par l'�l�ment <literal><key></literal>. + </para> + + <para> + Il peut y avoir une contrainte de nullit� sur la colonne de la clef �trang�re. Pour les + associations unidirectionnelles un vers plusieurs, la colonne de la clef �trang�re + peut �tre nulle par d�faut, donc vous pourriez avoir besoin de sp�cifier + <literal>not-null="true"</literal>. + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" not-null="true"/>]]></programlisting> + + <para> + La contraite de la clef �trang�re peut utiliser <literal>ON DELETE CASCADE</literal>. + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" on-delete="cascade"/>]]></programlisting> + + <para> + Voir le chapitre pr�c�dent pour une d�finition compl�te de l'�l�ment <literal><key></literal>. + </para> + + </sect2> + + <sect2 id="collections-elements" > + <title>Les �l�ments d'une collection</title> + + <para> + Les collections peuvent contenir la plupart des autres types Hibernate, dont tous les types + basiques, les types utilisateur, les composants, et bien s�r, les r�f�rences vers + d'autres entit�s. C'est une distinction importante : un objet dans une collection + pourrait �tre g�r� avec une s�mantique de "valeur" (sa dur�e de vie d�pend compl�tement + du propri�taire de la collection) ou il pourrait avoir une r�f�rence vers une autre + entit�, avec sa propre dur�e de vie. Dans le dernier cas, seul le "lien" entre les 2 objets + est consid�r� �tre l'�tat retenu par la collection. + </para> + + <para> + Le type contenu est r�f�renc� comme le <emphasis>type de l'�l�ment de la collection</emphasis>. + Les �l�ments de la collections sont mapp�s par <literal><element></literal> ou + <literal><composite-element></literal>, ou dans le cas des r�f�rences d'entit�, avec + <literal><one-to-many></literal> ou <literal><many-to-many></literal>. + Les deux premiers mappent des �l�ments avec un s�mantique de valeur, les deux suivants sont + utilis�s pour mapper des associations d'entit�. + </para> + + </sect2> + + <sect2 id="collections-indexed"> + <title>Collections index�es</title> + + <para> + Tous les mappings de collection, except�s ceux avec les s�mantiques d'ensemble (NdT : set) et + de sac (NdT : bag), ont besoin d'une <emphasis>colonne d'index</emphasis> dans la + table de la collection - une colonne qui mappe un index de tableau, ou un index de + <literal>List</literal>, ou une clef de <literal>Map</literal>. L'index d'une + <literal>Map</literal> peut �tre n'importe quel type basique, mapp� avec + <literal><map-key></literal>, �a peut �tre une r�f�rence d'entit� mapp�e avec + <literal><map-key-many-to-many></literal>, ou �a peut �tre un type compos�, mapp� avec + <literal><composite-map-key></literal>. L'index d'un tableau ou d'une liste est toujours + de type <literal>integer</literal> et est mapp� en utilisant l'�l�ment <literal><list-index></literal>. + Les colonnes mapp�es contiennent des entiers s�quentiels (num�rot�s � partir de z�ro par d�faut). + </para> + + <programlistingco> + <areaspec> + <area id="index1" coords="2 45"/> + <area id="index2" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<list-index + column="nom_de_colonne" + base="0|1|..."/>]]></programlisting> + <calloutlist> + <callout arearefs="index1"> + <para> + <literal>nom_de_colonne</literal> (requis) : le nom de la colonne contenant les valeurs de l'index de la collection + </para> + </callout> + <callout arearefs="index1"> + <para> + <literal>base</literal> (optionnel, par d�faut = <literal>0</literal>) : la valeur + de la colonne de l'index qui correspond au premier �l�ment de la liste ou du tableau + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="mapkey1" coords="2 45"/> + <area id="mapkey2" coords="3 45"/> + <area id="mapkey3" coords="4 45"/> + </areaspec> + <programlisting><![CDATA[<map-key + column="nom_de_colonne" + formula="n'importe quelle expression SQL" + type="nom_du_type" + node="@nom-d-attribut" + length="N"/>]]></programlisting> + <calloutlist> + <callout arearefs="mapkey1"> + <para> + <literal>column</literal> (optionnel) : + le nom de la colonne contenant les valeurs de l'index de la collection + </para> + </callout> + <callout arearefs="mapkey2"> + <para> + <literal>formula</literal> (optionnel) : + une formule SQL utilis�e pour �valuer la clef de la map + </para> + </callout> + <callout arearefs="mapkey3"> + <para> + <literal>type</literal> (reguis): le type des clefs de la map + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="indexmanytomany1" coords="2 45"/> + <area id="indexmanytomany2" coords="3 45"/> + <area id="indexmanytomany3" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<map-key-many-to-many + column="nom_de_colonne" + formula="n'importe quelle expression SQL" + class="NomDeClasse" +/>]]></programlisting> + <calloutlist> + <callout arearefs="indexmanytomany1"> + <para> + <literal>column</literal> (optionnel) : + le nom de la colonne de la clef �trang�re pour les valeurs de l'index de la collection + </para> + </callout> + <callout arearefs="indexmanytomany2"> + <para> + <literal>formula</literal> (optionnel) : + une formulre SQL utilis�e pour �valuer la clef �trang�re de la clef de la map + </para> + </callout> + <callout arearefs="indexmanytomany3"> + <para> + <literal>class</literal> (requis): la classe de l'entit� utilis�e comme clef de la map + </para> + </callout> + </calloutlist> + </programlistingco> + <para> + Si votre table n'a pas de colonne d'index, et que vous souhaitez tout de m�me utiliser + <literal>List</literal> comme type de propri�t�, vous devriez mapper la propri�t� comme un + <emphasis><bag></emphasis> Hibernate. Un sac (NdT : bag) ne garde pas son ordre quand + il est r�cup�r� de la base de donn�es, mais il peut �tre optionnellement tri� ou ordonn�. + </para> + + </sect2> + + <para> + Il y a pas mal de vari�t�s de mappings qui peuvent �tre g�n�r�s pour les collections, + couvrant beaucoup des mod�les relationnels communs. Nous vous sugg�rons d'exp�rimenter avec l'outil de + g�n�ration de sch�ma pour avoir une id�e de comment traduire les diff�rentes d�clarations de mapping vers des table de la base de donn�es. + </para> + + <sect2 id="collections-ofvalues" revision="2"> + <title>Collections de valeurs et associations plusieurs-vers-plusieurs</title> + + <para> + N'importe quelle collection de valeurs ou association plusieurs-vers-plusieurs requiert une + <emphasis>table de collection</emphasis> avec une(des) colonne(s) de clef �trang�re, une(des) + <emphasis>colonne(s) d'�l�ment de la collection</emphasis> ou des colonnes et possiblement + une(des) colonne(s) d'index. + </para> + + <para> + Pour une collection de valeurs, nous utilisons la balise <literal><element></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="element1b" coords="2 50"/> + <area id="element2b" coords="3 50"/> + <area id="element3b" coords="4 50"/> + </areaspec> + <programlisting><![CDATA[<element + column="nom_de_colonne" + formula="n'importe quelle expression SQL" + type="nomDeType" + length="L" + precision="P" + scale="S" + not-null="true|false" + unique="true|false" + node="nom-d-element" +/>]]></programlisting> + <calloutlist> + <callout arearefs="element1b"> + <para> + <literal>column</literal> (optionnel) : le nom de la colonne contenant les valeurs de l'�l�ment de la collection + </para> + </callout> + <callout arearefs="element2b"> + <para> + <literal>formula</literal> (optionnel) : une formule SQL utilis�e pour �valuer l'�l�ment + </para> + </callout> + <callout arearefs="element3b"> + <para> + <literal>type</literal> (requis) : le type de l'�l�ment de la collection + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Une <emphasis>association plusieurs-vers-plusieurs</emphasis> est sp�cifi�e en + utilisant l'�l�ment <literal><many-to-many></literal>. + </para> + + <programlistingco> + <areaspec> + <area id="manytomany1" coords="2 60"/> + <area id="manytomany2" coords="3 60"/> + <area id="manytomany3" coords="4 60"/> + <area id="manytomany4" coords="5 60"/> + <area id="manytomany5" coords="6 60"/> + <area id="manytomany6" coords="7 60"/> + <area id="manytomany7" coords="8 60"/> + <area id="manytomany8" coords="9 60"/> + </areaspec> + <programlisting><![CDATA[<many-to-many + column="nom_de_colonne" + formula="n'importe quelle expression SQL" + class="NomDeClasse" + fetch="select|join" + unique="true|false" + not-found="ignore|exception" + entity-name="NomDEntite" + property-ref="nomDeProprieteDeLaClasseAssociee" + node="nom-d-element" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="manytomany1"> + <para> + <literal>column</literal> (optionnel) : le nom de la colonne de la clef �trang�re de l'�l�ment + </para> + </callout> + <callout arearefs="manytomany2"> + <para> + <literal>formula</literal> (optionnel) : + une formule SQL utilis�e pour �valuer la valeur de la clef �trang�re de l'�l�ment + </para> + </callout> + <callout arearefs="manytomany3"> + <para> + <literal>class</literal> (requis) : le nom de la classe associ�e + </para> + </callout> + <callout arearefs="manytomany4"> + <para> + <literal>fetch</literal> (optionnel - par d�faut <literal>join</literal>) : + active les r�cup�rations par jointures externes ou par selects s�quentiels pour cette association. + C'est un cas sp�cial ; pour une r�cup�ration compl�te sans attente (dans un seul <literal>SELECT</literal>) d'une + entit� et de ses relations plusieurs-vers-plusieurs vers d'autres entit�s, + vous devriez activer la r�cup�ration <literal>join</literal> non seulement sur + la collection elle-m�me, mais aussi avec cet attribut sur l'�l�ment imbriqu� + <literal><many-to-many></literal>. + </para> + </callout> + <callout arearefs="manytomany5"> + <para> + <literal>unique</literal> (optionnel) : activer la g�n�ration DDL d'une + contrainte d'unicit� pour la colonne de la clef �trang�re. �a rend la pluralit� + de l'association effectivement un-vers-plusieurs. + </para> + </callout> + <callout arearefs="manytomany6"> + <para> + <literal>not-found</literal> (optionnel - par d�faut <literal>exception</literal>) : + sp�cifie comment les clefs �trang�res qui r�f�rencent la lignes + manquantes seront g�r�es : <literal>ignore</literal> traitera + une ligne manquante comme une association nulle. + </para> + </callout> + <callout arearefs="manytomany7"> + <para> + <literal>entity-name</literal> (optionnel) : le nom de l'entit� de la classe associ�e, comme une alternative � <literal>class</literal> + </para> + </callout> + <callout arearefs="manytomany8"> + <para> + <literal>property-ref</literal> (optionnel) : le nom d'une propri�t� de + la classe associ�e qui est jointe � cette clef �trang�re. Si non sp�cifi�e, + la clef primaire de la classe associ�e est utilis�e. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Quelques exemples, d'abord, un ensemble de cha�nes de caract�res : + </para> + + <programlisting><![CDATA[<set name="names" table="person_names"> + <key column="person_id"/> + <element column="person_name" type="string"/> +</set>]]></programlisting> + + <para> + Un bag contenant des entiers (avec un ordre d'it�ration d�termin� par l'attribut <literal>order-by</literal>) : + </para> + + <programlisting><![CDATA[<bag name="sizes" + table="item_sizes" + order-by="size asc"> + <key column="item_id"/> + <element column="size" type="integer"/> +</bag>]]></programlisting> + + <para> + Un tableau d'entit�s - dans ce cas, une association plusieurs-vers-plusieurs : + </para> + + <programlisting><![CDATA[<array name="addresses" + table="PersonAddress" + cascade="persist"> + <key column="personId"/> + <list-index column="sortOrder"/> + <many-to-many column="addressId" class="Address"/> +</array>]]></programlisting> + + <para> + Une map de cha�nes de caract�res vers des dates : + </para> + + <programlisting><![CDATA[<map name="holidays" + table="holidays" + schema="dbo" + order-by="hol_name asc"> + <key column="id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + Une liste de composants (discute dans le prochain chapitre) : + </para> + + <programlisting><![CDATA[<list name="carComponents" + table="CarComponents"> + <key column="carId"/> + <list-index column="sortOrder"/> + <composite-element class="CarComponent"> + <property name="price"/> + <property name="type"/> + <property name="serialNumber" column="serialNum"/> + </composite-element> +</list>]]></programlisting> + + </sect2> + + <sect2 id="collections-onetomany"> + <title>Association un-vers-plusieurs</title> + + <para> + Une <emphasis>association un vers plusieurs</emphasis> lie les tables de deux classes + par une clef �trang�re, sans l'intervention d'une table de collection. Ce mapping perd certaines s�mantiques des collections Java normales : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Une instance de la classe de l'entit� contenue ne peut pas appartenir � plus d'une + instance de la collection + </para> + </listitem> + <listitem> + <para> + Une instance de la classe de l'entit� contenue ne peut pas appara�tre plus plus d'une valeur d'index de la collection + </para> + </listitem> + </itemizedlist> + + <para> + Une association de <literal>Product</literal> vers <literal>Part</literal> requiert l'existence d'une + clef �trang�re et possiblement une colonne d'index pour la table <literal>Part</literal>. Une balise + <literal><one-to-many></literal> indique que c'est une association un vers plusieurs. + </para> + + <programlistingco> + <areaspec> + <area id="onetomany1" coords="2 60"/> + <area id="onetomany2" coords="3 60"/> + <area id="onetomany3" coords="4 60"/> + </areaspec> + <programlisting><![CDATA[<one-to-many + class="NomDeClasse" + not-found="ignore|exception" + entity-name="NomDEntite" + node="nom-d-element" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="onetomany1"> + <para> + <literal>class</literal> (requis) : le nom de la classe associ�e + </para> + </callout> + <callout arearefs="onetomany2"> + <para> + <literal>not-found</literal> (optionnel - par d�faut <literal>exception</literal>) : + sp�cifie comment les identifiants cach�s qui r�f�rencent des lignes manquantes seront g�r�s : + <literal>ignore</literal> traitera une ligne manquante comme une association nulle + </para> + </callout> + <callout arearefs="onetomany3"> + <para> + <literal>entity-name</literal> (optionnel) : le nom de l'entit� de la + classe associ�e, comme une alternative � <literal>class</literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Notez que l'�l�ment <literal><one-to-many></literal> n'a pas besoin de d�clarer de colonnes. Il n'est pas non plus n�cessaire de sp�cifier le nom de la table nulle part. + </para> + + <para> + <emphasis>Note tr�s importante :</emphasis> si la colonne de la clef d'une association + <literal><one-to-many></literal> est d�clar�e <literal>NOT NULL</literal>, vous devez d�clarer le + mapping de <literal><key></literal> avec <literal>not-null="true"</literal> ou + <emphasis>utiliser une association bidirectionnelle</emphasis> avec le mapping de la + collection marqu� <literal>inverse="true"</literal>. Voir la discussion sur les associations bidirectionnelles plus tard dans ce chapitre. + </para> + + <para> + Cet exemple montre une map d'entit�s <literal>Part</literal> par nom (o� + <literal>partName</literal> est une propri�t� persistante de <literal>Part</literal>). + Notez l'utilisation d'un index bas� sur une formule. + </para> + + <programlisting><![CDATA[<map name="parts" + cascade="all"> + <key column="productId" not-null="true"/> + <map-key formula="partName"/> + <one-to-many class="Part"/> +</map>]]></programlisting> + </sect2> + + </sect1> + + <sect1 id="collections-advancedmappings"> + <title>Mappings de collection avanc�s</title> + + <sect2 id="collections-sorted" revision="2"> + <title>Collections tri�es</title> + + <para> + Hibernate supporte des collections impl�mentant <literal>java.util.SortedMap</literal> et + <literal>java.util.SortedSet</literal>. Vous devez sp�cifier un comparateur dans le fichier de mapping : + </para> + + <programlisting><![CDATA[<set name="aliases" + table="person_aliases" + sort="natural"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" sort="my.custom.HolidayComparator"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + Les valeurs permises pour l'attribut <literal>sort</literal> sont <literal>unsorted</literal>, + <literal>natural</literal> et le nom d'une classe impl�mentant + <literal>java.util.Comparator</literal>. + </para> + + <para> + Les collections tri�es se comportent r�ellement comme <literal>java.util.TreeSet</literal> ou + <literal>java.util.TreeMap</literal>. + </para> + + <para> + Si vous voulez que la base de donn�es elle-m�me ordonne les �l�ments de la collection, utilisez l'attribut + <literal>order-by</literal> des mappings <literal>set</literal>, <literal>bag</literal> + ou <literal>map</literal>. Cette solution est seulement disponible � partir du JDK 1.4 (c'est + impl�ment� en utilisant <literal>LinkedHashSet</literal> ou + <literal>LinkedHashMap</literal>). Ceci ex�cute le tri dans la requ�te SQL, pas en m�moire. + </para> + + <programlisting><![CDATA[<set name="aliases" table="person_aliases" order-by="lower(name) asc"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" order-by="hol_date, hol_name"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date type="date"/> +</map>]]></programlisting> + + <para> + Notez que la valeur de l'attribut <literal>order-by</literal> est un ordre SQL, pas un ordre HQL ! + </para> + + <para> + Les associations peuvent m�me �tre tri�es sur des crit�res arbitraires � l'ex�cution en utilisant un <literal>filter()</literal> de collection. + </para> + + <programlisting><![CDATA[sortedUsers = s.createFilter( group.getUsers(), "order by this.name" ).list();]]></programlisting> + + </sect2> + + <sect2 id="collections-bidirectional" revision="1"> + <title>Associations bidirectionnelles</title> + + <para> + Une <emphasis>association bidirectionnelle</emphasis> permet une navigation � + partir de la "fin" de l'association. Deux sortes d'associations bidirectionnelles sont support�es : + <variablelist> + <varlistentry> + <term>un-vers-plusieurs (NdT : one-to-many)</term> + <listitem> + <para> + ensemble ou sac � une extr�mit�, une seule valeur � l'autre + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>plusieurs-vers-plusieurs (NdT : many-to-many)</term> + <listitem> + <para> + ensemble ou sac aux deux extr�mit�s + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + Vous pouvez sp�cifier une association plusieurs-vers-plusieurs bidirectionnelle simplement + en mappant deux associations plusieurs-vers-plusieurs vers la m�me table de base de donn�es et en d�clarant une extr�mit� comme <emphasis>inverse</emphasis> (celle de votre choix, mais �a ne peut pas �tre une collection index�e). + </para> + + <para> + Voici un exemple d'association bidirectionnelle plusieurs-vers-plusieurs ; chaque cat�gorie peut + avoir plusieurs objets et chaque objet peut �tre dans plusieurs cat�gories : + </para> + + <programlisting><![CDATA[<class name="Category"> + <id name="id" column="CATEGORY_ID"/> + ... + <bag name="items" table="CATEGORY_ITEM"> + <key column="CATEGORY_ID"/> + <many-to-many class="Item" column="ITEM_ID"/> + </bag> +</class> + +<class name="Item"> + <id name="id" column="ITEM_ID"/> + ... + +  + <bag name="categories" table="CATEGORY_ITEM" inverse="true"> + <key column="ITEM_ID"/> + <many-to-many class="Category" column="CATEGORY_ID"/> + </bag> +</class>]]></programlisting> + + <para> + Les changements faits uniquement sur l'extr�mint� inverse de l'association <emphasis>ne sont pas</emphasis> + persist�s. Ceci signifie qu'Hibernate a deux repr�sentations en m�moire pour chaque + association bidirectionnelles, un lien de A vers B et un autre de B vers A. C'est + plus facile � comprendre si vous pensez au mod�le objet de Java et comment nous + cr�ons une relation plusieurs-vers-plusieurs en Java : + </para> + + <programlisting><![CDATA[ +category.getItems().add(item); // La cat�gorie est maintenant "au courant" de la relation +item.getCategories().add(category); // L'objet est maintenant "au courant" de la relation + +session.persist(item); // La relation ne sera pas sauvegard�e ! +session.persist(category); // La relation sera sauvegard�e]]></programlisting> + + <para> + La partie non-inverse est utilis�e pour sauvegarder la repr�sentation en m�moire dans la base de donn�es. + </para> + + <para> + Vous pouvez d�finir une association un-vers-plusieurs bidirectionnelle en mappant une + association un-vers-plusieurs vers la(es) m�me(s) colonne(s) de table qu'une association + plusieurs-vers-un et en d�clarant l'extr�mit� pluri-valu�e <literal>inverse="true"</literal>. + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + Mapper une extr�mit� d'une association avec <literal>inverse="true"</literal> n'affecte + pas l'op�ration de cascades, ce sont des concepts orthogonaux ! + </para> + + </sect2> + + <sect2 id="collections-indexedbidirectional"> + <title>Associations bidirectionnelles avec des collections index�es</title> + <para> + Une association bidirectionnelle o� une extr�mit� est repr�sent�e comme une <literal><list></literal> + ou une <literal><map></literal> requiert une consid�ration sp�ciale. Si il y a une + propri�t� de la classe enfant qui mappe la colonne de l'index, pas de probl�me, nous pouvons + continuer � utiliser <literal>inverse="true"</literal> sur le mapping de la collection : + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children" inverse="true"> + <key column="parent_id"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <property name="name" + not-null="true"/> + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + Mais, si il n'y a pas de telle prorpri�t� sur la classe enfant, nous ne pouvons pas penser + � l'association comme vraiment bidirectionnelle (il y a des informations disponibles � une + extr�mit� de l'association qui ne sont pas disponibles � l'autre extr�mit�). Dans ce cas, + nous ne pouvons pas mapper la collection <literal>inverse="true"</literal>. � la place, nous + pourrions utiliser le mapping suivant : + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children"> + <key column="parent_id" + not-null="true"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + insert="false" + update="false" + not-null="true"/> +</class>]]></programlisting> + + <para> + Notez que dans ce mapping, l'extr�mit� de l'association contenant la collection est responsable + des mises � jour de la clef �trang�re. � faire : cela entra�ne-t-il r�ellement des expressions + updates inutiles ? + </para> + + </sect2> + + <sect2 id="collections-ternary"> + <title>Associations ternaires</title> + + <para> + Il y a trois approches possibles pour mapper une association ternaire. L'une est d'utiliser + une <literal>Map</literal> avec une association en tant qu'index : + </para> + + <programlisting><![CDATA[<map name="contracts"> + <key column="employer_id" not-null="true"/> + <map-key-many-to-many column="employee_id" class="Employee"/> + <one-to-many class="Contract"/> +</map>]]></programlisting> + + <programlisting><![CDATA[<map name="connections"> + <key column="incoming_node_id"/> + <map-key-many-to-many column="outgoing_node_id" class="Node"/> + <many-to-many column="connection_id" class="Connection"/> +</map>]]></programlisting> + + <para> + Une seconde approche est simplement de remodeler l'association comme une classe d'entit�. C'est + l'approche la plus commune. + </para> + + <para> + Une alternative finale est d'utiliser des �l�ments composites, dont nous discuterons plus tard. + </para> + + </sect2> + + <sect2 id="collections-idbag" revision="1"> + <title>Utiliser un <literal><idbag></literal></title> + + <para> + Si vous embrassez pleinement notre vue que les clefs compos�es sont une mauvaise + chose et que des entit�s devraient avoir des identifiants artificiels (des clefs + subrog�es), alors vous pourriez trouver un peu curieux que les associations + plusieurs-vers-plusieurs et les collections de valeurs que nous avons montr� jusqu'ici + mappent toutes des tables avec des clefs compos�es ! Maintenant, ce point est assez + discutable ; une table d'association pure ne semble pas beaucoup b�n�ficier d'une clef + subrog�e (bien qu'une collection de valeur compos�es le <emphasis>pourrait</emphasis>). + N�anmoins, Hibernate fournit une foncionnalit� qui vous permet de mapper + des associations plusieurs-vers-plusieurs et des collections de valeurs vers une + table avec une clef subrog�e. + </para> + + <para> + L'�l�ment <literal><idbag></literal> vous laisse mapper une <literal>List</literal> + (ou une <literal>Collection</literal>) avec une s�mantique de sac. + </para> + +<programlisting><![CDATA[<idbag name="lovers" table="LOVERS"> + <collection-id column="ID" type="long"> + <generator class="sequence"/> + </collection-id> + <key column="PERSON1"/> + <many-to-many column="PERSON2" class="Person" fetch="join"/> +</idbag>]]></programlisting> + + <para> + Comme vous pouvez voir, un <literal><idbag></literal> a un g�n�r�teur d'id + artificiel, comme une classe d'entit� ! Une clef subrog�e diff�rente est assign�e + � chaque ligne de la collection. Cependant, Hibernate ne fournit pas de m�canisme pour + d�couvrir la valeur d'une clef subrog�e d'une ligne particuli�re. + </para> + + <para> + Notez que les performances de la mise � jour d'un <literal><idbag></literal> + sont <emphasis>bien</emphasis> meilleures qu'un <literal><bag></literal> ordinaire ! + Hibernate peut localiser des lignes individuelles efficacement et les mettre � jour ou + les effacer individuellement, comme une liste, une map ou un ensemble. + </para> + + <para> + Dans l'impl�mentation actuelle, la strat�gie de la g�n�ration de l'identifiant <literal>native</literal> + n'est pas support�e pour les identifiants de collection <literal><idbag></literal>. + </para> + + </sect2> + + </sect1> + +  + +  + + <sect1 id="collections-example" revision="1"> + <title>Exemples de collections</title> + + <para> + Les sections pr�c�dentes sont assez confuses. Donc prenons un exemple. Cette classe : + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; + +public class Parent { + private long id; + private Set children; + + public long getId() { return id; } + private void setId(long id) { this.id=id; } + + private Set getChildren() { return children; } + private void setChildren(Set children) { this.children=children; } + + .... + .... +}]]></programlisting> + + <para> + a une collection d'instances de <literal>Child</literal>. Si chaque enfant + a au plus un parent, le mapping le plus naturel est une association + un-vers-plusieurs : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Ceci mappe les d�finitions de tables suivantes : + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255), parent_id bigint ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + Si le parent est <emphasis>requis</emphasis>, utilisez une association un-vers-plusieurs unidirectionnelle : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Notez la contrainte <literal>NOT NULL</literal> : + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null + primary key, + name varchar(255), + parent_id bigint not null ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + Alternativement, si vous insistez absolument pour que cette association soit unidirectionnelle, + vous pouvez d�clarer la contrainte <literal>NOT NULL</literal> sur le mapping <literal><key></literal> : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + D'un autre c�t�, si un enfant pouvait avoir plusieurs parent, une association + plusieurs-vers-plusieurs est plus appropri�e : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" table="childset"> + <key column="parent_id"/> + <many-to-many class="Child" column="child_id"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + D�finitions des tables : + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255) ) +create table childset ( parent_id bigint not null, + child_id bigint not null, + primary key ( parent_id, child_id ) ) +alter table childset add constraint childsetfk0 (parent_id) references parent +alter table childset add constraint childsetfk1 (child_id) references child]]></programlisting> + + <para> + Pour plus d'exemples et une revue compl�te du mapping de la relation parent/enfant, voir + see <xref linkend="example-parentchild"/>. + </para> + + <para> + Des mappings d'association plus exotiques sont possibles, nous cataloguerons toutes les possibilit�s + dans le prochain chapitre. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/component_mapping.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/component_mapping.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/component_mapping.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/component_mapping.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,402 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<chapter id="components"> + <title>Mapping de composants</title> + + <para> + La notion de <emphasis>composants</emphasis> est r�utilis� dans diff�rents contextes, + avec diff�rents objectifs, � travers Hibernate. + </para> + + <sect1 id="components-dependentobjects" revision="2" > + <title>Objects d�pendants</title> + + <para> + Le composant est un objet inclu dans un autre qui est sauvegard� comme une valeur, et + non pas comme une entit�. + Le composant fait r�f�rence � la notion (au sens objet) de composition + (et non pas de composant au sens d'architecture de composants). + Par exemple on pourrait mod�lis� l'objet personne de cette fa�on: + </para> + + <programlisting><![CDATA[public class Person { + private java.util.Date birthday; + private Name name; + private String key; + public String getKey() { + return key; + } + private void setKey(String key) { + this.key=key; + } + public java.util.Date getBirthday() { + return birthday; + } + public void setBirthday(java.util.Date birthday) { + this.birthday = birthday; + } + public Name getName() { + return name; + } + public void setName(Name name) { + this.name = name; + } + ...... + ...... +}]]></programlisting> + +<programlisting><![CDATA[public class Name { + char initial; + String first; + String last; + public String getFirst() { + return first; + } + void setFirst(String first) { + this.first = first; + } + public String getLast() { + return last; + } + void setLast(String last) { + this.last = last; + } + public char getInitial() { + return initial; + } + void setInitial(char initial) { + this.initial = initial; + } +}]]></programlisting> + + <para> + Maintenant <literal>Name</literal> peut-�tre sauvegard� comme un composant de + <literal>Person</literal>. Remarquer que <literal>Name</literal> d�finit des methodes + d'acc�s et de modification pour ses propri�t�s persistantes, mais il n'a pas besoin + des interfaces ou des propri�t�s d'identification ( par exemple getId() ) qui sont propres aux entit�s. + </para> + + <para> + Nous serions alors amen� � mapper ce composant de cette fa�on: + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name">  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + <para> + La table person aurai les colonnes <literal>pid</literal>, + <literal>birthday</literal>, + <literal>initial</literal>, + <literal>first</literal> and + <literal>last</literal>. + </para> + + <para> + Comme tous les types valeurs, les composants ne supportent pas les r�f�rences partag�s. + En d'autres mots, deux instances de person peuvent avoir un m�me nom, mais ces noms sont + ind�pendants, ils peuvent �tre identiques si on les compare par valeur mais ils repr�sentent + deux objets distincts en m�moire. La notion de nullit� pour un composant est + <emphasis>ad hoc</emphasis>. Quand il recharge l'objet qui contient le composant, Hibernate + supposera que si tous les champs du composants sont nuls alors le composant sera positionn� + � la valeur null. Ce choix programmatif devrait �tre satisfaisant dans la plupart des cas. + </para> + + <para> + Les propri�t�s d'un composant peuvent �tre de tous les types qu'Hibernate supporte habituellement + (collections, many-to-one associations, autres composants, etc). Les composants inclus ne doivent <emphasis>pas</emphasis> + �tre vus comme quelque chose d'exotique. Hibernate a �t� con�u pour supporter un mod�le objet tr�s granulaire. + </para> + + <para> + Le <literal><component></literal> peut inclure dans la liste de ses propri�t�s + une r�f�rence au <literal><parent></literal> conteneur. + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name" unique="true"> + <parent name="namedPerson"/>  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-incollections" revision="1"> + <title>Collection d'objets d�pendants</title> + + <para> + Les collections d'objets d�pendants sont support�s (exemple: un tableau de type + <literal>Name</literal>). D�clarer la collection de composants en rempla�ant le tag <literal><element></literal> + par le tag <literal><composite-element></literal>. + </para> + + <programlisting><![CDATA[<set name="someNames" table="some_names" lazy="true"> + <key column="id"/> + <composite-element class="eg.Name">  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </composite-element> +</set>]]></programlisting> + + <para> + Remarque: Si vous d�finissez un <literal>Set</literal> d'�l�ment composite, + il est tr�s important d'impl�menter la m�thode <literal>equals()</literal> et + <literal>hashCode()</literal> correctement. + </para> + + <para> + Les �lements composite peuvent aussi contenir des composants mais pas des collections. + Si votre �l�ment composite contient aussi des composants, utilisez l'�l�ment <literal><nested-composite-element></literal> + . Une collections de composants qui ccontiennent eux-m�mes des composants est un cas tr�s exotique. + A ce stade demandez-vous si une association un-�-plusieurs ne serait pas plus appropri�. + Essayez de re remodeler votre �l�ment composite comme une entit� ( Dans ce cas m�me si le mod�le + Java est le m�me la logique de persitence et de relation sont tout de m�me diff�rentes) + </para> + + <para> + Remarque, le mapping d'�l�ments composites ne supporte pas la nullit� des + propri�t�s lorsqu'on utilise un <literal><set></literal>. Hibernate + lorsqu'il supprime un objet utilise chaque colonne pour identifier un objet + (on ne peut pas utiliser des cl�s primaires distinctes dans une table d'�l�ments composites), + ce qui n'est pas possible avec des valeurs nulles. Vous devez donc choisir d'interdire la nullit� + des propri�t�s d'un �l�ment composite ou choisir un autre type de collection comme : + <literal><list></literal>, <literal><map></literal>, + <literal><bag></literal> ou <literal><idbag></literal>. + </para> + + <para> + Un cas particulier d'�l�ment composite est un �l�ment composite qui inclut un �l�ment + <literal><many-to-one></literal>. Un mapping comme celui-ci + vous permet d'associer les colonnes d'une table d'association plusieurs � plusieurs (many-to-many) + � la classse de l'�l�ment composite. L'exemple suivant est une association plusieurs � plusieurs + de <literal>Order</literal> � <literal>Item</literal> � + <literal>purchaseDate</literal>, <literal>price</literal> et + <literal>quantity</literal> sont des propri�t�s de l'association. + </para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.Purchase"> + <property name="purchaseDate"/> + <property name="price"/> + <property name="quantity"/> + <many-to-one name="item" class="eg.Item"/>  + </composite-element> + </set> +</class>]]></programlisting> + + <para> + Bien s�r, il ne peut pas y avoir de r�f�rence � l'achat (purchase) depuis l'article (item), pour + pouvoir naviguer de fa�on bidirectionnelle dans l'association. N'oubliez pas que les composants + sont de type valeurs et n'autorise pas les r�f�rences partag�es. + </para> + + <para>M�me les associations ternaires ou quaternaires sont possibles:</para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.OrderLine"> + <many-to-one name="purchaseDetails class="eg.Purchase"/> + <many-to-one name="item" class="eg.Item"/> + </composite-element> + </set> +</class>]]></programlisting> + + <para> + Les �l�ments composites peuvent appara�tre dans les requ�tes en utilisant + la m�me syntaxe que associations + </para> + + </sect1> + + <sect1 id="components-asmapindex"> + <title>Utiliser les composants comme index de map</title> + + <para> + l'�l�ment <literal><composite-map-key></literal> + vous permet d'utiliser une classe de composant comme indice de + <literal>Map</literal>. Assurez-vous d'avoir surd�fini + <literal>hashCode()</literal> et <literal>equals()</literal> dans la + classe du composant. + </para> + </sect1> + + <sect1 id="components-compositeid" revision="1"> + <title>Utiliser un composant comme identifiant</title> + + <para> + Vous pouvez utiliser un composant comme identifiant d'une entit�. + Mais pour cela la classe du composant doit respecter certaines r�gles. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Elle doit impl�menter <literal>java.io.Serializable</literal>. + </para> + </listitem> + <listitem> + <para> + Elle doit red�finir <literal>equals()</literal> et + <literal>hashCode()</literal>, de fa�on coh�rente avec le + fait qu'elle d�finit une cl� composite dans la base de + donn�es. + </para> + </listitem> + </itemizedlist> + + <para> + <emphasis> + Remarque: avec hibernate3, la seconde r�gle n'est plus absolument + necessaire mais fa�tes le quand m�me.</emphasis> + </para> + + <para> + Vous ne pouvez pas utiliser de <literal>IdentifierGenerator</literal> pour g�n�rer + une cl� composite, l'application devra d�finir elle m�me ses propres identifiants. + </para> + + <para> + Utiliser l'�l�ment <literal><composite-id></literal> (en incluant l'�l�ment + <literal><key-property></literal>) � la place de l'habituel d�claration + <literal><id></literal>. Par exemple la classe + <literal>OrderLine</literal> qui d�pend de la cl� primaire + (composite) de <literal>Order</literal>. + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + + <composite-id name="id" class="OrderLineId"> + <key-property name="lineId"/> + <key-property name="orderId"/> + <key-property name="customerId"/> + </composite-id> + + <property name="name"/> + + <many-to-one name="order" class="Order" + insert="false" update="false"> + <column name="orderId"/> + <column name="customerId"/> + </many-to-one> + .... + +</class>]]></programlisting> + + <para> + Maintenant toutes cl�s �trang�res r�f�ren�ant la table <literal>OrderLine</literal> + devra aussi �tre composite. Vous devez en tenir compte lorsque vous �crivez vos mapping d'association pour les autres classes. + Une association � <literal>OrderLine</literal> devrait �tre mapp� de la fa�on suivante : + </para> + + <programlisting><![CDATA[<many-to-one name="orderLine" class="OrderLine"> + + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> +</many-to-one>]]></programlisting> + + <para> + (Remarque: l'�l�ment <literal><column></literal> est une alternative � l'attribut + <literal>column</literal> que l'on utilise partout.) + </para> + + <para> + Une association <literal>plusieurs-�-plusieurs</literal> (many-to-many) � <literal>OrderLine</literal> + utilisera aussi une cl� �trang�re composite: + </para> + + <programlisting><![CDATA[<set name="undeliveredOrderLines"> + <key column name="warehouseId"/> + <many-to-many class="OrderLine"> + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </many-to-many> +</set>]]></programlisting> + + <para> + La collection des <literal>OrderLine</literal>s dans <literal>Order</literal> + utilisera: + </para> + + <programlisting><![CDATA[<set name="orderLines" inverse="true"> + <key> + <column name="orderId"/> + <column name="customerId"/> + </key> + <one-to-many class="OrderLine"/> +</set>]]></programlisting> + + <para> + (L'�l�ment <literal><one-to-many></literal>, comme d'habitude, ne d�clare pas de colonne.) + </para> + + <para> + Si <literal>OrderLine</literal> lui-m�me poss�de une collection, celle-ci aura aussi + une cl� composite �trang�re. + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + .... + .... + <list name="deliveryAttempts"> + <key>  + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </key> + <list-index column="attemptId" base="1"/> + <composite-element class="DeliveryAttempt"> + ... + </composite-element> + </set> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-dynamic" revision="1"> + <title>Composant Dynamique</title> + + <para> + Vous pouvez m�me mapper une propri�t� de type <literal>Map</literal>: + </para> + + <programlisting><![CDATA[<dynamic-component name="userAttributes"> + <property name="foo" column="FOO"/> + <property name="bar" column="BAR"/> + <many-to-one name="baz" class="Baz" column="BAZ_ID"/> +</dynamic-component>]]></programlisting> + + <para> + La s�mantique de l'association � un <literal><dynamic-component></literal> + est identique � celle que l'on utilise pour les composants. + L'avantage de ce type de mapping est qu'il pemet de d�terminer les v�ritables propri�t�s + du bean au moment su d�ploiement en �ditant simplement le document de mapping. + La manipulation du document de mapping pendant l'execution de l'application est aussi + possible en utilisant un parser DOM. Il ya m�me mieux, vous pouvez acc�der (et changer) + le metamodel de configuration d'hibernate en utilisant l'objet <literal>Configuration</literal> + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/configuration.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/configuration.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/configuration.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/configuration.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1759 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<chapter id="session-configuration" revision="1"> + + <title>Configuration</title> + + <para> + Parce qu'Hibernate est con�u pour fonctionner dans diff�rents environnements, + il existe beaucoup de param�tres de configuration. Heureusement, la plupart + ont des valeurs par d�faut appropri�es et la distribution d'Hibernate contient + un exemple de fichier <literal>hibernate.properties</literal> dans le r�pertoire + <literal>etc/</literal> qui montre les diff�rentes options. Vous n'avez qu'� + placer ce fichier dans votre classpath et � l'adapter. + </para> + + <sect1 id="configuration-programmatic" revision="1"> + <title>Configuration par programmation</title> + + <para> + Une instance de <literal>org.hibernate.cfg.Configuration</literal> + repr�sente un ensemble de mappings des classes Java d'une application vers + la base de donn�es SQL. La <literal>Configuration</literal> est utilis�e + pour construire un objet (immuable) <literal>SessionFactory</literal>. + Les mappings sont constitu�s d'un ensemble de fichiers de mapping XML. + </para> + + <para> + Vous pouvez obtenir une instance de <literal>Configuration</literal> + en l'instanciant directement et en sp�cifiant la liste des documents + XML de mapping. Si les fichiers de mapping sont dans le classpath, vous + pouvez le faire � l'aide de la m�thode <literal>addResource()</literal> : + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addResource("Item.hbm.xml") + .addResource("Bid.hbm.xml");]]></programlisting> + + <para> + Une alternative (parfois meilleure) est de sp�cifier les classes mapp�es + et de laisser Hibernate trouver les documents de mapping pour vous : + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class);]]></programlisting> + + <para> + Hibernate va rechercher les fichiers de mappings + <literal>/org/hibernate/auction/Item.hbm.xml</literal> et + <literal>/org/hibernate/auction/Bid.hbm.xml</literal> dans le classpath. + Cette approche �limine les noms de fichiers en dur. + </para> + + <para> + Une <literal>Configuration</literal> vous permet �galement de pr�ciser des + propri�t�s de configuration : + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class) + .setProperty("hibernate.dialect", "org.hibernate.dialect.MySQLInnoDBDialect") + .setProperty("hibernate.connection.datasource", "java:comp/env/jdbc/test") + .setProperty("hibernate.order_updates", "true");]]></programlisting> + + <para> + Ce n'est pas le seul moyen de passer des propri�t�s de configuration � Hibernate. + Les diff�rentes options sont : + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + Passer une instance de <literal>java.util.Properties</literal> + � <literal>Configuration.setProperties()</literal>. + </para> + </listitem> + <listitem> + <para> + Placer <literal>hibernate.properties</literal> dans un r�pertoire racine + du classpath + </para> + </listitem> + <listitem> + <para> + Positionner les propri�t�s <literal>System</literal> en utilisant + <literal>java -Dproperty=value</literal>. + </para> + </listitem> + <listitem> + <para> + Inclure des �l�ments <literal><property></literal> dans le + fichier <literal>hibernate.cfg.xml</literal> (voir plus loin). + </para> + </listitem> + </orderedlist> + + <para> + L'utilisation d'<literal>hibernate.properties</literal> est l'approche la plus + simple si vous voulez d�marrer rapidement + </para> + <para> + La <literal>Configuration</literal> est un objet de d�marrage qui sera supprim� + une fois qu'une <literal>SessionFactory</literal> aura �t� cr��e. + </para> + + </sect1> + + <sect1 id="configuration-sessionfactory"> + <title>Obtenir une SessionFactory</title> + + <para> + Une fois que tous les mappings ont �t� pars�s par la <literal>Configuration</literal>, + l'application doit obtenir une fabrique d'instances de <literal>Session</literal>. + Cette fabrique sera partag�e entre tous les threads de l'application : + </para> + + <programlisting><![CDATA[SessionFactory sessions = cfg.buildSessionFactory();]]></programlisting> + + <para> + Hibernate permet � votre application d'instancier plus d'une <literal>SessionFactory</literal>. + Cela est pratique lorsque vous utilisez plus d'une base de donn�es. + </para> + + </sect1> + + <sect1 id="configuration-hibernatejdbc" revision="1"> + <title>Connexions JDBC</title> + + <para> + Habituellement, vous voulez que la <literal>SessionFactory</literal> cr�e les connexions JDBC et + les mette dans un pool pour vous. Si vous suivez cette approche, ouvrir une <literal>Session</literal> + est aussi simple que : + </para> + + <programlisting><![CDATA[Session session = sessions.openSession(); // open a new Session]]></programlisting> + + <para> + D�s que vous ferez quelquechose qui requiert un acc�s � la base de donn�es, une connexion + JDBC sera r�cup�r�e dans le pool. + </para> + + <para> + Pour faire cela, il faut passer les propri�t�s de la connexion JDBC � Hibernate. + Tous les noms des propri�t�s Hibernate et leur signification sont d�finies dans + la classe <literal>org.hibernate.cfg.Environment</literal>. Nous allons maintenant + d�crire les param�tres de configuration des connexions JDBC les plus importants. + </para> + + <para> + Hibernate obtiendra des connexions (et les mettra dans un pool) en utilisant + <literal>java.sql.DriverManager</literal> si vous positionnez les param�tres de la mani�re + suivante : + </para> + + <table frame="topbot"> + <title>Propri�t�s JDBC d'Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.driver_class</literal> + </entry> + <entry> + <emphasis>Classe du driver jdbc</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.url</literal> + </entry> + <entry> + <emphasis>URL jdbc</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>utilisateur de la base de donn�es</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>mot de passe de la base de donn�es</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.pool_size</literal> + </entry> + <entry> + <emphasis>nombre maximum de connexions dans le pool</emphasis> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + L'algorithme natif de pool de connexions d'Hibernate est plut�t rudimentaire. Il a �t� fait + dans le but de vous aider � d�marrer et <emphasis>n'est pas pr�vu pour un syst�me en production</emphasis> + ou m�me pour un test de peformance. Utilisez plut�t un pool tiers pour de meilleures performances et une + meilleure stabilit� : pour cela, remplacez la propri�t� <literal>hibernate.connection.pool_size</literal> avec les propri�t�s + sp�cifique au pool de connexions que vous avez choisi. Cela d�sactivera le pool de connexions interne + d'Hibernate. Vous pouvez par exemple utiliser C3P0. + </para> + + <para> + C3P0 est un pool de connexions JDBC open source distribu� avec Hibernate dans le r�pertoire + <literal>lib</literal>. Hibernate utilisera son provider <literal>C3P0ConnectionProvider</literal> + pour le pool de connexions si vous positionnez les propri�t�s <literal>hibernate.c3p0.*</literal>. + Si vous voulez utiliser Proxool, r�f�rez vous au groupe de propri�t�s d'<literal>hibernate.properties</literal> + correspondant et regardez sur le site web d'Hibernate pour plus d'informations. + </para> + + <para> + Voici un exemple de fichier <literal>hibernate.properties</literal> pour C3P0: + </para> + + <programlisting id="c3p0-configuration" revision="1"><![CDATA[hibernate.connection.driver_class = org.postgresql.Driver +hibernate.connection.url = jdbc:postgresql://localhost/mydatabase +hibernate.connection.username = myuser +hibernate.connection.password = secret +hibernate.c3p0.min_size=5 +hibernate.c3p0.max_size=20 +hibernate.c3p0.timeout=1800 +hibernate.c3p0.max_statement=50 +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + Dans le cadre de l'utilisation au sein d'un serveur d'applications, + vous devriez quasiment toujours configurer Hibernate pour qu'il obtienne + ses connexions de la <literal>DataSource</literal> du serveur d'application + enregistr�e dans le JNDI. Pour cela vous devrez d�finir au moins une des + propri�t�s suivantes : + </para> + + <table frame="topbot"> + <title>Propri�t� d'une Datasource Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom d'une propri�t�</entry> + <entry>fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.datasource</literal> + </entry> + <entry> + <emphasis>Nom JNDI de la datasource</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.url</literal> + </entry> + <entry> + <emphasis>URL du fournisseur JNDI</emphasis> (optionnelle) + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.class</literal> + </entry> + <entry> + <emphasis>Classe de l'<literal>InitialContextFactory</literal> du JNDI</emphasis> (optionnelle) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>utilisateur de la base de donn�es</emphasis> (optionnelle) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>mot de passe de la base de donn�es</emphasis> (optionnelle) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Voici un exemple de fichier <literal>hibernate.properties</literal> + pour l'utilisation d'une datasource JNDI fournie par un serveur d'applications : + </para> + + <programlisting><![CDATA[hibernate.connection.datasource = java:/comp/env/jdbc/test +hibernate.transaction.factory_class = \ + org.hibernate.transaction.JTATransactionFactory +hibernate.transaction.manager_lookup_class = \ + org.hibernate.transaction.JBossTransactionManagerLookup +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + Les connexions JDBC obtenues � partir d'une datasource JNDI participeront automatiquement + aux transactions g�r�es par le conteneur du serveur d'applications. + </para> + + <para> + Des propri�t�s suppl�mentaires de connexion peuvent �tre pass�es en pr�fixant + le nom de la propri�t� par "<literal>hibernate.connnection</literal>". Par exemple, + vous pouvez sp�cifier un jeu de caract�res en utilisant + <literal>hibernate.connection.charSet</literal>. + </para> + + <para> + Vous pouvez fournir votre propre strat�gie d'obtention des connexions JDBC en impl�mentant l'interface + <literal>org.hibernate.connection.ConnectionProvider</literal>. Vous pouvez s�lectionner + une impl�mentation sp�cifique en positionnant <literal>hibernate.connection.provider_class</literal>. + </para> + + </sect1> + + <sect1 id="configuration-optional" revision="1"> + <title>Propri�t�s de configuration optionnelles</title> + + <para> + Il y a un certain nombre d'autres propri�t�s qui contr�lent le fonctionnement + d'Hibernate � l'ex�cution. Toutes sont optionnelles et ont comme valeurs par d�faut + des valeurs "raisonnables" pour un fonctionnement nominal. + </para> + + <para> + <emphasis>Attention : Certaines de ces propri�t�s sont uniquement de niveau System.</emphasis> + Les propri�t�s de niveau System ne peuvent �tre positionn�es que via la ligne de commande + (<literal>java -Dproperty=value</literal>) ou �tre d�finies dans <literal>hibernate.properties</literal>. + Elle <emphasis>ne peuvent pas</emphasis> l'�tre via une des autres techniques d�crites ci-dessus. + </para> + + <table frame="topbot" id="configuration-optional-properties" revision="8"> + <title>Propri�t�s de configuration d'Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.dialect</literal> + </entry> + <entry> + Le nom de la classe du <literal>Dialect</literal> Hibernate. + qui permet � Hibernate de g�n�rer du SQL optimis� pour une + base de donn�es relationnelle particuli�re. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>nom.complet.de.ma.classe.de.Dialect</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.show_sql</literal> + </entry> + <entry> + Ecrit toutes les requ�tes SQL sur la console. Il s'agit d'une + alternative au positionnement de la cat�gorie de log + <literal>org.hibernate.SQL</literal> au niveau <literal>debug</literal>. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.format_sql</literal> + </entry> + <entry> + Formate et indente le sql dans la console et dans le log + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_schema</literal> + </entry> + <entry> + Positionne dans le SQL g�n�r� un sch�ma/tablespace par d�faut pour les noms de + table ne l'ayant pas surcharg�. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>MON_SCHEMA</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_catalog</literal> + </entry> + <entry> + Qualifie les noms de tables non qualifi�es avec ce catalogue + dans le SQL g�n�r�. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>CATALOG_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.session_factory_name</literal> + </entry> + <entry> + La <literal>SessionFactory</literal> sera automatiquement + li�e � ce nom dans le JNDI apr�s sa cr�ation. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>jndi/nom/hierarchique</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.max_fetch_depth</literal> + </entry> + <entry> + D�finit la profondeur maximale d'un arbre de chargement par + jointures ouvertes pour les associations � cardinalit� unitaire + (un-�-un, plusieurs-�-un). + Un <literal>0</literal> d�sactive le chargement par jointure + ouverte. + <para> + <emphasis role="strong">ex.</emphasis> + valeurs recommand�es entre <literal>0</literal> et <literal>3</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_batch_fetch_size</literal> + </entry> + <entry> + D�finit une taille par d�faut pour le chargement par lot des associations + <para> + <emphasis role="strong">ex.</emphasis> + Valeurs recommand�es : <literal>4</literal>, <literal>8</literal>, + <literal>16</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_entity_mode</literal> + </entry> + <entry> + D�finit un mode de repr�sentation par d�faut des entit�s pour + toutes les sessions ouvertes depuis cette <literal>SessionFactory</literal> + <para> + <literal>dynamic-map</literal>, <literal>dom4j</literal>, + <literal>pojo</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.order_updates</literal> + </entry> + <entry> + Force Hibernate � trier les updates SQL par la valeur de la cl� + primaire des �l�ments qui sont mis � jour. Cela permet de limiter + les deadlocks de transaction dans les syst�mes hautement concurents. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.generate_statistics</literal> + </entry> + <entry> + Si activ�, Hibernate va collecter des statistiques utiles + pour le r�glage des performances. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_identifer_rollback</literal> + </entry> + <entry> + Si activ�, les propri�t�s correspondant � l'identifiant + des objets vont �tre remises aux valeurs par d�faut lorsque + les objets seront supprim�s. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_sql_comments</literal> + </entry> + <entry> + Si activ�, Hibernate va g�n�rer des commentaires � l'int�rieur + des requ�tes SQL pour faciliter le debogage., par d�faut � <literal>false</literal>. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-jdbc-properties" revision="8"> + <title>Propri�t�s Hibernate li�es � JDBC et aux connexions</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.jdbc.fetch_size</literal> + </entry> + <entry> + Une valeur non nulle d�termine la taille de chargement + des statements JDBC (appelle + <literal>Statement.setFetchSize()</literal>). + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_size</literal> + </entry> + <entry> + Une valeur non nulle active l'utilisation par Hibernate des mises + � jour par batch de JDBC2. + <para> + <emphasis role="strong">ex.</emphasis> + les valeurs recommand�es entre <literal>5</literal> et <literal>30</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_versioned_data</literal> + </entry> + <entry> + Param�trez cette propri�t� � <literal>true</literal> si votre pilote JDBC + retourne des row counts corrects depuis <literal>executeBatch()</literal> (il est + souvent appropri� d'activer cette option). Hibernate utilisera alors le "batched DML" pour + versionner automatiquement les donn�es. Par d�faut = <literal>false</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.factory_class</literal> + </entry> + <entry> + S�lectionne un <literal>Batcher</literal> personnalis�. La + plupart des applications n'auront pas besoin de cette propri�t� + de configuration + <para> + <emphasis role="strong">ex.</emphasis> + <literal>classname.of.BatcherFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_scrollable_resultset</literal> + </entry> + <entry> + Active l'utilisation par Hibernate des resultsets scrollables + de JDBC2. Cette propri�t� est seulement n�cessaire lorsque l'on + utilise une connexion JDBC fournie par l'utilisateur. Autrement, + Hibernate utilise les m�tadonn�es de la connexion. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_streams_for_binary</literal> + </entry> + <entry> + Utilise des flux lorsque l'on �crit/lit des types + <literal>binary</literal> ou <literal>serializable</literal> + vers et � partir de JDBC (propri�t� de niveau syst�me). + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_get_generated_keys</literal> + </entry> + <entry> + Active l'utilisation de <literal>PreparedStatement.getGeneratedKeys()</literal> de JDBC3 + pour r�cup�rer nativement les cl�s g�n�r�es apr�s insertion. N�cessite un pilote + JDBC3+, le mettre � false si votre pilote a des probl�mes avec les g�n�rateurs + d'identifiant Hibernate. Par d�faut, essaie de d�terminer les possibilit�s du + pilote en utilisant les meta donn�es de connexion. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.provider_class</literal> + </entry> + <entry> + Le nom de la classe d'un <literal>ConnectionProvider</literal> personnalis� + qui fournit des connexions JDBC � Hibernate + <para> + <emphasis role="strong">ex.</emphasis> + <literal>classname.of.ConnectionProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.isolation</literal> + </entry> + <entry> + D�finit le niveau d'isolation des transactions JDBC. Regardez + <literal>java.sql.Connection</literal> pour conna�tre le + sens des diff�rentes valeurs mais notez �galement que la plupart + des bases de donn�es ne supportent pas tous les niveaux d'isolation. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>1, 2, 4, 8</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.autocommit</literal> + </entry> + <entry> + Active le mode de commit automatique (autocommit) pour les connexions + JDBC du pool (non recommand�). + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.release_mode</literal> + </entry> + <entry> + Sp�cifie � quel moment Hibernate doit relacher les connexion JDBC. + Par d�faut une connexion JDBC est conserv�e jusqu'� ce que la session + soit explicitement ferm�e ou d�connect�e. Pour une source de donn�es + JTA d'un serveur d'application, vous devriez utiliser <literal>after_statement</literal> + pour lib�rer les connexions de mani�re plus agressive apr�s chaque appel + JDBC. Pour une connexion non JTA, il est souvent pr�f�rable de lib�rer + la connexion � la fin de chaque transaction en utilisant <literal>after_transaction</literal>. + <literal>auto</literal> choisira <literal>after_statement</literal> pour + des transactions JTA et CMT et <literal>after_transaction</literal> pour + des transactions JDBC. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>on_close</literal> (default) | <literal>after_transaction</literal> | + <literal>after_statement</literal> | <literal>auto</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.<emphasis><propertyName></emphasis></literal> + </entry> + <entry> + Passe la propri�t� JDBC<literal>propertyName</literal> + � <literal>DriverManager.getConnection()</literal>. + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.<emphasis><propertyName></emphasis></literal> + </entry> + <entry> + Passe la propri�t� <literal>propertyName</literal> � l'<literal>InitialContextFactory</literal> + de JNDI. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-cache-properties" revision="7"> + <title>Propri�t�s du Cache d'Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.cache.provider_class</literal> + </entry> + <entry> + Le nom de classe d'un <literal>CacheProvider</literal> + sp�cifique. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>nom.de.classe.du.CacheProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_minimal_puts</literal> + </entry> + <entry> + Optimise le cache de second niveau en minimisant les �critures, + au prix de plus de lectures. Ce param�tre est surtout utile pour + les caches en cluster et est activ� par d�faut dans hibernate3 + pour les impl�mentations de cache en cluster. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_query_cache</literal> + </entry> + <entry> + Activer le cache de requ�te, les requ�tes individuelles doivent tout + de m�me �tre d�clar�es comme pouvant �tre mise en cache. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_second_level_cache</literal> + </entry> + <entry> + Peut �tre utilis� pour d�sactiver compl�tement le cache de second niveau + qui est activ� par d�faut pour les classes qui sp�cifient un �l�ment + <literal><cache></literal> dans leur mapping. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.query_cache_factory</literal> + </entry> + <entry> + Le nom de classe d'une interface <literal>QueryCacheFactory</literal> , + par d�faut = built-in <literal>StandardQueryCacheFactory</literal>. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>nom.de.la.classe.de.QueryCacheFactory</literal> + </para> + </entry> + </row> + + <row> + <entry> + <literal>hibernate.cache.region_prefix</literal> + </entry> + <entry> + Un pr�fixe � utiliser pour le nom des r�gions du + cache de second niveau. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>prefix</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_structured_entries</literal> + </entry> + <entry> + Force Hibernate � stocker les donn�es dans le cache de + second niveau dans un format plus adapt� � la visualisation + par un humain. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-transaction-properties" revision="9"> + <title>Propri�t�s des transactions Hibernate</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.transaction.factory_class</literal> + </entry> + <entry> + Le nom de classe d'une <literal>TransactionFactory</literal> + qui sera utilis�e par l'API <literal>Transaction</literal> + d'Hibernate (la valeur par d�faut est + <literal>JDBCTransactionFactory</literal>). + <para> + <emphasis role="strong">ex.</emphasis> + <literal>nom.de.classe.d.une.TransactionFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>jta.UserTransaction</literal> + </entry> + <entry> + Le nom JNDI utilis� par la <literal>JTATransactionFactory</literal> + pour obtenir la <literal>UserTransaction</literal> JTA du serveur + d'applications. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>jndi/nom/compose</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.manager_lookup_class</literal> + </entry> + <entry> + Le nom de la classe du <literal>TransactionManagerLookup</literal> + - requis lorsque le cache de niveau JVM est activ� ou lorsque l'on + utilise un g�n�rateur hilo dans un environnement JTA. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>nom.de.classe.du.TransactionManagerLookup</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.flush_before_completion</literal> + </entry> + <entry> + Si activ�, la session sera automatiquement vid�e durant la phase + qui pr�c�de la fin de la transaction (before completion). + La gestion automatique de contexte fourni par Hibernate est + recommand�e, voir + <xref linkend="architecture-current-session"/>. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.auto_close_session</literal> + </entry> + <entry> + Si activ�, la session sera automatiquement ferm� pendant la phase + qui suit la fin de la transaction (after completion). + La gestion automatique de contexte fourni par Hibernate est + recommand�e, voir + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-misc-properties" revision="9"> + <title>Propri�t�s diverses</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.current_session_context_class</literal> + </entry> + <entry> + Fournit une strat�gie particuli�re pour contextualiser + la <literal>Session</literal> courante. Voir + <xref linkend="architecture-current-session"/> pour plus + d'informations sur les strat�gies fournies. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>jta</literal> | <literal>thread</literal> | + <literal>custom.Class</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.factory_class</literal> + </entry> + <entry> + Choisi l'impl�mentation du parseur de requ�te + <para> + <emphasis role="strong">ex.</emphasis> + <literal>org.hibernate.hql.ast.ASTQueryTranslatorFactory</literal> ou + <literal>org.hibernate.hql.classic.ClassicQueryTranslatorFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.substitutions</literal> + </entry> + <entry> + Lien entre les tokens de requ�tes Hibernate et les + tokens SQL (les tokens peuvent �tre des fonctions ou des + noms litt�raux par exemple). + <para> + <emphasis role="strong">ex.</emphasis> + <literal>hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.hbm2ddl.auto</literal> + </entry> + <entry> + Valide ou exporte automatiquement le sch�ma DDL vers la base de donn�es + lorsque la <literal>SessionFactory</literal> est cr��e. + La valeur <literal>create-drop</literal> permet de supprimer + le sch�ma de base de donn�es lorsque la <literal>SessionFactory</literal> + est ferm�e explicitement. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>validate</literal> | <literal>update</literal> | + <literal>create</literal> | <literal>create-drop</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cglib.use_reflection_optimizer</literal> + </entry> + <entry> + Active l'utilisation de CGLIB � la place de la r�flexion � l'ex�cution + (Propri�t� de niveau syst�me). La r�flexion peut parfois �tre utile pour + r�soudre des probl�mes. Notez qu'Hibernate a tout de m�me toujours besoin + de CGLIB m�me si l'optimiseur est d�sactiv�. Cette optimisation ne peut �tre + d�finie que dans le fichier <literal>hibernate.cfg.xml</literal>. + <para> + <emphasis role="strong">ex.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="configuration-optional-dialects" revision="1"> + <title>Dialectes SQL</title> + + <para> + Vous devriez toujours positionner la propri�t� <literal>hibernate.dialect</literal> � + la sous-classe de <literal>org.hibernate.dialect.Dialect</literal> appropri�e � + votre base de donn�es. Si vous sp�cifiez un dialecte, + Hibernate utilisera des valeurs adapt�es pour certaines autres + propri�t�s list�es ci-dessus, vous �vitant l'effort de le faire � la main. + </para> + + <table frame="topbot" id="sql-dialects" revision="2"> + <title>Dialectes SQL d'Hibernate (<literal>hibernate.dialect</literal>)</title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>SGBD</entry> + <entry>Dialecte</entry> + </row> + </thead> + <tbody> + <row> + <entry>DB2</entry> <entry><literal>org.hibernate.dialect.DB2Dialect</literal></entry> + </row> + <row> + <entry>DB2 AS/400</entry> <entry><literal>org.hibernate.dialect.DB2400Dialect</literal></entry> + </row> + <row> + <entry>DB2 OS390</entry> <entry><literal>org.hibernate.dialect.DB2390Dialect</literal></entry> + </row> + <row> + <entry>PostgreSQL</entry> <entry><literal>org.hibernate.dialect.PostgreSQLDialect</literal></entry> + </row> + <row> + <entry>MySQL</entry> <entry><literal>org.hibernate.dialect.MySQLDialect</literal></entry> + </row> + <row> + <entry>MySQL with InnoDB</entry> <entry><literal>org.hibernate.dialect.MySQLInnoDBDialect</literal></entry> + </row> + <row> + <entry>MySQL with MyISAM</entry> <entry><literal>org.hibernate.dialect.MySQLMyISAMDialect</literal></entry> + </row> + <row> + <entry>Oracle (any version)</entry> <entry><literal>org.hibernate.dialect.OracleDialect</literal></entry> + </row> + <row> + <entry>Oracle 9i/10g</entry> <entry><literal>org.hibernate.dialect.Oracle9Dialect</literal></entry> + </row> + <row> + <entry>Sybase</entry> <entry><literal>org.hibernate.dialect.SybaseDialect</literal></entry> + </row> + <row> + <entry>Sybase Anywhere</entry> <entry><literal>org.hibernate.dialect.SybaseAnywhereDialect</literal></entry> + </row> + <row> + <entry>Microsoft SQL Server</entry> <entry><literal>org.hibernate.dialect.SQLServerDialect</literal></entry> + </row> + <row> + <entry>SAP DB</entry> <entry><literal>org.hibernate.dialect.SAPDBDialect</literal></entry> + </row> + <row> + <entry>Informix</entry> <entry><literal>org.hibernate.dialect.InformixDialect</literal></entry> + </row> + <row> + <entry>HypersonicSQL</entry> <entry><literal>org.hibernate.dialect.HSQLDialect</literal></entry> + </row> + <row> + <entry>Ingres</entry> <entry><literal>org.hibernate.dialect.IngresDialect</literal></entry> + </row> + <row> + <entry>Progress</entry> <entry><literal>org.hibernate.dialect.ProgressDialect</literal></entry> + </row> + <row> + <entry>Mckoi SQL</entry> <entry><literal>org.hibernate.dialect.MckoiDialect</literal></entry> + </row> + <row> + <entry>Interbase</entry> <entry><literal>org.hibernate.dialect.InterbaseDialect</literal></entry> + </row> + <row> + <entry>Pointbase</entry> <entry><literal>org.hibernate.dialect.PointbaseDialect</literal></entry> + </row> + <row> + <entry>FrontBase</entry> <entry><literal>org.hibernate.dialect.FrontbaseDialect</literal></entry> + </row> + <row> + <entry>Firebird</entry> <entry><literal>org.hibernate.dialect.FirebirdDialect</literal></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-outerjoin" revision="4"> + <title>Chargement par Jointure Ouverte</title> + + <para> + Si votre base de donn�es supporte les outer joins de type ANSI, Oracle ou Sybase, + <emphasis>le chargement par jointure ouverte</emphasis> devrait am�liorer les + performances en limitant le nombre d'aller-retour avec la base de donn�es (la + base de donn�es effectuant donc potentiellement plus de travail). Le chargement par + jointure ouverte permet � un graphe entier d'objets connect�s par une relation plusieurs-�-un, + un-�-plusieurs ou un-�-un d'�tre charg� en un seul <literal>SELECT</literal> SQL. + </para> + + <para> + Le chargement par jointure ouverte peut �tre d�sactiver <emphasis>globalement</emphasis> + en mettant la propri�t� <literal>hibernate.max_fetch_depth</literal> � <literal>0</literal>. + Une valeur de <literal>1</literal> ou plus active le chargement par jointure ouverte + pour les associatiosn un-�-un et plusieurs-�-un qui ont �t� mapp�e avec + <literal>fetch="join"</literal>. + </para> + + <para> + Reportez vous � <xref linkend="performance-fetching"/> pour plus d'information. + </para> + + </sect2> + + <sect2 id="configuration-optional-binarystreams" revision="1"> + <title>Flux binaires</title> + + <para> + Oracle limite la taille d'un tableau de <literal>byte</literal> qui peuvent �tre + pass�es � et vers son pilote JDBC. Si vous souhaitez utiliser des instances larges + de type <literal>binary</literal> ou <literal>serializable</literal>, vous devez activer + la propri�t� <literal>hibernate.jdbc.use_streams_for_binary</literal>. <emphasis>C'est une + fonctionalit� de niveau syst�me uniquement.</emphasis> + </para> + + </sect2> + + <sect2 id="configuration-optional-cacheprovider" revision="2"> + <title>Cache de second niveau et cache de requ�tes</title> + + <para> + Les propri�t�s pr�fix�es par <literal>hibernate.cache</literal> + vous permettent d'utiliser un syst�me de cache de second niveau. Ce cache + peut avoir une port�e dans le processus ou m�me �tre utilisable dans un + syst�me distribu�. R�f�rez vous au chapitre <xref linkend="performance-cache"/> + pour plus de d�tails. + </para> + + </sect2> + + <sect2 id="configuration-optional-querysubstitution"> + <title>Substitution dans le langage de requ�tage</title> + + <para> + Vous pouvez d�finir de nouveaux tokens dans les requ�tes Hibernate en utilisant la propri�t� + <literal>hibernate.query.substitutions</literal>. Par exemple : + </para> + + <programlisting>hibernate.query.substitutions vrai=1, faux=0</programlisting> + + <para> + remplacerait les tokens <literal>vrai</literal> et <literal>faux</literal> par + des entiers dans le SQL g�n�r�. + </para> + + <programlisting>hibernate.query.substitutions toLowercase=LOWER</programlisting> + + <para> + permettrait de renommer la fonction SQL <literal>LOWER</literal> en <literal>toLowercase</literal> + </para> + + </sect2> + + <sect2 id="configuration-optional-statistics" revision="2"> + <title>Statistiques Hibernate</title> + + <para> + Si vous activez <literal>hibernate.generate_statistics</literal>, Hibernate va + fournir un certains nombre de m�triques utiles pour r�gler les performances + d'une application qui tourne via <literal>SessionFactory.getStatistics()</literal>. + Hibernate peut aussi �tre configur� pour exposer ces statistiques via JMX. + Lisez les Javadoc des interfaces dans le package + <literal>org.hibernate.stats</literal> pour plus d'informations. + </para> + + </sect2> + </sect1> + + <sect1 id="configuration-logging"> + <title>Tracer</title> + + <para> + Hibernate trace divers �v�nements en utilisant Apache commons-logging. + </para> + + <para> + Le service commons-logging d�l�guera directement � Apache Log4j + (si vous incluez <literal>log4j.jar</literal> dans votre classpath) + ou le syst�me de trace du JDK 1.4 (si vous tournez sous le JDK 1.4 + et sup�rieur). Vous pouvez t�l�charger Log4j � partir de + <literal>http://jakarta.apache.org</literal>. Pour utiliser Log4j, + vous devrez placer dans votre classpath un fichier + <literal>log4j.properties</literal>. Un exemple de fichier est distribu� + avec Hibernate dans le r�pertoire <literal>src/</literal>. + </para> + + <para> + Nous vous recommandons fortement de vous familiariser avec les messages des traces + d'Hibernate. Beaucoup de soins a �t� apport� pour donner le plus de d�tails + possible sans les rendre illisibles. C'est un outil essentiel en cas de soucis. + Les cat�gories de trace les plus int�ressantes sont les suivantes : + </para> + + <table frame="topbot" id="log-categories" revision="2"> + <title>Cat�gories de trace d'Hibernate</title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>Cat�gorie</entry> + <entry>Fonction</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.SQL</literal></entry> + <entry>Trace toutes les requ�ts SQL de type DML (gestion des donn�es) qui sont ex�cut�es</entry> + </row> + <row> + <entry><literal>org.hibernate.type</literal></entry> + <entry>Trace tous les param�tres JDBC</entry> + </row> + <row> + <entry><literal>org.hibernate.tool.hbm2ddl</literal></entry> + <entry>Trace toutes les requ�ts SQL de type DDL (gestion de la structure de la base) qui sont ex�cut�es</entry> + </row> + <row> + <entry><literal>org.hibernate.pretty</literal></entry> + <entry> + Trace l'�tat de toutes les entit�s (20 entit�s maximum) qui + sont associ�es avec la session hibernate au moment du flush + </entry> + </row> + <row> + <entry><literal>org.hibernate.cache</literal></entry> + <entry>Trace toute l'activit� du cache de second niveau</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction</literal></entry> + <entry>Trace toute l'activit� relative aux transactions</entry> + </row> + <row> + <entry><literal>org.hibernate.jdbc</literal></entry> + <entry>Trace toute acquisition de ressource JDBC</entry> + </row> + <row> + <entry><literal>org.hibernate.hql.ast.AST</literal></entry> + <entry> + Trace l'arbre syntaxique des requ�tes HQL et SQL durant l'analyse syntaxique des requ�tes + </entry> + </row> + <row> + <entry><literal>org.hibernate.secure</literal></entry> + <entry>Trace toutes les demandes d'autorisation JAAS</entry> + </row> + <row> + <entry><literal>org.hibernate</literal></entry> + <entry> + Trace tout (beaucoupe d'informations, mais tr�s utile pour r�soudre les probl�mes). + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Lorsque vous d�veloppez des applications avec Hibernate, vous devriez quasiment toujours + travailler avec le niveau <literal>debug</literal> activ� pour la cat�gorie + <literal>org.hibernate.SQL</literal>, ou sinon avec la propri�t� + <literal>hibernate.show_sql</literal> activ�e. + </para> + + + </sect1> + + <sect1 id="configuration-namingstrategy"> + <title>Impl�menter une <literal>NamingStrategy</literal></title> + + <para> + L'interface <literal>org.hibernate.cfg.NamingStrategy</literal> vous permet de + sp�cifier une "strat�gie de nommage" des objets et �l�ments de la base de donn�es. + </para> + + <para> + Vous pouvez fournir des r�gles pour automatiquement g�n�rer les identifiants + de base de donn�es � partir des identifiants Java, ou transformer une colonne + ou table "logique" donn�e dans le fichier de mapping en une colonne ou table + "physique". Cette fonctionnalit� aide � r�duire la verbosit� de documents + de mapping, en �liminant le bruit r�p�titif (les pr�fixes <literal>TBL_</literal> + par exemple). La strat�gie par d�faut utilis�e par Hibernate est minimale. + </para> + + <para> + Vous pouvez d�finir une strat�gie diff�rente en appelant + <literal>Configuration.setNamingStrategy()</literal> avant d'ajouter des + mappings : + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .setNamingStrategy(ImprovedNamingStrategy.INSTANCE) + .addFile("Item.hbm.xml") + .addFile("Bid.hbm.xml") + .buildSessionFactory();]]></programlisting> + + <para> + <literal>net.sf.hibernate.cfg.ImprovedNamingStrategy</literal> est une + strat�gie fournie qui peut �tre utile comme point de d�part de quelques + applications. + </para> + + </sect1> + + <sect1 id="configuration-xmlconfig" revision="2"> + <title>Fichier de configuration XML</title> + + <para> + Une approche alternative est de sp�cifier toute la configuration dans un + fichier nomm� <literal>hibernate.cfg.xml</literal>. Ce fichier peut �tre + utilis� � la place du fichier <literal>hibernate.properties</literal>, voire + m�me peut servir � surcharger les propri�t�s si les deux fichiers sont pr�sents. + </para> + + <para> + Le fichier de configuration XML doit par d�faut se placer � la racine + du <literal>CLASSPATH</literal>. En voici un exemple : + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + +  + <session-factory + name="java:hibernate/SessionFactory"> + +  + <property name="connection.datasource">java:/comp/env/jdbc/MyDB</property> + <property name="dialect">org.hibernate.dialect.MySQLDialect</property> + <property name="show_sql">false</property> + <property name="transaction.factory_class"> + org.hibernate.transaction.JTATransactionFactory + </property> + <property name="jta.UserTransaction">java:comp/UserTransaction</property> + +  + <mapping resource="org/hibernate/auction/Item.hbm.xml"/> + <mapping resource="org/hibernate/auction/Bid.hbm.xml"/> + +  + <class-cache class="org.hibernate.auction.Item" usage="read-write"/> + <class-cache class="org.hibernate.auction.Bid" usage="read-only"/> + <collection-cache collection="org.hibernate.auction.Item.bids" usage="read-write"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + Commme vous pouvez le voir, l'avantage de cette approche est l'externalisation + des noms des fichiers de mapping de la configuration. Le fichier <literal>hibernate.cfg.xml</literal> + est �galement plus pratique quand on commence � r�gler le cache d'Hibernate. Notez + que vous pouvez choisir entre utiliser <literal>hibernate.properties</literal> ou + <literal>hibernate.cfg.xml</literal>, les deux sont �quivalents, sauf en ce qui + concerne les b�n�fices de l'utilisation de la syntaxe XML mentionn�s ci-dessus. + </para> + + <para> + Avec la configuration XML, d�marrer Hibernate devient donc aussi simple que ceci : + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration().configure().buildSessionFactory();]]></programlisting> + + + + </sect1> + + <sect1 id="configuration-j2ee" revision="1"> + <title>Int�gration � un serveur d'application J2EE</title> + + <para> + Hibernate poss�de les points suivants d'int�gration � l'infrastructure J2EE : + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Source de donn�es g�r�e par le conteneur</emphasis> : Hibernate peut + utiliser des connexions JDBC g�r�es par le conteneur et fournie par l'interm�diaire + de JNDI. Souvent, un <literal>TransactionManager</literal> compatible JTA + et un <literal>ResourceManager</literal> s'occupent de la gestion des transactions (CMT). + Ils sont particuli�rement pr�vus pour pouvoir g�rer des transactions distribu�es + sur plusieurs sources de donn�es. Vous pouvez bien s�r �galement d�finir vos + limites de transaction dans votre programme (BMT) ou vous pouvez sinon aussi + utiliser l'API optionnelle <literal>Transaction</literal> d'Hibernate qui vous garantira + la portabilit� de votre code entre plusieurs serveurs d'application. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>Association JNDI automatique</emphasis>: Hibernate peut associer sa + <literal>SessionFactory</literal> � JNDI apr�s le d�marrage. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>Association de la Session � JTA:</emphasis> La <literal>Session</literal> Hibernate + peut �tre associ�e automatiquement � une transaction JTA si vous utilisez les EJBs. + Vous avez juste � r�cup�rer la <literal>SessionFactory</literal> depuis JNDI et + � r�cup�rer la <literal>Session</literal> courante. Hibernate s'occupe de vider et + fermer la <literal>Session</literal> lorsque le transaction JTA se termine. La + d�marcation des transactions se fait de mani�re d�clarative dans les descripteurs de d�ploiement. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>D�ploiement JMX :</emphasis>Si vous avez un serveur d'application compatible JMX + (JBoss AS par exemple), vous pouvez choisir de d�ployer Hibernate en temps que MBean g�r� par + le serveur. Cela vous �vite de coder la ligne de d�marrage qui permet de construire + la <literal>SessionFactory</literal> depuis la <literal>Configuration</literal>. + Le conteneur va d�marrer votre <literal>HibernateService</literal>, et va id�alement + s'occuper des d�pendances entre les services (la source de donn�es doit �tre disponible + avant qu'Hibernate ne d�marre, etc). + </para> + </listitem> + </itemizedlist> + + <para> + En fonction de votre environnement, vous devrez peut �tre mettre l'option de + configuration <literal>hibernate.connection.aggressive_release</literal> � vrai si + le serveur d'application affiche des exceptions de type "connection containment". + </para> + + <sect2 id="configuration-optional-transactionstrategy" revision="3"> + <title>Configuration de la strat�gie transactionnelle</title> + + <para> + L'API de la <literal>Session</literal> Hibernate est ind�pendante de tout syst�me + de d�marcation des transactions qui peut �tre pr�sent dans votre architecture. Si + vous laissez Hibernate utiliser l'API JDBC directement via un pool de connexion, vous + devrez commencer et terminer vos transactions en utilisant l'API JDBC. Si votre + application tourne � l'int�rieur d'un serveur d'application J2EE, vous voudrez peut �tre + utiliser les transactions g�r�es par les beans (BMT) et appeller l'API JTA et + <literal>UserTransaction</literal> lorsque cela est n�cessaire. + </para> + <para> + Pour conserver votre code portable entre ces deux environnements (et d'autres �ventuels) + nous vous recommandons d'utiliser l'API optionnelle <literal>Transaction</literal> d'Hibernate, + qui va encapsuler et masquer le syst�me de transaction sous-jacent. + Pour cela, vous devez pr�ciser une classe de fabrique d'instances de <literal>Transaction</literal> + en positionnant la propri�t� + <literal>hibernate.transaction.factory_class</literal>. + </para> + + <para> + Il existe trois choix standards (fournis) : + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term><literal>net.sf.hibernate.transaction.JDBCTransactionFactory</literal></term> + <listitem> + <para>d�l�gue aux transactions de la base de donn�es (JDBC). Valeur par d�faut.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.JTATransactionFactory</literal></term> + <listitem> + <para> + d�l�gue � CMT si une transaction existante est sous ce contexte (ex: m�thode + d'un EJB session), sinon une nouvelle transaction est entam�e et + une transaction g�r�e par le bean est utilis�e. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.CMTTransactionFactory</literal></term> + <listitem> + <para>d�l�gue � aux transactions JTA g�r�es par le conteneur</para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Vous pouvez �galement d�finir votre propre strat�gie transactionnelle + (pour un service de transaction CORBA par exemple). + </para> + + <para> + Certaines fonctionnalit�s d'Hibernate (i.e. le cache de second niveau, l'association + automatique des Session � JTA, etc.) n�cessitent l'acc�s au <literal>TransactionManager</literal> + JTA dans un environnement "manag�". Dans un serveur d'application, vous devez indiquer + comment Hibernate peut obtenir une r�f�rence vers le <literal>TransactionManager</literal>, + car J2EE ne fournit pas un seul m�canisme standard. + </para> + + <table frame="topbot" id="jtamanagerlookup" revision="1"> + <title>TransactionManagers JTA</title> + <tgroup cols="2"> + <colspec colwidth="2.5*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry>Fabrique de Transaction</entry> + <entry align="center">Serveur d'application</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.transaction.JBossTransactionManagerLookup</literal></entry> + <entry align="center">JBoss</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WeblogicTransactionManagerLookup</literal></entry> + <entry align="center">Weblogic</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereTransactionManagerLookup</literal></entry> + <entry align="center">WebSphere</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereExtendedJTATransactionLookup</literal></entry> + <entry align="center">WebSphere 6</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.OrionTransactionManagerLookup</literal></entry> + <entry align="center">Orion</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.ResinTransactionManagerLookup</literal></entry> + <entry align="center">Resin</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOTMTransactionManagerLookup</literal></entry> + <entry align="center">JOTM</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOnASTransactionManagerLookup</literal></entry> + <entry align="center">JOnAS</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JRun4TransactionManagerLookup</literal></entry> + <entry align="center">JRun4</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.BESTransactionManagerLookup</literal></entry> + <entry align="center">Borland ES</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-jndi" revision="3"> + <title><literal>SessionFactory</literal> associ�e au JNDI</title> + + <para> + Une <literal>SessionFactory</literal> Hibernate associ�e au JNDI peut + simplifier l'acc�s � la fabrique et donc la cr�ation de nouvelles + <literal>Session</literal>s. Notez que cela n'est pas li� avec les <literal>Datasource</literal> + associ�es au JNDI, elles utilisent juste le m�me registre. + </para> + + <para> + Si vous d�sirez associer la <literal>SessionFactory</literal> � un nom JNDI, + sp�cifiez un nom (ex. <literal>java:hibernate/SessionFactory</literal>) en + utilisant la propri�t� <literal>hibernate.session_factory_name</literal>. + Si cette propri�t� est omise, la <literal>SessionFactory</literal> ne sera pas + associ�e au JNDI (c'est particuli�rement pratique dans les environnements ayant une + impl�mentation de JNDI en lecture seule, comme c'est le cas pour Tomcat). + </para> + + <para> + Lorsqu'il associe la <literal>SessionFactory</literal> au JNDI, Hibernate utilisera + les valeurs de <literal>hibernate.jndi.url</literal>, <literal>hibernate.jndi.class</literal> + pour instancier un contexte d'initialisation. S'ils ne sont pas sp�cifi�s, + l'<literal>InitialContext</literal> par d�faut sera utilis�. + </para> + + <para> + Hibernate va automatiquement placer la <literal>SessionFactory</literal> dans JNDI + apr�s avoir appel� <literal>cfg.buildSessionFactory()</literal>. Cela signifie que vous + devez avoir cet appel dans un code de d�marrage (ou dans une classe utilitaire) dans + votre application sauf si vous utilisez le d�ploiement JMX avec le service + <literal>HibernateService</literal> pr�sent� plus tard dans ce document. + </para> + <para> + Si vous utilisez <literal>SessionFactory</literal> JNDI, un EJB ou n'importe quelle autre classe + peut obtenir la <literal>SessionFactory</literal> en utilisant un lookup JNDI. + </para> + + <para> + Nous recommandons que vous liiez la <literal>SessionFactory</literal> � JNDI dans les + environnements manag�s et que vous utilisiez un singleton <literal>static</literal> si ce n'est pas le cas. + Pour isoler votre application de ces d�tails, nous vous recommandons aussi de masquer + le code de lookup actuel pour une <literal>SessionFactory</literal> dans une classe helper, + comme <literal>HibernateUtil.getSessionFactory()</literal>. Notez qu'une telle classe + est aussi un moyen efficace de d�marrer Hibernate—voir chapitre 1. + </para> + </sect2> + + <sect2 id="configuration-j2ee-currentsession" revision="4"> + <title>Association automatique de la Session � JTA</title> + + <para> + Le moyen le plus simple de g�rer les <literal>Session</literal>s et transactions est + la gestion automatique de session "courante" offerte par Hibernate. + Voir d�tail � <xref linkend="architecture-current-session">current sessions</xref>. + En utilisant le contexte de session <literal>"jta"</literal> session context, s'il n'y a pas + de <literal>Session</literal> associ�e � la transaction JTA courante, une session sera + d�marr�e et associ�e � la transaction JTA courante la premi�re fois que vous appelez + <literal>sessionFactory.getCurrentSession()</literal>. Les <literal>Session</literal>s + obtenue via <literal>getCurrentSession()</literal> dans une contexte <literal>"jta"</literal> + seront automatiquement flush�es avant la validation de la transaction, ferm�es une fois + la transaction compl�t�e, et lib�reront les connexions JDBC de mani�re aggressive + apr�s chaque statement. Ceci permet aux <literal>Session</literal>s d'�tre + g�r�es par le cycle de vie de la transaction JTA � la quelle est sont associ�es, + laissant le code de l'utilisateur propre de ce type de gestion. Votre code peut + soit utiliser JTA de mani�re programmatique via <literal>UserTransaction</literal>, ou (ce qui est recommand� + pour la portabilit� du code) utiliser l'API <literal>Transaction</literal> API pour marquer + les limites. Si vous ex�cutez sous un conteneur EJB, la d�marcation d�clarative des transactions + avec CMT est recommand�e. + </para> + + </sect2> + + <sect2 id="configuration-j2ee-jmx" revision="1"> + <title>D�ploiement JMX</title> + + <para> + La ligne <literal>cfg.buildSessionFactory()</literal> doit toujours �tre ex�cut�e + quelque part pour avoir une <literal>SessionFactory</literal> dans JNDI. Vous pouvez + faire cela dans un bloc d'initialisation <literal>static</literal> (comme + celui qui se trouve dans la classe <literal>HibernateUtil</literal>) ou vous pouvez + d�ployer Hibernate en temps que <emphasis>service manag�</emphasis>. + </para> + + <para> + Hibernate est distribu� avec <literal>org.hibernate.jmx.HibernateService</literal> + pour le d�ploiement sur un serveur d'application avec le support de JMX comme JBoss AS. + Le d�ploiement et la configuration sont sp�cifiques � chaque vendeur. Voici un fichier + <literal>jboss-service.xml</literal> d'exemple pour JBoss 4.0.x: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<server> + +<mbean code="org.hibernate.jmx.HibernateService" + name="jboss.jca:service=HibernateFactory,name=HibernateFactory"> + +  + <depends>jboss.jca:service=RARDeployer</depends> + <depends>jboss.jca:service=LocalTxCM,name=HsqlDS</depends> + +  + <attribute name="JndiName">java:/hibernate/SessionFactory</attribute> + +  + <attribute name="Datasource">java:HsqlDS</attribute> + <attribute name="Dialect">org.hibernate.dialect.HSQLDialect</attribute> + +  + <attribute name="TransactionStrategy"> + org.hibernate.transaction.JTATransactionFactory</attribute> + <attribute name="TransactionManagerLookupStrategy"> + org.hibernate.transaction.JBossTransactionManagerLookup</attribute> + <attribute name="FlushBeforeCompletionEnabled">true</attribute> + <attribute name="AutoCloseSessionEnabled">true</attribute> + +  + <attribute name="MaximumFetchDepth">5</attribute> + +  + <attribute name="SecondLevelCacheEnabled">true</attribute> + <attribute name="CacheProviderClass">org.hibernate.cache.EhCacheProvider</attribute> + <attribute name="QueryCacheEnabled">true</attribute> + +  + <attribute name="ShowSqlEnabled">true</attribute> + +  + <attribute name="MapResources">auction/Item.hbm.xml,auction/Category.hbm.xml</attribute> + +</mbean> + +</server>]]></programlisting> + + <para> + Ce fichier est d�ploy� dans un r�pertoire <literal>META-INF</literal> et est packag� + dans un fichier JAR avec l'extension <literal>.sar</literal> (service archive). + Vous devez �galement packager Hibernate, les librairies tierces requises, vos classes + persistantes compil�es et vos fichiers de mapping dans la m�me archive. Vos beans + entreprise (souvent des EJBs session) peuvent rester dans leur propre fichier JAR mais + vous pouvez inclure ce fichier JAR dans le jar principal du service pour avoir une seule unit� + d�ployable � chaud. Vous pouvez consulter la documentation de JBoss AS pour plus d'information + sur les services JMX et le d�ploiement des EJBs. + </para> + + </sect2> + + + </sect1> + + + + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/events.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/events.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/events.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/events.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,263 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="events"> + <title>Les intercepteurs et les �v�nements</title> + + <para> + Il est souvent utile pour l'application de r�agir � certains �v�nements + qui surviennent dans Hibernate. Cela autorise l'impl�mentation de certaines sortes de + fonctionnalit�s g�n�riques, et d'extensions de fonctionnalit�s d'Hibernate. + </para> + + <sect1 id="objectstate-interceptors" revision="2"> + <title>Intercepteurs</title> + + <para> + L'interface <literal>Interceptor</literal> fournit des "callbacks" de la session vers l'application + et permettent � l'application de consulter et/ou de manipuler des propri�t�s + d'un objet persistant avant qu'il soit sauvegard�, mis � jour, supprim� ou charg�. + Une utilisation possible de cette fonctionnalit� est de tracer l'acc�s � l'information. + Par exemple, l'<literal>Interceptor</literal> suivant positionne + <literal>createTimestamp</literal> quand un <literal>Auditable</literal> est cr�� + et met � jour la propri�t� <literal>lastUpdateTimestamp</literal> quand un + <literal>Auditable</literal> est mis � jour. + </para> + + <para> + Vous pouvez soit impl�menter <literal>Interceptor</literal> directement ou (mieux) + �tendre <literal>EmptyInterceptor</literal>. + </para> + + <programlisting><![CDATA[package org.hibernate.test; + +import java.io.Serializable; +import java.util.Date; +import java.util.Iterator; + +import org.hibernate.EmptyInterceptor; +import org.hibernate.Transaction; +import org.hibernate.type.Type; + +public class AuditInterceptor extends EmptyInterceptor { + + private int updates; + private int creates; + private int loads; + + public void onDelete(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + // ne fait rien + } + + public boolean onFlushDirty(Object entity, + Serializable id, + Object[] currentState, + Object[] previousState, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + updates++; + for ( int i=0; i < propertyNames.length; i++ ) { + if ( "lastUpdateTimestamp".equals( propertyNames[i] ) ) { + currentState[i] = new Date(); + return true; + } + } + } + return false; + } + + public boolean onLoad(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + if ( entity instanceof Auditable ) { + loads++; + } + return false; + } + + public boolean onSave(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + creates++; + for ( int i=0; i<propertyNames.length; i++ ) { + if ( "createTimestamp".equals( propertyNames[i] ) ) { + state[i] = new Date(); + return true; + } + } + } + return false; + } + + public void postFlush(Iterator entities) { + System.out.println("Creations: " + creates + ", Updates: " + updates); + } + + public void afterTransactionCompletion(Transaction tx) { + if ( tx.wasCommitted() ) { + System.out.println("Creations: " + creates + ", Updates: " + updates, "Loads: " + loads); + } + updates=0; + creates=0; + loads=0; + } + +}]]></programlisting> + + <para> + L'intercepteur doit �tre sp�cifi� quand une session est cr��e. + </para> + + <programlisting><![CDATA[Session session = sf.openSession( new AuditInterceptor() );]]></programlisting> + + <para> + Vous pouvez aussi mettre un intercepteur au niveau global, en utilisant l'objet <literal>Configuration</literal>. + Dans ce cas, l'intercepteur doit �tre "threadsafe". + </para> + + <programlisting><![CDATA[new Configuration().setInterceptor( new AuditInterceptor() );]]></programlisting> + + </sect1> + + <sect1 id="objectstate-events" revision="3"> + <title>Syst�me d'�v�nements</title> + + <para> + Si vous devez r�agir � des �v�nements particuliers dans votre couche de persistance, + vous pouvez aussi utiliser l'architecture d'<emphasis>�v�nements</emphasis> d'Hibernate3. + Le syst�me d'�v�nements peut �tre utilis� en suppl�ment ou en remplacement des interceptors. + </para> + + <para> + Essentiellement toutes les m�thodes de l'interface <literal>Session</literal> sont corr�l�es � + un �v�nement. Vous avez un <literal>LoadEvent</literal>, un <literal>FlushEvent</literal>, etc + (consultez la DTD du fichier de configuration XML ou le paquet <literal>org.hibernate.event</literal> + pour avoir la liste compl�te des types d'�v�nement d�finis). + Quand une requ�te est faite � partir d'une de ces m�thodes, la + <literal>Session</literal> Hibernate g�n�re un �v�nement appropri� et le passe + au listener configur� pour ce type. + Par d�faut, ces listeners impl�mentent le m�me traitement dans lequel ces m�thodes + aboutissent toujours. + Cependant, vous �tes libre d'impl�menter une version personnalis�e d'une de ces + interfaces de listener (c'est-�-dire, le <literal>LoadEvent</literal> est trait� par + l'impl�mentation de l'interface <literal>LoadEventListener</literal> d�clar�e), dans + quel cas leur impl�mentation devrait �tre responsable du traitement des + requ�tes <literal>load()</literal> faites par la <literal>Session</literal>. + </para> + + <para> + Les listeners devraient effectivement �tre consid�r�s comme des singletons ; dans le sens + o� ils sont partag�s entre des requ�tes, et donc ne devraient pas sauvegarder des �tats + de variables d'instance. + </para> + + <para> + Un listener personnalis� devrait impl�menter l'interface appropri�e pour l'�v�nement + qu'il veut traiter et/ou �tendre une des classes de base (ou m�me l'�v�nement pr�t � + l'emploi utilis� par Hibernate comme ceux d�clar�s non-finaux � cette intention). Les + listeners personnalis�s peuvent �tre soit inscrits par programmation � travers l'objet + <literal>Configuration</literal>, ou sp�cifi�s la configuration XML d'Hibernate + (la configuration d�clarative � travers le fichier de propri�t�s n'est pas support�e). + Voici un exemple de listener personnalis� pour l'�v�nement de chargement : + </para> + + <programlisting><![CDATA[public class MyLoadListener implements LoadEventListener { + // C'est une simple m�thode d�finie par l'interface LoadEventListener + public void onLoad(LoadEvent event, LoadEventListener.LoadType loadType) + throws HibernateException { + if ( !MySecurity.isAuthorized( event.getEntityClassName(), event.getEntityId() ) ) { + throw MySecurityException("Unauthorized access"); + } + } +}]]></programlisting> + + <para> + Vous avez aussi besoin d'une entr�e de configuration disant � Hibernate d'utiliser + ce listener en plus du listener par d�faut : + </para> + +<programlisting><![CDATA[<hibernate-configuration> + <session-factory> + ... + <event type="load"> + <listener class="com.eg.MyLoadListener"/> + <listener class="org.hibernate.event.def.DefaultLoadEventListener"/> + </event> + </session-factory> +</hibernate-configuration>]]></programlisting> + + <para> + Vous pouvez aussi l'inscrire par programmation : + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration(); +LoadEventListener[] stack = { new MyLoadListener(), new DefaultLoadEventListener() }; +cfg.EventListeners().setLoadEventListeners(stack);]]></programlisting> + + <para> + Les listeners inscrits d�clarativement ne peuvent pas partager d'instances. Si le m�me + nom de classe est utilis�e dans plusieurs �l�ments <literal><listener/></literal>, + chaque r�f�rence sera une instance distincte de cette classe. Si vous avez besoin de la + facult� de partager des instances de listener entre plusieurs types de listener, vous devez + utiliser l'approche d'inscription par programmation. + </para> + + <para> + Pourquoi impl�menter une interface et d�finir le type sp�cifique durant la configuration ? + Une impl�mentation de listener pourrait impl�menter plusieurs interfaces de listener + d'�v�nements. Avoir en plus le type d�fini durant l'inscription rend plus facile + l'activation ou la d�sactivation pendant la configuration. + </para> + + </sect1> + + <sect1 id="objectstate-decl-security" revision="2"> + <title>S�curit� d�clarative d'Hibernate</title> + <para> + G�n�ralement, la s�curit� d�clarative dans les applications Hibernate est g�r�e dans la + couche de session. Maintenant, Hibernate3 permet � certaines actions d'�tre approuv�es + via JACC, et autoris�es via JAAS. Cette fonctionnalit� optionnelle est construite + au dessus de l'architecture d'�v�nements. + </para> + + <para> + D'abord, vous devez configurer les listeners d'�v�nements appropri�s pour permettre + l'utilisation d'autorisations JAAS. + </para> + + <programlisting><![CDATA[<listener type="pre-delete" class="org.hibernate.secure.JACCPreDeleteEventListener"/> +<listener type="pre-update" class="org.hibernate.secure.JACCPreUpdateEventListener"/> +<listener type="pre-insert" class="org.hibernate.secure.JACCPreInsertEventListener"/> +<listener type="pre-load" class="org.hibernate.secure.JACCPreLoadEventListener"/>]]></programlisting> + + <para> + Notez que <literal><listener type="..." class="..."/></literal> est juste un raccourci + pour <literal><event type="..."><listener class="..."/></event></literal> + quand il y a exactement un listener pour un type d'�v�nement particulier. + </para> + + <para> + Ensuite, toujours dans <literal>hibernate.cfg.xml</literal>, lier les permissions aux r�les : + </para> + + <programlisting><![CDATA[<grant role="admin" entity-name="User" actions="insert,update,read"/> +<grant role="su" entity-name="User" actions="*"/>]]></programlisting> + + <para> + Les noms de r�le sont les r�les compris par votre fournisseur JAAC. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_mappings.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/example_mappings.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_mappings.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_mappings.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,672 @@ +<?xml version="1.0" encoding="iso-8859-1"?> + +<chapter id="example-mappings"> + <title>Exemple : quelques mappings</title> + + <para> + Ce chapitre montre quelques mappings plus complexes. + </para> + + <sect1 id="example-mappings-emp"> + <title>Employeur/Employ� (Employer/Employee)</title> + + <para> + Le mod�le suivant de relation entre <literal>Employer</literal> et + <literal>Employee</literal> utilise une vraie classe entit� (<literal>Employment</literal>) + pour repr�senter l'association. On a fait cela parce qu'il peut y avoir plus d'une p�riode + d'emploi pour les deux m�mes parties. Des composants sont utilis�s pour mod�liser les + valeurs mon�taires et les noms des employ�s. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/EmployerEmployee.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/EmployerEmployee.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + Voici un document de mapping possible : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Employer" table="employers"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employer_id_seq</param> + </generator> + </id> + <property name="name"/> + </class> + + <class name="Employment" table="employment_periods"> + + <id name="id"> + <generator class="sequence"> + <param name="sequence">employment_id_seq</param> + </generator> + </id> + <property name="startDate" column="start_date"/> + <property name="endDate" column="end_date"/> + + <component name="hourlyRate" class="MonetaryAmount"> + <property name="amount"> + <column name="hourly_rate" sql-type="NUMERIC(12, 2)"/> + </property> + <property name="currency" length="12"/> + </component> + + <many-to-one name="employer" column="employer_id" not-null="true"/> + <many-to-one name="employee" column="employee_id" not-null="true"/> + + </class> + + <class name="Employee" table="employees"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employee_id_seq</param> + </generator> + </id> + <property name="taxfileNumber"/> + <component name="name" class="Name"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </component> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Et voici le sch�ma des tables g�n�r�es par <literal>SchemaExport</literal>. + </para> + + <programlisting><![CDATA[create table employers ( + id BIGINT not null, + name VARCHAR(255), + primary key (id) +) + +create table employment_periods ( + id BIGINT not null, + hourly_rate NUMERIC(12, 2), + currency VARCHAR(12), + employee_id BIGINT not null, + employer_id BIGINT not null, + end_date TIMESTAMP, + start_date TIMESTAMP, + primary key (id) +) + +create table employees ( + id BIGINT not null, + firstName VARCHAR(255), + initial CHAR(1), + lastName VARCHAR(255), + taxfileNumber VARCHAR(255), + primary key (id) +) + +alter table employment_periods + add constraint employment_periodsFK0 foreign key (employer_id) references employers +alter table employment_periods + add constraint employment_periodsFK1 foreign key (employee_id) references employees +create sequence employee_id_seq +create sequence employment_id_seq +create sequence employer_id_seq]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-authorwork"> + <title>Auteur/Travail (Author/Work)</title> + + <para> + Soit le mod�le de la relation entre <literal>Work</literal>, <literal>Author</literal> + et <literal>Person</literal>. Nous repr�sentons la relation entre <literal>Work</literal> + et <literal>Author</literal> comme une association plusieurs-vers-plusieurs. Nous avons choisi de + repr�senter la relation entre <literal>Author</literal> et <literal>Person</literal> + comme une association un-vers-un. Une autre possibilit� aurait �t� que + <literal>Author</literal> h�rite de <literal>Person</literal>. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/AuthorWork.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/AuthorWork.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + Le mapping suivant repr�sente exactement ces relations : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Work" table="works" discriminator-value="W"> + + <id name="id" column="id"> + <generator class="native"/> + </id> + <discriminator column="type" type="character"/> + + <property name="title"/> + <set name="authors" table="author_work"> + <key column name="work_id"/> + <many-to-many class="Author" column name="author_id"/> + </set> + + <subclass name="Book" discriminator-value="B"> + <property name="text"/> + </subclass> + + <subclass name="Song" discriminator-value="S"> + <property name="tempo"/> + <property name="genre"/> + </subclass> + + </class> + + <class name="Author" table="authors"> + + <id name="id" column="id"> +  + <generator class="assigned"/> + </id> + + <property name="alias"/> + <one-to-one name="person" constrained="true"/> + + <set name="works" table="author_work" inverse="true"> + <key column="author_id"/> + <many-to-many class="Work" column="work_id"/> + </set> + + </class> + + <class name="Person" table="persons"> + <id name="id" column="id"> + <generator class="native"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Il y a quatre tables dans ce mapping. <literal>works</literal>, + <literal>authors</literal> et <literal>persons</literal> qui contiennent + respectivement les donn�es de work, author et person. + <literal>author_work</literal> est une table d'association qui lie authors + � works. Voici le sch�ma de tables, g�n�r� par <literal>SchemaExport</literal>. + </para> + + <programlisting><![CDATA[create table works ( + id BIGINT not null generated by default as identity, + tempo FLOAT, + genre VARCHAR(255), + text INTEGER, + title VARCHAR(255), + type CHAR(1) not null, + primary key (id) +) + +create table author_work ( + author_id BIGINT not null, + work_id BIGINT not null, + primary key (work_id, author_id) +) + +create table authors ( + id BIGINT not null generated by default as identity, + alias VARCHAR(255), + primary key (id) +) + +create table persons ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +alter table authors + add constraint authorsFK0 foreign key (id) references persons +alter table author_work + add constraint author_workFK0 foreign key (author_id) references authors +alter table author_work + add constraint author_workFK1 foreign key (work_id) references works]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-customerorderproduct"> + <title>Client/Commande/Produit (Customer/Order/Product)</title> + + <para> + Imaginons maintenant le mod�le de relation entre <literal>Customer</literal>, + <literal>Order</literal>, <literal>LineItem</literal> et <literal>Product</literal>. + Il y a une association un-vers-plusieurs entre <literal>Customer</literal> et + <literal>Order</literal>, mais comment devrions nous repr�senter <literal>Order</literal> / + <literal>LineItem</literal> / <literal>Product</literal>? J'ai choisi de mapper + <literal>LineItem</literal> comme une classe d'association repr�sentant l'association + plusieurs-vers-plusieurs entre <literal>Order</literal> et <literal>Product</literal>. Dans + Hibernate, on appelle cela un �l�ment composite. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/CustomerOrderProduct.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/CustomerOrderProduct.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + Le document de mapping : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Customer" table="customers"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name"/> + <set name="orders" inverse="true"> + <key column="customer_id"/> + <one-to-many class="Order"/> + </set> + </class> + + <class name="Order" table="orders"> + <id name="id"> + <generator class="native"/> + </id> + <property name="date"/> + <many-to-one name="customer" column="customer_id"/> + <list name="lineItems" table="line_items"> + <key column="order_id"/> + <list-index column="line_number"/> + <composite-element class="LineItem"> + <property name="quantity"/> + <many-to-one name="product" column="product_id"/> + </composite-element> + </list> + </class> + + <class name="Product" table="products"> + <id name="id"> + <generator class="native"/> + </id> + <property name="serialNumber"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + <literal>customers</literal>, <literal>orders</literal>, <literal>line_items</literal> et + <literal>products</literal> contiennent les donn�es de customer, order, order line item et product. + <literal>line_items</literal> est aussi la table d'association liant orders � products. + </para> + + <programlisting><![CDATA[create table customers ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +create table orders ( + id BIGINT not null generated by default as identity, + customer_id BIGINT, + date TIMESTAMP, + primary key (id) +) + +create table line_items ( + line_number INTEGER not null, + order_id BIGINT not null, + product_id BIGINT, + quantity INTEGER, + primary key (order_id, line_number) +) + +create table products ( + id BIGINT not null generated by default as identity, + serialNumber VARCHAR(255), + primary key (id) +) + +alter table orders + add constraint ordersFK0 foreign key (customer_id) references customers +alter table line_items + add constraint line_itemsFK0 foreign key (product_id) references products +alter table line_items + add constraint line_itemsFK1 foreign key (order_id) references orders]]></programlisting> + + </sect1> + + <sect1 id="misc"> + <title>Divers mappings d'exemple</title> + + <para> + Ces exemples sont tous pris de la suite de tests d'Hibernate. Vous en trouverez beaucoup d'autres. + Regardez dans le dossier <literal>test</literal> de la distribution d'Hibernate. + </para> + + <para>TODO: put words around this stuff</para> + + <sect2 id="example-mappings-typed-onetone"> + <title>"Typed" one-to-one association</title> +<programlisting><![CDATA[<class name="Person"> + <id name="name"/> + <one-to-one name="address" + cascade="all"> + <formula>name</formula> + <formula>'HOME'</formula> + </one-to-one> + <one-to-one name="mailingAddress" + cascade="all"> + <formula>name</formula> + <formula>'MAILING'</formula> + </one-to-one> +</class> + +<class name="Address" batch-size="2" + check="addressType in ('MAILING', 'HOME', 'BUSINESS')"> + <composite-id> + <key-many-to-one name="person" + column="personName"/> + <key-property name="type" + column="addressType"/> + </composite-id> + <property name="street" type="text"/> + <property name="state"/> + <property name="zip"/> +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key"> + <title>Exemple de clef compos�e</title> +<programlisting><![CDATA[<class name="Customer"> + + <id name="customerId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="name" not-null="true" length="100"/> + <property name="address" not-null="true" length="200"/> + + <list name="orders" + inverse="true" + cascade="save-update"> + <key column="customerId"/> + <index column="orderNumber"/> + <one-to-many class="Order"/> + </list> + +</class> + +<class name="Order" table="CustomerOrder" lazy="true"> + <synchronize table="LineItem"/> + <synchronize table="Product"/> + + <composite-id name="id" + class="Order$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + </composite-id> + + <property name="orderDate" + type="calendar_date" + not-null="true"/> + + <property name="total"> + <formula> + ( select sum(li.quantity*p.price) + from LineItem li, Product p + where li.productId = p.productId + and li.customerId = customerId + and li.orderNumber = orderNumber ) + </formula> + </property> + + <many-to-one name="customer" + column="customerId" + insert="false" + update="false" + not-null="true"/> + + <bag name="lineItems" + fetch="join" + inverse="true" + cascade="save-update"> + <key> + <column name="customerId"/> + <column name="orderNumber"/> + </key> + <one-to-many class="LineItem"/> + </bag> + +</class> + +<class name="LineItem"> + + <composite-id name="id" + class="LineItem$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + <key-property name="productId" length="10"/> + </composite-id> + + <property name="quantity"/> + + <many-to-one name="order" + insert="false" + update="false" + not-null="true"> + <column name="customerId"/> + <column name="orderNumber"/> + </many-to-one> + + <many-to-one name="product" + insert="false" + update="false" + not-null="true" + column="productId"/> + +</class> + +<class name="Product"> + <synchronize table="LineItem"/> + + <id name="productId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="description" + not-null="true" + length="200"/> + <property name="price" length="3"/> + <property name="numberAvailable"/> + + <property name="numberOrdered"> + <formula> + ( select sum(li.quantity) + from LineItem li + where li.productId = productId ) + </formula> + </property> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key-manytomany"> + <title>Many-to-many avec une clef compos�e partag�e</title> +<programlisting><![CDATA[<class name="User" table="`User`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <set name="groups" table="UserGroup"> + <key> + <column name="userName"/> + <column name="org"/> + </key> + <many-to-many class="Group"> + <column name="groupName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> + +<class name="Group" table="`Group`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <property name="description"/> + <set name="users" table="UserGroup" inverse="true"> + <key> + <column name="groupName"/> + <column name="org"/> + </key> + <many-to-many class="User"> + <column name="userName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> +]]></programlisting> + </sect2> + + <sect2 id="example-mappings-content-discrimination"> + <title>Contenu bas� sur une discrimination</title> +<programlisting><![CDATA[<class name="Person" + discriminator-value="P"> + + <id name="id" + column="person_id" + unsaved-value="0"> + <generator class="native"/> + </id> + + + <discriminator + type="character"> + <formula> + case + when title is not null then 'E' + when salesperson is not null then 'C' + else 'P' + end + </formula> + </discriminator> + + <property name="name" + not-null="true" + length="80"/> + + <property name="sex" + not-null="true" + update="false"/> + + <component name="address"> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </component> + + <subclass name="Employee" + discriminator-value="E"> + <property name="title" + length="20"/> + <property name="salary"/> + <many-to-one name="manager"/> + </subclass> + + <subclass name="Customer" + discriminator-value="C"> + <property name="comments"/> + <many-to-one name="salesperson"/> + </subclass> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-association-alternatekeys" revision="2"> + <title>Associations sur des clefs altern�es</title> +<programlisting><![CDATA[<class name="Person"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="name" length="100"/> + + <one-to-one name="address" + property-ref="person" + cascade="all" + fetch="join"/> + + <set name="accounts" + inverse="true"> + <key column="userId" + property-ref="userId"/> + <one-to-many class="Account"/> + </set> + + <property name="userId" length="8"/> + +</class> + +<class name="Address"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="address" length="300"/> + <property name="zip" length="5"/> + <property name="country" length="25"/> + <many-to-one name="person" unique="true" not-null="true"/> + +</class> + +<class name="Account"> + <id name="accountId" length="32"> + <generator class="uuid"/> + </id> + + <many-to-one name="user" + column="userId" + property-ref="userId"/> + + <property name="type" not-null="true"/> + +</class>]]></programlisting> + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_parentchild.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/example_parentchild.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_parentchild.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_parentchild.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,372 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="example-parentchild"> + <title>Exemple : P�re/Fils</title> + + <para> + L'une des premi�res choses que les nouveaux utilisateurs essaient de faire avec Hibernate est de mod�liser + une relation p�re/fils. Il y a deux approches diff�rentes pour cela. Pour un certain nombre de raisons, la m�thode la + plus courante, en particulier pour les nouveaux utilisateurs, est de mod�liser les deux relations <literal>P�re</literal> + et <literal>Fils</literal> comme des classes entit�s li�es par une association <literal><one-to-many></literal> du + <literal>P�re</literal> vers le <literal>Fils</literal> (l'autre approche est de d�clarer le <literal>Fils</literal> + comme un <literal><composite-element></literal>). Il est �vident que le sens de l'association un vers plusieurs + (dans Hibernate) est bien moins proche du sens habituel d'une relation p�re/fils que ne l'est celui d'un + �l�ment cmposite. Nous allons vous expliquer comment utiliser une association <emphasis>un vers plusieurs bidirectionnelle + avec cascade</emphasis> afin de mod�liser efficacement et �l�gamment une relation p�re/fils, ce n'est vraiment + pas difficile ! + </para> + + <sect1 id="example-parentchild-collections"> + <title>Une note � propos des collections</title> + + <para> + Les collections Hibernate sont consid�r�es comme �tant une partie logique + de l'entit� dans laquelle elles sont contenues ; jamais des entit�s qu'elle + contient. C'est une distinction crutiale ! Les cons�quences sont les suivantes : + </para> + + <itemizedlist> + <listitem> + <para> + Quand nous ajoutons / retirons un objet d'une collection, le num�ro de version du + propri�taire de la collection est incr�ment�. + </para> + </listitem> + <listitem> + <para> + Si un objet qui a �t� enlev� d'une collection est une instance de type valeur (ex : + �l�ment composite), cet objet cessera d'�tre persistant et son �tat sera compl�tement effac� + de la base de donn�es. Par ailleurs, ajouter une instance de type valeur dans une collection + aura pour cons�quence que son �tat sera imm�diatement persistant. + </para> + </listitem> + <listitem> + <para> + Si une entit� est enlev�e d'une collection (association un-vers-plusieurs + ou plusieurs-vers-plusieurs), par d�faut, elle ne sera pas effac�e. Ce comportement + est compl�tement logique - une modification de l'un des �tats internes d'une entit� + ne doit pas causer la disparition de l'entit� associ�e ! + De m�me, l'ajout d'une entit� dans une collection n'engendre pas, + par d�faut, la persistance de cette entit�. + </para> + </listitem> + </itemizedlist> + + <para> + Le comportement par d�faut est donc que l'ajout d'une entit� dans une collection cr�� + simplement le lien entre les deux entit�s, et qu'effacer une entit� supprime ce lien. + C'est le comportement le plus appropri� dans la plupart des cas. Ce comportement n'est + cependant pas appropri� lorsque la vie du fils est li�e au cycle de vie du p�re. + </para> + + </sect1> + + <sect1 id="example-parentchild-bidir"> + <title>un-vers-plusieurs bidirectionnel</title> + + <para> + Supposons que nous ayons une simple association <literal><one-to-many></literal> + de <literal>Parent</literal> vers <literal>Child</literal>. + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set>]]></programlisting> + + <para> + Si nous executions le code suivant + </para> + + <programlisting><![CDATA[Parent p = .....; +Child c = new Child(); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + Hibernate ex�cuterait deux ordres SQL: + </para> + + <itemizedlist> + <listitem> + <para>un <literal>INSERT</literal> pour cr�er l'enregistrement pour <literal>c</literal></para> + </listitem> + <listitem> + <para> + un <literal>UPDATE</literal> pour cr�er le lien de <literal>p</literal> vers + <literal>c</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Ceci est non seuleument inefficace, mais viole aussi toute contrainte <literal>NOT NULL</literal> sur + la colonne <literal>parent_id</literal>. Nous pouvons r�parer la contrainte de nullit� + en sp�cifiant <literal>not-null="true"</literal> dans le mapping de la collection : + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Cependant ce n'est pas la solution recommand�e. + </para> + + <para> + La cause sous jacente � ce comportement est que le lien (la cl� �trang�re <literal>parent_id</literal>) de + <literal>p</literal> vers <literal>c</literal> n'est pas consid�r�e comme faisant partie de l'�tat + de l'objet <literal>Child</literal> et n'est donc pas cr�� par l'<literal>INSERT</literal>. + La solution est donc que ce lien fasse partie du mapping de <literal>Child</literal>. + </para> + + <programlisting><![CDATA[<many-to-one name="parent" column="parent_id" not-null="true"/>]]></programlisting> + + <para> + (Nous avons aussi besoin d'ajouter la propri�t� <literal>parent</literal> dans la classe <literal>Child</literal>). + </para> + + <para> + Maintenant que l'�tat du lien est g�r� par l'entit� <literal>Child</literal>, nous sp�cifions � la + collection de ne pas mettre � jour le lien. Nous utilisons l'attribut <literal>inverse</literal>. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Le code suivant serait utilis� pour ajouter un nouveau <literal>Child</literal> + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +c.setParent(p); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + Maintenant, seul un <literal>INSERT</literal> SQL est n�cessaire ! + </para> + + <para> + Pour all�ger encore un peu les choses, nous devrions cr�er une m�thode <literal>addChild()</literal> + dans <literal>Parent</literal>. + </para> + + <programlisting><![CDATA[public void addChild(Child c) { + c.setParent(this); + children.add(c); +}]]></programlisting> + + <para> + Le code d'ajout d'un <literal>Child</literal> serait alors + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.save(c); +session.flush();]]></programlisting> + + </sect1> + + <sect1 id="example-parentchild-cascades"> + <title>Cycle de vie en cascade</title> + + <para> + L'appel explicite de <literal>save()</literal> est un peu fastidieux. Nous pouvons + simplifier cela en utilisant les cascades. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Simplifie le code pr�c�dent en + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.flush();]]></programlisting> + + <para> + De la m�me mani�re, nous n'avons pas � it�rer sur les fils lorsque nous sauvons + ou effacons un <literal>Parent</literal>. Le code suivant efface <literal>p</literal> + et tous ses fils de la base de donn�es. + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +session.delete(p); +session.flush();]]></programlisting> + + <para> + Par contre, ce code + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +c.setParent(null); +session.flush();]]></programlisting> + + <para> + n'effacera pas <literal>c</literal> de la base de donn�es, il enl�vera seulement + le lien vers <literal>p</literal> (et causera une violation de contrainte + <literal>NOT NULL</literal>, dans ce cas). + Vous devez explicitement utiliser <literal>delete()</literal> sur <literal>Child</literal>. + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +session.delete(c); +session.flush();]]></programlisting> + + <para> + Dans notre cas, un <literal>Child</literal> ne peut pas vraiment exister sans son p�re. Si nous + effacons un <literal>Child</literal> de la collection, nous voulons vraiment qu'il soit effac�. + Pour cela, nous devons utiliser <literal>cascade="all-delete-orphan"</literal>. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all-delete-orphan"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + A noter : m�me si le mapping de la collection sp�cifie <literal>inverse="true"</literal>, les cascades + sont toujours assur�es par l'it�ration sur les �l�ments de la collection. Donc, si vous avez besoin + qu'un objet soit enregistr�, effac� ou mis � jour par cascade, vous devez l'ajouter dans la colleciton. + Il ne suffit pas d'appeler explicitement <literal>setParent()</literal>. + </para> + + </sect1> + + <sect1 id="example-parentchild-update"> + <title>Cascades et <literal>unsaved-value</literal></title> + + <para> + Supposons que nous ayons charg� un <literal>Parent</literal> dans une <literal>Session</literal>, + que nous l'ayons ensuite modifi� et que voulions persiter ces modifications dans une nouvelle session + en appelant <literal>update()</literal>. + Le <literal>Parent</literal> contiendra une collection de fils et, puisque la cascade est activ�e, + Hibernate a besoin de savoir quels fils viennent d'�tre instanci�s et quels fils proviennent de la base + de donn�es. Supposons aussi que <literal>Parent</literal> et <literal>Child</literal> ont tous deux + des identifiants du type <literal>Long</literal>. + Hibernate utilisera la propri�t� de l'identifiant et la propri�t� de la version/horodatage pour d�terminer quels fils sont nouveaux + (vous pouvez aussi utiliser la propri�t� version ou timestamp, voir + <xref linkend="manipulatingdata-updating-detached"/>). + <emphasis>Dans Hibernate3, il n'est plus n�cessaire de sp�cifier + une <literal>unsaved-value</literal> explicitement.</emphasis> + </para> + + <para> + Le code suivant mettra � jour <literal>parent</literal> et <literal>child</literal> + et ins�rera <literal>newChild</literal>. + </para> + + <programlisting><![CDATA[//parent et child ont �t� charg�s dans une session pr�c�dente +parent.addChild(child); +Child newChild = new Child(); +parent.addChild(newChild); +session.update(parent); +session.flush();]]></programlisting> + + <para> + Ceci est tr�s bien pour des identifiants g�n�r�s, mais qu'en est-il des identifiants assign�s et des + identifiants compos�s ? C'est plus difficile, + puisqu'Hibernate ne peut pas utiliser la propri�t� de l'identifiant pour distinguer un objet + nouvellement instanci� (avec un identifiant assign� par l'utilisateur) d'un objet charg� dans une session pr�c�dente. + Dans ce cas, Hibernate utilisera soit la propri�t� de version ou d'horodatage, soit effectuera vraiment une requ�te au cache + de second niveau, soit, dans le pire des cas, � la base de donn�es, pour voir si la ligne existe. + </para> + +  + </sect1> + + <sect1 id="example-parentchild-conclusion"> + <title>Conclusion</title> + + <para> + Il y a quelques principes � ma�triser dans ce chapitre et tout cela peut para�tre d�routant la premi�re fois. + Cependant, dans la pratique, tout fonctionne parfaitement. La plupart des applications Hibernate utilisent + le pattern p�re / fils. + </para> + + <para> + Nous avons �voqu� une alternative dans le premier paragraphe. Aucun des points trait�s pr�c�demment n'existe + dans le cas d'un mapping <literal><composite-element></literal> qui poss�de exactement la s�mantique + d'une relation p�re / fils. Malheureusement, il y a deux grandes limitations pour les classes �l�ments + composites : les �l�ments composites ne peuvent contenir de collections, et ils ne peuvent �tre les fils + d'entit�s autres que l'unique parent. + </para> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_weblog.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/example_weblog.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_weblog.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/example_weblog.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,432 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="example-weblog"> + <title>Exemple : application Weblog</title> + + <sect1 id="example-weblog-classes"> + <title>Classes persistantes</title> + + <para> + Les classes persistantes representent un weblog, et un article post� + dans un weblog. Il seront mod�lis�s comme une relation p�re/fils + standard, mais nous allons utiliser un "bag" tri� au lieu d'un set. + + </para> + + <programlisting><![CDATA[package eg; + +import java.util.List; + +public class Blog { + private Long _id; + private String _name; + private List _items; + + public Long getId() { + return _id; + } + public List getItems() { + return _items; + } + public String getName() { + return _name; + } + public void setId(Long long1) { + _id = long1; + } + public void setItems(List list) { + _items = list; + } + public void setName(String string) { + _name = string; + } +}]]></programlisting> + + <programlisting><![CDATA[package eg; + +import java.text.DateFormat; +import java.util.Calendar; + +public class BlogItem { + private Long _id; + private Calendar _datetime; + private String _text; + private String _title; + private Blog _blog; + + public Blog getBlog() { + return _blog; + } + public Calendar getDatetime() { + return _datetime; + } + public Long getId() { + return _id; + } + public String getText() { + return _text; + } + public String getTitle() { + return _title; + } + public void setBlog(Blog blog) { + _blog = blog; + } + public void setDatetime(Calendar calendar) { + _datetime = calendar; + } + public void setId(Long long1) { + _id = long1; + } + public void setText(String string) { + _text = string; + } + public void setTitle(String string) { + _title = string; + } +}]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-mappings"> + <title>Mappings Hibernate</title> + + <para> + Le mapping XML doit maintenant �tre relativement simple � vos yeux. + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="Blog" + table="BLOGS"> + + <id + name="id" + column="BLOG_ID"> + + <generator class="native"/> + + </id> + + <property + name="name" + column="NAME" + not-null="true" + unique="true"/> + + <bag + name="items" + inverse="true" + order-by="DATE_TIME" + cascade="all"> + + <key column="BLOG_ID"/> + <one-to-many class="BlogItem"/> + + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="BlogItem" + table="BLOG_ITEMS" + dynamic-update="true"> + + <id + name="id" + column="BLOG_ITEM_ID"> + + <generator class="native"/> + + </id> + + <property + name="title" + column="TITLE" + not-null="true"/> + + <property + name="text" + column="TEXT" + not-null="true"/> + + <property + name="datetime" + column="DATE_TIME" + not-null="true"/> + + <many-to-one + name="blog" + column="BLOG_ID" + not-null="true"/> + + </class> + +</hibernate-mapping>]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-code"> + <title>Code Hibernate</title> + + <para> + La classe suivante montre quelques utilisations que nous pouvons faire + de ces classes. + </para> + + <programlisting><![CDATA[package eg; + +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Iterator; +import java.util.List; + +import org.hibernate.HibernateException; +import org.hibernate.Query; +import org.hibernate.Session; +import org.hibernate.SessionFactory; +import org.hibernate.Transaction; +import org.hibernate.cfg.Configuration; +import org.hibernate.tool.hbm2ddl.SchemaExport; + +public class BlogMain { + + private SessionFactory _sessions; + + public void configure() throws HibernateException { + _sessions = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class) + .buildSessionFactory(); + } + + public void exportTables() throws HibernateException { + Configuration cfg = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class); + new SchemaExport(cfg).create(true, true); + } + + public Blog createBlog(String name) throws HibernateException { + + Blog blog = new Blog(); + blog.setName(name); + blog.setItems( new ArrayList() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.persist(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public BlogItem createBlogItem(Blog blog, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setBlog(blog); + item.setDatetime( Calendar.getInstance() ); + blog.getItems().add(item); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public BlogItem createBlogItem(Long blogid, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setDatetime( Calendar.getInstance() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + Blog blog = (Blog) session.load(Blog.class, blogid); + item.setBlog(blog); + blog.getItems().add(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public void updateBlogItem(BlogItem item, String text) + throws HibernateException { + + item.setText(text); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public void updateBlogItem(Long itemid, String text) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + BlogItem item = (BlogItem) session.load(BlogItem.class, itemid); + item.setText(text); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public List listAllBlogNamesAndItemCounts(int max) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "select blog.id, blog.name, count(blogItem) " + + "from Blog as blog " + + "left outer join blog.items as blogItem " + + "group by blog.name, blog.id " + + "order by max(blogItem.datetime)" + ); + q.setMaxResults(max); + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } + + public Blog getBlogAndAllItems(Long blogid) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + Blog blog = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "left outer join fetch blog.items " + + "where blog.id = :blogid" + ); + q.setParameter("blogid", blogid); + blog = (Blog) q.uniqueResult(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public List listBlogsAndRecentItems() throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "inner join blog.items as blogItem " + + "where blogItem.datetime > :minDate" + ); + + Calendar cal = Calendar.getInstance(); + cal.roll(Calendar.MONTH, false); + q.setCalendar("minDate", cal); + + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/filters.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/filters.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/filters.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/filters.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="filters"> + <title>Filtrer les donn�es</title> + + <para> + Hibernate3 fournit une nouvelle approche innovatrice pour g�rer des donn�es + avec des r�gles de "visibilit�". Un <emphasis>filtre Hibernate</emphasis> est un filtre + global, nomm�, param�tr� qui peut �tre activ� ou d�sactiv� pour une session Hibernate + particuli�re. + </para> + + <sect1 id="objectstate-filters"> + <title>Filtres Hibernate</title> + + <para> + Hibernate3 ajoute la capacit� de pr�d�finir des crit�res de filtre et d'attacher ces + filtres � une classe ou � une collection. Un crit�re de filtre est la facult� de d�finir + une clause de restriction tr�s similaire � l'attribut "where" existant disponible sur + une classe et divers �l�ments d'une collection. Mis � part que ces conditions de filtre + peuvent �tre param�tr�es. L'application peut alors prendre la d�cision � l'ex�cution + si des filtres donn�s devraient �tre activ�s et quels devraient �tre leurs param�tres. + Des filtres peuvent �tre utilis�s comme des vues de base de donn�es, mais param�tr�es + dans l'application. + </para> + + <para> + Afin d'utiliser des filtres, ils doivent d'abord �tre d�finis, puis attach�s aux �l�ments + de mapping appropri�s. Pour d�finir un filtre, utilisez l'�l�ment <literal><filter-def/></literal> + dans un �l�ment <literal><hibernate-mapping/></literal> : + </para> + + <programlisting><![CDATA[<filter-def name="myFilter"> + <filter-param name="myFilterParam" type="string"/> +</filter-def>]]></programlisting> + + <para> + Puis, ce filtre peut �tre attach� � une classe : + </para> + + <programlisting><![CDATA[<class name="myClass" ...> + ... + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</class>]]></programlisting> + + <para> + ou � une collection : + </para> + + <programlisting><![CDATA[<set ...> + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</set>]]></programlisting> + + <para> + ou m�me aux deux (ou � plusieurs de chaque) en m�me temps. + </para> + + <para> + Les m�thodes sur <literal>Session</literal> sont : <literal>enableFilter(String filterName)</literal>, + <literal>getEnabledFilter(String filterName)</literal>, et <literal>disableFilter(String filterName)</literal>. + Par d�faut, les filtres <emphasis>ne sont pas</emphasis> activ�s pour une session donn�e ; + ils doivent �tre explicitement activ�s en appelant la m�thode + <literal>Session.enabledFilter()</literal>, laquelle retourne une instance de l'interface + <literal>Filter</literal>. Utiliser le simple filtre d�fini au-dessus ressemblerait � : + </para> + + <programlisting><![CDATA[session.enableFilter("myFilter").setParameter("myFilterParam", "some-value");]]></programlisting> + + <para> + Notez que des m�thodes sur l'interface org.hibernate.Filter autorisent le cha�nage de beaucoup + de m�thodes communes d'Hibernate. + </para> + + <para> + Un exemple complet, utilisant des donn�es temporelles avec une structure de date + d'enregistrement effectif : + </para> + + <programlisting><![CDATA[<filter-def name="effectiveDate"> + <filter-param name="asOfDate" type="date"/> +</filter-def> + +<class name="Employee" ...> +... + <many-to-one name="department" column="dept_id" class="Department"/> + <property name="effectiveStartDate" type="date" column="eff_start_dt"/> + <property name="effectiveEndDate" type="date" column="eff_end_dt"/> +... +  + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> +</class> + +<class name="Department" ...> +... + <set name="employees" lazy="true"> + <key column="dept_id"/> + <one-to-many class="Employee"/> + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> + </set> +</class>]]></programlisting> + + <para> + Puis, afin de s'assurer que vous pouvez toujours r�cup�rer les enregistrements actuellement + effectifs, activez simplement le filtre sur la session avant de r�cup�rer des donn�es des + employ�s : + </para> + +<programlisting><![CDATA[Session session = ...; +session.enabledFilter("effectiveDate").setParameter("asOfDate", new Date()); +List results = session.createQuery("from Employee as e where e.salary > :targetSalary") + .setLong("targetSalary", new Long(1000000)) + .list(); +]]></programlisting> + + <para> + Dans le HQL ci-dessus, bien que nous ayons seulement mentionn� une contrainte de + salaire sur les resultats, � cause du filtre activ�, la requ�te retournera seulement + les employ�s actuellement actifs qui ont un salaire sup�rieur � un million de dollars. + </para> + + <para> + A noter : si vous pr�voyez d'utiliser des filtres avec des jointures externes (soit + � travers HQL, soit par le chargement) faites attention � la direction de l'expression + de condition. Il est plus s�r de la positionner pour les jointures externes � gauche ; + en g�n�ral, placez le param�tre d'abord, suivi du(des) nom(s) de colonne apr�s l'op�rateur. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/inheritance_mapping.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/inheritance_mapping.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/inheritance_mapping.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/inheritance_mapping.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,483 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="inheritance"> + <title>Mapping d'h�ritage de classe</title> + + <sect1 id="inheritance-strategies" revision="3"> + <title>Les trois strat�gies</title> + + <para> + Hibernate supporte les trois strat�gies d'h�ritage de base : + </para> + + <itemizedlist> + <listitem> + <para> + une table par hi�rarchie de classe (table per class hierarchy) + </para> + </listitem> + <listitem> + <para> + une table par classe fille (table per subclass) + </para> + </listitem> + <listitem> + <para> + une table par classe concr�te (table per concrete class) + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate supporte en plus une quatri�mestrat�gie, l�g�rement diff�rente, qui supporte le polymorphisme : + </para> + + <itemizedlist> + <listitem> + <para> + le polymorphisme implicite + </para> + </listitem> + </itemizedlist> + + <para> + Il est possible d'utiliser diff�rentes strat�gies de mapping pour diff�rentes branches d'une m�me + hi�rarchie d'h�ritage, et alors d'employer le polymorphisme implicite pour r�aliser le + polymorphisme � travers toute la hi�rarchie. Pourtant, Hibernate ne supporte pas de m�langer + des mappings <literal><subclass></literal> et + <literal><joined-subclass></literal> et <literal><union-subclass></literal> + pour le m�me �l�ment <literal><class></literal> racine. + Il est possible de m�langer ensemble les strat�gies d'une table par hi�rarchie et d'une + table par sous-classe, pour le m�me �l�ment <literal><class></literal>, en combinant + les �l�ments <literal><subclass></literal> et <literal><join></literal> (voir dessous). + </para> + + <para> + Il est possible de d�finir des mappings de <literal>subclass</literal>, <literal>union-subclass</literal>, + et <literal>joined-subclass</literal> dans des documents de mapping s�par�s, directement sous + <literal>hibernate-mapping</literal>. Ceci vous permet d'�tendre une hi�rarchie de classe juste en + ajoutant un nouveau fichier de mapping. Vous devez sp�cifier un attribut <literal>extends</literal> + dans le mapping de la sous-classe, en nommant une super-classe pr�c�demment mapp�e. Note : + pr�c�demment cette foncionnalit� rendait l'ordre des documents de mapping important. Depuis + Hibernate3, l'ordre des fichier de mapping n'importe plus lors de l'utilisation du mot-clef "extends". + L'ordre � l'int�rieur d'un simple fichier de mapping impose encore de d�finir les classes m�res + avant les classes filles. + </para> + + <programlisting><![CDATA[ + <hibernate-mapping> + <subclass name="DomesticCat" extends="Cat" discriminator-value="D"> + <property name="name" type="string"/> + </subclass> + </hibernate-mapping>]]></programlisting> + + + <sect2 id="inheritance-tableperclass" > + <title>Une table par hi�rarchie de classe</title> + + <para> + Supposons que nous ayons une interface <literal>Payment</literal>, impl�ment�e + par <literal>CreditCardPayment</literal>, <literal>CashPayment</literal>, + <literal>ChequePayment</literal>. La strat�gie une table par hi�rarchie serait : + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + Une seule table est requise. Une grande limitation de cette + strat�gie est que les colonnes d�clar�es par les classes filles, telles que <literal>CCTYPE</literal>, + ne peuvent avoir de contrainte <literal>NOT NULL</literal>. + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass"> + <title>Une table par classe fille</title> + + <para> + La strat�gie une table par classe fille serait : + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <joined-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </joined-subclass> + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + Quatre tables sont requises. Les trois tables des classes filles ont + une cl� primaire associ�e � la table classe m�re (le mod�le relationnel + est une association un-vers-un). + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass-discriminator" revision="2"> + <title>Une table par classe fille, en utilisant un discriminant</title> + + <para> + Notez que l'impl�mentation Hibernate de la strat�gie un table par + classe fille ne n�cessite pas de colonne discriminante dans la table + classe m�re. D'autres impl�mentations de mappers Objet/Relationnel utilisent + une autre impl�mentation de la strat�gie une table par classe fille qui n�cessite + une colonne de type discriminant dans la table de la classe m�re. L'approche + prise par Hibernate est plus difficile � impl�menter mais plus correcte + d'une point de vue relationnel. Si vous aimeriez utiliser + une colonne discriminante avec la strat�gie d'une table par classe fille, vous pourriez combiner + l'utilisation de <literal><subclass></literal> et + <literal><join></literal>, comme suit : + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + <join table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + <join table="CHEQUE_PAYMENT" fetch="select"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> +</class>]]></programlisting> + + <para> + La d�claration optionnelle <literal>fetch="select"</literal> indique � Hibernate + de ne pas r�cup�rer les donn�es de la classe fille <literal>ChequePayment</literal> par une jointure externe lors des requ�tes sur la classe m�re. + </para> + + </sect2> + + <sect2 id="inheritance-mixing-tableperclass-tablepersubclass"> + <title>M�lange d'une table par hi�rarchie de classe avec une table par classe fille</title> + + <para> + Vous pouvez m�me m�langer les strat�gies d'une table par hi�rarchie de classe et d'une table par classe fille en utilisant cette approche : + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + Pour importe laquelle de ces strat�gies, une association polymorphique vers la classe racine + <literal>Payment</literal> est mapp�e en utilisant <literal><many-to-one></literal>. + </para> + + <programlisting><![CDATA[<many-to-one name="payment" column="PAYMENT_ID" class="Payment"/>]]></programlisting> + + </sect2> + + <sect2 id="inheritance-tableperconcrete" revision="2"> + <title>Une table par classe concr�te</title> + + <para> + Il y a deux mani�res d'utiliser la strat�gie d'une table par classe concr�te. La premi�re + est d'employer <literal><union-subclass></literal>. + </para> + + <programlisting><![CDATA[<class name="Payment"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="sequence"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <union-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </union-subclass> + <union-subclass name="CashPayment" table="CASH_PAYMENT"> + ... + </union-subclass> + <union-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + ... + </union-subclass> +</class>]]></programlisting> + + <para> + Trois tables sont n�cessaires pour les classes filles. Chaque table d�finit des colonnes + pour toutes les propri�t�s de la classe, incluant les propri�t�s h�rit��s. + </para> + + <para> + La limitation de cette approche est que si une propri�t� est mapp�e sur la classe m�re, le nom + de la colonne doit �tre le m�me pour toutes les classes filles. (Nous pourrions �tre plus souple + dans une future version d'Hibernate). + La strat�gie du g�n�rateur d'identifiant n'est pas permise dans l'h�ritage de classes filles par + union, en effet la valeur (NdT : seed) de la clef primaire + doit �tre partag�e par toutes les classes filles "union" d'une hi�rarchie. + </para> + + <para> + Si votre classe m�re est abstraite, mappez la avec <literal>abstract="true"</literal>. + Bien s�r, si elle n'est pas abstraite, une table suppl�mentaire (par d�faut, + <literal>PAYMENT</literal> dans l'exemple ci-dessus) est requise pour contenir des instances + de la classe m�re. + </para> + + </sect2> + + <sect2 id="inheritance-tableperconcreate-polymorphism"> + <title>Une table par classe concr�te, en utilisant le polymorphisme implicite</title> + + <para> + Une approche alternative est l'emploi du polymorphisme implicite : + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CREDIT_AMOUNT"/> + ... +</class> + +<class name="CashPayment" table="CASH_PAYMENT"> + <id name="id" type="long" column="CASH_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CASH_AMOUNT"/> + ... +</class> + +<class name="ChequePayment" table="CHEQUE_PAYMENT"> + <id name="id" type="long" column="CHEQUE_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... +</class>]]></programlisting> + + <para> + Notez que nulle part nous ne mentionnons l'interface <literal>Payment</literal> explicitement. + Notez aussi que des propri�t�s de <literal>Payment</literal> sont mapp�es dans + chaque classe fille. Si vous voulez �viter des duplications, consid�rez l'utilisation des + entit�s XML (cf. <literal>[ <!ENTITY allproperties SYSTEM "allproperties.xml"> ]</literal> + dans la d�claration du <literal>DOCTYPE</literal> et <literal>&allproperties;</literal> dans le mapping). + </para> + + <para> + L'inconv�nient de cette approche est qu'Hibernate ne g�n�re pas d'<literal>UNION</literal>s SQL + lors de l'ex�cution des requ�tes polymorphiques. + </para> + + <para> + Pour cette strat�gie de mapping, une association polymorphique pour <literal>Payment</literal> + est habituellement mapp�e en utilisant <literal><any></literal>. + </para> + + <programlisting><![CDATA[<any name="payment" meta-type="string" id-type="long"> + <meta-value value="CREDIT" class="CreditCardPayment"/> + <meta-value value="CASH" class="CashPayment"/> + <meta-value value="CHEQUE" class="ChequePayment"/> + <column name="PAYMENT_CLASS"/> + <column name="PAYMENT_ID"/> +</any>]]></programlisting> + + </sect2> + + <sect2 id="inheritace-mixingpolymorphism"> + <title>M�lange du polymorphisme implicite avec d'autres mappings d'h�ritage</title> + + <para> + Il y a une chose suppl�mentaire � noter � propos de ce mapping. Puisque les classes filles sont + chacune mapp�es avec leur propre �l�ment <literal><class></literal> (et puisque + <literal>Payment</literal> est juste une interface), chaque classe fille pourrait + facilement faire partie d'une autre hi�rarchie + d'h�ritage ! (Et vous pouvez encore faire des requ�tes polymorphiques pour l'interface <literal>Payment</literal>). + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="CREDIT_CARD" type="string"/> + <property name="amount" column="CREDIT_AMOUNT"/> + ... + <subclass name="MasterCardPayment" discriminator-value="MDC"/> + <subclass name="VisaPayment" discriminator-value="VISA"/> +</class> + +<class name="NonelectronicTransaction" table="NONELECTRONIC_TXN"> + <id name="id" type="long" column="TXN_ID"> + <generator class="native"/> + </id> + ... + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CASH_AMOUNT"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + Encore une fois, nous ne mentionnons pas explicitement <literal>Payment</literal>. + Si nous ex�cutons une requ�te sur l'interface <literal>Payment</literal> - par + exemple, <literal>from Payment</literal> - Hibernate retournera + automatiquement les instances de <literal>CreditCardPayment</literal> + (et ses classes filles puisqu'elles impl�mentent aussi <literal>Payment</literal>), + <literal>CashPayment</literal> et <literal>ChequePayment</literal> mais pas + les instances de <literal>NonelectronicTransaction</literal>. + </para> + + </sect2> + + </sect1> + + <sect1 id="inheritance-limitations"> + <title>Limitations</title> + + <para> + Il y a certaines limitations � l'approche du "polymorphisme implicite" + pour la strat�gie de mapping d'une table par classe concr�te. + Il y a plut�t moins de limitations restrictives aux mappings <literal><union-subclass></literal>. + </para> + + <para> + La table suivante montre les limitations des mappings d'une table par classe concr�te, et du polymorphisme implicite, dans Hibernate. + </para> + + <table frame="topbot"> + <title>Caract�ristiques du mapping d'h�ritage</title> + <tgroup cols='8' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <colspec colname='c6' colwidth="1*"/> + <colspec colname='c7' colwidth="1*"/> + <colspec colname='c8' colwidth="1*"/> + <thead> + <row> + <entry>Strat�gie d'h�ritage</entry> + <entry>many-to-one polymorphique</entry> + <entry>one-to-one polymorphique</entry> + <entry>one-to-many polymorphique</entry> + <entry>many-to-many polymorphique</entry> + <entry><literal>load()/get()</literal> polymorphique</entry> + <entry>Requ�tes polymorphiques</entry> + <entry>Jointures polymorphiques</entry> + <entry>R�cup�ration par jointure externe</entry> + </row> + </thead> + <tbody> + <row> + <entry>une table par hi�rarchie de classe</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal></entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>support�e</emphasis></entry> + </row> + <row> + <entry>une table par classe fille</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal></entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>support�e</emphasis></entry> + </row> + <row> + <entry>une table par classe concr�te (union-subclass)</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal> (pour <literal>inverse="true"</literal> seulement)</entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>support�e</emphasis></entry> + </row> + <row> + <entry>une table par classe concr�te (polymorphisme implicite)</entry> + <entry><literal><any></literal></entry> + <entry><emphasis>non support�</emphasis></entry> + <entry><emphasis>non support�</emphasis></entry> + <entry><literal><many-to-any></literal></entry> + <entry><literal>s.createCriteria(Payment.class).add( Restrictions.idEq(id) ).uniqueResult()</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><emphasis>non support�es</emphasis></entry> + <entry><emphasis>non support�e</emphasis></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/performance.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/performance.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/performance.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/performance.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1451 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="performance"> + <title>Am�liorer les performances</title> + + <sect1 id="performance-fetching" revision="2"> + <title>Strat�gies de chargement</title> + + <para> + Une <emphasis>strat�gie de chargement</emphasis> est une strat�gie qu'Hibernate va + utiliser pour r�cup�rer des objets associ�s si l'application � besoin de naviguer � + travers une association. + Les strat�gies de chargement peuvent �tre d�clar�es dans les m�ta-donn�es de l'outil + de mapping objet relationnel ou surcharg�es par une requ�te de type HQL ou <literal>Criteria</literal> + particuli�re. + </para> + + <para> + Hibernate3 d�finit les strat�gies de chargement suivantes : + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Chargement par jointure</emphasis> - Hibernate r�cup�re + l'instance associ�e ou la collection dans un m�me <literal>SELECT</literal>, + en utilisant un <literal>OUTER JOIN</literal>. + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement par select</emphasis> - Un second <literal>SELECT</literal> + est utilis� pour r�cup�rer l'instance associ�e ou la collection. A moins + que vous ne d�sactiviez explicitement le chargement tardif en sp�cifiant + <literal>lazy="false"</literal>, ce second select ne sera ex�cut� que lorsque + vous acc�derez r�ellement � l'association. + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement par sous-select</emphasis> - Un second <literal>SELECT</literal> + est utilis� pour r�cup�rer les associations pour toutes les entit�s r�cup�r�es dans + une requ�te ou un chargement pr�alable. A moins + que vous ne d�sactiviez explicitement le chargement tardif en sp�cifiant + <literal>lazy="false"</literal>, ce second select ne sera ex�cut� que lorsque + vous acc�derez r�ellement � l'association. + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement par lot</emphasis> - Il s'agit d'une strat�gie d'optimisation + pour le chargement par select - Hibernate r�cup�re un lot + d'instances ou de collections en un seul <literal>SELECT</literal> en sp�cifiant + une liste de cl� primaire ou de cl� �trang�re. + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate fait �galement la distinction entre : + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Chargement imm�diat</emphasis> - Une association, une collection ou + un attribut est charg� imm�diatement lorsque l'objet auquel appartient cet + �l�ment est charg�. + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement tardif d'une collection</emphasis> - Une collection est + charg�e lorque l'application invoque une m�thode sur cette collection (il s'agit + du mode de chargement par d�faut pour les collections). + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement "super tardif" d'une collection</emphasis> - les + �l�ments de la collection sont r�cup�r�s individuellement depuis la base de donn�es + lorsque n�cessaire. + Hibernate essaie de ne pas charger toute la collection en m�moire sauf si cela est + absolument n�cessaire (bien adapt� aux tr�s grandes collections). + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement par proxy</emphasis> - une association vers un seul + objet est charg�e lorsqu'une m�thode autre que le getter sur l'identifiant est + appel�e sur l'objet associ�. + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement "sans proxy"</emphasis> - une association vers un seul objet + est charg�e lorsque l'on acc�de � cet objet. Par rapport au chargement par proxy, + cette approche est moins tardif (l'association est quand m�me charg�e m�me + si on n'acc�de qu'� l'identifiant) mais plus transparente car il n'y a pas de proxy + visible dans l'application. Cette approche requiert une instrumentation du bytecode + � la compilation et est rarement n�cessaire. + </para> + </listitem> + <listitem> + <para> + <emphasis>Chargement tardif des attributs</emphasis> - Un attribut ou un + objet associ� seul est charg� lorsque l'on y acc�de. Cette approche requiert + une instrumentation du bytecode � la compilation et est rarement n�cessaire. + </para> + </listitem> + </itemizedlist> + + <para> + Nous avons ici deux notions orthogonales : <emphasis>quand</emphasis> l'association est + charg�e et <emphasis>comment</emphasis> (quelle requ�te SQL est utilis�e). Il ne faut + pas confondre les deux. Le mode de chargement est utilis� pour am�liorer les performances. + On peut utiliser le mode tardif pour d�finir un contrat sur quelles donn�es sont toujours + accessibles sur une instance d�tach�e d'une classe particuli�re. + </para> + + <sect2 id="performance-fetching-lazy"> + <title>Travailler avec des associations charg�es tardivement</title> + + <para> + Par d�faut, Hibernate3 utilise le chargement tardif par select pour les collections + et le chargement tardif par proxy pour les associations vers un seul objet. + Ces valeurs par d�faut sont valables pour la plupart des associations dans la + plupart des applications. + </para> + + <para> + <emphasis>Note :</emphasis> si vous d�finissez + <literal>hibernate.default_batch_fetch_size</literal>, Hibernate va utiliser l'optimisation + du chargement par lot pour le chargement tardif (cette optimisation peut aussi + �tre activ�e � un niveau de granularit� plus fin). + </para> + + <para> + Cependant, le chargement tardif pose un probl�me qu'il faut connaitre. L'acc�s � + une association d�finie comme "tardive", hors du contexte d'une session hibernate + ouverte, va conduire � une exception. Par exemple : + </para> + + <programlisting><![CDATA[s = sessions.openSession(); +Transaction tx = s.beginTransaction(); + +User u = (User) s.createQuery("from User u where u.name=:userName") + .setString("userName", userName).uniqueResult(); +Map permissions = u.getPermissions(); + +tx.commit(); +s.close(); + +Integer accessLevel = (Integer) permissions.get("accounts"); // Error!]]></programlisting> + + <para> + Etant donn� que la collection des permissions n'a pas �t� initialis�e + avant que la <literal>Session</literal> soit ferm�e, la collection n'est + pas capable de se charger. <emphasis>Hibernate ne supporte pas le chargement + tardif pour des objets d�tach�s</emphasis>. La solution � ce probl�me est de + d�placer le code qui lit la collection avant le "commit" de la transaction. + </para> + + <para> + Une autre alternative est d'utiliser une collection ou une association non + "tardive" en sp�cifiant <literal>lazy="false"</literal> dans le mapping de + l'association. + Cependant il est pr�vu que le chargement tardif soit utilis� pour quasiment + toutes les collections ou associations. Si vous d�finissez trop d'associtions + non "tardives" dans votre mod�le objet, Hibernate va finir par devoir charger + toute la base de donn�es en m�moire � chaque transaction ! + </para> + + <para> + D'un autre c�t�, on veut souvent choisir un chargement par jointure (qui est par + d�faut non tardif) � la place du chargement par select dans une transaction particuli�re. + Nous allons maintenant voir comment adapter les strat�gies de chargement. Dans Hibernate3 + les m�canismes pour choisir une strat�gie de chargement sont identiques que + l'on ait une association vers un objet simple ou vers une collection. + </para> + + </sect2> + + <sect2 id="performance-fetching-custom" revision="4"> + <title>Personnalisation des strat�gies de chargement</title> + + <para> + Le chargement par select (mode par d�faut) est tr�s vuln�rable au probl�me du + N+1 selects, du coup vous pouvez avoir envie d'activer le chargement par jointure + dans les fichiers de mapping : + </para> + + <programlisting><![CDATA[<set name="permissions" + fetch="join"> + <key column="userId"/> + <one-to-many class="Permission"/> +</set]]></programlisting> + + <programlisting><![CDATA[<many-to-one name="mother" class="Cat" fetch="join"/>]]></programlisting> + + <para> + La strat�gie de chargement d�finie � l'aide du mot <literal>fetch</literal> dans les fichiers + de mapping affecte : + </para> + + <itemizedlist> + <listitem> + <para> + La r�cup�ration via <literal>get()</literal> ou <literal>load()</literal> + </para> + </listitem> + <listitem> + <para> + La r�cup�ration implicite lorsque l'on navigue � travers une association + </para> + </listitem> + <listitem> + <para> + Les requ�tes de type <literal>Criteria</literal> + </para> + </listitem> + <listitem> + <para> + Les requ�tes HQL si l'on utilise le chargement par <literal>subselect</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Quelle que soit la strat�gie de chargement que vous utilisez, la partie du graphe + d'objets qui est d�finie comme non "tardive" sera charg�e en m�moire. Cela peut + mener � l'ex�cution de plusieurs selects successifs pour une seule requ�te HQL. + </para> + + <para> + On n'utilise pas souvent les documents de mapping pour adapter le chargement. + Au lieu de cela, on conserve le comportement par d�faut et on le surcharge pour + une transaction particuli�re en utilisant <literal>left join fetch</literal> + dans les requ�tes HQL. Cela indique � hibernate � Hibernate de charger l'association + de mani�re agressive lors du premier select en utilisant une jointure externe. + Dans l'API Criteria vous pouvez utiliser la m�thode + <literal>setFetchMode(FetchMode.JOIN)</literal> + </para> + + <para> + Si vous ne vous sentez pas pr�t � modifier la strat�gie de chargement utilis� + par <literal>get()</literal> ou <literal>load()</literal>, vous pouvez juste + utiliser une requ�te de type <literal>Criteria</literal> comme par exemple : + </para> + + <programlisting><![CDATA[User user = (User) session.createCriteria(User.class) + .setFetchMode("permissions", FetchMode.JOIN) + .add( Restrictions.idEq(userId) ) + .uniqueResult();]]></programlisting> + + <para> + (Il s'agit de l'�quivalent pour Hibernate de ce que d'autres outils de mapping + appellent un "fetch plan" ou "plan de chargement") + </para> + + <para> + Une autre mani�re compl�tement diff�rente d'�viter le probl�me des N+1 selects + est d'utiliser le cache de second niveau. + </para> + + </sect2> + + <sect2 id="performance-fetching-proxies" revision="2"> + <title>Proxys pour des associations vers un seul objet</title> + + <para> + Le chargement tardif des collections est impl�ment� par Hibernate en utilisant + ses propres impl�mentations pour des collections persistantes. Si l'on veut un + chargement tardif pour des associations vers un seul objet m�tier il faut utiliser + un autre m�canisme. L'entit� qui est point�e par l'association doit �tre masqu�e + derri�re un proxy. Hibernate impl�mente l'initialisation tardive des proxys sur des + objets persistents via une mise � jour � chaud du bytecode (� l'aide de l'excellente + librairie CGLIB). + </para> + + <para> + Par d�faut, Hibernate g�n�re des proxys (au d�marrage) pour toutes les classes + persistantes et les utilise pour activer le chargement tardif des associations + <literal>many-to-one</literal> et <literal>one-to-one</literal>. + </para> + + <para> + Le fichier de mapping peut d�clarer une interface qui sera utilis�e par le proxy + d'interfa�age pour cette classe � l'aide de l'attribut <literal>proxy</literal>. + Par d�faut Hibernate utilises une sous classe de la classe persistante. + <emphasis>Il faut que les classes pour lesquelles on ajoute un proxy impl�mentent + un constructeur par d�faut de visibilit� au moins package. Ce constructeur est + recommand� pour toutes les classes persistantes !</emphasis> + </para> + + + + <para> + Il y a quelques pr�cautions � prendre lorsque l'on �tend cette approche � des classes + polymorphiques, exemple : + </para> + + <programlisting><![CDATA[<class name="Cat" proxy="Cat"> + ...... + <subclass name="DomesticCat" proxy="DomesticCat"> + ..... + </subclass> + </class>]]></programlisting> + + <para> + Tout d'abord, les instances de <literal>Cat</literal> ne pourront jamais �tre "cast�es" + en <literal>DomesticCat</literal>, m�me si l'instance sous jacente est une instance + de <literal>DomesticCat</literal> : + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instancie un proxy (n'interroge pas la base de donn�es) +if ( cat.isDomesticCat() ) { // interroge la base de donn�es pour initialiser le proxy + DomesticCat dc = (DomesticCat) cat; // Erreur ! + .... +}]]></programlisting> + + <para> + Deuxi�mement, il est possible de casser la notion d'<literal>==</literal> des proxy. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instancie un proxy Cat +DomesticCat dc = + (DomesticCat) session.load(DomesticCat.class, id); // acquiert un nouveau proxy DomesticCat +System.out.println(cat==dc); // faux]]></programlisting> + + <para> + Cette situation n'est pas si mauvaise qu'il n'y parait. M�me si nous avons deux + r�f�rences � deux objets proxys diff�rents, l'instance de base sera quand m�me le m�me objet : + </para> + + <programlisting><![CDATA[cat.setWeight(11.0); // interroge la base de donn�es pour initialiser le proxy +System.out.println( dc.getWeight() ); // 11.0]]></programlisting> + + <para> + Troisi�mement, vous ne pourrez pas utiliser un proxy CGLIB pour une classe <literal>final</literal> + ou pour une classe contenant la moindre m�thode <literal>final</literal>. + </para> + + <para> + Enfin, si votre objet persistant obtient une ressource � l'instanciation (par + example dans les initialiseurs ou dans le contructeur par d�faut), alors ces ressources + seront aussi obtenues par le proxy. La classe proxy est vraiment une sous classe de la classe + persistante. + </para> + + <para> + Ces probl�mes sont tous dus aux limitations fondamentales du mod�le d'h�ritage unique de Java. + Si vous souhaitez �viter ces probl�mes, vos classes persistantes doivent chacune impl�menter + une interface qui d�clare ses m�thodes m�tier. Vous devriez alors sp�cifier ces interfaces + dans le fichier de mapping : + </para> + + <programlisting><![CDATA[<class name="CatImpl" proxy="Cat"> + ...... + <subclass name="DomesticCatImpl" proxy="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + o� <literal>CatImpl</literal> impl�mente l'interface <literal>Cat</literal> et <literal>DomesticCatImpl</literal> + impl�mente l'interface <literal>DomesticCat</literal>. Ainsi, des proxys pour les instances de + <literal>Cat</literal> et <literal>DomesticCat</literal> pourraient �tre retourn�es par <literal>load()</literal> + ou <literal>iterate()</literal> (Notez que <literal>list()</literal> ne retourne g�n�ralement pas de proxy). + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(CatImpl.class, catid); +Iterator iter = session.createQuery("from CatImpl as cat where cat.name='fritz'").iterate(); +Cat fritz = (Cat) iter.next();]]></programlisting> + + <para> + Les relations sont aussi initialis�es tardivement. Ceci signifie que vous + devez d�clarer chaque propri�t� comme �tant de type <literal>Cat</literal>, + et non <literal>CatImpl</literal>. + </para> + + <para> + Certaines op�rations ne n�cessitent pas l'initialisation du proxy + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>equals()</literal>, si la classe persistante ne surcharge pas + <literal>equals()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hashCode()</literal>, si la classe persistante ne surcharge pas + <literal>hashCode()</literal> + </para> + </listitem> + <listitem> + <para> + Le getter de l'identifiant + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate d�tectera les classes qui surchargent <literal>equals()</literal> ou + <literal>hashCode()</literal>. + </para> + + <para> + Eh choisissant <literal>lazy="no-proxy"</literal> au lieu de <literal>lazy="proxy"</literal> + qui est la valeur par d�faut, il est possible d'�viter les probl�mes li�s au transtypage. + Il faudra alors une instrumentation du bytecode � la compilation et toutes les op�rations + r�sulterons imm�diatement en une initialisation du proxy. + </para> + + </sect2> + + <sect2 id="performance-fetching-initialization" revision="1"> + <title>Initialisation des collections et des proxys</title> + + <para> + Une exception de type <literal>LazyInitializationException</literal> sera renvoy�e par hibernate + si une collection ou un proxy non initialis� est acc�d� en dehors de la port�e de la <literal>Session</literal>, + e.g. lorsque l'entit� � laquelle appartient la collection ou qui a une r�f�rence vers le proxy est + dans l'�tat "d�tach�e". + </para> + + <para> + Parfois, nous devons nous assurer qu'un proxy ou une collection est initialis�e avant de + fermer la <literal>Session</literal>. Bien s�r, nous pouvons toujours forcer l'initialisation + en appelant par exemple <literal>cat.getSex()</literal> ou <literal>cat.getKittens().size()</literal>. + Mais ceci n'est pas tr�s lisible pour les personnes parcourant le code et n'est pas tr�s g�n�rique. + </para> + + <para> + Les m�thodes statiques <literal>Hibernate.initialize()</literal> et <literal>Hibernate.isInitialized()</literal> + fournissent � l'application un moyen de travailler avec des proxys ou des collections initialis�s. + <literal>Hibernate.initialize(cat)</literal> forcera l'initialisation d'un proxy de <literal>cat</literal>, + si tant est que sa <literal>Session</literal> est ouverte. <literal>Hibernate.initialize( cat.getKittens() )</literal> + a le m�me effet sur la collection kittens. + </para> + + <para> + Une autre option est de conserver la <literal>Session</literal> ouverte jusqu'� + ce que toutes les collections et tous les proxys aient �t� charg�s. Dans certaines + architectures applicatives, particuli�rement celles ou le code d'acc�s aux donn�es + via hiberante et le code qui utilise ces donn�es sont dans des couches applicatives + diff�rentes ou des processus physiques diff�rents, il peut devenir probl�matique + de garantir que la <literal>Session</literal> est ouverte lorsqu'une collection + est initialis�e. Il y a deux moyens de traiter ce probl�me : + </para> + + <itemizedlist> + <listitem> + <para> + Dans une application web, un filtre de servlet peut �tre utilis� pour + fermer la <literal>Session</literal> uniquement lorsque la requ�te + a �t� enti�rement trait�e, lorsque le rendu de la vue est fini + (il s'agit du pattern <emphasis>Open Session in View</emphasis>). + Bien s�r, cela demande plus d'attention � la bonne gestion des exceptions + de l'application. Il est d'une importance vitale que la <literal>Session</literal> + soit ferm�e et la transaction termin�e avant que l'on rende la main � l'utilisateur + m�me si une exception survient durant le traitement de la vue. + Voir le wiki Hibernate pour des exemples sur le pattern + "Open Session in View". + </para> + </listitem> + <listitem> + <para> + Dans une application avec une couche m�tier s�par�e, la couche contenant + la logique m�tier doit "pr�parer" toutes les collections qui seront + n�cessaires � la couche web avant de retourner les donn�es. Cela signifie + que la couche m�tier doit charger toutes les donn�es et retourner toutes + les donn�es d�j� initialis�es � la couche de pr�sentation/web pour un + cas d'utilisation donn�. En g�n�ral l'application appelle la m�thode + <literal>Hibernate.initialize()</literal> pour chaque collection n�cessaire + dans la couche web (cet appel doit �tre fait avant la fermeture de la session) + ou bien r�cup�re les collections de mani�re agressive � l'aide d'une requ�te + HQL avec une clause <literal>FETCH</literal> ou � l'aide du mode + <literal>FetchMode.JOIN</literal> pour une requ�te de type <literal>Criteria</literal>. + Cela est en g�n�ral plus facile si vous utilisez le pattern <emphasis>Command</emphasis> + plut�t que <emphasis>Session Facade</emphasis>. + </para> + </listitem> + <listitem> + <para> + Vous pouvez �galement attacher � une <literal>Session</literal> un objet charg� + au pr�alable � l'aide des m�thodes <literal>merge()</literal> ou <literal>lock()</literal> + avant d'acc�der aux collections (ou aux proxys) non initialis�s. Non, Hibernate ne + fait pas, et ne doit pas faire, cela automatiquement car cela pourrait introduire + une s�mantique transactionnelle ad hoc. + </para> + </listitem> + </itemizedlist> + + <para> + Parfois, vous ne voulez pas initialiser une grande collection mais vous avez quand m�me + besoin d'informations sur elle (comme sa taille) ou un sous ensemble de ses donn�es + </para> + + <para> + Vous pouvez utiliser un filtre de collection pour r�cup�rer sa taille sans l'initialiser : + </para> + + <programlisting><![CDATA[( (Integer) s.createFilter( collection, "select count(*)" ).list().get(0) ).intValue()]]></programlisting> + + <para> + La m�thode <literal>createFilter()</literal> est �galement utilis�e pour r�cup�rer + de mani�re efficace des sous ensembles d'une collection sans avoir besoin de l'initialiser + dans son ensemble. + </para> + + <programlisting><![CDATA[s.createFilter( lazyCollection, "").setFirstResult(0).setMaxResults(10).list();]]></programlisting> + + </sect2> + + + <sect2 id="performance-fetching-batch"> + <title>Utiliser le chargement par lot</title> + + <para> + Pour am�liorer les performances, Hibernate peut utiliser le chargement par lot + ce qui veut dire qu'Hibernate peut charger plusieurs proxys (ou collections) non initialis�s en une seule + requ�te lorsque l'on acc�de � l'un de ces proxys. Le chargement par lot est une optimisation + intimement li�e � la strat�gie de chargement tardif par select. Il y a deux moyens d'activer le + chargement par lot : au niveau de la classe et au niveau de la collection. + </para> + + <para> + Le chargement par lot pour les classes/entit�s est plus simple � comprendre. Imaginez que vous ayez la + situation suivante � l'ex�cution : vous avez 25 instances de <literal>Cat</literal> + charg�es dans une <literal>Session</literal>, chaque <literal>Cat</literal> a une r�f�rence + � son <literal>owner</literal>, une <literal>Person</literal>. + La classe <literal>Person</literal> est mapp�e avec un proxy, <literal>lazy="true"</literal>. + Si vous it�rez sur tous les cats et appelez <literal>getOwner()</literal> sur chacun d'eux, + Hibernate ex�cutera par d�faut 25 <literal>SELECT</literal>, pour charger les owners + (initialiser le proxy). Vous pouvez param�trer ce comportement en sp�cifiant une + <literal>batch-size</literal> (taille du lot) dans le mapping de <literal>Person</literal> : + </para> + + <programlisting><![CDATA[<class name="Person" batch-size="10">...</class>]]></programlisting> + + <para> + Hibernate ex�cutera d�sormais trois requ�tes, en chargeant respectivement 10, + 10, et 5 entit�s. + </para> + + <para> + Vous pouvez aussi activer le chargement par lot pour les collections. Par exemple, + si chaque <literal>Person</literal> a une collection charg�e tardivement de + <literal>Cat</literal>s, et que 10 personnes sont actuellement charg�es dans la + <literal>Session</literal>, it�rer sur toutes les persons g�n�rera 10 <literal>SELECT</literal>s, + un pour chaque appel de <literal>getCats()</literal>. Si vous activez le chargement par lot pour la + collection <literal>cats</literal> dans le mapping de <literal>Person</literal>, Hibernate pourra + pr�charger les collections : + </para> + + <programlisting><![CDATA[<class name="Person"> + <set name="cats" batch-size="3"> + ... + </set> +</class>]]></programlisting> + + <para> + Avec une taille de lot (<literal>batch-size</literal>) de 3, Hibernate chargera + respectivement 3, 3, 3, et 1 collections en quatre <literal>SELECT</literal>s. + Encore une fois, la valeur de l'attribut d�pend du nombre de collections + non initialis�es dans une <literal>Session</literal> particuli�re. + </para> + + <para> + Le chargement par lot de collections est particuli�rement utile si vous avez des + arborescenses r�cursives d'�l�ments (typiquement, le sch�ma facture de + mat�riels). (Bien qu'un <emphasis>sous ensemble</emphasis> ou un + <emphasis>chemin mat�rialis�</emphasis> est sans doute une meilleure option pour + des arbres principalement en lecture.) + </para> + + </sect2> + + <sect2 id="performance-fetching-subselect"> + <title>Utilisation du chargement par sous select</title> + + <para> + Si une collection ou un proxy vers un objet doit �tre charg�, Hibernate va tous les + charger en r�-ex�cutant la requ�te orignial dans un sous select. Cela fonctionne de la + m�me mani�re que le chargement par lot sans la possibilit� de fragmenter le chargement. + </para> + +  + + </sect2> + + <sect2 id="performance-fetching-lazyproperties"> + <title>Utiliser le chargement tardif des propri�t�s</title> + + <para> + Hibernate3 supporte le chargement tardif de propri�t�s individuelles. La technique + d'optimisation est �galement connue sous le nom de <emphasis>fetch groups</emphasis> (groupes + de chargement). Il faut noter qu'il s'agit principalement d'une fonctionnalit� marketing + car en pratique l'optimisation de la lecture d'un enregistrement est beaucoup plus importante + que l'optimisation de la lecture d'une colonne. Cependant, la restriction du chargement � + certaines colonnes peut �tre pratique dans des cas extr�mes, lorsque des tables "legacy" + poss�dent des centaines de colonnes et que le mod�le de donn�es ne peut pas �tre am�lior�. + </para> + + <para> + Pour activer le chargement tardif d'une propri�t�, il faut mettre l'attribut <literal>lazy</literal> + sur une propri�t� particuli�re du mapping : + </para> + + <programlisting><![CDATA[<class name="Document"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name" not-null="true" length="50"/> + <property name="summary" not-null="true" length="200" lazy="true"/> + <property name="text" not-null="true" length="2000" lazy="true"/> +</class>]]></programlisting> + + <para> + Le chargement tardif des propri�t�s requiert une instrumentation du bytecode lors de la + compilation ! Si les classes persistantes ne sont pas instrument�es, Hibernate ignorera de + mani�re silencieuse le mode tardif et retombera dans le mode de chargement imm�diat. + </para> + + <para> + Pour l'instrumentation du bytecode vous pouvez utiliser la t�che Ant suivante : + </para> + + <programlisting><![CDATA[<target name="instrument" depends="compile"> + <taskdef name="instrument" classname="org.hibernate.tool.instrument.InstrumentTask"> + <classpath path="${jar.path}"/> + <classpath path="${classes.dir}"/> + <classpath refid="lib.class.path"/> + </taskdef> + + <instrument verbose="true"> + <fileset dir="${testclasses.dir}/org/hibernate/auction/model"> + <include name="*.class"/> + </fileset> + </instrument> +</target>]]></programlisting> + + <para> + Une autre fa�on (meilleure ?) pour �viter de lire plus de colonnes que + n�cessaire au moins pour des transactions en lecture seule est d'utiliser + les fonctionnalit�s de projection des requ�tes HQL ou Criteria. Cela �vite + de devoir instrumenter le bytecode � la compilation et est certainement une + solution pr�f�rable. + </para> + + <para> + Vous pouvez forcer le mode de chargement agressif des propri�t�s en utilisant + <literal>fetch all properties</literal> dans les requ�ts HQL. + </para> + + </sect2> + </sect1> + + <sect1 id="performance-cache" revision="1"> + <title>Le cache de second niveau</title> + + <para> + Une <literal>Session</literal> Hibernate est un cache de niveau transactionnel + des donn�es persistantes. Il est possible de configurer un cache de cluster ou de JVM + (de niveau <literal>SessionFactory</literal> pour �tre exact) d�fini classe par classe + et collection par collection. Vous pouvez m�me utiliser votr choix de cache + en impl�mentant le pourvoyeur (provider) associ�. + Faites attention, les caches ne sont jamais avertis des modifications faites + dans la base de donn�es par d'autres applications (ils peuvent cependant �tre + configur�s pour r�guli�rement expirer les donn�es en cache). + </para> + + <para> + Par d�faut, Hibernate utilise EHCache comme cache de niveau JVM (le support + de JCS est d�sormais d�pr�ci� et sera enlev� des futures versions d'Hibernate). + Vous pouvez choisir une autre impl�mentation en sp�cifiant le nom de la classe qui + impl�mente <literal>org.hibernate.cache.CacheProvider</literal> en utilisant + la propri�t� <literal>hibernate.cache.provider_class</literal>. + </para> + + <table frame="topbot" id="cacheproviders" revision="1"> + <title>Fournisseur de cache</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Cache</entry> + <entry>Classe pourvoyeuse</entry> + <entry>Type</entry> + <entry>Support en Cluster</entry> + <entry>Cache de requ�tes support�</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (ne pas utiliser en production)</entry> + <entry><literal>org.hibernate.cache.HashtableCacheProvider</literal></entry> + <entry>m�moire</entry> + <entry></entry> + <entry>oui</entry> + </row> + <row> + <entry>EHCache</entry> + <entry><literal>org.hibernate.cache.EhCacheProvider</literal></entry> + <entry>m�moire, disque</entry> + <entry></entry> + <entry>oui</entry> + </row> + <row> + <entry>OSCache</entry> + <entry><literal>org.hibernate.cache.OSCacheProvider</literal></entry> + <entry>m�moire, disque</entry> + <entry>oui (invalidation de cluster)</entry> + <entry>oui</entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry><literal>org.hibernate.cache.SwarmCacheProvider</literal></entry> + <entry>en cluster (multicast ip)</entry> + <entry>oui (invalidation de cluster)</entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry><literal>org.hibernate.cache.TreeCacheProvider</literal></entry> + <entry>en cluster (multicast ip), transactionnel</entry> + <entry>oui (replication)</entry> + <entry>oui (horloge sync. n�cessaire)</entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="performance-cache-mapping" revision="2"> + <title>Mapping de Cache</title> + + <para> + L'�l�ment <literal><cache></literal> d'une classe ou d'une collection � + la forme suivante : + </para> + + <programlistingco> + <areaspec> + <area id="cache1" coords="2 70"/> + <area id="cache2" coords="3 70"/> + <area id="cache3" coords="4 70"/> + </areaspec> + <programlisting><![CDATA[<cache + usage="transactional|read-write|nonstrict-read-write|read-only" + region="RegionName" + include="all|non-lazy" +/>]]></programlisting> + <calloutlist> + <callout arearefs="cache1"> + <para> + <literal>usage</literal> (requis) sp�cifie la strat�gie de cache : + <literal>transactionel</literal>, + <literal>lecture-�criture</literal>, + <literal>lecture-�criture non stricte</literal> ou + <literal>lecture seule</literal> + </para> + </callout> + <callout arearefs="cache2"> + <para> + <literal>region</literal> (optionnel, par d�faut il s'agit du nom + de la classe ou du nom de role de la collection) sp�cifie le nom de la + r�gion du cache de second niveau + </para> + </callout> + <callout arearefs="cache3"> + <para> + <literal>include</literal> (optionnel, par d�faut <literal>all</literal>) + <literal>non-lazy</literal> sp�cifie que les propri�t�s des entit�s mapp�es avec + <literal>lazy="true"</literal> ne doivent pas �tre mises en cache lorsque + le chargement tardif des attributs est activ�. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Alternativement (voir pr�f�rentiellement), vous pouvez sp�cifier les �l�ments + <literal><class-cache></literal> et <literal><collection-cache></literal> + dans <literal>hibernate.cfg.xml</literal>. + </para> + + <para> + L'attribut <literal>usage</literal> sp�cifie une <emphasis>strat�gie de concurrence d'acc�s au cache</emphasis>. + </para> + + </sect2> + + <sect2 id="performance-cache-readonly"> + <title>Strategie : lecture seule</title> + + <para> + Si votre application a besoin de lire mais ne modifie jamais les instances d'une classe, + un cache <literal>read-only</literal> peut �tre utilis�. C'est la strat�gie la plus simple + et la plus performante. Elle est m�me parfaitement s�re dans un cluster. + </para> + + <programlisting><![CDATA[<class name="eg.Immutable" mutable="false"> + <cache usage="read-only"/> + .... +</class>]]></programlisting> + + </sect2> + + + <sect2 id="performance-cache-readwrite"> + <title>Strat�gie : lecture/�criture</title> + + <para> + Si l'application a besoin de mettre � jour des donn�es, un cache <literal>read-write</literal> peut + �tre appropri�. Cette strat�gie ne devrait jamais �tre utilis�e si votre application + n�cessite un niveau d'isolation transactionnelle s�rialisable. Si le cache est utilis� + dans un environnement JTA, vous devez sp�cifier + <literal>hibernate.transaction.manager_lookup_class</literal>, fournissant une strat�gie pour obtenir + le <literal>TransactionManager</literal> JTA. Dans d'autres environnements, vous devriez vous assurer + que la transation est termin�e � l'appel de <literal>Session.close()</literal> + ou <literal>Session.disconnect()</literal>. Si vous souhaitez utiliser cette strat�gie + dans un cluster, vous devriez vous assurer que l'impl�mentation de cache utilis�e supporte + le v�rrouillage. Ce que ne font <emphasis>pas</emphasis> les pourvoyeurs caches fournis. + </para> + + <programlisting><![CDATA[<class name="eg.Cat" .... > + <cache usage="read-write"/> + .... + <set name="kittens" ... > + <cache usage="read-write"/> + .... + </set> +</class>]]></programlisting> + + </sect2> + + <sect2 id="performance-cache-nonstrict"> + <title>Strat�gie : lecture/�criture non stricte</title> + + <para> + Si l'application besoin de mettre � jour les donn�es de mani�re occasionnelle + (qu'il est tr�s peu probable que deux transactions essaient de mettre � jour le m�me + �l�ment simultan�ment) et qu'une isolation transactionnelle stricte n'est pas n�cessaire, + un cache <literal>nonstrict-read-write</literal> peut �tre appropri�. Si le cache est + utilis� dans un environnement JTA, vous devez sp�cifier + <literal>hibernate.transaction.manager_lookup_class</literal>. Dans d'autres + environnements, vous devriez vous assurer que la transation est termin�e � l'appel + de <literal>Session.close()</literal> ou <literal>Session.disconnect()</literal> + </para> + + </sect2> + + <sect2 id="performance-cache-transactional"> + <title>Strat�gie : transactionelle</title> + + <para> + La strat�gie de cache <literal>transactional</literal> supporte un cache + compl�tement transactionnel comme, par exemple, JBoss TreeCache. Un tel cache ne + peut �tre utilis� que dans un environnement JTA et vous devez sp�cifier + <literal>hibernate.transaction.manager_lookup_class</literal>. + </para> + + </sect2> + + <para> + Aucun des caches livr�s ne supporte toutes les strat�gies de concurrence. Le tableau suivant montre + quels caches sont compatibles avec quelles strat�gies de concurrence. + </para> + + <table frame="topbot"> + <title>Strat�gie de concurrence du cache</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Cache</entry> + <entry>read-only (lecture seule)</entry> + <entry>nonstrict-read-write (lecture-�criture non stricte)</entry> + <entry>read-write (lecture-�riture)</entry> + <entry>transactional (transactionnel)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (ne pas utilser en production)</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry></entry> + </row> + <row> + <entry>EHCache</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry></entry> + </row> + <row> + <entry>OSCache</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry></entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry>oui</entry> + <entry>oui</entry> + <entry></entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry>oui</entry> + <entry></entry> + <entry></entry> + <entry>oui</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + + <sect1 id="performance-sessioncache" revision="2"> + <title>G�rer les caches</title> + + <para> + A chaque fois que vous passez un objet � la m�thode <literal>save()</literal>, + <literal>update()</literal> ou <literal>saveOrUpdate()</literal> et � chaque fois + que vous r�cup�rez un objet avec <literal>load()</literal>, <literal>get()</literal>, + <literal>list()</literal>, <literal>iterate()</literal> or <literal>scroll()</literal>, + cet objet est ajout� au cache interne de la <literal>Session</literal>. + </para> + <para> + Lorsqu'il y a un appel � la m�thode <literal>flush()</literal>, l'�tat de cet objet + va �tre synchronis� avec la base de donn�es. Si vous ne voulez pas que cette synchronisation + ait lieu ou si vous traitez un grand nombre d'objets et que vous avez besoin de g�rer + la m�moire de mani�re efficace, vous pouvez utiliser la m�thode <literal>evict()</literal> + pour supprimer l'objet et ses collections d�pendantes du cache de la session + </para> + + <programlisting><![CDATA[ScrollableResult cats = sess.createQuery("from Cat as cat").scroll(); //a huge result set +while ( cats.next() ) { + Cat cat = (Cat) cats.get(0); + doSomethingWithACat(cat); + sess.evict(cat); +}]]></programlisting> + + <para> + La <literal>Session</literal> dispose aussi de la m�thode <literal>contains()</literal> pour d�terminer + si une instance appartient au cache de la session. + </para> + + <para> + Pour retirer tous les objets du cache session, appelez <literal>Session.clear()</literal> + </para> + + <para> + Pour le cache de second niveau, il existe des m�thodes d�finies dans + <literal>SessionFactory</literal> pour retirer des instances du cache, + la classe enti�re, une instance de collection ou + le r�le entier d'une collection. + </para> + + <programlisting><![CDATA[sessionFactory.evict(Cat.class, catId); //evict a particular Cat +sessionFactory.evict(Cat.class); //evict all Cats +sessionFactory.evictCollection("Cat.kittens", catId); //evict a particular collection of kittens +sessionFactory.evictCollection("Cat.kittens"); //evict all kitten collections]]></programlisting> + + <para> + Le <literal>CacheMode</literal> contr�le comme une session particuli�re interragit avec le + cache de second niveau + </para> + + <itemizedlist> + <listitem> + <para> + <literal>CacheMode.NORMAL</literal> - lit et �crit les items dans le cache de second niveau + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.GET</literal> - lit les items dans le cache de second niveau mais ne + les �crit pas sauf dans le cache d'une mise � jour d'une donn�e + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.PUT</literal> - �crit les items dans le cache de second niveau mais ne les + lit pas dans le cache de second niveau + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.REFRESH</literal> - �crit les items dans le cache de second niveau mais ne les + lit pas dans le cache de second niveau, outrepasse l'effet de<literal>hibernate.cache.use_minimal_puts</literal>, + en for�ant un rafra�chissement du cache de second niveau pour chaque item lu dans la base + </para> + </listitem> + </itemizedlist> + + <para> + Pour parcourir le contenu du cache de second niveau ou la r�gion du cache d�di�e au requ�tes, vous + pouvez utiliser l'API <literal>Statistics</literal> + API: + </para> + + <programlisting><![CDATA[Map cacheEntries = sessionFactory.getStatistics() + .getSecondLevelCacheStatistics(regionName) + .getEntries();]]></programlisting> + + <para> + Vous devez pour cela activer les statistiques et optionnellement forcer Hibernate � conserver les entr�es dans le + cache sous un format plus compr�hensible pour l'utilisateur : + </para> + + <programlisting><![CDATA[hibernate.generate_statistics true +hibernate.cache.use_structured_entries true]]></programlisting> + + </sect1> + + <sect1 id="performance-querycache" revision="1"> + <title>Le cache de requ�tes</title> + + <para> + Les r�sultats d'une requ�te peuvent aussi �tre plac�s en cache. Ceci n'est utile + que pour les requ�tes qui sont ex�cut�es avec les m�mes param�tres. Pour utiliser + le cache de requ�tes, vous devez d'abord l'activer : + </para> + + <programlisting><![CDATA[hibernate.cache.use_query_cache true]]></programlisting> + + <para> + Ce param�tre am�ne la cr�ation de deux nouvelles r�gions dans le cache, une qui va conserver + le r�sultat des requ�tes mises en cache (<literal>org.hibernate.cache.StandardQueryCache</literal>) + et l'autre qui va conserver l'horodatage des mises � jour les plus r�centes effectu�es sur les + tables requ�tables (<literal>org.hibernate.cache.UpdateTimestampsCache</literal>). + Il faut noter que le cache de requ�te ne conserve pas l'�tat des entit�s, il met en cache + uniquement les valeurs de l'identifiant et les valeurs de types de base (?). Le cache + de requ�te doit toujours �tre utilis� avec le cache de second niveau pour �tre efficace. + </para> + + <para> + La plupart des requ�tes ne retirent pas de b�n�fice pas du cache, + donc par d�faut les requ�tes ne sont pas mises en cache. Pour activer le cache, + appelez <literal>Query.setCacheable(true)</literal>. + Cet appel permet de v�rifier si les r�sultats sont en cache ou non, voire + d'ajouter ces r�sultats si la requ�te est ex�cut�e. + </para> + + <para> + Si vous avez besoin de contr�ler finement les d�lais d'expiration du cache, vous + pouvez sp�cifier une r�gion de cache nomm�e pour une requ�te particuli�re en + appelant <literal>Query.setCacheRegion()</literal>. + </para> + + <programlisting><![CDATA[List blogs = sess.createQuery("from Blog blog where blog.blogger = :blogger") + .setEntity("blogger", blogger) + .setMaxResults(15) + .setCacheable(true) + .setCacheRegion("frontpages") + .list();]]></programlisting> + + <para> + Si une requ�te doit forcer le rafra�chissement de sa r�gion de cache, vous devez + appeler <literal>Query.setCacheMode(CacheMode.REFRESH)</literal>. C'est particuli�rement + utile lorsque les donn�es peuvent avoir �t� mises � jour par un processus s�par� (e.g. elles + n'ont pas �t� modifi�es par Hibernate). Cela permet � l'application de rafra�chir de + mani�re s�lective les r�sultats d'une requ�te particuli�re. Il s'agit d'une alternative plus + efficace � l'�viction d'une r�gion du cache � l'aide de la m�thode + <literal>SessionFactory.evictQueries()</literal>. + </para> + + </sect1> + <sect1 id="performance-collections"> + <title>Comprendre les performances des Collections</title> + + <para> + Nous avons d�j� pass� du temps � discuter des collections. + Dans cette section, nous allons traiter du comportement des + collections � l'ex�cution. + </para> + + <sect2 id="performance-collections-taxonomy"> + <title>Classification</title> + + <para>Hibernate d�finit trois types de collections :</para> + + <itemizedlist> + <listitem> + <para>les collections de valeurs</para> + </listitem> + <listitem> + <para>les associations un-vers-plusieurs</para> + </listitem> + <listitem> + <para>les associations plusieurs-vers-plusieurs</para> + </listitem> + </itemizedlist> + + <para> + Cette classification distingue les diff�rentes relations entre les tables + et les cl�s �trang�res mais ne nous apprend rien de ce que nous devons savoir + sur le mod�le relationnel. Pour comprendre parfaitement la structure relationnelle + et les caract�ristiques des performances, nous devons consid�rer la structure + de la cl� primaire qui est utilis�e par Hibernate pour mettre � jour ou supprimer + les �l�ments des collections. Cel� nous am�ne aux classifications suivantes : + </para> + + <itemizedlist> + <listitem> + <para>collections index�es</para> + </listitem> + <listitem> + <para>sets</para> + </listitem> + <listitem> + <para>bags</para> + </listitem> + </itemizedlist> + + <para> + Toutes les collections index�es (maps, lists, arrays) ont une cl� primaire constitu�e + des colonnes cl� (<literal><key></literal>) et <literal><index></literal>. + Avec ce type de cl� primaire, la mise � jour de collection est en g�n�ral tr�s performante - la cl� + primaire peut �tre index�es efficacement et un �l�ment particulier peut �tre + localis� efficacement lorsqu'Hibernate essaie de le mettre � jour ou de le supprimer. + </para> + + <para> + Les Sets ont une cl� primaire compos�e de <literal><key></literal> et des + colonnes repr�sentant l'�l�ment. Elle est donc moins efficace pour certains + types de collections d'�l�ments, en particulier les �l�ments composites, + les textes volumineux ou les champs binaires ; la base de donn�es + peut ne pas �tre capable d'indexer aussi efficacement une cl� primaire + aussi complexe. Cependant, pour les associations un-vers-plusieurs + ou plusieurs-vers-plusieurs, sp�cialement lorsque l'on utilise des entit�s + ayant des identifiants techniques, il est probable que cela soit aussi efficace + (note : si vous voulez que <literal>SchemaExport</literal> cr�� effectivement + la cl� primaire d'un <literal><set></literal> pour vous, vous devez + d�clarer toutes les colonnes avec <literal>not-null="true"</literal>). + </para> + + <para> + Le mapping � l'aide d'<literal><idbag></literal> d�finit une cl� + de substitution ce qui leur permet d'�tre tr�s efficaces lors de la + mise � jour. En fait il s'agit du meilleur cas de mise � jour d'une collection + </para> + + <para> + Le pire cas intervient pour les Bags. Dans la mesure o� un bag permet + la duplications des �l�ments et n'a pas de colonne d'index, aucune cl� primaire + ne peut �tre d�finie. Hibernate n'a aucun moyen de distinguer des enregistrements + dupliqu�s. Hibernate r�sout ce probl�me en supprimant compl�tement les + enregistrements (via un simple <literal>DELETE</literal>), puis en recr�ant + la collection chaque fois qu'elle change. Ce qui peut �tre tr�s inefficace. + </para> + + <para> + Notez que pour une relation un-vers-plusieurs, la "cl� primaire" + peut ne pas �tre la cl� primaire de la table en base de donn�es - + mais m�me dans ce cas, la classification ci-dessus reste utile + (Elle explique comment Hibernate "localise" chaque enregistrement + de la collection). + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficientupdate"> + <title>Les lists, les maps, les idbags et les sets sont les collections les plus efficaces pour la mise � jour</title> + + <para> + La discussion pr�c�dente montre clairement que les collections index�es + et (la plupart du temps) les sets, permettent de r�aliser le plus efficacement + les op�rations d'ajout, de suppression ou de modification d'�l�ments. + </para> + + <para> + Il existe un autre avantage qu'ont les collections index�es sur les Sets + dans le cadre d'une association plusieurs vers plusieurs ou d'une collection de valeurs. + A cause de la structure inh�rente d'un <literal>Set</literal>, Hibernate n'effectue jamais + d'<literal>UPDATE</literal> quand un enregistrement est modifi�. Les modifications + apport�es � un <literal>Set</literal> se font via un <literal>INSERT</literal> et <literal>DELETE</literal> + (de chaque enregistrement). Une fois de plus, ce cas ne s'applique pas aux associations + un vers plusieurs. + </para> + + <para> + Apr�s s'�tre rappel� que les tableaux ne peuvent pas �tre charg�s tardivement, + nous pouvons conclure que les lists, les maps et les idbags sont les types de collections + (non invers�es) les plus performants, avec les sets pas loin derri�res. + Les sets son le type de collection le plus courant dans les applications Hibernate. Cela + est du au fait que la s�mantique des "set" est la plus naturelle dans le mod�le + relationnel. + </para> + + <para> + Cependant, dans des mod�les objet bien con�us avec Hibernate, on voit souvent que + la plupart des collections sont en fait des associations "un-vers-plusieurs" avec + <literal>inverse="true"</literal>. Pour ces associations, les mises � jour sont g�r�es + au niveau de l'association "plusieurs-vers-un" et les consid�rations de performance de + mise � jour des collections ne s'appliquent tout simplement pas dans ces cas l�. + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficentinverse"> + <title>Les Bags et les lists sont les plus efficaces pour les collections inverse</title> + + <para> + Avant que vous n'oubliez les bags pour toujours, il y a un cas pr�cis o� les bags + (et les lists) sont bien plus performants que les sets. Pour une collection marqu�e + comme <literal>inverse="true"</literal> (le choix le plus courant pour un relation + un vers plusieurs bidirectionnelle), nous pouvons ajouter des �l�ments � un bag + ou une list sans avoir besoin de l'initialiser (fetch) les �l�ments du sac! + Ceci parce que <literal>Collection.add()</literal> ou <literal>Collection.addAll()</literal> + doit toujours retourner vrai pour un bag ou une <literal>List</literal> + (contrairement au <literal>Set</literal>). + Cela peut rendre le code suivant beaucoup plus rapide. + </para> + + <programlisting><![CDATA[Parent p = (Parent) sess.load(Parent.class, id); + Child c = new Child(); + c.setParent(p); + p.getChildren().add(c); //pas besoin de charger la collection ! + sess.flush();]]></programlisting> + + </sect2> + + <sect2 id="performance-collections-oneshotdelete"> + <title>Suppression en un coup</title> + + <para> + Parfois, effacer les �l�ments d'une collection un par un peut �tre extr�mement inefficace. + Hibernate n'est pas totalement stupide, il sait qu'il ne faut pas le faire dans le cas d'une + collection compl�tement vid�e (lorsque vous appellez <literal>list.clear()</literal>, par exemple). + Dans ce cas, Hibernate fera un simple <literal>DELETE</literal> et le travail est fait ! + </para> + + <para> + Supposons que nous ajoutions un �l�ment dans une collection de taille vingt et que nous + enlevions ensuite deux �l�ments. Hibernate effectuera un <literal>INSERT</literal> puis + deux <literal>DELETE</literal> (� moins que la collection ne soit un bag). Ce qui est + souhaitable. + </para> + + <para> + Cependant, supposons que nous enlevions dix huit �l�ments, laissant ainsi deux �l�ments, puis + que nous ajoutions trois nouveaux �l�ments. Il y a deux moyens de proc�der. + </para> + + <itemizedlist> + <listitem> + <para>effacer dix huit enregistrements un � un puis en ins�rer trois</para> + </listitem> + <listitem> + <para>effacer la totalit� de la collection (en un <literal>DELETE</literal> SQL) puis ins�rer + les cinq �l�ments restant un � un</para> + </listitem> + </itemizedlist> + + <para> + Hibernate n'est pas assez intelligent pour savoir que, dans ce cas, la seconde m�thode est plus + rapide (Il plut�t heureux qu'Hibernate ne soit pas trop intelligent ; un tel comportement + pourrait rendre l'utilisation de triggers de bases de donn�es plut�t al�atoire, etc...). + </para> + + <para> + Heureusement, vous pouvez forcer ce comportement lorsque vous le souhaitez, en liberant + (c'est-�-dire en d�r�f�ren�ant) la collection initiale et en retournant une collection + nouvellement instanci�e avec les �l�ments restants. Ceci peut �tre tr�s pratique et + tr�s puissant de temps en temps. + </para> + + <para> + Bien s�r, la suppression en un coup ne s'applique pas pour les collections qui sont mapp�es + avec <literal>inverse="true"</literal>. + </para> + </sect2> + + </sect1> + + <sect1 id="performance-monitoring" revision="1"> + <title>Moniteur de performance</title> + + <para> + L'optimisation n'est pas d'un grand int�r�t sans le suivi et l'acc�s aux donn�es de + performance. Hibernate fournit toute une panoplie de rapport sur ses op�rations internes. + Les statistiques dans Hibernate sont fournies par <literal>SessionFactory</literal>. + </para> + + <sect2 id="performance-monitoring-sf" revision="2"> + <title>Suivi d'une SessionFactory</title> + + <para> + Vous pouvez acc�der au m�triques d'une <literal>SessionFactory</literal> de deux + mani�res. La premi�re option est d'appeler <literal>sessionFactory.getStatistics()</literal> + et de lire ou d'afficher les <literal>Statistics</literal> vous m�me. + </para> + + <para> + Hibernate peut �galement utiliser JMX pour publier les m�triques si vous activez + le MBean <literal>StatisticsService</literal>. Vous pouvez activer un seul MBean + pour toutes vos <literal>SessionFactory</literal> ou un par factory. Voici un code + qui montre un exemple de configuration minimaliste : + </para> + + <programlisting><![CDATA[// MBean service registration for a specific SessionFactory +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "myFinancialApp"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +stats.setSessionFactory(sessionFactory); // Bind the stats to a SessionFactory +server.registerMBean(stats, on); // Register the Mbean on the server]]></programlisting> + + +<programlisting><![CDATA[// MBean service registration for all SessionFactory's +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "all"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +server.registerMBean(stats, on); // Register the MBean on the server]]></programlisting> + + <para> + TODO: Cela n'a pas de sens : dans le premier cs on r�cup�re et on utilise le MBean directement. + Dans le second, on doit fournir le nom JNDI sous lequel est retenu la fabrique de session avant de + l'utiliser. Pour cela il faut utiliser + <literal>hibernateStatsBean.setSessionFactoryJNDIName("my/JNDI/Name")</literal> + </para> + <para> + Vous pouvez (d�s)activer le suivi pour une <literal>SessionFactory</literal> + </para> + <itemizedlist> + <listitem> + <para> + au moment de la configuration en mettant <literal>hibernate.generate_statistics</literal> � <literal>false</literal> + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + � chaud avec <literal>sf.getStatistics().setStatisticsEnabled(true)</literal> + ou <literal>hibernateStatsBean.setStatisticsEnabled(true)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Les statistiques peuvent �tre remises � z�ro de mani�re programmatique � l'aide de la m�thode + <literal>clear()</literal> + Un r�sum� peut �tre envoy� � un logger (niveau info) � l'aide de la m�thode <literal>logSummary()</literal> + </para> + + </sect2> + + <sect2 id="performance-monitoring-metrics" revision="1"> + <title>M�triques</title> + + <para> + Hibernate fournit un certain nombre de m�triques, qui vont des informations tr�s basiques + aux informations tr�s sp�cialis�es qui ne sont appropri�es que dans certains scenarii. + Tous les compteurs accessibles sont d�crits dans l'API de l'interface + <literal>Statistics</literal> dans trois cat�gories : + </para> + <itemizedlist> + <listitem> + <para> + Les m�triques relatives � l'usage g�n�ral de la <literal>Session</literal> + comme le nombre de sessions ouvertes, le nombre de connexions JDBC r�cup�r�es, etc... + </para> + </listitem> + <listitem> + <para> + Les m�triques relatives aux entit�s, collections, requ�tes et caches dans + leur ensemble (m�triques globales), + </para> + </listitem> + <listitem> + <para> + Les m�triques d�taill�es relatives � une entit�, une collection, une requ�te + ou une r�gion de cache particuli�re. + </para> + </listitem> + </itemizedlist> + + <para> + Par exemple, vous pouvez v�rifier l'acc�s au cache ainsi que le taux d'�l�ments manquants et + de mise � jour des entit�s, collections et requ�tes et le temps moyen que met une requ�te. + Il faut faire attention au fait que le nombre de millisecondes est sujet � approximation en + Java. Hibernate est li� � la pr�cision de la machine virtuelle, sur certaines plateformes, + cela n'offre qu'une pr�cision de l'ordre de 10 secondes. + </para> + + <para> + Des accesseurs simples sont utilis�s pour acc�der aux m�triques globales (e.g. celles qui ne + sont pas li�es � une entit�, collection ou r�gion de cache particuli�re). Vous pouvez acc�der + aux m�triques d'une entit�, collection, r�gion de cache particuli�re � l'aide de son nom et � l'aide + de sa repr�sentation HQL ou SQL pour une requ�te. R�f�rez vous � la javadoc des APIS + <literal>Statistics</literal>, <literal>EntityStatistics</literal>, + <literal>CollectionStatistics</literal>, <literal>SecondLevelCacheStatistics</literal>, + and <literal>QueryStatistics</literal> pour plus d'informations. Le code ci-dessous montre + un exemple simple : + </para> + + <programlisting><![CDATA[Statistics stats = HibernateUtil.sessionFactory.getStatistics(); + +double queryCacheHitCount = stats.getQueryCacheHitCount(); +double queryCacheMissCount = stats.getQueryCacheMissCount(); +double queryCacheHitRatio = + queryCacheHitCount / (queryCacheHitCount + queryCacheMissCount); + +log.info("Query Hit ratio:" + queryCacheHitRatio); + +EntityStatistics entityStats = + stats.getEntityStatistics( Cat.class.getName() ); +long changes = + entityStats.getInsertCount() + + entityStats.getUpdateCount() + + entityStats.getDeleteCount(); +log.info(Cat.class.getName() + " changed " + changes + "times" );]]></programlisting> + + <para> + Pour travailler sur toutes les entit�s, collections, requ�tes et r�gions de cache, vous pouvez + r�cup�rer la liste des noms des entit�s, collections, requ�tes et r�gions de cache avec les + m�thodes : <literal>getQueries()</literal>, <literal>getEntityNames()</literal>, + <literal>getCollectionRoleNames()</literal>, et + <literal>getSecondLevelCacheRegionNames()</literal>. + </para> + + </sect2> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/persistent_classes.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/persistent_classes.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/persistent_classes.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/persistent_classes.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,536 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<chapter id="persistent-classes" revision="2"> + <title>Classes persistantes</title> + + <para> + Les classes persistantes sont les classes d'une application qui impl�mentent + les entit�s d'un probl�me m�tier (ex. Client et Commande dans une application + de commerce �lectronique). + Toutes les instances d'une classe persistante ne sont pas forc�ment + dans l'�tat persistant - au lieu de cela, une instance peut �tre �ph�m�re (NdT : transient) ou d�tach�e. + </para> + + <para> + Hibernate fonctionne de mani�re optimale lorsque ces classes suivent quelques r�gles + simples, aussi connues comme le mod�le de programmation Plain Old Java Object + (POJO). Cependant, aucune de ces r�gles ne sont des besoins absolus. En effet, Hibernate3 suppose tr�s peu de choses � propos + de la nature de vos objets persistants. Vous pouvez exprimer un mod�le de domaine par d'autres moyens : utiliser des arbres + d'instances de <literal>Map</literal>, par exemple. + </para> + + <sect1 id="persistent-classes-pojo"> + <title>Un exemple simple de POJO</title> + + <para> + Toute bonne application Java n�cessite une classe persistante + repr�sentant les f�lins. + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +public class Cat { + private Long id; // identifier + + private Date birthdate; + private Color color; + private char sex; + private float weight; + private int litterId; + + private Cat mother; + private Set kittens = new HashSet(); + + private void setId(Long id) { + this.id=id; + } + public Long getId() { + return id; + } + + void setBirthdate(Date date) { + birthdate = date; + } + public Date getBirthdate() { + return birthdate; + } + + void setWeight(float weight) { + this.weight = weight; + } + public float getWeight() { + return weight; + } + + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + + void setSex(char sex) { + this.sex=sex; + } + public char getSex() { + return sex; + } + + void setLitterId(int id) { + this.litterId = id; + } + public int getLitterId() { + return litterId; + } + + void setMother(Cat mother) { + this.mother = mother; + } + public Cat getMother() { + return mother; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + public Set getKittens() { + return kittens; + } + + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kitten.setMother(this); + kitten.setLitterId( kittens.size() ); + kittens.add(kitten); + } +}]]></programlisting> + + <para> + Il y a quatre r�gles � suivre ici : + </para> + + + <sect2 id="persistent-classes-pojo-constructor" revision="1"> + <title>Impl�menter un constructeur sans argument</title> + + <para> + <literal>Cat</literal> a un constructeur sans argument. Toutes les classes persistantes doivent avoir un + constructeur par d�faut (lequel peut ne pas �tre public) pour qu'Hibernate puissent les instancier en utilisant + <literal>Constructor.newInstance()</literal>. Nous recommandons fortement d'avoir un constructeur par d�faut avec + au moins une visibilit� <emphasis>paquet</emphasis> pour la g�n�ration du proxy � l'ex�cution dans Hibernate. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-identifier" revision="2"> + <title>Fournir une propri�t� d'indentifiant (optionnel)</title> + + <para> + <literal>Cat</literal> poss�de une propri�t� appel�e <literal>id</literal>. + Cette propri�t� mappe la valeur de la colonne de cl� primaire de la table + d'une base de donn�es.La propri�t� aurait pu s'appeler compl�tement autrement, + et son type aurait pu �tre n'importe quel type primitif, n'importe quel "encapsuleur" + de type primitif, <literal>java.lang.String</literal> ou <literal>java.util.Date</literal>. + (Si votre base de donn�es h�rit�e poss�de des cl�s composites, elles peuvent �tre mapp�es + en utilisant une classe d�finie par l'utilisateur et poss�dant les propri�t�s associ�es aux + types de la cl� composite - voir la section concernant les identifiants composites plus tard). + </para> + + <para> + La propri�t� d'identifiant est strictement optionnelle. Vous pouver l'oublier et laisser Hibernate + s'occuper des identifiants de l'objet en interne. Toutefois, nous ne le recommandons pas. + </para> + + <para> + En fait, quelques fonctionnalit�s ne sont disponibles que pour les classes + d�clarant un identifiant de propri�t� : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Les r�attachements transitifs pour les objets d�tach�s (mise � jour en cascade ou fusion en cascade) - + voir <xref linkend="objectstate-transitive"/> + </para> + </listitem> + <listitem> + <para> + <literal>Session.saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>Session.merge()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Nous recommandons que vous d�clariez les propri�t�s d'identifiant de mani�re + uniforme. Nous recommandons �galement que vous utilisiez un type nullable + (ie. non primitif). + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-final"> + <title>Favoriser les classes non finales (optionnel)</title> + <para> + Une fonctionnalit� clef d'Hibernate, les <emphasis>proxies</emphasis>, n�cessitent + que la classe persistente soit non finale ou qu'elle soit l'impl�mentation d'une + interface qui d�clare toutes les m�thodes publiques. + </para> + <para> + Vous pouvez persister, gr�ce � Hibernate, les classes <literal>final</literal> + qui n'impl�mentent pas d'interface, mais vous ne pourrez pas utiliser les proxies pour les chargements d'associations paresseuses + - ce qui limitera vos possibilit�s d'ajustement des performances. + </para> + <para> + Vous devriez aussi �viter de d�clarer des m�thodes <literal>public final</literal> sur des classes + non-finales. Si vous voulez utiliser une classe avec une m�thode <literal>public final</literal>, vous devez + explicitement d�sactiver les proxies en param�trant + <literal>lazy="false"</literal>. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-accessors" revision="2"> + <title>D�clarer les accesseurs et mutateurs des attributs persistants (optionnel)</title> + + <para> + <literal>Cat</literal> d�clare des mutateurs pour toutes ses champs persistants. Beaucoup d'autres + solutions de mapping Objet/relationnel persistent directement les variables d'instance. Nous pensons + qu'il est bien mieux de fournir une indirection entre le sch�ma relationnel et les structures de donn�es internes de la classe. + Par d�faut, Hibernate persiste les propri�t�s suivant le style JavaBean, et reconna�t les noms de m�thodes de la forme <literal> + getFoo</literal>, <literal>isFoo</literal> et + <literal>setFoo</literal>. Nous pouvons changer pour un acc�s direct aux champs pour des propri�t�s particuli�res, si besoin est. + </para> + + <para> + Les propri�t�s <emphasis>n'ont pas</emphasis> � �tre d�clar�es publiques - + Hibernate peut persister une propri�t� avec un paire de getter/setter de + visibilit� par d�fault, <literal>protected</literal> ou <literal> + private</literal>. + </para> + + </sect2> + + </sect1> + + <sect1 id="persistent-classes-inheritance"> + <title>Impl�menter l'h�ritage</title> + + <para> + Une sous-classe doit �galement suivre la premi�re et la seconde r�gle. + Elle h�rite sa propri�t� d'identifiant de <literal>Cat</literal>. + </para> + + <programlisting><![CDATA[package eg; + +public class DomesticCat extends Cat { + private String name; + + public String getName() { + return name; + } + protected void setName(String name) { + this.name=name; + } +}]]></programlisting> + </sect1> + + <sect1 id="persistent-classes-equalshashcode" revision="1"> + <title>Impl�menter <literal>equals()</literal> et <literal>hashCode()</literal></title> + + <para> + Vous devez surcharger les m�thodes <literal>equals()</literal> et + <literal>hashCode()</literal> si vous + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + avez l'intention de mettre des instances de classes persistantes dans un <literal>Set</literal> + (la mani�re recommand�e pour repr�senter des associations pluri-valu�es) + <emphasis>et</emphasis> + </para> + </listitem> + <listitem> + <para> + avez l'intention d'utiliser le r�attachement d'instances d�tach�es + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate garantit l'�quivalence de l'identit� persistante (ligne de base de donn�es) et l'identit� Java seulement + � l'int�rieur de la port�e d'une session particuli�re. Donc d�s que nous m�langeons des instances venant de diff�rentes + sessions, nous devons impl�menter <literal>equals()</literal> et + <literal>hashCode()</literal> si nous souhaitons avoir une s�mantique correcte pour les <literal>Set</literal>s. + </para> + + <para> + La mani�re la plus �vidente est d'impl�menter <literal>equals()</literal>/<literal>hashCode()</literal> + en comparant la valeur de l'identifiant des deux objets. Si cette valeur est identique, les deux + doivent repr�senter la m�me ligne de base de donn�es, ils sont donc �gaux (si les deux sont + ajout�s � un <literal>Set</literal>, nous n'aurons qu'un seul �l�ment dans le + <literal>Set</literal>). Malheureusement, nous ne pouvons pas utiliser cette approche avec + des identifiants g�n�r�s ! Hibernate n'assignera de + valeur d'identifiant qu'aux objets qui sont persistants, une instance nouvellement cr��e n'aura + donc pas de valeur d'identifiant ! De plus, si une instance est non sauvegard�e et actuellement dans un <literal>Set</literal>, + le sauvegarder assignera une valeur d'identifiant � l'objet. Si <literal>equals()</literal> et <literal>hashCode()</literal> + sont bas�es sur la valeur de l'identifiant, le code de hachage devrait changer, rompant le contrat du <literal>Set</literal>. + Regardez sur le site web d'Hibernate pour une discussion compl�te de ce probl�me. + Notez que ceci n'est pas un probl�me d'Hibernate, mais la s�mantique normale de Java pour l'identit� d'un objet et l'�galit�. + </para> + + <para> + Nous recommandons donc d'impl�menter + <literal>equals()</literal> et <literal>hashCode()</literal> en utilisant <emphasis> + l'�galit� par cl� m�tier</emphasis>.L'�galit� par cl� m�tier signifie que la m�thode <literal>equals()</literal> + compare uniquement les propri�t�s qui forment une cl� m�tier, une cl� qui + identifierait notre instance dans le monde r�el (une cl� candidate + <emphasis>naturelle</emphasis>) : + </para> + + <programlisting><![CDATA[public class Cat { + + ... + public boolean equals(Object other) { + if (this == other) return true; + if ( !(other instanceof Cat) ) return false; + + final Cat cat = (Cat) other; + + if ( !cat.getLitterId().equals( getLitterId() ) ) return false; + if ( !cat.getMother().equals( getMother() ) ) return false; + + return true; + } + + public int hashCode() { + int result; + result = getMother().hashCode(); + result = 29 * result + getLitterId(); + return result; + } + +}]]></programlisting> + + <para> + Notez qu'une clef m�tier ne doit pas �tre solide comme une clef primaire de base de donn�es + (voir <xref linkend="transactions-basics-identity"/>). Les propri�t�s + immuables ou uniques sont g�n�ralement de bonnes candidates pour une clef m�tier. + </para> + + </sect1> + + <sect1 id="persistent-classes-dynamicmodels"> + <title>Mod�les dynamiques</title> + + <para> + <emphasis>Notez que la fonctionnalit�s suivantes sont actuellement consid�r�es + comme exp�rimentales et peuvent changer dans un futur proche.</emphasis> + </para> + + <para> + Les entit�s persistantes ne doivent pas n�cessairement �tre repr�sent�es comme + des classes POJO ou des objets JavaBean � l'ex�cution. Hibernate supporte aussi les + mod�les dynamiques (en utilisant des <literal>Map</literal>s de <literal>Map</literal>s + � l'ex�cution) et la repr�sentation des entit�s comme des arbres DOM4J. Avec cette + approche, vous n'�crivez pas de classes persistantes, seulement des fichiers de mapping. + </para> + + <para> + Par d�faut, Hibernate fonctionne en mode POJO normal. Vous pouvez param�trer + un mode de repr�sentation d'entit� par d�faut pour une <literal>SessionFactory</literal> + particuli�re en utilisant l'option de configuration <literal>default_entity_mode</literal> + (voir <xref linkend="configuration-optional-properties"/>). + </para> + + <para> + Les exemples suivants d�montrent la repr�sentation utilisant des <literal>Map</literal>s. + D'abord, dans le fichier de mapping, un <literal>entity-name</literal> doit �tre d�clar� + au lieu (ou en plus) d'un nom de classe : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class entity-name="Customer"> + + <id name="id" + type="long" + column="ID"> + <generator class="sequence"/> + </id> + + <property name="name" + column="NAME" + type="string"/> + + <property name="address" + column="ADDRESS" + type="string"/> + + <many-to-one name="organization" + column="ORGANIZATION_ID" + class="Organization"/> + + <bag name="orders" + inverse="true" + lazy="false" + cascade="all"> + <key column="CUSTOMER_ID"/> + <one-to-many class="Order"/> + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Notez que m�me si des associations sont d�clar�es en utilisant des noms de classe cible, + le type de cible d'une association peut aussi �tre une entit� dynamique au lieu d'un POJO. + </para> + + <para> + Apr�s avoir configur� le mode d'entit� par d�faut � <literal>dynamic-map</literal> + pour la <literal>SessionFactory</literal>, nous pouvons lors de l'ex�cution fonctionner + avec des <literal>Map</literal>s de <literal>Map</literal>s : + </para> + + <programlisting><![CDATA[Session s = openSession(); +Transaction tx = s.beginTransaction(); +Session s = openSession(); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); + +// Create an organization +Map foobar = new HashMap(); +foobar.put("name", "Foobar Inc."); + +// Link both +david.put("organization", foobar); + +// Save both +s.save("Customer", david); +s.save("Organization", foobar); + +tx.commit(); +s.close();]]></programlisting> + + <para> + Les avantages d'un mapping dynamique sont un gain de temps pour le prototypage + sans la n�cessit� d'impl�menter les classes d'entit�. Pourtant, vous perdez la + v�rification du typage au moment de la compilation et aurez plus d'exceptions � + g�rer lors de l'ex�cution. Gr�ce au mapping d'Hibernate, le sch�ma de la base de + donn�es peut facilement �tre normalis� et solidifi�, permettant de rajouter une + impl�mentation propre du mod�le de domaine plus tard. + </para> + + <para> + Les modes de repr�sentation d'une entit� peut aussi �tre configur� par <literal>Session</literal> : + </para> + + <programlisting><![CDATA[Session dynamicSession = pojoSession.getSession(EntityMode.MAP); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); +dynamicSession.save("Customer", david); +... +dynamicSession.flush(); +dynamicSession.close() +... +// Continue on pojoSession +]]></programlisting> + + + <para> + Veuillez noter que l'appel � <literal>getSession()</literal> en utilisant un + <literal>EntityMode</literal> se fait sur l'API <literal>Session</literal>, pas + <literal>SessionFactory</literal>. De cette mani�re, la nouvelle <literal>Session</literal> + partage les connexions JDBC, transactions et autres informations de contexte sous-jacentes. + Cela signifie que vous n'avez pas � appeler <literal>flush()</literal> et <literal>close()</literal> + sur la <literal>Session</literal> secondaire, et laissez aussi la gestion de la transaction + et de la connexion � l'unit� de travail primaire. + </para> + + <para> + Plus d'informations � propos de la repr�sentation XML peuvent �tre trouv�es dans + <xref linkend="xml"/>. + </para> + + </sect1> + + <sect1 id="persistent-classes-tuplizers" revision="0"> + <title>Tuplizers</title> + + <para> + <literal>org.hibernate.tuple.Tuplizer</literal>, et ses sous-interfaces, sont responsables + de la gestion d'une repr�sentation particuli�re d'un morceau de donn�es, en fonction du + <literal>org.hibernate.EntityMode</literal> de r�pr�sentation. Si un morceau donn� de donn�es + est pens� comme une structure de donn�es, alors un tuplizer est la chose qui sait comment + cr�er une telle structure de donn�es, comment extraire des valeurs et injecter des valeurs dans + une telle structure de donn�es. Par exemple, pour le mode d'entit� POJO, le tuplizer correspondant + sait comment cr�er le POJO � travers son constructeur et comment acc�der aux propri�t�s du POJO + utilisant les accesseurs de la propri�t� d�finie. Il y a deux types de Tuplizers haut niveau, + repr�sent� par les interfaces <literal>org.hibernate.tuple.EntityTuplizer</literal> et + <literal>org.hibernate.tuple.ComponentTuplizer</literal>. Les <literal>EntityTuplizer</literal>s + sont responsables de la gestion des contrats mentionn�s ci-dessus pour les entit�s, alors que + les <literal>ComponentTuplizer</literal>s s'occupent des composants. + </para> + + <para> + Les utilisateurs peuvent aussi brancher leurs propres tuplizers. Peut-�tre vous est-il n�cessaire qu'une + impl�mentation de <literal>java.util.Map</literal> autre que <literal>java.util.HashMap</literal> + soit utilis�e dans le mode d'entit� dynamic-map ; ou peut-�tre avez-vous besoin de d�finir une + stat�gie de g�n�ration de proxy diff�rente de celle utilis�e par d�faut. Les deux devraient �tre + effectu�es en d�finissant une impl�mentation de tuplizer utilisateur. Les d�finitions de tuplizers + sont attach�es au mapping de l'entit� ou du composant qu'ils sont cens�s g�rer. Retour � l'exemple de + notre entit� utilisateur : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + <class entity-name="Customer"> +  + <tuplizer entity-mode="dynamic-map" + class="CustomMapTuplizerImpl"/> + + <id name="id" type="long" column="ID"> + <generator class="sequence"/> + </id> + +  + ... + </class> +</hibernate-mapping> + + +public class CustomMapTuplizerImpl + extends org.hibernate.tuple.DynamicMapEntityTuplizer { + // override the buildInstantiator() method to plug in our custom map... + protected final Instantiator buildInstantiator( + org.hibernate.mapping.PersistentClass mappingInfo) { + return new CustomMapInstantiator( mappingInfo ); + } + + private static final class CustomMapInstantiator + extends org.hibernate.tuple.DynamicMapInstantitor { + // override the generateMap() method to return our custom map... + protected final Map generateMap() { + return new CustomMap(); + } + } +}]]></programlisting> + + + </sect1> + + <para> + TODO: Document user-extension framework in the property and proxy packages + </para> + +</chapter> + Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/preface.xml =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/preface.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/preface.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,112 @@ +<?xml version='1.0'?> + +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<preface id="preface"> + <title>Préface</title> + + <para> + Travailler dans les deux univers que sont l'orienté objet et la base de données + relationnelle peut être lourd et consommateur en temps dans le monde de + l'entreprise d'aujourd'hui. Hibernate est un outil de mapping objet/relationnel + pour le monde Java. Le terme mapping objet/relationnel (ORM) décrit la technique + consistant à faire le lien entre la représentation objet des données + et sa représentation relationnelle basée sur un schéma SQL. + </para> + + <para> + Non seulement, Hibernate s'occupe du transfert des classes Java dans les tables + de la base de données (et des types de données Java dans les types de données SQL), + mais il permet de requêter les données et propose des moyens de les récupérer. + Il peut donc réduire de manière significative le temps de développement qui + aurait été autrement perdu dans une manipulation manuelle des données via SQL + et JDBC. + </para> + + <para> + Le but d'Hibernate est de libérer le développeur de 95 pourcent des tâches de + programmation liées à la persistance des données communes. Hibernate n'est + probablement pas la meilleure solution pour les applications centrées sur les + données qui n'utilisent que les procédures stockées pour implémenter la logique + métier dans la base de données, il est le plus utile dans les modèles métier orientés + objets dont la logique métier est implémentée dans la couche Java dite intermédiaire. + Cependant, Hibernate vous aidera à supprimer ou à encapsuler le code SQL + spécifique à votre base de données et vous aidera sur la tâche commune qu'est + la transformation des données d'une représentation tabulaire à une + représentation sous forme de graphe d'objets. + </para> + + <para> + Si vous êtes nouveau dans Hibernate et le mapping Objet/Relationnel voire même en Java, + suivez ces quelques étapes : + </para> + + <orderedlist> + <listitem> + <para> + Lisez <xref linkend="tutorial"/> pour un didacticiel plus long avec plus d'instructions étape par étape. + </para> + </listitem> + <listitem> + <para> + Lisez <xref linkend="architecture"/> pour comprendre les environnements dans lesquels + Hibernate peut être utilisé. + </para> + </listitem> + <listitem> + <para> + Regardez le répertoire <literal>eg</literal> de la distribution Hibernate, il contient + une application simple et autonome. Copiez votre pilote JDBC dans le répertoire + <literal>lib/</literal> et éditez <literal>src/hibernate.properties</literal>, en + positionnant correctement les valeurs pour votre base de données. A partir d'une + invite de commande dans le répertoire de la distribution, tapez <literal>ant eg</literal> + (cela utilise Ant), ou sous Windows tapez <literal>build eg</literal>. + </para> + </listitem> + <listitem> + <para> + Faîtes de cette documentation de référence votre principale source d'information. + Pensez à lire <emphasis>Java Persistence with Hibernate</emphasis> + (http://www.manning.com/bauer2) si vous avez besoin de plus d'aide avec le design + d'applications ou si vous préférez un tutoriel pas à pas. Visitez aussi + http://caveatemptor.hibernate.org et téléchargez l'application exemple + pour Java Persistence with Hibernate. + </para> + </listitem> + <listitem> + <para> + Les questions les plus fréquemment posées (FAQs) trouvent leur réponse sur le + site web Hibernate. + </para> + </listitem> + <listitem> + <para> + Des démos, exemples et tutoriaux de tierces personnes sont référencés sur + le site web Hibernate. + </para> + </listitem> + <listitem> + <para> + La zone communautaire (Community Area) du site web Hibernate est une + bonne source d'information sur les design patterns et sur différentes + solutions d'intégration d'Hibernate (Tomcat, JBoss, Spring Framework, Struts, + EJB, etc). + </para> + </listitem> + </orderedlist> + + <para> + Si vous avez des questions, utilisez le forum utilisateurs du site web Hibernate. + Nous utilisons également l'outil de gestion des incidents JIRA pour tout ce qui + est rapports de bogue et demandes d'évolution. Si vous êtes intéressé par le + développement d'Hibernate, joignez-vous à la liste de diffusion de développement. + </para> + + <para> + Le développement commercial, le support de production et les formations à Hibernate + sont proposés par JBoss Inc (voir http://www.hibernate.org/SupportTraining/). Hibernate + est un projet Open Source professionnel et un composant critique de la suite de produits + JBoss Enterprise Middleware System (JEMS). + </para> + + </preface> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_criteria.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/query_criteria.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_criteria.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_criteria.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,443 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="querycriteria"> + <title>Requ�tes par crit�res</title> + + <para> + Hibernate offre une API d'interrogation par crit�res intuitive et extensible. + </para> + + <sect1 id="querycriteria-creating"> + <title>Cr�er une instance de <literal>Criteria</literal></title> + + <para> + L'interface <literal>net.sf.hibernate.Criteria</literal> repr�sente une requ�te sur une + classe persistente donn�e. La <literal>Session</literal> fournit les instances de + <literal>Criteria</literal>. + </para> + + <programlisting><![CDATA[Criteria crit = sess.createCriteria(Cat.class); +crit.setMaxResults(50); +List cats = crit.list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-narrowing"> + <title>Restriction du r�sultat</title> + + <para> + Un criterion (crit�re de recherche) est une instance de l'interface + <literal>org.hibernate.criterion.Criterion</literal>. La classe + <literal>org.hibernate.criterion.Restrictions</literal> d�finit + des m�thodes pour obtenir des types de <literal>Criterion</literal> + pr�-d�finis. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.between("weight", minWeight, maxWeight) ) + .list();]]></programlisting> + + <para> + Les restrictions peuvent �tre goup�es de mani�re logique. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.or( + Restrictions.eq( "age", new Integer(0) ), + Restrictions.isNull("age") + ) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) ) + .add( Restrictions.disjunction() + .add( Restrictions.isNull("age") ) + .add( Restrictions.eq("age", new Integer(0) ) ) + .add( Restrictions.eq("age", new Integer(1) ) ) + .add( Restrictions.eq("age", new Integer(2) ) ) + ) ) + .list();]]></programlisting> + + <para> + Il y a plusieurs types de criterion pr�-d�finis (sous classes de <literal>Restriction</literal>), + mais l'une d'entre elle particuli�rement utile vous permet de sp�cifier directement + du SQL. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.sql("lower({alias}.name) like lower(?)", "Fritz%", Hibernate.STRING) ) + .list();]]></programlisting> + + <para> + La zone <literal>{alias}</literal> sera remplac�e par l'alias de colonne de l'entit� + que l'on souhaite int�rroger. + </para> + + <para> + Une autre approche pour obtenir un criterion est de le r�cup�rer d'une instance de <literal>Property</literal>. + Vous pouvez cr�er une <literal>Property</literal> en appelant <literal>Property.forName()</literal>. + </para> + + <programlisting><![CDATA[ +Property age = Property.forName("age"); +List cats = sess.createCriteria(Cat.class) + .add( Restrictions.disjunction() + .add( age.isNull() ) + .add( age.eq( new Integer(0) ) ) + .add( age.eq( new Integer(1) ) ) + .add( age.eq( new Integer(2) ) ) + ) ) + .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-ordering"> + <title>Trier les r�sultats</title> + + <para> + Vous pouvez trier les r�sultats en utilisant <literal>org.hibernate.criterion.Order</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") + .addOrder( Order.asc("name") ) + .addOrder( Order.desc("age") ) + .setMaxResults(50) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Property.forName("name").like("F%") ) + .addOrder( Property.forName("name").asc() ) + .addOrder( Property.forName("age").desc() ) + .setMaxResults(50) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-associations" revision="2"> + <title>Associations</title> + + <para> + Vous pouvez facilement sp�cifier des contraintes sur des entit�s li�es, + par des associations en utilisant <literal>createCriteria()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") + .createCriteria("kittens") + .add( Restrictions.like("name", "F%") + .list();]]></programlisting> + + <para> + Notez que la seconde <literal>createCriteria()</literal> retourne une nouvelle + instance de <literal>Criteria</literal>, qui se rapporte aux �l�ments de la + collection <literal>kittens</literal>. + </para> + + <para> + La forme alternative suivante est utile dans certains cas. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createAlias("kittens", "kt") + .createAlias("mate", "mt") + .add( Restrictions.eqProperty("kt.name", "mt.name") ) + .list();]]></programlisting> + + <para> + (<literal>createAlias()</literal> ne cr�e pas de nouvelle instance de + <literal>Criteria</literal>.) + </para> + + <para> + Notez que les collections kittens contenues dans les instances de <literal>Cat</literal> + retourn�es par les deux pr�c�dentes requ�tes ne sont <emphasis>pas</emphasis> pr�-filtr�es + par les crit�res ! Si vous souhaitez r�cup�rer uniquement les kittens qui correspondent � la + criteria, vous devez utiliser <literal>ResultTransformer</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createCriteria("kittens", "kt") + .add( Restrictions.eq("name", "F%") ) + .setResultTransformer(Criteria.ALIAS_TO_ENTITY_MAP) + .list(); +Iterator iter = cats.iterator(); +while ( iter.hasNext() ) { + Map map = (Map) iter.next(); + Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS); + Cat kitten = (Cat) map.get("kt"); +}]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-dynamicfetching" revision="1"> + <title>Peuplement d'associations de mani�re dynamique</title> + + <para> + Vous pouvez sp�ficier au moment de l'ex�cution le peuplement d'une association en utilisant + <literal>setFetchMode()</literal> (c'est-�-dire le chargement de celle-ci). + Cela permet de surcharger les valeurs + "lazy" et "outer-join" du mapping. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .setFetchMode("mate", FetchMode.EAGER) + .setFetchMode("kittens", FetchMode.EAGER) + .list();]]></programlisting> + + <para> + Cette requ�te recherchera <literal>mate</literal> et <literal>kittens</literal> + via les jointures externes. Voir <xref linkend="performance-fetching"/> pour plus d'informations. + </para> + + </sect1> + + <sect1 id="querycriteria-examples"> + <title>Requ�tes par l'exemple</title> + + <para> + La classe <literal>org.hibernate.criterion.Example</literal> vous permet de + construire un crit�re suivant une instance d'objet donn�e. + </para> + + <programlisting><![CDATA[Cat cat = new Cat(); +cat.setSex('F'); +cat.setColor(Color.BLACK); +List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .list();]]></programlisting> + + <para> + Les propri�t�s de type version, identifiant et association sont ignor�es. + Par d�faut, les valeurs null sont exclues. + </para> + + <para> + Vous pouvez ajuster la strat�gie d'utilisation de valeurs de + l'<literal>Exemple</literal>. + </para> + + <programlisting><![CDATA[Example example = Example.create(cat) + .excludeZeroes() //exclude zero valued properties + .excludeProperty("color") //exclude the property named "color" + .ignoreCase() //perform case insensitive string comparisons + .enableLike(); //use like for string comparisons +List results = session.createCriteria(Cat.class) + .add(example) + .list();]]></programlisting> + + <para> + Vous pouvez utiliser les "exemples" pour des crit�res sur les objets associ�s. + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .createCriteria("mate") + .add( Example.create( cat.getMate() ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-projection"> + <title>Projections, agr�gation et regroupement</title> + <para> + La classe <literal>org.hibernate.criterion.Projections</literal> est une + fabrique d'instances de <literal>Projection</literal>. Nous appliquons une + projection sur une requ�te en appelant <literal>setProjection()</literal>. + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.rowCount() ) + .add( Restrictions.eq("color", Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount() ) + .add( Projections.avg("weight") ) + .add( Projections.max("weight") ) + .add( Projections.groupProperty("color") ) + ) + .list();]]></programlisting> + + <para> + Il n'y a pas besoin de "group by" explicite dans une requ�te par crit�re. + Certains types de projection sont d�finis pour �tre des <emphasis>projections + de regroupement</emphasis>, lesquels apparaissent aussi dans la clause + <literal>group by</literal> SQL. + </para> + + <para> + Un alias peut optionnellement �tre assign� � une projection, ainsi la valeur + projet�e peut �tre r�f�renc�e dans des restrictions ou des tris. Voici deux fa�ons + diff�rentes de faire �a : + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.alias( Projections.groupProperty("color"), "colr" ) ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.groupProperty("color").as("colr") ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <para> + Les m�thodes <literal>alias()</literal> et <literal>as()</literal> enveloppe simplement + une instance de projection dans une autre instance (alias�e) de <literal>Projection</literal>. + Comme un raccourci, vous pouvez assignez un alias lorsque vous ajoutez la projection � la + liste de projections : + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount(), "catCountByColor" ) + .add( Projections.avg("weight"), "avgWeight" ) + .add( Projections.max("weight"), "maxWeight" ) + .add( Projections.groupProperty("color"), "color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Domestic.class, "cat") + .createAlias("kittens", "kit") + .setProjection( Projections.projectionList() + .add( Projections.property("cat.name"), "catName" ) + .add( Projections.property("kit.name"), "kitName" ) + ) + .addOrder( Order.asc("catName") ) + .addOrder( Order.asc("kitName") ) + .list();]]></programlisting> + + <para> + Vous pouvez aussi utiliser <literal>Property.forName()</literal> pour formuler des projections : + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Property.forName("name") ) + .add( Property.forName("color").eq(Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount().as("catCountByColor") ) + .add( Property.forName("weight").avg().as("avgWeight") ) + .add( Property.forName("weight").max().as("maxWeight") ) + .add( Property.forName("color").group().as("color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-detachedqueries"> + <title>Requ�tes et sous-requ�tes d�tach�es</title> + <para> + La classe <literal>DetachedCriteria</literal> vous laisse cr�er une requ�te en dehors de la + port�e de la session, et puis l'ex�cuter plus tard en utilisant n'importe quelle <literal>Session</literal> + arbitraire. + </para> + + <programlisting><![CDATA[DetachedCriteria query = DetachedCriteria.forClass(Cat.class) + .add( Property.forName("sex").eq('F') ); + +Session session = ....; +Transaction txn = session.beginTransaction(); +List results = query.getExecutableCriteria(session).setMaxResults(100).list(); +txn.commit(); +session.close();]]></programlisting> + + <para> + Une <literal>DetachedCriteria</literal> peut aussi �tre utilis�e pour exprimer une + sous-requ�te. Des instances de criterion impliquant des sous-requ�tes peuvent �tre + obtenues via <literal>Subqueries</literal> ou <literal>Property</literal>. + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeight = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight").avg() ); +session.createCriteria(Cat.class) + .add( Property.forName("weight").gt(avgWeight) ) + .list();]]></programlisting> + + <programlisting><![CDATA[DetachedCriteria weights = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight") ); +session.createCriteria(Cat.class) + .add( Subqueries.geAll("weight", weights) ) + .list();]]></programlisting> + + <para> + M�me des requ�tes corr�l�es sont possibles : + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeightForSex = DetachedCriteria.forClass(Cat.class, "cat2") + .setProjection( Property.forName("weight").avg() ) + .add( Property.forName("cat2.sex").eqProperty("cat.sex") ); +session.createCriteria(Cat.class, "cat") + .add( Property.forName("weight").gt(avgWeightForSex) ) + .list();]]></programlisting> + + </sect1> + +  + + <sect1 id="query-criteria-naturalid"> + <title>Requ�tes par identifiant naturel</title> + + <para> + Pour la plupart des requ�tes, incluant les requ�tes par crit�re, le cache de requ�tes + n'est pas tr�s efficace, parce que l'invalidation du cache de requ�tes arrive trop + souvent. Cependant, il y a une sorte sp�ciale de requ�te o� nous pouvons optimiser + l'algorithme d'invalidation du cache : les recherches sur une clef naturelle constante. + Dans certaines applications, cette sorte de requ�te se produit fr�quemment. L'API de + crit�re fournit une provision sp�ciale pour ce cas d'utilisation. + </para> + + <para> + D'abord vous devriez mapper la clef naturelle de votre entit� en utilisant + <literal><natural-id></literal>, et activer l'utilisation du cache de second niveau. + </para> + + <programlisting><![CDATA[<class name="User"> + <cache usage="read-write"/> + <id name="id"> + <generator class="increment"/> + </id> + <natural-id> + <property name="name"/> + <property name="org"/> + </natural-id> + <property name="password"/> +</class>]]></programlisting> + + <para> + Notez que cette fonctionnalit� n'est pas pr�vue pour l'utilisation avec des + entit�s avec des clefs naturelles <emphasis>mutables</emphasis>. + </para> + + <para> + Ensuite, activez le cache de requ�te d'Hibernate. + </para> + + <para> + Maintenant <literal>Restrictions.naturalId()</literal> nous permet de rendre + l'utilisation de l'algorithme de cache plus efficace. + </para> + + <programlisting><![CDATA[session.createCriteria(User.class) + .add( Restrictions.naturalId() + .set("name", "gavin") + .set("org", "hb") + ).setCacheable(true) + .uniqueResult();]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_hql.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/query_hql.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_hql.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_hql.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1149 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="queryhql"> + <title>HQL: Langage de requ�tage d'Hibernate</title> + + <para> + Hibernate fourni un langage d'interrogation extr�mement puissant qui + ressemble (et c'est voulu) au SQL. Mais ne soyez pas distraits par la syntaxe ; + HQL est totalement orient� objet, comprenant des notions d'h�ritage, de + polymorphisme et d'association. + </para> + + <sect1 id="queryhql-casesensitivity"> + <title>Sensibilit� � la casse</title> + + <para> + Les requ�tes sont insensibles � la casse, � l'exception des noms des classes Java + et des propri�t�s. + Ainsi, <literal>SeLeCT</literal> est identique � + <literal>sELEct</literal> et � + <literal>SELECT</literal> mais + <literal>net.sf.hibernate.eg.FOO</literal> n'est pas identique + <literal>net.sf.hibernate.eg.Foo</literal> et + <literal>foo.barSet</literal> n'est pas identique � + <literal>foo.BARSET</literal>. + </para> + + <para> + Ce guide utilise les mots cl�s HQL en minuscule. Certains utilisateurs trouvent les + requ�tes �crites avec les mots cl�s en majuscule plus lisibles, mais nous trouvons + cette convention p�nible lorsqu'elle est lue dans du code Java. + </para> + + </sect1> + + <sect1 id="queryhql-from"> + <title>La clause from</title> + + <para> + La requ�te Hibernate la plus simple est de la forme : + </para> + + <programlisting><![CDATA[from eg.Cat]]></programlisting> + + <para> + qui retourne simplement toutes les instances de la classe <literal>eg.Cat</literal>. + Nous n'avons pas besoin d'habitude de qualifier le nom de la classe, + puisque <literal>auto-import</literal> est la valeur par d�faut. Donc nous �crivons presque toujours : + </para> + + <programlisting><![CDATA[from Cat]]></programlisting> + + <para> + La plupart du temps, vous devrez assigner un <emphasis>alias</emphasis> puisque vous + voudrez faire r�f�rence � <literal>Cat</literal> dans d'autres parties de la requ�te. + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + Cette requ�te assigne l'alias <literal>cat</literal> � l'instance <literal>Cat</literal>, + nous pouvons donc utiliser cet alias ailleurs dans la requ�te. Le mot cl� <literal>as</literal> + est optionnel ; nous aurions pu �crire : + </para> + + <programlisting><![CDATA[from Cat cat]]></programlisting> + + <para> + Plusieurs classes peuvent appara�tre, ce qui conduira � un produit + cart�sien (encore appel� jointures crois�es). + </para> + + <programlisting><![CDATA[from Formula, Parameter]]></programlisting> + <programlisting><![CDATA[from Formula as form, Parameter as param]]></programlisting> + + <para> + C'est une bonne pratique que de nommer les alias dans les requ�tes en utilisant l'initiale + en miniscule, ce qui a le m�rite d'�tre en phase avec les standards de + nommage Java pour les variables locales (<literal>domesticCat</literal>). + </para> + + </sect1> + + <sect1 id="queryhql-joins" revision="1"> + <title>Associations et jointures</title> + + <para> + On peut aussi assigner des alias � des entit�s associ�es, ou m�me aux �l�ments d'une collection + de valeurs, en utilisant un <literal>join</literal> (jointure). + </para> + + <programlisting><![CDATA[from Cat as cat + inner join cat.mate as mate + left outer join cat.kittens as kitten]]></programlisting> + + <programlisting><![CDATA[from Cat as cat left join cat.mate.kittens as kittens]]></programlisting> + + <programlisting><![CDATA[from Formula form full join form.parameter param]]></programlisting> + + <para> + Les types de jointures support�es sont celles de ANSI SQL + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>inner join</literal> (jointure ferm�e) + </para> + </listitem> + <listitem> + <para> + <literal>left outer join</literal> (jointure ouverte par la gauche) + </para> + </listitem> + <listitem> + <para> + <literal>right outer join</literal> (jointure ouverte par la droite) + </para> + </listitem> + <listitem> + <para> + <literal>full join</literal> (jointure ouverte totalement - g�n�ralement inutile) + </para> + </listitem> + </itemizedlist> + + <para> + Les constructions des jointures <literal>inner join</literal>, <literal>left outer join</literal> + et <literal>right outer join</literal> peuvent �tre abbr�g�es. + </para> + + <programlisting><![CDATA[from Cat as cat + join cat.mate as mate + left join cat.kittens as kitten]]></programlisting> + + <para> + Nous pouvons soumettre des conditions de jointure suppl�mentaires en utilisant le mot-clef HQL <literal>with</literal>. + </para> + + <programlisting><![CDATA[from Cat as cat + left join cat.kittens as kitten + with kitten.bodyWeight > 10.0]]></programlisting> + + <para> + Par ailleurs, une jointure "fetch�e" (rapport�e) permet d'initialiser + les associations ou collections de valeurs en m�me temps que leur objet parent, + le tout n'utilisant qu'un seul Select. + Ceci est particuli�rement utile dans le cas des collections. Ce syst�me permet de surcharger + les d�clarations "lazy" et "outer-join" des fichiers de mapping pour les associations et + collections. Voir + <xref linkend="performance-fetching"/> pour plus d'informations. + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens]]></programlisting> + + <para> + Une jointure "fetch�e" (rapport�e) n'a g�n�ralement pas besoin de se voir assigner + un alias puisque les objets associ�s n'ont pas � �tre utilis�s dans les autres clauses. + Notez aussi que les objets associ�s ne sont pas retourn�s directement dans le r�sultat de + la requ�te mais l'on peut y acc�der via l'objet parent. La seule raison pour laquelle nous + pourrions avoir besoin d'un alias est si nous r�cup�rions r�cursivement une collection suppl�mentaire : + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens child + left join fetch child.kittens]]></programlisting> + + <para> + Notez que la construction de <literal>fetch</literal> ne peut pas �tre utilis�e dans les requ�tes appel�es par + <literal>scroll()</literal> ou <literal>iterate()</literal>. + <literal>fetch</literal> ne devrait pas non plus �tre utilis� avec <literal>setMaxResults()</literal> ou + <literal>setFirstResult()</literal>. <literal>fetch</literal> ne peut pas non plus �tre utilis� avec une + condition <literal>with</literal> ad hoc. Il est + possible de cr�er un produit cart�sien par jointure en r�cup�rant plus d'une collection dans une requ�te, + donc faites attention dans ce cas. R�cup�rer par jointure de multiples collections donne aussi parfois + des r�sultats inattendus pour des mappings de bag, donc soyez prudent lorsque vous formulez vos requ�tes dans de tels cas. + Finalement, notez que <literal>full join fetch</literal> et <literal>right join fetch</literal> ne sont pas utiles en g�n�ral. + </para> + + <para> + Si vous utilisez un chargement retard� pour les propri�t�s (avec une instrumentation par bytecode), il est possible + de forcer Hibernate � r�cup�rer les propri�t�s non encore charg�es imm�diatement (dans la premi�re requ�te) + en utilisant <literal>fetch all properties</literal>. + </para> + + <programlisting><![CDATA[from Document fetch all properties order by name]]></programlisting> + <programlisting><![CDATA[from Document doc fetch all properties where lower(doc.name) like '%cats%']]></programlisting> + + </sect1> + + <sect1 id="queryhql-joins-forms"> + <title>Formes de syntaxes pour les jointures</title> + + <para> + HQL supporte deux formes pour joindre les associations: <literal>implicite</literal> et <literal>explicite</literal>. + </para> + + <para> + Les requ�tes pr�sentes dans la section pr�c�dente utilisent la forme <literal>explicite</literal> + o� le mode cl� join est explicitement utilis� dans la clause from. C'est la forme recommand�e. + </para> + + <para> + La forme <literal>implicite</literal> n'utilise pas le mot cl� join. + A la place, les associations sont "d�r�f�renc�es" en utilisant le notation '.'. Ces + jointures peuvent apparaitre dans toutes les clauses. Les jointures <literal>implicites</literal> + r�sultent en des inner join dans le SQL g�n�r�. + </para> + + <programlisting><![CDATA[from Cat as cat where cat.mate.name like '%s%']]></programlisting> + </sect1> + + <sect1 id="queryhql-select"> + <title>La clause select</title> + + <para> + La clause <literal>select</literal> s�lectionne les objets et propri�t�s + qui doivent �tre retourn�s dans le r�sultat de la requ�te. + Soit : + </para> + + <programlisting><![CDATA[select mate +from Cat as cat + inner join cat.mate as mate]]></programlisting> + + <para> + La requ�te recherchera les <literal>mate</literal>s li�s aux <literal>Cat</literal>s. + Vous pouvez explimer la requ�te d'une mani�re plus compacte : + </para> + + <programlisting><![CDATA[select cat.mate from Cat cat]]></programlisting> + + <para> + Les requ�tes peuvent retourner des propri�t�s de n'importe quel type, m�me celles de type + composant (component) : + </para> + + <programlisting><![CDATA[select cat.name from DomesticCat cat +where cat.name like 'fri%']]></programlisting> + + <programlisting><![CDATA[select cust.name.firstName from Customer as cust]]></programlisting> + + <para> + Les requ�tes peuvent retourner plusieurs objets et/ou propri�t�s sous la forme + d'un tableau du type <literal>Object[]</literal>, + </para> + + <programlisting><![CDATA[select mother, offspr, mate.name +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + ou sous la forme d'une <literal>List</literal>, + </para> + + <programlisting><![CDATA[select new list(mother, offspr, mate.name) +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + ou sous la forme d'un objet Java typ�, + </para> + + <programlisting><![CDATA[select new Family(mother, mate, offspr) +from DomesticCat as mother + join mother.mate as mate + left join mother.kittens as offspr]]></programlisting> + + <para> + � condition que la classe <literal>Family</literal> poss�de le constructeur appropri�. + </para> + + <para> + Vous pouvez assigner des alias aux expressions s�lectionn�es en utilisant <literal>as</literal> : + </para> + + <programlisting><![CDATA[select max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n +from Cat cat]]></programlisting> + + <para> + C'est surtout utile lorsque c'est utilis� avec + <literal>select new map</literal> : + </para> + + <programlisting><![CDATA[select new map( max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n ) +from Cat cat]]></programlisting> + + <para> + Cette requ�te retourne une <literal>Map</literal> � partir des alias vers les valeurs s�lectionn�es. + </para> + + </sect1> + + <sect1 id="queryhql-aggregation"> + <title>Fonctions d'aggr�gation</title> + + <para> + Les requ�tes HQL peuvent aussi retourner le r�sultat de fonctions d'aggr�gation + sur les propri�t�s : + </para> + + <programlisting><![CDATA[select avg(cat.weight), sum(cat.weight), max(cat.weight), count(cat) +from Cat cat]]></programlisting> + + + + <para> + Les fonctions support�es sont + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>avg(...), sum(...), min(...), max(...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(*)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(...), count(distinct ...), count(all...)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Vous pouvez utiliser des op�rateurs arithm�tiques, la concat�nation, et des fonctions SQL reconnues dans la clause select : + </para> + + <programlisting><![CDATA[select cat.weight + sum(kitten.weight) +from Cat cat + join cat.kittens kitten +group by cat.id, cat.weight]]></programlisting> + + <programlisting><![CDATA[select firstName||' '||initial||' '||upper(lastName) from Person]]></programlisting> + + <para> + Les mots cl� <literal>distinct</literal> et <literal>all</literal> peuvent �tre utilis�s et ont + la m�me signification qu'en SQL. + </para> + + <programlisting><![CDATA[select distinct cat.name from Cat cat + +select count(distinct cat.name), count(cat) from Cat cat]]></programlisting> + + </sect1> + + <sect1 id="queryhql-polymorphism"> + <title>Requ�tes polymorphiques</title> + + <para> + Une requ�te comme: + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + retourne non seuleument les instances de <literal>Cat</literal>, mais aussi celles des + sous classes comme <literal>DomesticCat</literal>. Les requ�tes Hibernate peuvent nommer n'importe + quelle classe ou interface Java dans la clause <literal>from</literal>. La requ�te retournera les + instances de toutes les classes persistantes qui �tendent cette classe ou impl�mente cette interface. + La requ�te suivante retournera tous les objets persistants : + </para> + + <programlisting><![CDATA[from java.lang.Object o]]></programlisting> + + <para> + L'interface <literal>Named</literal> peut �tre impl�ment�e par plusieurs classes persistantes : + </para> + + <programlisting><![CDATA[from Named n, Named m where n.name = m.name]]></programlisting> + + <para> + Notez que ces deux derni�res requ�tes n�cessitent plus d'un <literal>SELECT</literal> SQL. + Ce qui signifie que la clause <literal>order by</literal> ne trie pas correctement la totalit� + des r�sultats (cela signifie aussi que vous ne pouvez ex�cuter ces requ�tes en appelant + <literal>Query.scroll()</literal>). + </para> + + </sect1> + + <sect1 id="queryhql-where"> + <title>La clause where</title> + + <para> + La clause <literal>where</literal> vous permet de r�duire la liste des instances retourn�es. + Si aucun alias n'existe, vous pouvez vous r�f�rer aux propri�t�s par leur nom : + </para> + + <programlisting><![CDATA[from Cat where name='Fritz']]></programlisting> + + <para> + S'il y a un alias, utilisez un nom de propri�t� qualifi� : + </para> + + <programlisting><![CDATA[from Cat as cat where cat.name='Fritz']]></programlisting> + + <para> + retourne les instances de <literal>Cat</literal> dont name est �gale � 'Fritz'. + </para> + + <programlisting><![CDATA[select foo +from Foo foo, Bar bar +where foo.startDate = bar.date]]></programlisting> + + <para> + retournera les instances de <literal>Foo</literal> pour lesquelles + il existe une instance de <literal>bar</literal> avec la + propri�t� <literal>date</literal> est �gale � la + propri�t� <literal>startDate</literal> de <literal>Foo</literal>. + Les expressions utilisant la navigation rendent la clause <literal>where</literal> + extr�mement puissante. Soit : + </para> + + <programlisting><![CDATA[from Cat cat where cat.mate.name is not null]]></programlisting> + + <para> + Cette requ�te se traduit en SQL par une jointure interne � une table. + Si vous souhaitez �crire quelque chose comme : + </para> + + <programlisting><![CDATA[from Foo foo +where foo.bar.baz.customer.address.city is not null]]></programlisting> + + <para> + vous finiriez avec une requ�te qui n�cessiterait quatre jointures en SQL. + </para> + + <para> + L'op�rateur <literal>=</literal> peut �tre utilis� pour comparer aussi bien des propri�t�s que des instances : + </para> + + <programlisting><![CDATA[from Cat cat, Cat rival where cat.mate = rival.mate]]></programlisting> + + <programlisting><![CDATA[select cat, mate +from Cat cat, Cat mate +where cat.mate = mate]]></programlisting> + + <para> + La propri�t� sp�ciale (en minuscule) <literal>id</literal> peut �tre utilis�e + pour faire r�f�rence � l'identifiant d'un objet (vous pouvez aussi utiliser + le nom de cette propri�t�). + </para> + + <programlisting><![CDATA[from Cat as cat where cat.id = 123 + +from Cat as cat where cat.mate.id = 69]]></programlisting> + + <para> + La seconde requ�te est particuli�rement efficace. Aucune jointure n'est n�cessaire ! + </para> + + <para> + Les propri�t�s d'un identifiant compos� peuvent aussi �tre utilis�es. Supposez que + <literal>Person</literal> ait un identifiant compos� de <literal>country</literal> et + <literal>medicareNumber</literal>. + </para> + + <programlisting><![CDATA[from bank.Person person +where person.id.country = 'AU' + and person.id.medicareNumber = 123456]]></programlisting> + + <programlisting><![CDATA[from bank.Account account +where account.owner.id.country = 'AU' + and account.owner.id.medicareNumber = 123456]]></programlisting> + + <para> + Une fois de plus, la seconde requ�te ne n�cessite pas de jointure. + </para> + + <para> + De m�me, la propri�t� sp�ciale <literal>class</literal> interroge la valeur discriminante + d'une instance dans le cas d'une persistance polymorphique. Le nom d'une classe Java incorpor�e + dans la clause where sera traduite par sa valeur discriminante. + </para> + + <programlisting><![CDATA[from Cat cat where cat.class = DomesticCat]]></programlisting> + + <para> + Vous pouvez aussi sp�cifier les propri�t�s des composants ou types utilisateurs compos�s + (components, composite user types etc). N'essayez jamais d'utiliser un expression de navigation + qui se terminerait par une propri�t� de type composant (qui est diff�rent d'une propri�t� d'un + composant). Par exemple, si <literal>store.owner</literal> est une entit� avec un composant + <literal>address</literal> + </para> + + <programlisting><![CDATA[store.owner.address.city // okay +store.owner.address // error!]]></programlisting> + + <para> + Un type "any" poss�de les propri�t�s sp�ciales <literal>id</literal> et <literal>class</literal>, + qui nous permettent d'exprimer une jointure de la mani�re suivante (o� <literal>AuditLog.item</literal> + est une propri�t� mapp�e avec <literal><any></literal>). + </para> + + <programlisting><![CDATA[from AuditLog log, Payment payment +where log.item.class = 'Payment' and log.item.id = payment.id]]></programlisting> + + <para> + Dans la requ�te pr�c�dente, notez que <literal>log.item.class</literal> et <literal>payment.class</literal> + feraient r�f�rence � des valeurs de colonnes de la base de donn�es compl�tement diff�rentes. + </para> + + </sect1> + + <sect1 id="queryhql-expressions"> + <title>Expressions</title> + + <para> + Les expressions permises dans la clause <literal>where</literal> incluent + la plupart des choses que vous pouvez utiliser en SQL : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + op�rateurs math�matiques <literal>+, -, *, /</literal> + </para> + </listitem> + <listitem> + <para> + op�rateur de comparaison binaire <literal>=, >=, <=, <>, !=, like</literal> + </para> + </listitem> + <listitem> + <para> + op�rateurs logiques <literal>and, or, not</literal> + </para> + </listitem> + <listitem> + <para> + Parenth�ses <literal>( )</literal>, indiquant un regroupement + </para> + </listitem> + <listitem> + <para> + <literal>in</literal>, + <literal>not in</literal>, + <literal>between</literal>, + <literal>is null</literal>, + <literal>is not null</literal>, + <literal>is empty</literal>, + <literal>is not empty</literal>, + <literal>member of</literal> and + <literal>not member of</literal> + </para> + </listitem> + <listitem> + <para> + "Simple" case, <literal>case ... when ... then ... else ... end</literal>, and + "searched" case, <literal>case when ... then ... else ... end</literal> + </para> + </listitem> + <listitem> + <para> + concatenation de cha�ne de caract�res <literal>...||...</literal> ou <literal>concat(...,...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>current_date()</literal>, <literal>current_time()</literal>, + <literal>current_timestamp()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>second(...)</literal>, <literal>minute(...)</literal>, + <literal>hour(...)</literal>, <literal>day(...)</literal>, + <literal>month(...)</literal>, <literal>year(...)</literal>, + </para> + </listitem> + <listitem> + <para> + N'importe quel fonction ou op�rateur d�fini par EJB-QL 3.0 : <literal>substring(), trim(), + lower(), upper(), length(), locate(), abs(), sqrt(), bit_length(), mod()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>coalesce()</literal> et <literal>nullif()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>str()</literal> pour convertir des valeurs num�riques ou temporelles vers une cha�ne de caract�res lisible + </para> + </listitem> + <listitem> + <para> + <literal>cast(... as ...)</literal>, o� le second argument est le nom d'un type Hibernate, et <literal>extract(... from ...)</literal> si le + <literal>cast()</literal> ANSI et <literal>extract()</literal> sont support�s par la base de donn�es sous-jacente + </para> + </listitem> + <listitem> + <para> + La fonction HQL <literal>index()</literal>, qui s'applique aux alias d'une collection index�e jointe + </para> + </listitem> + <listitem> + <para> + Les fonctions HQL qui s'appliquent expressions repr�sentant des collections : <literal>size(), + minelement(), maxelement(), minindex(), maxindex()</literal>, ainsi que les fonctions sp�ciales <literal>elements()</literal> + et <literal>indices</literal> qui peuvent �tre quantifi�es en utilisant <literal>some, all, exists, any, in</literal>. + </para> + </listitem> + <listitem> + <para> + N'importe quelle fonction scalaire support�e par la base de donn�es comme + <literal>sign()</literal>, + <literal>trunc()</literal>, <literal>rtrim()</literal>, <literal>sin()</literal> + </para> + </listitem> + <listitem> + <para> + Les param�tres positionnels de JDBC + <literal>?</literal> + </para> + </listitem> + <listitem> + <para> + param�tres nomm�s <literal>:name</literal>, <literal>:start_date</literal>, <literal>:x1</literal> + </para> + </listitem> + <listitem> + <para> + litt�ral SQL <literal>'foo'</literal>, <literal>69</literal>, <literal>'1970-01-01 10:00:01.0'</literal> + </para> + </listitem> + <listitem> + <para> + Constantes Java <literal>public static final</literal> <literal>eg.Color.TABBY</literal> + </para> + </listitem> + </itemizedlist> + + <para> + <literal>in</literal> et <literal>between</literal> peuvent �tre utilis�s comme suit : + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + et la forme n�gative peut �tre �crite + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + De m�me, <literal>is null</literal> et <literal>is not null</literal> peuvent �tre utilis�s pour tester + les valeurs nulle. + </para> + + <para> + Les bool�ens peuvent �tre facilement utilis�s en d�clarant les substitutions de requ�tes dans la + configuration Hibernate : + </para> + + <programlisting><![CDATA[<property name="hibernate.query.substitutions">true 1, false 0</property>]]></programlisting> + + <para> + Ce qui remplacera les mots cl�s <literal>true</literal> et <literal>false</literal> par + <literal>1</literal> et <literal>0</literal> dans la traduction SQL du HQL suivant : + </para> + + <programlisting><![CDATA[from Cat cat where cat.alive = true]]></programlisting> + + <para> + Vous pouvez tester la taille d'une collection par la propri�t� sp�ciale <literal>size</literal>, ou + la fonction sp�ciale <literal>size()</literal>. + </para> + + <programlisting><![CDATA[from Cat cat where cat.kittens.size > 0]]></programlisting> + + <programlisting><![CDATA[from Cat cat where size(cat.kittens) > 0]]></programlisting> + + <para> + Pour les collections index�es, vous pouvez faire r�f�rence aux indices minimum et maximum en + utilisant les fonctions <literal>minindex</literal> and <literal>maxindex</literal>. De mani�re similaire, + vous pouvez faire r�f�rence aux �l�ments minimum et maximum d'une collection de type basiques + en utilisant les fonctions <literal>minelement</literal> et <literal>maxelement</literal>. + </para> + + <programlisting><![CDATA[from Calendar cal where maxelement(cal.holidays) > current date]]></programlisting> + + <programlisting><![CDATA[from Order order where maxindex(order.items) > 100]]></programlisting> + + <programlisting><![CDATA[from Order order where minelement(order.items) > 10000]]></programlisting> + + <para> + Les fonctions SQL <literal>any, some, all, exists, in</literal> supportent que leur soient pass�es + l'�l�ment, l'index d'une collection (fonctions <literal>elements</literal> et <literal>indices</literal>) + ou le r�sultat d'une sous requ�te (voir ci dessous). + </para> + + <programlisting><![CDATA[select mother from Cat as mother, Cat as kit +where kit in elements(foo.kittens)]]></programlisting> + + <programlisting><![CDATA[select p from NameList list, Person p +where p.name = some elements(list.names)]]></programlisting> + + <programlisting><![CDATA[from Cat cat where exists elements(cat.kittens)]]></programlisting> + + <programlisting><![CDATA[from Player p where 3 > all elements(p.scores)]]></programlisting> + + <programlisting><![CDATA[from Show show where 'fizard' in indices(show.acts)]]></programlisting> + + <para> + Notez que l'�criture de - <literal>size</literal>, <literal>elements</literal>, + <literal>indices</literal>, <literal>minindex</literal>, <literal>maxindex</literal>, + <literal>minelement</literal>, <literal>maxelement</literal> - peuvent seulement �tre utilis�e dans la clause where dans Hibernate3. + </para> + + <para> + Les �l�ments de collections index�es (arrays, lists, maps) peuvent �tre r�f�renc�s via index + (dans une clause where seulement) : + </para> + + <programlisting><![CDATA[from Order order where order.items[0].id = 1234]]></programlisting> + + <programlisting><![CDATA[select person from Person person, Calendar calendar +where calendar.holidays['national day'] = person.birthDay + and person.nationality.calendar = calendar]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ order.deliveredItemIndices[0] ] = item and order.id = 11]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ maxindex(order.items) ] = item and order.id = 11]]></programlisting> + + <para> + L'expression entre <literal>[]</literal> peut m�me �tre une expression arithm�tique. + </para> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ size(order.items) - 1 ] = item]]></programlisting> + + <para> + HQL propose aussi une fonction <literal>index()</literal> interne, pour les �l�ments + d'une association one-to-many ou d'une collections de valeurs. + </para> + + <programlisting><![CDATA[select item, index(item) from Order order + join order.items item +where index(item) < 5]]></programlisting> + + <para> + Les fonctions SQL scalaires support�es par la base de donn�es utilis�e peuvent �tre utilis�es + </para> + + <programlisting><![CDATA[from DomesticCat cat where upper(cat.name) like 'FRI%']]></programlisting> + + <para> + Si vous n'�tes pas encore convaincu par tout cela, imaginez la taille et l'illisibilit� qui caract�riseraient + la transformation SQL de la requ�te HQL suivante : + </para> + + <programlisting><![CDATA[select cust +from Product prod, + Store store + inner join store.customers cust +where prod.name = 'widget' + and store.location.name in ( 'Melbourne', 'Sydney' ) + and prod = all elements(cust.currentOrder.lineItems)]]></programlisting> + + <para> + <emphasis>Un indice :</emphasis> cela donnerait quelque chose comme + </para> + + <programlisting><![CDATA[SELECT cust.name, cust.address, cust.phone, cust.id, cust.current_order +FROM customers cust, + stores store, + locations loc, + store_customers sc, + product prod +WHERE prod.name = 'widget' + AND store.loc_id = loc.id + AND loc.name IN ( 'Melbourne', 'Sydney' ) + AND sc.store_id = store.id + AND sc.cust_id = cust.id + AND prod.id = ALL( + SELECT item.prod_id + FROM line_items item, orders o + WHERE item.order_id = o.id + AND cust.current_order = o.id + )]]></programlisting> + + </sect1> + + <sect1 id="queryhql-ordering"> + <title>La clause order by</title> + + <para> + La liste retoun�e par la requ�te peut �tre tri�e par n'importe quelle propri�t� de la classe ou + du composant retourn� : + </para> + + <programlisting><![CDATA[from DomesticCat cat +order by cat.name asc, cat.weight desc, cat.birthdate]]></programlisting> + + <para> + Le mot optionnel <literal>asc</literal> ou <literal>desc</literal> indique respectivement si le tri + doit �tre croissant ou d�croissant. + </para> + </sect1> + + <sect1 id="queryhql-grouping"> + <title>La clause group by</title> + + <para> + Si la requ�te retourne des valeurs aggr�g�es, celles ci peuvent �tre group�es par propri�t� ou composant : + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color]]></programlisting> + + <programlisting><![CDATA[select foo.id, avg(name), max(name) +from Foo foo join foo.names name +group by foo.id]]></programlisting> + + <para> + Une clause <literal>having</literal> est aussi permise. + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color +having cat.color in (eg.Color.TABBY, eg.Color.BLACK)]]></programlisting> + + <para> + Les fonctions SQL et les fonctions d'aggr�gations sont permises dans les clauses <literal>having</literal> + et <literal>order by</literal>, si elles sont support�es par la base de donn�es (ce que ne fait pas MySQL par exemple). + </para> + + <programlisting><![CDATA[select cat +from Cat cat + join cat.kittens kitten +group by cat +having avg(kitten.weight) > 100 +order by count(kitten) asc, sum(kitten.weight) desc]]></programlisting> + + <para> + Notez que ni la clause <literal>group by</literal> ni la clause + <literal>order by</literal> ne peuvent contenir d'expressions arithm�tiques. + </para> + + </sect1> + + <sect1 id="queryhql-subqueries" revision="2"> + <title>Sous-requ�tes</title> + + <para> + Pour les bases de donn�es le supportant, Hibernate supporte les sous requ�tes dans les requ�tes. + Une sous requ�te doit �tre entre parenth�ses (souvent pour un appel � une fonction d'agr�gation SQL) + M�me les sous requ�tes corr�l�es (celles qui font r�f�rence � un alias de la requ�te principale) sont + support�es. + </para> + + <programlisting><![CDATA[from Cat as fatcat +where fatcat.weight > ( + select avg(cat.weight) from DomesticCat cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name = some ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[from Cat as cat +where not exists ( + from Cat as mate where mate.mate = cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name not in ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[select cat.id, (select max(kit.weight) from cat.kitten kit) +from Cat as cat]]></programlisting> + + <para> + Notez que les sous-requ�tes HQL peuvent arriver seulememnt dans les clauses select ou where. + </para> + + <para> + Pour des sous-requ�tes avec plus d'une expression dans le select, vous pouvez utiliser un constructeur de tuples : + </para> + + <programlisting><![CDATA[from Cat as cat +where not ( cat.name, cat.color ) in ( + select cat.name, cat.color from DomesticCat cat +)]]></programlisting> + + <para> + Notez que sur certaines bases de donn�es (mais par Oracle ou HSQL), vous pouvez utiliser des constructeurs de tuples + dans d'autres contextes, par exemple lors du requ�tage de composants ou de types utilisateur composites : + </para> + + <programlisting><![CDATA[from Person where name = ('Gavin', 'A', 'King')]]></programlisting> + + <para> + Ce qui est �quivalent � la forme plus verbeuse suivante : + </para> + + <programlisting><![CDATA[from Person where name.first = 'Gavin' and name.initial = 'A' and name.last = 'King')]]></programlisting> + + <para> + Il y a deux bonnes raisons que vous ne puissiez ne pas vouloir faire cette sorte de choses : d'abord, ce n'est + pas compl�tement portable entre les plateformes de base de donn�es ; deuxi�mement, la requ�te est maintenant + d�pendante de l'ordre des propri�t�s dans le document de mapping. + </para> + + </sect1> + + <sect1 id="queryhql-examples"> + <title>Exemples HQL</title> + + <para> + Les requ�tes Hibernate peuvent �tre relativement puissantes et complexes. En fait, la puissance + du langage de requ�tage est l'un des avantages principaux d'Hibernate. Voici quelques exemples + tr�s similaires aux requ�tes que nous avons utilis�es lors d'un r�cent projet. Notez que la plupart + des requ�tes que vous �crirez seront plus simples que les exemples suivantes ! + </para> + + <para> + La requ�te suivante retourne l'id de commande (order), le nombre d'articles (items) et la valeur + totale de la commande (order) pour toutes les commandes non pay�es d'un client (customer) particulier + pour un total minimum donn�, le tout tri� par la valeur totale. La requ�te SQL g�n�r�e sur les tables + <literal>ORDER</literal>, <literal>ORDER_LINE</literal>, <literal>PRODUCT</literal>, + <literal>CATALOG</literal> et <literal>PRICE</literal> est compos�e de quatre jointures interne ainsi que + d'une sous-requ�te (non corr�l�e). + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog.effectiveDate < sysdate + and catalog.effectiveDate >= all ( + select cat.effectiveDate + from Catalog as cat + where cat.effectiveDate < sysdate + ) +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + Quel monstre ! + En principe, nous ne sommes pas tr�s fan des sous-requ�tes, la requ�te ressemblait donc plut�t + � cela : + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog = :currentCatalog +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + La requ�te suivante compte le nombre de paiements (payments) pour chaque status, en excluant + les paiements dans le status <literal>AWAITING_APPROVAL</literal> o� le changement de status + le plus r�cent � �t� fait par l'utilisateur courant. En SQL, cette requ�te effectue deux + jointures internes et des sous requ�tes corr�l�es sur les tables <literal>PAYMENT</literal>, + <literal>PAYMENT_STATUS</literal> et <literal>PAYMENT_STATUS_CHANGE</literal>. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status + join payment.statusChanges as statusChange +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or ( + statusChange.timeStamp = ( + select max(change.timeStamp) + from PaymentStatusChange change + where change.payment = payment + ) + and statusChange.user <> :currentUser + ) +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + Si nous avions mapp� la collection <literal>statusChanges</literal> comme une liste, au lieu d'un ensemble, + la requ�te aurait �t� plus facile � �crire. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or payment.statusChanges[ maxIndex(payment.statusChanges) ].user <> :currentUser +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + La requ�te qui suit utilise la fonction de MS SQL <literal>isNull()</literal> pour retourner + tous les comptes (accounts) et paiements (payments) impay�s pour l'organisation � laquelle + l'uilisateur (user) courant appartient. Elle est traduite en SQL par trois jointures internes, + une jointure externe ainsi qu'une sous requ�te sur les tables <literal>ACCOUNT</literal>, <literal>PAYMENT</literal>, + <literal>PAYMENT_STATUS</literal>, <literal>ACCOUNT_TYPE</literal>, <literal>ORGANIZATION</literal> et + <literal>ORG_USER</literal>. + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + left outer join account.payments as payment +where :currentUser in elements(account.holder.users) + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + <para> + Pour d'autres base de donn�es, nous aurions d� faire sans la sous-requ�te (corr�l�e). + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + join account.holder.users as user + left outer join account.payments as payment +where :currentUser = user + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + </sect1> + + <sect1 id="queryhql-bulk" revision="2"> + <title>Mise � jour et suppression</title> + + <para> + HQL supporte maintenant les expressions <literal>update</literal>, <literal>delete</literal> et + <literal>insert ... select ...</literal>. + Voir <xref linkend="batch-direct"/> pour les d�tails. + </para> + </sect1> + + <sect1 id="queryhql-tipstricks"> + <title>Trucs & Astuces</title> + + <para> + Vous pouvez compter le nombre de r�sultats d'une requ�te sans les retourner : + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue()]]></programlisting> + + <para> + Pour trier les r�sultats par la taille d'une collection, utilisez la requ�te suivante : + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +order by count(msg)]]></programlisting> + + <para> + Si votre base de donn�es supporte les sous-requ�tes, vous pouvez placer des + conditions sur la taille de la s�lection dans la clause where de votre requ�te: + </para> + + <programlisting><![CDATA[from User usr where size(usr.messages) >= 1]]></programlisting> + + <para> + Si votre base de donn�es ne supporte pas les sous-requ�tes, utilisez la requ�te suivante : + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User usr.name + join usr.messages msg +group by usr.id, usr.name +having count(msg) >= 1]]></programlisting> + + <para> + Cette solution ne peut pas retourner un <literal>User</literal> avec z�ro message + � cause de la jointure interne, la forme suivante peut donc �tre utile : + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +having count(msg) = 0]]></programlisting> + + <para> + Les propri�t�s d'un JavaBean peuvent �tre inject�es dans les param�tres nomm�s d'un requ�te : + </para> + + <programlisting><![CDATA[Query q = s.createQuery("from foo Foo as foo where foo.name=:name and foo.size=:size"); +q.setProperties(fooBean); // fooBean has getName() and getSize() +List foos = q.list();]]></programlisting> + + <para> + Les collections sont paginables via l'utilisation de l'interface <literal>Query</literal> avec un filtre : + </para> + + <programlisting><![CDATA[Query q = s.createFilter( collection, "" ); // the trivial filter +q.setMaxResults(PAGE_SIZE); +q.setFirstResult(PAGE_SIZE * pageNumber); +List page = q.list();]]></programlisting> + + <para> + Les �l�ments d'une collection peuvent �tre tri�s ou group�s en utilisant un filtre de requ�te : + </para> + + <programlisting><![CDATA[Collection orderedCollection = s.filter( collection, "order by this.amount" ); +Collection counts = s.filter( collection, "select this.type, count(this) group by this.type" );]]></programlisting> + + <para> + Vous pouvez r�cup�rer la taille d'une collection sans l'initialiser : + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue();]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_sql.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/query_sql.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_sql.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/query_sql.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,606 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="querysql" revision="2"> + <title>SQL natif</title> + + <para> + Vous pouvez aussi �crire vos requ�tes dans le dialecte SQL natif de votre base de donn�es. + Ceci est utile si vous souhaitez utiliser les fonctionnalit�s sp�cifiques de votre base de + donn�es comme le mot cl� <literal>CONNECT</literal> d'Oracle. Cette fonctionnalit� offre par ailleurs un moyen + de migration plus propre et doux d'une application bas�e sur SQL/JDBC vers + une application Hibernate. + </para> + + <para>Hibernate3 vous permet de sp�cifier du SQL �crit � la main (incluant les proc�dures stock�es) + pour toutes les op�rations de cr�ation, mise � jour, suppression et chargement.</para> + + <sect1 id="querysql-creating" revision="3"> + <title>Utiliser une <literal>SQLQuery</literal></title> + + <para>L'ex�cution des requ�tes en SQL natif est contr�l�e par l'interface <literal>SQLQuery</literal>, + laquelle est obtenue en appelant <literal>Session.createSQLQuery()</literal>. + Dans des cas extr�mement simples, nous pouvons utiliser la forme suivante : + </para> + + <programlisting>List cats = sess.createSQLQuery("select * from cats") + .addEntity(Cat.class) + .list();</programlisting> + + <para>Cette requ�te a sp�cifi� :</para> + + <itemizedlist> + <listitem> + <para>la requ�te SQL</para> + </listitem> + + <listitem> + <para>l'entit� retourn�e par la requ�te</para> + </listitem> + </itemizedlist> + + <para> + Ici, les noms de colonne des r�sultats sont suppos�s �tre les m�mes que les noms de colonne sp�cifi�s dans le + document de mapping. Cela peut �tre probl�matique pour des requ�tes SQL qui joignent de multiple tables, puisque + les m�mes noms de colonne peuvent appara�tre dans plus d'une table. La forme suivante n'est pas vuln�rable � la + duplication des noms de colonne : + </para> + + <programlisting>List cats = sess.createSQLQuery("select {cat.*} from cats cat") + .addEntity("cat", Cat.class) + .list();</programlisting> + + <para>Cette requ�te a sp�cifi� :</para> + + <itemizedlist> + <listitem> + <para>la requ�te SQL, avec un param�tre fictif pour Hibernate pour injecter les alias de colonne</para> + </listitem> + + <listitem> + <para>l'entit� retourn�e par la requ�te, et son alias de table SQL</para> + </listitem> + </itemizedlist> + + <para> + La m�thode <literal>addEntity()</literal> associe l'alias de la table SQL + avec la classe de l'entit� retourn�e, et d�termine la forme de l'ensemble des r�sultats de la requ�te. + </para> + + <para> + La m�thode <literal>addJoin()</literal> peut �tre utilis�e pour charger des associations vers d'autres + entit�s et collections. + </para> + + <programlisting>List cats = sess.createSQLQuery( + "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id" + ) + .addEntity("cat", Cat.class) + .addJoin("kitten", "cat.kittens") + .list();</programlisting> + + <para> + Une requ�te SQL native pourrait retourner une simple valeur scalaire ou une combinaison de scalaires et d'entit�s. + </para> + + <programlisting>Double max = (Double) sess.createSQLQuery("select max(cat.weight) as maxWeight from cats cat") + .addScalar("maxWeight", Hibernate.DOUBLE); + .uniqueResult();</programlisting> + + <para>Vous pouvez alternativement d�crire les informations de mapping des r�sultats dans vos fichiers hbm + et les utiliser pour vos requ�tes.</para> + + <programlisting>List cats = sess.createSQLQuery( + "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id" + ) + .setResultSetMapping("catAndKitten") + .list();</programlisting> + </sect1> + + <sect1 id="querysql-aliasreferences"> + <title>Alias et r�f�rences de propri�t�</title> + + <para> + La notation <literal>{cat.*}</literal> utilis�e au-dessus est un raccourci pour "toutes les propri�t�s". + Alternativement, vous pouvez lister explicitement les colonnes, mais m�me ce cas que nous laissons � Hibernate + injecte des alias de colonne SQL pour chaque propri�t�. Le rempla�ant pour un alias de colonne + est juste le nom de la propri�t� qualifi� par l'alias de la table. + Dans l'exemple suivant, nous r�cup�rons des <literal>Cat</literal>s � partir d'une table diff�rente + (<literal>cat_log</literal>) de celle d�clar�e dans les m�ta-donn�es de mapping. + Notez que nous pouvons m�me utiliser les alias de propri�t� dans la clause "where" si nous le souhaitons. + </para> + + <para> + La syntaxe <literal>{}</literal> <emphasis>n'est pas</emphasis> requise pour le requ�tes nomm�es. Voir + <xref linkend="querysql-namedqueries" />. + </para> + + <programlisting>String sql = "select cat.originalId as {cat.id}, " + + "cat.mateid as {cat.mate}, cat.sex as {cat.sex}, " + + "cat.weight*10 as {cat.weight}, cat.name as {cat.name} " + + "from cat_log cat where {cat.mate} = :catId" + +List loggedCats = sess.createSQLQuery(sql) + .addEntity("cat", Cat.class) + .setLong("catId", catId) + .list();</programlisting> + + <para> + <emphasis>� noter :</emphasis> si vous listez chaque propri�t� explicitement, vous devez inclure + toutes les propri�t�s de la classe <emphasis>et ses sous-classes</emphasis> ! + </para> + + <para> + La table suivante montre les diff�rentes possibilit�s d'utilisation de l'injection d'alias. � noter : les noms + des alias dans le r�sultat sont des exemples, chaque alias aura un nom unique et probablement diff�rent lors de l'utilisation. + </para> + + <table frame="topbot" id="aliasinjection-summary"> + <title>Noms d'injection d'alias</title> + + <tgroup cols="4"> + <colspec colwidth="1*" /> + + <colspec colwidth="1*" /> + + <colspec colwidth="2.5*" /> + + <thead> + <row> + <entry>Description</entry> + + <entry>Syntaxe</entry> + + <entry>Exemple</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Une simple propri�t�</entry> + + <entry><literal>{[aliasname].[propertyname]}</literal></entry> + + <entry><literal>A_NAME as {item.name}</literal></entry> + </row> + + <row> + <entry>Une propri�t� compos�e</entry> + + <entry><literal>{[aliasname].[componentname].[propertyname]}</literal></entry> + + <entry><literal>CURRENCY as {item.amount.currency}, VALUE as + {item.amount.value}</literal></entry> + </row> + + <row> + <entry>Discriminant d'une entit�</entry> + + <entry><literal>{[aliasname].class}</literal></entry> + + <entry><literal>DISC as {item.class}</literal></entry> + </row> + + <row> + <entry>Toutes les propri�t�s d'une entit�</entry> + + <entry><literal>{[aliasname].*}</literal></entry> + + <entry><literal>{item.*}</literal></entry> + </row> + + <row> + <entry>Une clef de collection</entry> + + <entry><literal>{[aliasname].key}</literal></entry> + + <entry><literal>ORGID as {coll.key}</literal></entry> + </row> + + <row> + <entry>L'identifiant d'une collection</entry> + + <entry><literal>{[aliasname].id}</literal></entry> + + <entry><literal>EMPID as {coll.id}</literal></entry> + </row> + + <row> + <entry>L'�l�ment d'une collection</entry> + + <entry><literal>{[aliasname].element}</literal></entry> + + <entry><literal>XID as {coll.element}</literal></entry> + + <entry></entry> + </row> + + <row> + <entry>Propri�t� de l'�l�ment dans la collection</entry> + + <entry><literal>{[aliasname].element.[propertyname]}</literal></entry> + + <entry><literal>NAME as {coll.element.name}</literal></entry> + </row> + + <row> + <entry>Toutes les propri�t�s de l'�l�ment dans la collection</entry> + + <entry><literal>{[aliasname].element.*}</literal></entry> + + <entry><literal>{coll.element.*}</literal></entry> + </row> + + <row> + <entry>Toutes les propri�t�s de la collection</entry> + + <entry><literal>{[aliasname].*}</literal></entry> + + <entry><literal>{coll.*}</literal></entry> + </row> + </tbody> + </tgroup> + </table> + </sect1> + + <sect1 id="querysql-namedqueries" revision="3"> + <title>Requ�tes SQL nomm�es</title> + + <para> + Les requ�tes SQL nomm�es peuvent �tre d�finies dans le document de mapping + et appel�es exactement de la m�me mani�re qu'un requ�te HQL nomm�e. Dans ce + cas, nous <emphasis>n'avons pas besoin</emphasis> d'appeler <literal>addEntity()</literal>. + </para> + + <programlisting><sql-query name="persons"> + <return alias="person" class="eg.Person"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex} + FROM PERSON person + WHERE person.NAME LIKE :namePattern +</sql-query></programlisting> + + <programlisting>List people = sess.getNamedQuery("persons") + .setString("namePattern", namePattern) + .setMaxResults(50) + .list();</programlisting> + + <para> + Les �l�ments <literal><return-join></literal> et + <literal><load-collection></literal> sont respectivement utilis�s pour lier + des associations et d�finir des requ�tes qui initialisent des collections. + </para> + + <programlisting><sql-query name="personsWith"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query></programlisting> + + <para> + Une requ�te SQL nomm�e peut retourner une valeur scalaire. Vous devez + sp�cifier l'alias de colonne et le type Hibernate utilisant l'�l�ment + <literal><return-scalar></literal> :</para> + + <programlisting><sql-query name="mySqlQuery"> + <return-scalar column="name" type="string"/> + <return-scalar column="age" type="long"/> + SELECT p.NAME AS name, + p.AGE AS age, + FROM PERSON p WHERE p.NAME LIKE 'Hiber%' +</sql-query></programlisting> + + <para> + Vous pouvez externaliser les informations de mapping des r�sultats dans un + �l�ment <literal><resultset></literal> pour soit les r�utiliser + dans diff�rentes requ�tes nomm�es, soit � travers l'API + <literal>setResultSetMapping()</literal>. + </para> + + <programlisting><resultset name="personAddress"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> +</resultset> + +<sql-query name="personsWith" resultset-ref="personAddress"> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query></programlisting> + + <sect2 id="propertyresults"> + <title>Utilisation de return-property pour sp�cifier explicitement les noms des colonnes/alias</title> + + <para> + Avec <literal><return-property></literal> vous pouvez explicitement dire + � Hibernate quels alias de colonne utiliser, plutot que d'employer la syntaxe + <literal>{}</literal> pour laisser Hibernate injecter ses propres alias. + </para> + + <programlisting><sql-query name="mySqlQuery"> + <return alias="person" class="eg.Person"> + <return-property name="name" column="myName"/> + <return-property name="age" column="myAge"/> + <return-property name="sex" column="mySex"/> + </return> + SELECT person.NAME AS myName, + person.AGE AS myAge, + person.SEX AS mySex, + FROM PERSON person WHERE person.NAME LIKE :name +</sql-query> +</programlisting> + + <para> + <literal><return-property></literal> fonctionne aussi avec de + multiple colonnes. Cela r�sout une limitation de la syntaxe <literal>{}</literal> + qui ne peut pas permettre une bonne granularit� des propri�t�s multi-colonnes. + </para> + + <programlisting><sql-query name="organizationCurrentEmployments"> + <return alias="emp" class="Employment"> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + <return-property name="endDate" column="myEndDate"/> + </return> + SELECT EMPLOYEE AS {emp.employee}, EMPLOYER AS {emp.employer}, + STARTDATE AS {emp.startDate}, ENDDATE AS {emp.endDate}, + REGIONCODE as {emp.regionCode}, EID AS {emp.id}, VALUE, CURRENCY + FROM EMPLOYMENT + WHERE EMPLOYER = :id AND ENDDATE IS NULL + ORDER BY STARTDATE ASC +</sql-query></programlisting> + + <para> + Notez que dans cet exemple nous avons utilis� <literal><return-property></literal> + en combinaison avec la syntaxe <literal>{}</literal> pour l'injection. Cela autorise les + utilisateurs � choisir comment ils veulent r�f�rencer les colonnes et les propri�t�s. + </para> + + <para> + Si votre mapping a un discriminant vous devez utiliser + <literal><return-discriminator></literal> pour sp�cifier la colonne + discriminante. + </para> + </sect2> + + <sect2 id="sp_query" revision="1"> + <title>Utilisation de proc�dures stock�es pour les requ�tes</title> + + <para> + Hibernate 3 introduit le support des requ�tes via proc�dures stock�es et les fonctions. + La documentation suivante est valable pour les deux. + Les proc�dures stock�es/fonctions doivent retourner l'ensemble de r�sultats en tant que + premier param�tre sortant (NdT: "out-parameter") pour �tre capable de fonctionner + avec Hibernate. Un exemple d'une telle proc�dure stock�e en Oracle 9 et + version sup�rieure : + </para> + + <programlisting>CREATE OR REPLACE FUNCTION selectAllEmployments + RETURN SYS_REFCURSOR +AS + st_cursor SYS_REFCURSOR; +BEGIN + OPEN st_cursor FOR + SELECT EMPLOYEE, EMPLOYER, + STARTDATE, ENDDATE, + REGIONCODE, EID, VALUE, CURRENCY + FROM EMPLOYMENT; + RETURN st_cursor; + END;</programlisting> + + <para>Pour utiliser cette requ�te dans Hibernate vous avez besoin de la mapper via une requ�te nomm�e.</para> + + <programlisting><sql-query name="selectAllEmployees_SP" callable="true"> + <return alias="emp" class="Employment"> + <return-property name="employee" column="EMPLOYEE"/> + <return-property name="employer" column="EMPLOYER"/> + <return-property name="startDate" column="STARTDATE"/> + <return-property name="endDate" column="ENDDATE"/> + <return-property name="regionCode" column="REGIONCODE"/> + <return-property name="id" column="EID"/> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + </return> + { ? = call selectAllEmployments() } +</sql-query></programlisting> + + <para> + Notez que les proc�dures stock�es retournent, pour le moment, seulement des + scalaires et des entit�s. <literal><return-join></literal> et + <literal><load-collection></literal> ne sont pas support�s. + </para> + + <sect3 id="querysql-limits-storedprocedures" revision="1"> + <title>R�gles/limitations lors de l'utilisation des proc�dures stock�es</title> + + <para> + Pur utiliser des proc�dures stock�es avec Hibernate, les proc�dures doivent + suivre certaines r�gles. Si elles ne suivent pas ces r�gles, elles ne sont pas + utilisables avec Hibernate. Si vous voulez encore utiliser ces proc�dures vous + devez les ex�cuter via <literal>session.connection()</literal>. Les r�gles + sont diff�rentes pour chaque base de donn�es, puisque les vendeurs de base + de donn�es ont des s�mantiques/syntaxes diff�rentes pour les proc�dures stock�es. + </para> + + <para>Les requ�tes de proc�dures stock�es ne peuvent pas �tre pagin�es avec + <literal>setFirstResult()/setMaxResults()</literal>.</para> + + <para>Pour Oracle les r�gles suivantes s'appliquent :</para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + La proc�dure doit retourner un ensemble de r�sultats. Le + prmeier param�tre d'une proc�dure doit �tre un <literal>OUT</literal> + qui retourne un ensemble de r�sultats. Ceci est fait en + retournant un <literal>SYS_REFCURSOR</literal> dans Oracle 9 ou 10. Dans + Oracle vous avez besoin de d�finir un type <literal>REF CURSOR</literal>.</para> + </listitem> + + </itemizedlist> + + <para>Pour Sybase ou MS SQL server les r�gles suivantes s'appliquent :</para> + + <itemizedlist spacing="compact"> + <listitem> + <para>La proc�dure doit retourner un ensemble de r�sultats. Notez que comme + ces serveurs peuvent retourner de multiples ensembles de r�sultats et mettre � jour + des compteurs, Hibernate it�rera les r�sultats et prendra le premier r�sultat qui est + un ensemble de r�sultat comme valeur de retour. Tout le reste sera ignor�.</para> + </listitem> + + <listitem> + <para>Si vous pouvez activer <literal>SET NOCOUNT ON</literal> dans votre proc�dure, + elle sera probablement plus efficace, mais ce n'est pas une obligation.</para> + </listitem> + </itemizedlist> + </sect3> + </sect2> + </sect1> + + <sect1 id="querysql-cud"> + <title>SQL personnalis� pour cr�er, mettre � jour et effacer</title> + + <para> + Hibernate3 peut utiliser des expression SQL personnalis�es pour des op�rations de cr�ation, + de mise � jour, et de suppression. Les objets persistants les classes et les collections + dans Hibernate contiennent d�j� un ensemble de cha�nes de caract�res g�n�r�es lors de la + configuration (insertsql, deletesql, updatesql, etc). Les tages de mapping + <literal><sql-insert></literal>, + <literal><sql-delete></literal>, et + <literal><sql-update></literal> surchargent ces cha�nes de caract�res :</para> + + <programlisting><class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert>INSERT INTO PERSON (NAME, ID) VALUES ( UPPER(?), ? )</sql-insert> + <sql-update>UPDATE PERSON SET NAME=UPPER(?) WHERE ID=?</sql-update> + <sql-delete>DELETE FROM PERSON WHERE ID=?</sql-delete> +</class></programlisting> + + <para>Le SQL est directement ex�cut� dans votre base de donn�es, donc vous �tes libre d'utiliser + le dialecte que vous souhaitez. Cela r�duira bien s�r la portabilit� de votre mapping si vous + utilisez du SQL sp�cifique � votre base de donn�es.</para> + + <para>Les proc�dures stock�es sont support�es si l'attribut <literal>callable</literal> est param�tr� :</para> + + <programlisting><class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert callable="true">{call createPerson (?, ?)}</sql-insert> + <sql-delete callable="true">{? = call deletePerson (?)}</sql-delete> + <sql-update callable="true">{? = call updatePerson (?, ?)}</sql-update> +</class></programlisting> + + <para>L'ordre des param�tres positionnels est actuellement vital, car ils doivent �tre dans la + m�me s�quence qu'Hibernate les attend.</para> + + <para> + Vous pouvez voir l'ordre attendu en activant les journaux de debug pour le + niveau <literal>org.hibernate.persister.entity</literal> level. Avec ce niveau activ�, + Hibernate imprimera le SQL statique qui est utilis� pour cr�er, mettre � jour, + supprimer, etc. des entit�s. (Pour voir la s�quence attendue, rappelez-vous de ne pas + inclure votre SQL personnalis� dans les fichiers de mapping de mani�re � surcharger le + SQL statique g�n�r� par Hibernate.)</para> + + <para>Les proc�dures stock�es sont dans la plupart des cas (lire : il vaut mieux le faire) + requises pour retourner le nombre de lignes ins�r�es/mises � jour/supprim�es, puisque + Hibernate fait quelques v�rifications de succ�s lors de l'ex�cution de l'expression. + Hibernate inscrit toujours la premi�re expression comme un param�tre de sortie num�rique pour les + op�rations CUD :</para> + + <programlisting>CREATE OR REPLACE FUNCTION updatePerson (uid IN NUMBER, uname IN VARCHAR2) + RETURN NUMBER IS +BEGIN + + update PERSON + set + NAME = uname, + where + ID = uid; + + return SQL%ROWCOUNT; + +END updatePerson;</programlisting> + </sect1> + + <sect1 id="querysql-load"> + <title>SQL personnalis� pour le chargement</title> + + <para>Vous pouvez aussi d�clarer vos propres requ�tes SQL (ou HQL) pour le chargement d'entit� :</para> + + <programlisting><sql-query name="person"> + <return alias="pers" class="Person" lock-mode="upgrade"/> + SELECT NAME AS {pers.name}, ID AS {pers.id} + FROM PERSON + WHERE ID=? + FOR UPDATE +</sql-query></programlisting> + + <para>Ceci est juste une d�claration de requ�te nomm�e, comme vu plus t�t. Vous pouvez r�f�rencer + cette requ�te nomm�e dans un mapping de classe :</para> + + <programlisting><class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <loader query-ref="person"/> +</class></programlisting> + + <para>Ceci fonctionne m�me avec des proc�dures stock�es.</para> + + <para>Vous pouvez m�me d�finir une requ�te pour le chargement d'une collection :</para> + + <programlisting><set name="employments" inverse="true"> + <key/> + <one-to-many class="Employment"/> + <loader query-ref="employments"/> +</set></programlisting> + + <programlisting><sql-query name="employments"> + <load-collection alias="emp" role="Person.employments"/> + SELECT {emp.*} + FROM EMPLOYMENT emp + WHERE EMPLOYER = :id + ORDER BY STARTDATE ASC, EMPLOYEE ASC +</sql-query></programlisting> + + <para>Vous pourriez m�me d�finir un chargeur d'entit� qui charge une collection par jointure :</para> + + <programlisting><sql-query name="person"> + <return alias="pers" class="Person"/> + <return-join alias="emp" property="pers.employments"/> + SELECT NAME AS {pers.*}, {emp.*} + FROM PERSON pers + LEFT OUTER JOIN EMPLOYMENT emp + ON pers.ID = emp.PERSON_ID + WHERE ID=? +</sql-query></programlisting> + </sect1> +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/session_api.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/session_api.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/session_api.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/session_api.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1226 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="objectstate"> + <title>Travailler avec des objets</title> + <para> + Hibernate est une solution de mapping objet/relationnel compl�te qui ne masque pas + seulement au d�velopppeur les d�tails du syst�me de gestion de base de donn�es sous-jacent, + mais offre aussi <emphasis>la gestion d'�tat</emphasis> des objets. C'est, contrairement + � la gestion de <literal>statements</literal> SQL dans les couches de persistance + habituelles JDBC/SQL, une vue orient�e objet tr�s naturelle de la persistance dans les + applications Java. + </para> + + <para> + En d'autres mots, les d�veloppeurs d'applications Hibernate devrait toujours + r�fl�chir � <emphasis>l'�tat</emphasis> de leurs objets, et pas n�cessairement � + l'ex�cution des expressions SQL. Cette part est prise en charge pas Hibernate et + seulement importante pour les d�veloppeurs d'applications lors du r�glage de la + performance de leur syst�me. + </para> + + <sect1 id="objectstate-overview"> + <title>�tats des objets Hibernate</title> + + <para> + Hibernate d�finit et comprend les �tats suivants : + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>�ph�m�re</emphasis> (NdT : transient) - un objet est �ph�m�re s'il a juste + �t� instanci� en utilisant l'op�rateur <literal>new</literal>. Il n'a aucune + repr�sentation persistante dans la base de donn�es et aucune valeur d'identifiant + n'a �t� assign�e. Les instances �ph�m�res seront d�truites par le ramasse-miettes + si l'application n'en conserve aucune r�f�rence. Utilisez la <literal>Session</literal> + d'Hibernate pour rendre un objet persistant (et laisser Hibernate s'occuper des + expressions SQL qui ont besoin d'�tre ex�cut�es pour cette transistion). + </para> + </listitem> + <listitem> + <para> + <emphasis>Persistant</emphasis> - une instance persistante a une repr�sentation dans la + base de donn�es et une valeur d'identifiant. Elle pourrait avoir juste �t� sauvegard�e + ou charg�e, pourtant, elle est par d�finition dans la port�e d'une <literal>Session</literal>. + Hibernate d�tectera n'importe quels changements effectu�s sur un objet dans l'�tat + persistant et synchronisera l'�tat avec la base de donn�es lors de la fin l'unit� de travail. + Les d�veloppeurs n'ex�cutent pas d'expressions <literal>UPDATE</literal> ou + <literal>DELETE</literal> manuelles lorsqu'un objet devrait �tre rendu �ph�m�re. + </para> + </listitem> + <listitem> + <para> + <emphasis>D�tach�</emphasis> - une instance d�tach�e est un objet qui a �t� persistant, + mais dont sa <literal>Session</literal> a �t� ferm�e. La r�f�rence � l'objet est + encore valide, bien s�r, et l'instance d�tach�e pourrait m�me �tre modifi�e dans cet + �tat. Une instance d�tach�e peut �tre r�attach�e � une nouvelle <literal>Session</literal> + plus tard dans le temps, la rendant (et toutes les modifications avec) de nouveau persistante. + Cette fonctionnalit� rend possible un mod�le de programmation pour de longues unit�s de travail + qui requi�rent un temps de r�flexion de l'utilisateur. Nous les appelons des <emphasis>conversations</emphasis>, + c'est-�-dire une unit� de travail du point de vue de l'utilisateur. + </para> + </listitem> + </itemizedlist> + + <para> + Nous alons maintenant dicuster des �tats et des transitions d'�tat (et des m�thodes + d'Hibernate qui d�clenchent une transition) plus en d�tails. + </para> + + </sect1> + + <sect1 id="objectstate-makingpersistent" revision="1"> + <title>Rendre des objets persistants</title> + + <para> + Les instances nouvellement instanci�es d'une classe persistante sont consid�r�es + <emphasis>�ph�m�res</emphasis> par Hibernate. Nous pouvons rendre une instance + �ph�m�re <emphasis>persistante</emphasis> en l'associant avec une session : + </para> + + <programlisting><![CDATA[DomesticCat fritz = new DomesticCat(); +fritz.setColor(Color.GINGER); +fritz.setSex('M'); +fritz.setName("Fritz"); +Long generatedId = (Long) sess.save(fritz);]]></programlisting> + + <para> + Si <literal>Cat</literal> a un identifiant g�n�r�, l'identifiant est g�n�r� et assign� + au <literal>cat</literal> lorsque <literal>save()</literal> est appel�e. Si <literal>Cat</literal> + a un identifiant <literal>assigned</literal>, ou une clef compos�e, l'identifiant + devrait �tre assign� � l'instance de <literal>cat</literal> avant d'appeler <literal>save()</literal>. + Vous pouvez aussi utiliser <literal>persist()</literal> � la place de<literal>save()</literal>, + avec la s�mantique d�finie plus t�t dans le brouillon d'EJB3. + </para> + + <para> + Alternativement, vous pouvez assigner l'identifiant en utilisant une version + surcharg�e de <literal>save()</literal>. + </para> + +<programlisting><![CDATA[DomesticCat pk = new DomesticCat(); +pk.setColor(Color.TABBY); +pk.setSex('F'); +pk.setName("PK"); +pk.setKittens( new HashSet() ); +pk.addKitten(fritz); +sess.save( pk, new Long(1234) );]]></programlisting> + + <para> + Si l'objet que vous rendez persistant a des objets associ�s (par exemple, + la collection <literal>kittens</literal> dans l'exemple pr�c�dent), ces objets + peuvent �tre rendus persistants dans n'importe quel ordre que vous souhaitez + � moins que vous ayez une contrainte <literal>NOT NULL</literal> sur la + colonne de la clef �trang�re. Il n'y a jamais de risque de violer une + contrainte de clef �trang�re. Cependant, vous pourriez violer une contrainte + <literal>NOT NULL</literal> si vous appeliez <literal>save()</literal> sur + les objets dans le mauvais ordre. + </para> + + <para> + Habituellement, vous ne vous pr�occupez pas de ce d�tail, puisque vous + utiliserez tr�s probablement la fonctionnalit� de <emphasis>persistance + transitive</emphasis> d'Hibernate pour sauvegarder les objets associ�s + automatiquement. Alors, m�me les violations de contrainte <literal>NOT NULL</literal> + n'ont plus lieu - Hibernate prendra soin de tout. La persistance transitive est + trait�e plus loin dans ce chapitre. + </para> + + </sect1> + + <sect1 id="objectstate-loading"> + <title>Chargement d'un objet</title> + + <para> + Les m�thodes <literal>load()</literal> de <literal>Session</literal> vous donnent + un moyen de r�cup�rer une instance persistante si vous connaissez d�j� son identifiant. + <literal>load()</literal> prend un objet de classe et chargera l'�tat dans une instance + nouvellement instanci�e de cette classe, dans un �tat persistant. + </para> + + <programlisting><![CDATA[Cat fritz = (Cat) sess.load(Cat.class, generatedId);]]></programlisting> + +<programlisting><![CDATA[// vous avez besoin d'envelopper les identiants primitifs +long pkId = 1234; +DomesticCat pk = (DomesticCat) sess.load( Cat.class, new Long(pkId) );]]></programlisting> + + <para> + Alternativement, vous pouvez charger un �tat dans une instance donn�e : + </para> + +<programlisting><![CDATA[Cat cat = new DomesticCat(); +// load pk's state into cat +sess.load( cat, new Long(pkId) ); +Set kittens = cat.getKittens();]]></programlisting> + + <para> + Notez que <literal>load()</literal> l�vera une exception irr�cup�rable s'il + n'y a pas de ligne correspondante dans la base de donn�es. Si la classe est mapp�e + avec un proxy, <literal>load()</literal> retourne juste un proxy non initialis� et + n'acc�de en fait pas � la base de donn�es jusqu'� ce que vous invoquiez une + m�thode du proxy. Ce comportement est tr�s utile si vous souhaitez cr�er + une association vers un objet sans r�ellement le charger � partir de la base de + donn�es. Cela permet aussi � de multiples instances d'�tre charg�es comme un lot + si <literal>batch-size</literal> est d�fini pour le mapping de la classe. + </para> + + <para> + Si vous n'�tes pas certain qu'une ligne correspondante existe, vous devriez + utiliser la m�thode <literal>get()</literal>, laquelle acc�de � la base de + donn�es imm�diatement et retourne null s'il n'y a pas de ligne correspondante. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id); +if (cat==null) { + cat = new Cat(); + sess.save(cat, id); +} +return cat;]]></programlisting> + + <para> + Vous pouvez m�me charger un objet en employant un <literal>SELECT ... FOR UPDATE</literal> SQL, + en utilisant un <literal>LockMode</literal>. Voir la documentation de l'API pour plus d'informations. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id, LockMode.UPGRADE);]]></programlisting> + + <para> + Notez que n'importe quelles instances associ�es ou collections contenues + <emphasis>ne sont pas</emphasis> s�lectionn�es par <literal>FOR UPDATE</literal>, + � moins que vous ne d�cidiez de sp�cifier <literal>lock</literal> ou <literal>all</literal> + en tant que style de cascade pour l'association. + </para> + + <para> + Il est possible de re-charger un objet et toutes ses collections � n'importe quel moment, + en utilisant la m�thode <literal>refresh()</literal>. C'est utile lorsque des "triggers" de + base de donn�es sont utilis�s pour initiliser certains propri�t�s de l'objet. + </para> + + <programlisting><![CDATA[sess.save(cat); +sess.flush(); //force the SQL INSERT +sess.refresh(cat); //re-read the state (after the trigger executes)]]></programlisting> + + <para> + Une question importante appara�t g�n�ralement � ce point : combien (NdT : de donn�es) Hibernate + charge-t-il de la base de donn�es et combient de <literal>SELECT</literal>s utilisera-t-il ? + Cela d�pent de la <emphasis>strat�gie de r�cup�ration</emphasis> et cela est expliqu� dans + <xref linkend="performance-fetching"/>. + </para> + + </sect1> + + <sect1 id="objectstate-querying" revision="1"> + <title>Requ�tage</title> + + <para> + Si vous ne connaissez par les identifiants des objets que vous recherchez, vous + avez besoin d'une requ�te. Hibernate supporte un langage de requ�tes orient�es objet + facile � utiliser mais puissant. Pour la cr�ation de requ�tes par programmation, + Hibernate supporte une fonction de requ�tage sophistiqu� Criteria et Example (QBC et QBE). + Vous pouvez aussi exprimez votre requ�te dans le SQL natif de votre base de donn�es, + avec un support optionnel d'Hibernate pour la conversion des ensembles de r�sultats en + objets. + </para> + + <sect2 id="objectstate-querying-executing"> + <title>Ex�cution de requ�tes</title> + + <para> + Les requ�tes HQL et SQL natives sont repr�sent�es avec une instance de <literal>org.hibernate.Query</literal>. + L'interface offre des m�thodes pour la liaison des param�tres, la gestion des ensembles de resultats, et pour + l'ex�cution de la requ�te r�elle. Vous obtenez toujours une <literal>Query</literal> en utilisant la + <literal>Session</literal> courante : + </para> + + <programlisting><![CDATA[List cats = session.createQuery( + "from Cat as cat where cat.birthdate < ?") + .setDate(0, date) + .list(); + +List mothers = session.createQuery( + "select mother from Cat as cat join cat.mother as mother where cat.name = ?") + .setString(0, name) + .list(); + +List kittens = session.createQuery( + "from Cat as cat where cat.mother = ?") + .setEntity(0, pk) + .list(); + +Cat mother = (Cat) session.createQuery( + "select cat.mother from Cat as cat where cat = ?") + .setEntity(0, izi) + .uniqueResult();]]></programlisting> + + <para> + Une requ�te est g�n�ralement ex�cut�e en invoquant <literal>list()</literal>, + le r�sultat de la requ�te sera charg�e compl�tement dans une collection en m�moire. + Les intances d'entit�s recup�r�es par une requ�te sont dans un �tat persistant. + La m�thode <literal>uniqueResult()</literal> offre un raccourci si vous + savez que votre requ�te retournera seulement un seul objet. + </para> + + <sect3 id="objectstate-querying-executing-iterate"> + <title>It�ration de r�sultats</title> + + <para> + Occasionnellement, vous pourriez �tre capable d'obtenir de meilleures + performances en ex�cutant la requ�te avec la m�thode <literal>iterate()</literal>. + Ce sera g�n�ralement seulement le cas si vous esp�rez que les intances r�elles + d'entit� retourn�es par la requ�te soient d�j� charg�es dans la session ou le + cache de second niveau. Si elles ne sont pas cach�es, <literal>iterate()</literal> + sera plus lent que <literal>list()</literal> et pourrait n�cessiter plusieurs + acc�s � la base de donn�es pour une simple requ�te, g�n�ralement <emphasis>1</emphasis> + pour le select initial qui retourne seulement les identifiants, et <emphasis>n</emphasis> + selects suppl�mentaires pour initialiser les instances r�elles. + </para> + + <programlisting><![CDATA[// fetch ids +Iterator iter = sess.createQuery("from eg.Qux q order by q.likeliness").iterate(); +while ( iter.hasNext() ) { + Qux qux = (Qux) iter.next(); // fetch the object + // something we couldnt express in the query + if ( qux.calculateComplicatedAlgorithm() ) { + // delete the current instance + iter.remove(); + // dont need to process the rest + break; + } +}]]></programlisting> + </sect3> + + <sect3 id="objectstate-querying-executing-tuples"> + <title>Requ�tes qui retournent des tuples</title> + + <para> + Les requ�tes d'Hibernate retournent parfois des tuples d'objets, auquel cas chaque tuple + est retourn� comme un tableau : + </para> + + <programlisting><![CDATA[Iterator kittensAndMothers = sess.createQuery( + "select kitten, mother from Cat kitten join kitten.mother mother") + .list() + .iterator(); + +while ( kittensAndMothers.hasNext() ) { + Object[] tuple = (Object[]) kittensAndMothers.next(); + Cat kitten = (Cat) tuple[0]; + Cat mother = (Cat) tuple[1]; + .... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-scalar" revision="1"> + <title>R�sultats scalaires</title> + + <para> + Des requ�tes peuvent sp�cifier une propri�t� d'une classe dans la clause <literal>select</literal>. + Elles peuvent m�me appeler des fonctions d'aggr�gat SQL. Les propri�t�s ou les aggr�gats sont + consid�r�s comme des r�sultats "scalaires" (et pas des entit�s dans un �tat persistant). + </para> + + <programlisting><![CDATA[Iterator results = sess.createQuery( + "select cat.color, min(cat.birthdate), count(cat) from Cat cat " + + "group by cat.color") + .list() + .iterator(); + +while ( results.hasNext() ) { + Object[] row = (Object[]) results.next(); + Color type = (Color) row[0]; + Date oldest = (Date) row[1]; + Integer count = (Integer) row[2]; + ..... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-parameters"> + <title>Lier des param�tres</title> + + <para> + Des m�thodes de <literal>Query</literal> sont fournies pour lier des + valeurs � des param�tres nomm�s ou � des param�tres de style JDBC <literal>?</literal>. + <emphasis>Contrairement � JDBC, les num�ros des param�tres d'Hibernate commencent � z�ro.</emphasis> + Les param�tres nomm�s sont des identifiants de la forme <literal>:nom</literal> dans la cha�ne de + caract�res de la requ�te. Les avantages des param�tres nomm�s sont : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + les param�tres nomm�s sont insensibles � l'ordre de leur place dans la cha�ne + de la requ�te + </para> + </listitem> + <listitem> + <para> + ils peuvent appara�tre plusieurs fois dans la m�me requ�te + </para> + </listitem> + <listitem> + <para> + ils sont auto-document�s + </para> + </listitem> + </itemizedlist> + + <programlisting><![CDATA[//param�tre nomme (pr�f�r�) +Query q = sess.createQuery("from DomesticCat cat where cat.name = :name"); +q.setString("name", "Fritz"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//param�tre positionnel +Query q = sess.createQuery("from DomesticCat cat where cat.name = ?"); +q.setString(0, "Izi"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//liste de param�tres nomm�s +List names = new ArrayList(); +names.add("Izi"); +names.add("Fritz"); +Query q = sess.createQuery("from DomesticCat cat where cat.name in (:namesList)"); +q.setParameterList("namesList", names); +List cats = q.list();]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-pagination"> + <title>Pagination</title> + + <para> + Si vous avez besoin de sp�cifier des liens sur votre ensemble de r�sultats (le nombre + maximum de lignes que vous voulez r�cup�rez et/ou la premi�re ligne que vous voulez r�cup�rer) + vous devriez utiliser des m�thodes de l'interface <literal>Query</literal> : + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("from DomesticCat cat"); +q.setFirstResult(20); +q.setMaxResults(10); +List cats = q.list();]]></programlisting> + + <para> + Hibernate sait comment traduite cette requ�te de limite en SQL natif pour votre SGBD. + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-scrolling"> + <title>It�ration "scrollable"</title> + + <para> + Si votre connecteur JDBC supporte les <literal>ResultSet</literal>s "scrollables", + l'interface <literal>Query</literal> peut �tre utilis�e pour obtenir un objet + <literal>ScrollableResults</literal>, lequel permet une navigation flexible dans les + r�sultats de la requ�te. + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("select cat.name, cat from DomesticCat cat " + + "order by cat.name"); +ScrollableResults cats = q.scroll(); +if ( cats.first() ) { + + // trouve le premier nom sur chaque page d'une liste alphab�tique de noms de chats + firstNamesOfPages = new ArrayList(); + do { + String name = cats.getString(0); + firstNamesOfPages.add(name); + } + while ( cats.scroll(PAGE_SIZE) ); + + // Maintenant, obtiens la premi�re page de chats + pageOfCats = new ArrayList(); + cats.beforeFirst(); + int i=0; + while( ( PAGE_SIZE > i++ ) && cats.next() ) pageOfCats.add( cats.get(1) ); + +} +cats.close()]]></programlisting> + + <para> + Notez qu'une connexion ouverte (et un curseur) est requise pour cette fonctionnalit�, + utilisez <literal>setMaxResult()</literal>/<literal>setFirstResult()</literal> si vous + avez besoin d'une fonctionnalit� de pagination hors ligne. + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-named"> + <title>Externaliser des requ�tes nomm�es</title> + + <para> + Vous pouvez aussi d�finir des requ�tes nomm�es dans le document de mapping. + (Souvenez-vous d'utiliser une section <literal>CDATA</literal> si votre requ�te + contient des caract�res qui pourraient �tre interpr�t�s comme des �l�ments XML.) + </para> + + <programlisting><![CDATA[<query name="eg.DomesticCat.by.name.and.minimum.weight"><![CDATA[ + from eg.DomesticCat as cat + where cat.name = ? + and cat.weight > ? +] ]></query>]]></programlisting> + + <para> + La liaison de param�tres et l'ex�cution sont fait par programmation : + </para> + + <programlisting><![CDATA[Query q = sess.getNamedQuery("eg.DomesticCat.by.name.and.minimum.weight"); +q.setString(0, name); +q.setInt(1, minWeight); +List cats = q.list();]]></programlisting> + + <para> + Notez que le code r�el du programme est ind�pendant du langage de requ�te qui est + utilis�, vous pouvez aussi d�finir des requ�tes SQL nativez dans les m�ta-donn�es, ou + migrer des requ�tes existantes vers Hibernate en les pla�ant dans les fichiers de mapping. + </para> + + </sect3> + + </sect2> + + <sect2 id="objectstate-filtering" revision="1"> + <title>Filtrer des collections</title> + <para> + Un <emphasis>filtre</emphasis> de collection est un type sp�cial de requ�te qui peut �tre + appliqu� � une collection persistante ou � un tableau. La cha�ne de requ�te peut se r�f�rer � + <literal>this</literal>, correspondant � l'�l�ment de la collection courant. + </para> + + <programlisting><![CDATA[Collection blackKittens = session.createFilter( + pk.getKittens(), + "where this.color = ?") + .setParameter( Color.BLACK, Hibernate.custom(ColorUserType.class) ) + .list() +);]]></programlisting> + + <para> + La collection retourn�e est consid�r�e comme un bag, et c'est une copie de la + collection donn�e. La collection originale n'est pas modifi�e (c'est contraire + � l'implication du nom "filtre"; mais coh�rent avec le comportement attendu). + </para> + + <para> + Observez que les filtres ne n�cessitent pas une clause <literal>from</literal> (bien qu'ils + puissent en avoir une si besoin est). Les filtres ne sont pas limit�s � retourner des + �l�ments de la collection eux-m�mes. + </para> + + <programlisting><![CDATA[Collection blackKittenMates = session.createFilter( + pk.getKittens(), + "select this.mate where this.color = eg.Color.BLACK.intValue") + .list();]]></programlisting> + + <para> + M�me une requ�te de filtre vide est utile, par exemple pour charger un sous-ensemble + d'�l�ments dans une �norme collection : + </para> + + <programlisting><![CDATA[Collection tenKittens = session.createFilter( + mother.getKittens(), "") + .setFirstResult(0).setMaxResults(10) + .list();]]></programlisting> + + </sect2> + + <sect2 id="objecstate-querying-criteria" revision="1"> + <title>Requ�tes Criteria</title> + + <para> + HQL est extr�mement puissant mais certains d�veloppeurs pr�f�rent construire des + requ�tes dynamiquement, en utilisant l'API orient�e objet, plut�t que construire + des cha�nes de requ�tes. Hibernate fournit une API intuitive de requ�te <literal>Criteria</literal> + pour ces cas : + </para> + + <programlisting><![CDATA[Criteria crit = session.createCriteria(Cat.class); +crit.add( Restrictions.eq( "color", eg.Color.BLACK ) ); +crit.setMaxResults(10); +List cats = crit.list();]]></programlisting> + + <para> + Les APIs <literal>Criteria</literal> et <literal>Example</literal> associ� sont + trait�es plus en d�tail dans <xref linkend="querycriteria"/>. + </para> + + </sect2> + + <sect2 id="objectstate-querying-nativesql" revision="2"> + <title>Requ�tes en SQL natif</title> + + <para> + Vous pouvez exprimer une requ�te en SQL, en utilisant <literal>createSQLQuery()</literal> + et laisser Hibernate s'occuper du mapping des r�sultats vers des objets. Notez que vous + pouvez n'importe quand appeler <literal>session.connection()</literal> et utiliser + directement la <literal>Connection</literal> JDBC. Si vous choisissez d'utiliser + l'API Hibernate, vous devez mettre les alias SQL entre accolades : + </para> + + <programlisting><![CDATA[List cats = session.createSQLQuery("SELECT {cat.*} FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list();]]></programlisting> + + <programlisting><![CDATA[List cats = session.createSQLQuery( + "SELECT {cat}.ID AS {cat.id}, {cat}.SEX AS {cat.sex}, " + + "{cat}.MATE AS {cat.mate}, {cat}.SUBCLASS AS {cat.class}, ... " + + "FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list()]]></programlisting> + + <para> + Les requ�tes SQL peuvent contenir des param�tres nomm�s et positionnels, comme des + requ�tes Hibernate. Plus d'informations � propos des requ�tes SQL natives dans Hibernate + peuvent �tre trouv�es dans <xref linkend="querysql"/>. + </para> + + </sect2> + + </sect1> + + <sect1 id="objectstate-modifying" revision="1"> + <title>Modifier des objets persistants</title> + + <para> + Les <emphasis>instances persistantes transactionnelles</emphasis> (c'est-�-dire des objets + charg�s, sauvegard�s, cr��s ou requ�t�s par la <literal>Session</literal>) peuvent �tre + manipul�es par l'application et n'importe quel changement vers l'�tat persistant sera + persist� lorsque la <literal>Session</literal> est <emphasis>"flush�e"</emphasis> (trait� + plus tard dans ce chapitre). Il n'y a pas besoin d'appeler une m�thode particuli�re + (comme <literal>update()</literal>, qui a un but diff�rent) pour rendre vos modifications + persistantes. Donc la mani�re la plus directe de mettre � jour l'�tat d'un objet est de + le charger avec <literal>load()</literal>, et puis le manipuler directement, tant que la + <literal>Session</literal> est ouverte : + </para> + + <programlisting><![CDATA[DomesticCat cat = (DomesticCat) sess.load( Cat.class, new Long(69) ); +cat.setName("PK"); +sess.flush(); // changes to cat are automatically detected and persisted]]></programlisting> + + <para> + Parfois ce mod�le de programmation est inefficace puisqu'il n�cessiterait un + <literal>SELECT</literal> SQL (pour charger l'objet) et un <literal>UPDATE</literal> + SQL (pour persister son �tat mis � jour) dans la m�me session. Aussi Hibernate offre + une autre approche, en utilisant des instances d�tach�es. + </para> + + <para> + <emphasis>Notez que Hibernate n'offre par sa propre API pour l'ex�cution directe + d'expressions <literal>UPDATE</literal> ou <literal>DELETE</literal>. Hibernate + est un service de <emphasis>gestion d'�tat</emphasis>, vous n'avez pas � penser + aux <emphasis>expressions</emphasis> pour l'utiliser. JDBC est une API parfaite + pour ex�cuter des expressions SQL, vous pouvez obtenir une <literal>Connection</literal> + JDBC n'importe quand en appelant <literal>session.connection()</literal>. En outre, + la notion d'op�rations de masse entre en conflit avec le mapping objet/relationnel + pour les applications orient�es processus de transactions en ligne. Les futures + versions d'Hibernate peuvent cependant fournir des fonctions d'op�ration de masse. + Voir <xref linkend="batch"/> pour les astuces possibles d'op�rations group�es.</emphasis> + </para> + + </sect1> + + <sect1 id="objectstate-detached" revision="2"> + <title>Modifier des objets d�tach�s</title> + + <para> + Beaucoup d'applications ont besoin de r�cup�rer un objet dans une transaction, + l'envoyer � la couche interfac�e avec l'utilisateur pour les manipulations, puis + sauvegarder les changements dans une nouvelle transaction. Les applications + qui utilisent cette approche dans un environnement � haute concurrence utilisent + g�n�ralement des donn�es versionn�es pour assurer l'isolation pour les "longues" + unit�s de travail. + </para> + + <para> + Hibernate supporte ce mod�le en permettant pour le r�attachement d'instances d�tach�es + l'utilisation des m�thodes <literal>Session.update()</literal> ou <literal>Session.merge()</literal> : + </para> + + <programlisting><![CDATA[// dans la premi�re session +Cat cat = (Cat) firstSession.load(Cat.class, catId); +Cat potentialMate = new Cat(); +firstSession.save(potentialMate); + +// dans une couche plus haute de l'application +cat.setMate(potentialMate); + +// plus tard, dans une nouvelle session +secondSession.update(cat); // update cat +secondSession.update(mate); // update mate]]></programlisting> + + <para> + Si le <literal>Cat</literal> avec l'identifiant <literal>catId</literal> avait d�j� + �t� charg� par <literal>secondSession</literal> lorsque l'application a essay� de le + r�attacher, une exception aurait �t� lev�e. + </para> + + <para> + Utilisez <literal>update()</literal> si vous �tes sure que la session ne contient pas + d�j� une instance persistante avec le m�me identifiant, et <literal>merge()</literal> + si vous voulez fusionner vos modifications n'importe quand sans consid�rer l'�tat de + la session. En d'autres mots, <literal>update()</literal> est g�n�ralement la premi�re m�thode + que vous devriez appeler dans une session fra�che, pour s'assurer que le r�attachement + de vos instances d�tach�es est la premi�re op�ration qui est ex�cut�e. + </para> + + <para> + L'application devrait individuellement <literal>update()</literal> (NdT : mettre � jour) + les instances d�tach�es accessibles depuis l'instance d�tach�e donn�e si et + <emphasis>seulement</emphasis> si elle veut que leur �tat soit aussi mis � jour. Ceci + peut �tre automatis� bien s�r, en utilisant la <emphasis>persistance transitive</emphasis>, + voir <xref linkend="objectstate-transitive"/>. + </para> + + <para> + La m�thode <literal>lock()</literal> permet aussi � une application de r�associer un + objet avec une nouvelle session. Pourtant, l'instance d�tach�e doit �tre non modifi�e ! + </para> + + <programlisting><![CDATA[//r�associe : +sess.lock(fritz, LockMode.NONE); +//fait une v�rification de version, puis r�associe : +sess.lock(izi, LockMode.READ); +//fait une v�rification de version, en utilisant SELECT ... FOR UPDATE, puis r�associe : +sess.lock(pk, LockMode.UPGRADE);]]></programlisting> + + <para> + Notez que <literal>lock()</literal> peut �tre utilis� avec diff�rents + <literal>LockMode</literal>s, voir la documentation de l'API documentation et le chapitre + sur la gestion des transactions pour plus d'informations. Le r�attachement n'est pas le seul + cas d'utilisation pour <literal>lock()</literal>. + </para> + + <para> + D'autres mod�les pour de longues unit�s de travail sont trait�s dans <xref linkend="transactions-optimistic"/>. + </para> + + </sect1> + + <sect1 id="objectstate-saveorupdate"> + <title>D�tection automatique d'un �tat</title> + + <para> + Les utilisateurs d'Hibernate ont demand� une m�thode dont l'intention g�n�rale + serait soit de sauvegarder une instance �ph�m�re en g�n�rant un nouvel identifiant, + soit mettre � jour/r�attacher les instances d�tach�es associ�es � l'identifiant courant. + La m�thode <literal>saveOrUpdate()</literal> impl�mente cette fonctionnalit�. + </para> + + <programlisting><![CDATA[// dans la premi�re session +Cat cat = (Cat) firstSession.load(Cat.class, catID); + +// dans une partie plus haute de l'application +Cat mate = new Cat(); +cat.setMate(mate); + +// plus tard, dans une nouvelle session +secondSession.saveOrUpdate(cat); // met � jour un �tat existant (cat a un identifiant non-null) +secondSession.saveOrUpdate(mate); // sauvegarde les nouvelles instances (mate a un identiant null)]]></programlisting> + + <para> + L'usage et la s�mantique de <literal>saveOrUpdate()</literal> semble �tre confuse pour les + nouveaux utilisateurs. Premi�rement, aussi longtemps que vous n'essayez pas d'utiliser des + instances d'une session dans une autre, vous ne devriez pas avoir besoin d'utiliser <literal>update()</literal>, + <literal>saveOrUpdate()</literal>, ou <literal>merge()</literal>. Certaines applications + n'utiliseront jamais ces m�thodes. + </para> + + <para> + G�n�ralement <literal>update()</literal> ou <literal>saveOrUpdate()</literal> sont utilis�es dans + le sc�nario suivant : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + l'application charge un objet dans la premi�re session + </para> + </listitem> + <listitem> + <para> + l'objet est pass� � la couche utilisateur + </para> + </listitem> + <listitem> + <para> + certaines modifications sont effectu�es sur l'objet + </para> + </listitem> + <listitem> + <para> + l'objet est retourn� � la couche logique m�tier + </para> + </listitem> + <listitem> + <para> + l'application persiste ces modifications en appelant + <literal>update()</literal> dans une seconde sessin + </para> + </listitem> + </itemizedlist> + + <para> + <literal>saveOrUpdate()</literal> s'utilise dans le cas suivant : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + si l'objet est d�j� persistant dans cette session, ne rien faire + </para> + </listitem> + <listitem> + <para> + si un autre objet associ� � la session a le m�me identifiant, lever une exception + </para> + </listitem> + <listitem> + <para> + si l'objet n'a pas de propri�t� d'identifiant, appeler <literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + si l'identifiant de l'objet a une valeur assign�e � un objet nouvellement instanci�, + appeler <literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + si l'objet est versionn� (par <literal><version></literal> ou + <literal><timestamp></literal>), et la valeur de la propri�t� de version + est la m�me valeur que celle assign�e � un objet nouvellement instanci�, appeler + <literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + sinon mettre � jour l'objet avec <literal>update()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + et <literal>merge()</literal> est tr�s diff�rent : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + s'il y a une instance persistante avec le m�me identifiant couramment + associ�e � la session, copier l'�tat de l'objet donn� dans l'instance persistante + </para> + </listitem> + <listitem> + <para> + s'il n'y a pas d'instance persistante associ�e � cette session, essayer de le charger + � partir de la base de donn�es, ou cr�er une nouvelle instance persistante + </para> + </listitem> + <listitem> + <para> + l'instance persistante est retourn�e + </para> + </listitem> + <listitem> + <para> + l'instance donn�e ne devient pas associ�e � la session, elle reste d�tach�e + </para> + </listitem> + </itemizedlist> + + </sect1> + + <sect1 id="objectstate-deleting" revision="1"> + <title>Suppression d'objets persistants</title> + + <para> + <literal>Session.delete()</literal> supprimera l'�tat d'un objet de la base de donn�es. + Bien s�r, votre application pourrait encore conserver une r�f�rence vers un objet effac�. + Il est mieux de penser � <literal>delete()</literal> comme rendant une instance persistante + �ph�m�re. + </para> + + <programlisting><![CDATA[sess.delete(cat);]]></programlisting> + + <para> + Vous pouvez effacer des objets dans l'ordre que vous voulez, sans risque de violations + de contrainte de clef �trang�re. Il est encore possible de violer une contrainte <literal>NOT + NULL</literal> sur une colonne de clef �trang�re en effa�ant des objets dans le + mauvais ordre, par exemple si vous effacer le parent, mais oubliez d'effacer les enfants. + </para> + + </sect1> + + <sect1 id="objectstate-replicating" revision="1"> + <title>R�plication d'objets entre deux entrep�ts de donn�es</title> + + <para> + Il est occasionnellement utile de pouvoir prendre un graphe d'instances persistantes + et de les rendre persistantes dans un entrep�t diff�rent, sans reg�n�rer les valeurs + des identifiants. + </para> + + <programlisting><![CDATA[//r�cup�re un cat de la base de donn�es +Session session1 = factory1.openSession(); +Transaction tx1 = session1.beginTransaction(); +Cat cat = session1.get(Cat.class, catId); +tx1.commit(); +session1.close(); + +// r�concilie la seconde base de donn�es +Session session2 = factory2.openSession(); +Transaction tx2 = session2.beginTransaction(); +session2.replicate(cat, ReplicationMode.LATEST_VERSION); +tx2.commit(); +session2.close();]]></programlisting> + + <para> + Le <literal>ReplicationMode</literal> d�termine comment <literal>replicate()</literal> + traitera les conflits avec les lignes existantes dans la base de donn�es. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ReplicationMode.IGNORE</literal> - ignore l'objet s'il y a une ligne + existante dans la base de donn�es avec le m�me identifiant + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.OVERWRITE</literal> - �crase n'importe quelle ligne existante + dans la base de donn�es avec le m�me identifiant + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.EXCEPTION</literal> - l�ve une exception s'il y une ligne dans + la base de donn�es avec le m�me identifiant + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.LATEST_VERSION</literal> - �crase la ligne si son num�ro de version + est plus petit que le num�ro de version de l'objet, ou ignore l'objet sinon + </para> + </listitem> + </itemizedlist> + + <para> + Les cas d'utilisation de cette fonctionnalit� incluent la r�conciliation de donn�es + entr�es dans diff�rentes base de donn�es, l'extension des informations de configuration + du syst�me durant une mise � jour du produit, retour en arri�re sur les changements effectu�s + durant des transactions non-ACID, et plus. + </para> + + </sect1> + + <sect1 id="objectstate-flushing"> + <title>Flush de la session</title> + + <para> + De temps en temps la <literal>Session</literal> ex�cutera les expressions SQL + requises pour syncrhoniser l'�tat de la connexion JDBC avec l'�tat des objets + retenus en m�moire. Ce processus, <emphasis>flush</emphasis>, arrive par d�faut aux + points suivants : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + lors de certaines ex�cutions de requ�te + </para> + </listitem> + <listitem> + <para> + lors d'un appel � <literal>org.hibernate.Transaction.commit()</literal> + </para> + </listitem> + <listitem> + <para> + lors d'un appel � <literal>Session.flush()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Les expressions SQL sont effectu�es dans l'ordre suivant : + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + insertion des entit�s, dans le m�me ordre que celui des + objets correspondants sauvegard�s par l'appel � <literal>Session.save()</literal> + </para> + </listitem> + <listitem> + <para> + mise � jours des entit�s + </para> + </listitem> + <listitem> + <para> + suppression des collections + </para> + </listitem> + <listitem> + <para> + suppression, mise � jour et insertion des �l�ments des collections + </para> + </listitem> + <listitem> + <para> + insertion des collections + </para> + </listitem> + <listitem> + <para> + suppression des entit�s, dans le m�me ordre que celui des objets + correspondants qui ont �t� supprim�s par l'appel � <literal>Session.delete()</literal> + </para> + </listitem> + </orderedlist> + + <para> + (Une exception est que des objets utilisant la g�n�ration <literal>native</literal> + d'identifiants sont ins�r�s lorsqu'ils sont sauvegard�s.) + </para> + + <para> + Except� lorsque vous appelez <literal>flush()</literal> explicitement, il n'y + absolument aucune garantie � propos de <emphasis>quand</emphasis> la <literal>Session</literal> + ex�cute les appels JDBC, seulement sur l'<emphasis>ordre</emphasis> dans lequel ils sont + ex�cut�s. Cependant, Hibernate garantit que <literal>Query.list(..)</literal> ne + retournera jamais de donn�es p�rim�es, ni des donn�es fausses. + </para> + + <para> + Il est possible de changer le comportement par d�faut, donc que le flush se produise + moins fr�quemment. La classe <literal>FlushMode</literal> d�finit trois modes diff�rents : + flush seulement lors du commit (et seulement quand l'API <literal>Transaction</literal> + d'Hibernate est utilis�e), flush automatiquement en utilisant la proc�dure expliqu�e, ou + jamais de flush � moins que <literal>flush()</literal> soit appel�e explicitement. + Le dernier mode est utile pour l'ex�cution de longues unit�s de travail, o� une + <literal>Session</literal> est gard�e ouverte et d�connect�e pour un long moment + (voir <xref linkend="transactions-optimistic-longsession"/>). + </para> + + <programlisting><![CDATA[sess = sf.openSession(); +Transaction tx = sess.beginTransaction(); +sess.setFlushMode(FlushMode.COMMIT); // permet aux requ�tes de retourner un �tat p�rim� + +Cat izi = (Cat) sess.load(Cat.class, id); +izi.setName(iznizi); + +// pourrait retourner des donn�es p�rim�es +sess.find("from Cat as cat left outer join cat.kittens kitten"); + +// le changement pour izi n'est pas flush� ! +... +tx.commit(); // le flush se produit]]></programlisting> + + <para> + Durant le flush, une exception peut se produire (par exemple, si une op�ration de la + DML viole une contrainte). Puisque les exceptions de gestion impliquent une certaine + compr�hension du comportement transactionnel d'Hibernate, nous le traitons dans + <xref linkend="transactions"/>. + </para> + + </sect1> + + <sect1 id="objectstate-transitive" revision="1"> + <title>Persistance transitive</title> + + <para> + Il est assez p�nible de sauvegarder, supprimer, ou r�attacher des objets + un par un, surtout si vous traitez un graphe d'objets associ�s. Un cas habituel + est une relation parent/enfant. Consid�rez l'exemple suivant : + </para> + + <para> + Si les enfants de la relation parent/enfant �taient des types de valeur (par exemple, + une collection d'adresses ou de cha�nes de caract�res), leur cycle de vie d�pendraient + du parent et aucune action ne serait requise pour "cascader" facilement les + changements d'�tat. Si le parent est sauvegard�, les objets enfants de type de valeur sont + sauvegard�s �galement, si le parent est supprim�, les enfants sont supprim�s, etc. Ceci + fonctionne m�me pour des op�rations telles que la suppression d'un enfant de la collection ; + Hibernate d�tectera cela et, puisque les objets de type de valeur ne peuvent pas avoir + des r�f�rences partag�es, supprimera l'enfant de la base de donn�es. + </para> + + <para> + Maintenant consid�rez le m�me sc�nario avec un parent et dont les objets enfants + sont des entit�s, et non des types de valeur (par exemple, des cat�gories et des + objets, ou un parent et des chatons). Les entit�s ont leur propre cycle de vie, + supportent les r�f�rences partag�es (donc supprimer une entit� de la collection + ne signifie pas qu'elle peut �tre supprim�e), et il n'y a par d�faut pas de + cascade d'�tat d'une entit� vers n'importe quelle entit� associ�e. Hibernate + n'impl�mente pas la <emphasis>persistance par accessibilit�</emphasis> par d�faut. + </para> + + <para> + Pour chaque op�ration basique de la session d'Hibernate - incluant <literal>persist(), merge(), + saveOrUpdate(), delete(), lock(), refresh(), evict(), replicate()</literal> - il y a un + style de cascade correspondant. Respectivement, les styles de cascade s'appellent <literal>persist, + merge, save-update, delete, lock, refresh, evict, replicate</literal>. Si vous voulez qu'une + op�ration soit cascad�e le long d'une association, vous devez l'indiquer dans le document de + mapping. Par exemple : + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist"/>]]></programlisting> + + <para> + Les styles de cascade peuvent �tre combin�s : + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist,delete,lock"/>]]></programlisting> + + <para> + Vous pouvez m�me utiliser <literal>cascade="all"</literal> pour sp�cifier que <emphasis>toutes</emphasis> + les op�rations devraient �tre cascad�es le long de l'association. La valeur par d�faut + <literal>cascade="none"</literal> sp�cifie qu'aucune op�ration ne sera cascad�e. + </para> + + <para> + Une style de cascade sp�cial, <literal>delete-orphan</literal>, s'applique seulement + aux associations un-vers-plusieurs, et indique que l'op�ration <literal>delete()</literal> + devrait �tre appliqu�e � n'importe quel enfant qui est supprim� de l'association. + </para> + + + <para> + Recommandations : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Cela n'a g�n�ralement aucun sens d'activer la cascade sur une association + <literal><many-to-one></literal> ou <literal><many-to-many></literal>. Les + cascades sont souvent utiles pour des associations + <literal><one-to-one></literal> et <literal><one-to-many></literal>. + </para> + </listitem> + <listitem> + <para> + Si la dur�e de vie de l'objet enfant est li�e � la dur�e de vie de l'objet parent, + faites en un <emphasis>objet du cycle de vie</emphasis> en sp�cifiant + <literal>cascade="all,delete-orphan"</literal>. + </para> + </listitem> + <listitem> + <para> + Sinon, vous pourriez ne pas avoir besoin de cascade du tout. Mais si vous pensez que vous + travaillerez souvent avec le parent et les enfants ensemble dans la m�me transaction, et + que vous voulez vous �viter quelques frappes, consid�rez l'utilisation de + <literal>cascade="persist,merge,save-update"</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + Mapper une association (soit une simple association valu�e, soit une collection) avec + <literal>cascade="all"</literal> marque l'association comme une relation de style + <emphasis>parent/enfant</emphasis> o� la sauvegarde/mise � jour/suppression du parent + entra�ne la sauvegarde/mise � jour/suppression de l'enfant ou des enfants. + </para> + <para> + En outre, une simple r�f�rence � un enfant d'un parent persistant aura pour cons�quence + la sauvegarde/mise � jour de l'enfant. Cette m�taphore est cependant incompl�te. Un enfant + qui devient non r�f�renc� par son parent <emphasis>n'est pas</emphasis> automatiquement + supprim�e, except� dans le cas d'une association <literal><one-to-many></literal> + mapp�e avec <literal>cascade="delete-orphan"</literal>. La s�mantique pr�cise des op�rations + de cascade pour une relation parent/enfant est la suivante : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Si un parent est pass� � <literal>persist()</literal>, tous les enfant sont pass�s � + <literal>persist()</literal> + </para> + </listitem> + <listitem> + <para> + Si un parent est pass� � <literal>merge()</literal>, tous les enfants sont pass�s � + <literal>merge()</literal> + </para> + </listitem> + <listitem> + <para> + Si un parent est pass� � <literal>save()</literal>, <literal>update()</literal> ou + <literal>saveOrUpdate()</literal>, tous les enfants sont pass�s � <literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + Si un enfant d�tach� ou �ph�m�re devient r�f�renc� par un parent persistant, + il est pass� � <literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + Si un parent est supprim�, tous les enfants sont pass�s � <literal>delete()</literal> + </para> + </listitem> + <listitem> + <para> + Si un enfant est d�r�f�renc� par un parent persistant, <emphasis>rien de sp�cial + n'arrive</emphasis> - l'application devrait explicitement supprimer l'enfant si n�cessaire - + � moins que <literal>cascade="delete-orphan"</literal> soit param�tr�, + au quel cas l'enfant "orphelin" est supprim�. + </para> + </listitem> + </itemizedlist> + + <para> + Enfin, la cascade des op�rations peut �tre effectu�e sur un graphe donn� lors + de l'<emphasis>appel de l'op�ration</emphasis> or lors du <emphasis>flush</emphasis> + suivant. Toutes les op�rations, lorsque cascad�es, le sont sur toutes les entit�s + associ�es atteignables lorsque l'op�tation est ex�cut�e. Cependant + <literal>save-upate</literal> et <literal>delete-orphan</literal> sont cascad�es + � toutes les entit�s associ�es atteignables lors du flush de la + <literal>Session</literal>. + </para> + + </sect1> + + <sect1 id="objectstate-metadata"> + <title>Utilisation des m�ta-donn�es</title> + + <para> + Hibernate requiert un mod�le de m�ta-niveau tr�s riche de toutes les entit�s et types valu�s. + De temps en temps, ce mod�le est tr�s utile � l'application elle m�me. Par exemple, + l'application pourrait utiliser les m�ta-donn�es d'Hibernate pour impl�menter un algorithme + de copie en profondeur "intelligent" qui comprendrait quels objets devraient copi�s + (par exemple les types de valeur mutables) et lesquels ne devraient pas l'�tre (par exemple + les types de valeurs immutables et, possiblement, les entit�s associ�es). + </para> + <para> + Hibernate expose les m�ta-donn�es via les interfaces <literal>ClassMetadata</literal> + et <literal>CollectionMetadata</literal> et la hi�rarchie <literal>Type</literal>. + Les instances des interfaces de m�ta-donn�es peuvent �tre obtenues � partir de la + <literal>SessionFactory</literal>. + </para> + + <programlisting><![CDATA[Cat fritz = ......; +ClassMetadata catMeta = sessionfactory.getClassMetadata(Cat.class); + +Object[] propertyValues = catMeta.getPropertyValues(fritz); +String[] propertyNames = catMeta.getPropertyNames(); +Type[] propertyTypes = catMeta.getPropertyTypes(); + +// r�cup�re une Map de toutes les propri�t�s qui ne sont pas des collections ou des associations +Map namedValues = new HashMap(); +for ( int i=0; i<propertyNames.length; i++ ) { + if ( !propertyTypes[i].isEntityType() && !propertyTypes[i].isCollectionType() ) { + namedValues.put( propertyNames[i], propertyValues[i] ); + } +}]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/toolset_guide.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/toolset_guide.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/toolset_guide.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/toolset_guide.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,594 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="toolsetguide" revision="2"> + <title>Guide des outils</title> + + <para> + Des outils en ligne de commande, des plugins Eclipse ainsu que des t�ches Ant permettent de g�rer de cycles de d�veloppement complet + de projets utilisant Hibernate. + </para> + + <para> + Les <emphasis>outils Hibernate</emphasis> actuels incluent des plugins pour l'IDE Eclipse ainsi que des t�ches Ant pour l'ing�nierie + inverse de bases de donn�es existantes : + </para> + + <itemizedlist> + <listitem><para> + <emphasis>Mapping Editor :</emphasis> un �diteur pour les fichiers de mapping XML Hibernate, supportant l'auto-compl�tion et la mise en valeur de la syntaxe. + Il supporte aussi l'auto-compl�tion automatique pour les noms de classes et les noms de propri�t�/champ, + le rendant beaucoup plus polyvalent qu'un �diteurXML normal. + </para></listitem> + <listitem><para> + <emphasis>Console :</emphasis> la console est une nouvelle vue d'Eclipse. En plus de la vue d'ensemble + arborescente de vos configurations de console, vous obtenez aussi une vue interactive de vos classes persistantes et de leurs relations. + La console vous permet d'ex�cuter des requ�te HQL dans votre base de donn�es et de parcourir les r�sultats directement dans Eclipse. + </para></listitem> + <listitem><para> + <emphasis>Development Wizards :</emphasis> plusieurs assistants sont fournis avec les outils d'Hibernate + pour Eclipse ; vous pouvez utiliser un assistant pour g�n�rer rapidement les fichiers de configuration d'Hibernate (cfg.xml), + ou vous pouvez m�me compl�tement g�n�rer les fichiers de mapping Hibernate et les sources des POJOs � partir d'un sch�ma de base de donn�es existant. + L'assistant d'ing�nierie inverse supporte les mod�les utilisateur. + </para></listitem> + <listitem><para> + <emphasis>T�ches Ant :</emphasis> + </para></listitem> + + </itemizedlist> + + <para> + Veuillez-vous r�f�rer au paquet <emphasis>outils Hibernate</emphasis> et sa documentation pour plus d'informations. + </para> + + <para> + Pourtant, le paquet principal d'Hibernate arrive avec un lot d'outils int�gr�s (il peut m�me �tre utilis� de "l'int�rieur" d'Hibernate � la vol�e) : + <emphasis>SchemaExport</emphasis> aussi connu comme + <literal>hbm2ddl</literal>. + </para> + + <sect1 id="toolsetguide-s1" revision="2"> + <title>G�n�ration automatique du sch�ma</title> + + <para> + La DDL peut �tre g�n�r�e � partir de vos fichiers de mapping par un utilitaire d'Hibernate. Le sch�ma g�n�r� + inclut les contraintes d'int�grit� r�f�rentielle (clefs primaires et �trang�res) pour les tables d'entit�s + et de collections. Les tables et les s�quences sont aussi cr��es pour les g�n�rateurs d'identifiant mapp�s. + </para> + + <para> + Vous <emphasis>devez</emphasis> sp�cifier un <literal>Dialect</literal> SQL via la propri�t� + <literal>hibernate.dialect</literal> lors de l'utilisation de cet outils, puisque la DDL est + fortement d�pendante de la base de donn�es. + </para> + + <para> + D'abord, personnalisez vos fichiers de mapping pour am�liorer le sch�ma g�n�r�. + </para> + + <sect2 id="toolsetguide-s1-2" revision="3"> + <title>Personnaliser le sch�ma</title> + + <para> + Plusieurs �l�ments du mapping hibernate d�finissent des attributs optionnels + nomm�s <literal>length</literal>, <literal>precision</literal> et <literal>scale</literal>. + Vous pouvez param�trer la longueur, la pr�cision,... d'une colonne avec ces attributs. + </para> + + <programlisting><![CDATA[<property name="zip" length="5"/>]]></programlisting> + <programlisting><![CDATA[<property name="balance" precision="12" scale="2"/>]]></programlisting> + + <para> + Certains �l�ments acceptent aussi un attribut <literal>not-null</literal> + (utilis� pour g�n�rer les contraintes de colonnes <literal>NOT NULL</literal>) et + un attribut <literal>unique</literal> (pour g�n�rer une contrainte de colonne + <literal>UNIQUE</literal>). + </para> + + <programlisting><![CDATA[<many-to-one name="bar" column="barId" not-null="true"/>]]></programlisting> + <programlisting><![CDATA[<element column="serialNumber" type="long" not-null="true" unique="true"/>]]></programlisting> + + <para> + Un attribut <literal>unique-key</literal> peut �tre utilis� pour grouper les colonnes + en une seule contrainte d'unicit�. Actuellement, la valeur sp�cifi�e par + l'attribut <literal>unique-key</literal> n'est <emphasis>pas</emphasis> utilis�e pour + nommer la contrainte dans le DDL g�n�r�, elle sert juste � grouper les colonnes + dans le fichier de mapping. + </para> + <programlisting><![CDATA[<many-to-one name="org" column="orgId" unique-key="OrgEmployeeId"/> + <property name="employeeId" unique-key="OrgEmployeeId"/>]]></programlisting> + + <para> + Un attribut <literal>index</literal> indique le nom d'un index qui sera + cr�� en utilisant la ou les colonnes mapp�es. Plusieurs colonnes + peuvent �tre group�es dans un m�me index, en sp�cifiant le m�me + nom d'index. + </para> + + <programlisting><![CDATA[<property name="lastName" index="CustName"/> +<property name="firstName" index="CustName"/>]]></programlisting> + + <para> + Un attribut <literal>foreign-key</literal> peut �tre utilis� pour surcharger le nom + des cl�s �trang�res g�n�r�es. + </para> + + <programlisting><![CDATA[<many-to-one name="bar" column="barId" foreign-key="FKFooBar"/>]]></programlisting> + + <para> + Plusieurs �l�ments de mapping acceptent aussi un �l�ment fils <literal><column></literal>. + Ceci est utile pour les type multi-colonnes: + </para> + + <programlisting><![CDATA[<property name="name" type="my.customtypes.Name"/> + <column name="last" not-null="true" index="bar_idx" length="30"/> + <column name="first" not-null="true" index="bar_idx" length="20"/> + <column name="initial"/> +</property>]]></programlisting> + + <para> + L'attribut <literal>default</literal> vous laisse sp�cifier une valeur par d�faut pour + une colonnes (vous devriez assigner la m�me valeur � la propri�t� mapp�e avant de sauvegarder une nouvelle instance + de la classe mapp�e). + </para> + + <programlisting><![CDATA[<property name="credits" type="integer" insert="false"> + <column name="credits" default="10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<version name="version" type="integer" insert="false"> + <column name="version" default="0"/> +</property>]]></programlisting> + + <para> + L'attribut <literal>sql-type</literal> laisse l'utilisateur surcharger le mapping + par d�faut du type Hibernate vers un type SQL. + </para> + + <programlisting><![CDATA[<property name="balance" type="float"> + <column name="balance" sql-type="decimal(13,3)"/> +</property>]]></programlisting> + + + <para> + L'attribut <literal>check</literal> permet de sp�cifier une contrainte de v�rification. + </para> + + <programlisting><![CDATA[<property name="foo" type="integer"> + <column name="foo" check="foo > 10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<class name="Foo" table="foos" check="bar < 100.0"> + ... + <property name="bar" type="float"/> +</class>]]></programlisting> + + + <table frame="topbot" id="schemattributes-summary" revision="2"> + <title>Summary</title> + <tgroup cols="3"> + <colspec colwidth="1*"/> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>Attribut</entry> + <entry>Valeur</entry> + <entry>Interpr�tation</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>length</literal></entry> + <entry>num�rique</entry> + <entry>taille d'une colonne</entry> + </row> + <row> + <entry><literal>precision</literal></entry> + <entry>num�rique</entry> + <entry>pr�cision d�cimale de la colonne</entry> + </row> + <row> + <entry><literal>scale</literal></entry> + <entry>num�rique</entry> + <entry>scale d�cimale de la colonne</entry> + </row> + <row> + <entry><literal>not-null</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>sp�cifie que la colonne doit �tre non-nulle</entry> + </row> + <row> + <entry><literal>unique</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>sp�cifie que la colonne doit avoir une contrainte d'unicit�</entry> + </row> + <row> + <entry><literal>index</literal></entry> + <entry><literal>index_name</literal></entry> + <entry>sp�cifie le nom d'un index (multi-colonnes)</entry> + </row> + <row> + <entry><literal>unique-key</literal></entry> + <entry><literal>unique_key_name</literal></entry> + <entry>sp�cifie le nom d'une contrainte d'unicit� multi-colonnes</entry> + </row> + <row> + <entry><literal>foreign-key</literal></entry> + <entry><literal>foreign_key_name</literal></entry> + <entry> + sp�cifie le nom d'une contrainte de cl� �trang�re g�n�r�e pour + une association, utilisez-la avec les �l�ments de mapping + <one-to-one>, <many-to-one>, <key>, et <many-to-many> + Notez que les extr�mit�s <literal>inverse="true"</literal> + se seront pas prises en compte par <literal>SchemaExport</literal>. + </entry> + </row> + <row> + <entry><literal>sql-type</literal></entry> + <entry><literal>SQL column_type</literal></entry> + <entry> + surcharge le type par d�faut (attribut de + l'�l�ment <literal><column></literal> uniquement) + </entry> + </row> + <row> + <entry><literal>default</literal></entry> + <entry>expression SQL</entry> + <entry> + sp�cifie une valeur par d�faut pour la colonne + </entry> + </row> + <row> + <entry><literal>check</literal></entry> + <entry>SQL expression</entry> + <entry> + cr�e une contrainte de v�rification sur la table ou la colonne + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + L'�l�ment <literal><comment></literal> vous permet de sp�cifier un commentaire pour le sch�ma g�n�r�. + </para> + + <programlisting><![CDATA[<class name="Customer" table="CurCust"> + <comment>Current customers only</comment> + ... +</class>]]></programlisting> + + <programlisting><![CDATA[<property name="balance"> + <column name="bal"> + <comment>Balance in USD</comment> + </column> +</property>]]></programlisting> + + <para> + Ceci a pour r�sultat une expression + <literal>comment on table</literal> ou + <literal>comment on column</literal> dans la DDL g�n�r�e (o� support�e). + </para> + + </sect2> + + <sect2 id="toolsetguide-s1-3" revision="2"> + <title>Ex�cuter l'outil</title> + + <para> + L'outil <literal>SchemaExport</literal> g�n�re un script DDL vers + la sortie standard et/ou ex�cute les ordres DDL. + </para> + + <para> + <literal>java -cp </literal><emphasis>classpath_hibernate</emphasis> + <literal>net.sf.hibernate.tool.hbm2ddl.SchemaExport</literal> <emphasis>options fichiers_de_mapping</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaExport</literal> Options de la ligne de commande</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>ne pas �crire le script vers la sortie standard</entry> + </row> + <row> + <entry><literal>--drop</literal></entry> + <entry>supprime seuleument les tables</entry> + </row> + <row> + <entry><literal>--create</literal></entry> + <entry>ne cr�� que les tables</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>ne pas ex�cuter sur la base de donn�es</entry> + </row> + <row> + <entry><literal>--output=my_schema.ddl</literal></entry> + <entry>�crit le script ddl vers un fichier</entry> + </row> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>s�lectionne une <literal>NamingStrategy</literal></entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>lit la configuration Hibernate � partir d'un fichier XML</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>lit les propri�t�s de la base de donn�es � partir d'un fichier</entry> + </row> + <row> + <entry><literal>--format</literal></entry> + <entry>formatte proprement le SQL g�n�r� dans le script</entry> + </row> + <row> + <entry><literal>--delimiter=x</literal></entry> + <entry>param�tre un d�limiteur de fin de ligne pour le script</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Vous pouvez m�me int�grer <literal>SchemaExport</literal> dans votre application : + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaExport(cfg).create(false, true);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-4"> + <title>Propri�t�s</title> + + <para> + Les propri�t�s de la base de donn�es peuvent �tre sp�cifi�es + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para>comme propri�t�s syst�me avec <literal>-D</literal><emphasis><property></emphasis></para> + </listitem> + <listitem> + <para>dans <literal>hibernate.properties</literal></para> + </listitem> + <listitem> + <para>dans un fichier de propri�t�s d�clar� avec <literal>--properties</literal></para> + </listitem> + </itemizedlist> + + <para> + Les propri�t�s n�cessaires sont : + </para> + + <table frame="topbot"> + <title>SchemaExport Connection Properties</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Nom de la propri�t�</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>hibernate.connection.driver_class</literal></entry> + <entry>classe du driver JDBC</entry> + </row> + <row> + <entry><literal>hibernate.connection.url</literal></entry> + <entry>URL JDBC</entry> + </row> + <row> + <entry><literal>hibernate.connection.username</literal></entry> + <entry>utilisateur de la base de donn�es</entry> + </row> + <row> + <entry><literal>hibernate.connection.password</literal></entry> + <entry>mot de passe de l'utilisateur</entry> + </row> + <row> + <entry><literal>hibernate.dialect</literal></entry> + <entry>dialecte</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="toolsetguide-s1-5"> + <title>Utiliser Ant</title> + + <para> + Vous pouvez appeler <literal>SchemaExport</literal> depuis votre script + de construction Ant : + </para> + + <programlisting><![CDATA[<target name="schemaexport"> + <taskdef name="schemaexport" + classname="org.hibernate.tool.hbm2ddl.SchemaExportTask" + classpathref="class.path"/> + + <schemaexport + properties="hibernate.properties" + quiet="no" + text="no" + drop="no" + delimiter=";" + output="schema-export.sql"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaexport> +</target>]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-6" revision="2"> + <title>Mises � jour incr�mentales du sch�ma</title> + + <para> + L'outil <literal>SchemaUpdate</literal> mettra � jour un sch�ma existant + en effectuant les changement par "incr�ment". + Notez que <literal>SchemaUpdate</literal> d�pends beaucoup de l'API JDBC + metadata, il ne fonctionnera donc pas avec tous les drivers JDBC. + </para> + + <para> + <literal>java -cp </literal><emphasis>classpath_hibernate</emphasis> + <literal>net.sf.hibernate.tool.hbm2ddl.SchemaUpdate</literal> <emphasis>options fichiers_de_mapping</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaUpdate</literal> Options de ligne de commande</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>ne pas �crire vers la sortie standard</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>ne pas exporter vers la base de donn�es</entry> + </row> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>choisit une <literal>NamingStrategy</literal></entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>lire les propri�t�s de la base de donn�es � partir d'un fichier</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Vous pouvez int�grer <literal>SchemaUpdate</literal> dans votre application : + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaUpdate(cfg).execute(false);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-7"> + <title>Utiliser Ant pour des mises � jour de sch�ma par incr�ment</title> + + <para> + Vous pouvez appeler <literal>SchemaUpdate</literal> depuis le script Ant : + </para> + + <programlisting><![CDATA[<target name="schemaupdate"> + <taskdef name="schemaupdate" + classname="org.hibernate.tool.hbm2ddl.SchemaUpdateTask" + classpathref="class.path"/> + + <schemaupdate + properties="hibernate.properties" + quiet="no"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaupdate> +</target>]]></programlisting> + + <sect2 id="toolsetguide-s1-8" revision="1"> + <title>Validation du sch�ma</title> + + <para> + L'outil <literal>SchemaValidator</literal> validera que le sch�ma existant correspond � vos documents de mapping. + Notez que le <literal>SchemaValidator</literal> d�pends de l'API metadata de JDBC, il ne fonctionnera + donc pas avec tous les drivers JDBC. Cet outil est extr�mement utile pour tester. + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaValidator</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaValidator</literal> Options de ligne de commande</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>Indique une <literal>NamingStrategy</literal></entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>lit les propri�t�s dela base de donn�es depuis un fichier de propri�t�s</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>indique un fichier <literal>.cfg.xml</literal></entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Vous pouvez inclure <literal>SchemaValidator</literal> dans votre application: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaValidator(cfg).validate();]]></programlisting> + + </sect2> + + </sect2> + <sect2 id="toolsetguide-s1-9"> + <title>Utiliser Ant pour la validation du Sch�ma</title> + + <para> + Vous pouvez appeler <literal>SchemaValidator</literal> depuis le script Ant: + </para> + + <programlisting><![CDATA[<target name="schemavalidate"> + <taskdef name="schemavalidator" + classname="org.hibernate.tool.hbm2ddl.SchemaValidatorTask" + classpathref="class.path"/> + + <schemavalidator + properties="hibernate.properties"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemavalidator> +</target>]]></programlisting> + + </sect2> + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/transactions.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/transactions.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/transactions.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/transactions.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1074 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="transactions" revision="2"> + <title>Transactions et acc�s concurrents</title> + + <para> + L'un des principaux avantages du m�canisme de contr�le des acc�s concurrents d'Hibernate est qu'il est tr�s + facile � comprendre. Hibernate utilise directement les connexions JDBC ainsi que les ressources JTA sans y + ajouter davantage de m�canisme de blocage. Nous vous recommandons de vous familiariser avec les sp�cifications + JDBC, ANSI et d'isolement de transaction de la base de donn�es que vous utilisez. + </para> + + <para> + Hibernate ne v�rouille pas vos objets en m�moire. Votre application peut suivre le + comportement d�fini par le niveau d'isolation de vos transactions de base de donn�es. + Notez que gr�ce � la <literal>Session</literal>, qui est aussi un cache de scope transaction, Hibernate + fournit des lectures r�p�t�es pour les r�cup�ration par identifiants et les requ�tes + d'entit�s (pas celle de valeurs scalaires). + </para> + + <para> + En addition au versionning pour le controle automatique de concurrence, Hibernate fournit + une API (mineure) pour le verrouillage perssimiste des enregistrements, en g�n�rant + une syntaxe <literal>SELECT FOR UPDATE</literal>. Le controle de concurrence optimiste + et cette API seront d�taill�s plus tard dans ce chapitre. + </para> + + <para> + Nous aborderons la gestion des acc�s concurrents en discutant de la granularit� des objets <literal>Configuration</literal>, + <literal>SessionFactory</literal>, et <literal>Session</literal>, ainsi que de certains concepts relatifs � la base de donn�es + et aux longues transactions applicatives. + </para> + + <sect1 id="transactions-basics" revision="1"> + <title>Gestion de session et d�limitation de transactions</title> + + <para>Il est important de savoir qu'un objet <literal>SessionFactory</literal> est un objet complexe et optimis� pour + fonctionner avec les threads(thread- safe). Il est co�teux � cr�er et est ainsi pr�vu pour n'�tre instanci� qu?une + seule fois via un objet <literal>Configuration</literal> au d�marrage de l'application, + et �tre partag� par tous les threads d'une application. + </para> + + <para>Un objet <literal>Session</literal> est relativement simple et n'est threadsafe. Il est �galement peu + co�teux � cr�er. Il devrait n'�tre utilis� qu'une seule fois, pour un processus d'affaire ou une unit� de + travail ou une conversation et ensuite �tre rel�ch�. Un objet <literal>Session</literal> ne tentera pas + d'obtenir de connexion ( <literal>Connection</literal> ) + JDBC (ou de <literal>Datasource</literal> ) si ce n'est pas n�cessaire. + </para> + + <para>Afin de compl�ter ce tableau, vous devez �galement penser aux transactions de base de donn�es. Une + transaction de base de donn�es se doit d'�tre la plus courte possible afin de r�duire les risques de + collision sur des enregistrements verrouill�s. De longues transactions � la base de donn�es nuiront � + l'extensibilit� de vos applications lorsque confront�es � de hauts niveaux de charge. Par cons�quent, + il n'est jamais bon de maintenir une transaction ouverte pendant la dur�e de reflexion de l'utilisateur, + jusqu'a ce que l'unit� de travail soit achev�e. + </para> + + <para>Maintenant, comment d�limiter une unit� de travail? Est-ce qu'une instance de <literal>Session</literal> peut avoir une dur�e + de vie d�passant plusieurs transactions � la base de donn�es, ou bien est-ce que celles-ci doivent �tre li�es une � une? + Quand faut-il ouvrir et fermer une <literal>Session</literal> ? Comment d�finir la d�marcation de vos transactions � la base de donn�es? + </para> + + <sect2 id="transactions-basics-uow" revision="1"> + <title>Unit� de travail</title> + + <para> + Il est important de mentionner que d'utiliser un paradigme <emphasis>session-par-operation</emphasis> + est un anti-pattern. Autrement dit: n'ouvrez et ne fermez pas la + <literal>Session</literal> � chacun de vos acc�s simples � la base de donn�es dans un m�me thread! Bien s�r, le m�me raisonnement + s'applique sur la gestion des transactions � la base de donn�es. Les appels � la base de donn�es + devraient �tre faits en ordre et selon une s�quence d�finie. Ils devraient �galement �tre regroup�s en + des unit�s de travail atomiques. (Notez que l?utilisation d?une connexion auto-commit constitue le m�me + anti-pattern. Ce mode de fonctionnement existe pour les applications �mettant des commandes SQL � partir + d?une console. Hibernate d�sengage le mode auto-commit et s'attend � ce qu'un serveur d'applications le + fasse �galement.) + Les transactions avec la base de donn�es ne sont jamais optionnelles, toute communication + avec une base de donn�es doit se d�rouler dans une transaction, peu importe si vous lisez + ou �crivez des donn�es. Comme �voqu�, le comportement auto-commit pour lire les + donn�es devrait �tre �vit�, puisque plusieurs petites transactions ne seront jamais + aussi efficaces qu'une seule plus grosse clairement d�finie comme unit� de travail. + Ce dernier choix et en plus beaucoup plus facile a maintenir et � faire �voluer. + </para> + + <para> + Le pattern d'utilisation le plus fr�quemment rencontr� dans des applications clients serveur + multi-usagers est le <emphasis>session-per-request</emphasis> + (litt�ralement : Session par requ�te). Dans ce mod�le, la requ�te d'un client est envoy�e � un serveur + (O� la couche de persistance est impl�ment�e via Hibernate), une nouvelle + <literal>Session</literal> est ouverte et toutes les op�rations d'acc�s � la base de donn�es sont ex�cut�es � l'int�rieur de + celle-ci. Lorsque le travail est termin� (et que les r�ponses � envoyer au client ont �t� pr�par�es), la + session est flush�e et ferm�e. Une seule transaction � la base de donn�es peut �tre utilis�e pour r�pondre + � la requ�te du client. La transaction est d�marr�e et valid�e au m�me moment o� la Session est ouverte + et ferm�e. La relation entre la <literal>Session</literal> et la <literal>Transaction</literal> est donc one-to-one. + Ce mod�le permet de r�pondre parfaitement aux attentes de la grande majorit� des + applications. + </para> + + <para> + Le d�fi r�side dans l'impl�mentation. Hibernate fournit une fonction de gestion de + la "session courante" pour simplifier ce pattern. Tout ce que vous devez faire + est d�marrer une transaction lorsqu'une requ�te est trait�e par le serveur, et + la terminer avant que la r�ponse ne soit envoy�e au client. Vous pouvez le faire + de la mani�re que vous voulez, les solutions communes sont un <literal>ServletFilter</literal>, + l'interception via AOP avec une pointcut sur les m�thodes de type "service", ou un conteneur + avec interception/proxy. Un conteneur EJB est un moyen standard d'impl�menter ce genre d'acpect + tranverse comme la d�marcation des transactions sur les EJBs session, de mani�re d�clarative + avec CMT. Si vous d�cidez d'utiliser la d�marcation programmatique des transactions, pr�ferrez + l'API Hibernate <literal>Transaction</literal> d�taill�e plus tard dans ce chapitre, afin de + facilit� l'utilisation et la portabilit� du code. + </para> + + <para> + Votre application peut acc�der la "session courante" pour ex�cuter une requ�te + en invoquant simplement <literal>sessionFactory.getCurrentSession()</literal> n'importe o� + et autant de fois que souhait�. Vous obtiendrez toujours une <literal>Session</literal> + dont le scope est la transaction courante avec la base de donn�es. Ceci doit �tre configur� + soit dans les ressources local ou dans l'environnement JTA, voir <xref linkend="architecture-current-session"/>. + </para> + + <para> + Il est parfois utile d'�tendre le scope d'une <literal>Session</literal> et d'une transaction + � la base de donn�es jusqu'� ce que "la vue soit rendue". Ceci est particuli�rement + utile dans des applications � base de servlet qui utilisent une phase de rendue s�par�e une fois + que la r�ponse a �t� pr�par�e. Etendre la transaction avec la base de donn�es jusqu'� la fin du + rendering de la vue est ais� si vous impl�mentez votre propre intercepteur. Cependant, + ce n'est pas facile si vous vous appuyez sur les EJBs avec CMT, puisqu'une transaction sera + achev�e au retour de la m�thode EJB, avant le rendu de la vue. Rendez vous sur le site + Hibernate et sur le forum pour des astuces et des exemples sur le pattern + <emphasis>Open Session in View</emphasis> pattern.. + </para> + </sect2> + + <sect2 id="transactions-basics-apptx" revision="1"> + <title>Longue conversation</title> + + <para>Le paradigme + <emphasis>session-per-request</emphasis> + n'est pas le seul �l�ment � utiliser dans le design de vos unit�s de travail. Plusieurs processus + d'affaire requi�rent toute une s�rie d'interactions avec l'utilisateur, entrelac�es d'acc�s � la base de + donn�e. Dans une application Web ou une application d'entreprise, il serait inacceptable que la dur�e de + vie d'une transaction s'�tale sur plusieurs interactions avec l'usager. Consid�rez l'exemple suivant: + </para> + + <itemizedlist> + <listitem> + <para>Un �cran s'affiche. Les donn�es vues par l'usager ont �t� charg�es dans l'instance d'un objet + <literal>Session</literal> , dans le cadre d'une transaction de base de donn�es. L'usager est libre de modifier ces objets. + </para> + </listitem> + <listitem> + + <para>L'usager clique "Sauvegarder" apr�s 5 minutes et souhaite persister les modifications qu'il a + apport�es. Il s'attend � �tre la seule personne a avoir modifi� ces donn�es et qu'aucune + modification conflictuelle ne se soit produite durant ce laps de temps.</para> + </listitem> + </itemizedlist> + + <para>Ceci s'appelle une unit� de travail. Du point de vue de l'utilisateur: une + <emphasis>conversation</emphasis> (ou <emphasis>transaction d'application</emphasis>). + Il y a plusieurs fa�on de mettre ceci en place dans votre application. + </para> + + <para>Une premi�re impl�mentation na�ve pourrait consister � garder la + <literal>Session</literal> et la transaction � la base de donn�es ouvertes durant le temps de travail de l'usager, � maintenir les + enregistrements verrouill�s dans la base de donn�es afin d'�viter des modifications concurrentes et de + maintenir l'isolation et l'atomicit� de la transaction de l'usager. Ceci est un anti-pattern � �viter, + puisque le verrouillage des enregistrements dans la base de donn�es ne permettrait pas � l'application + de g�rer un grand nombre d'usagers concurrents. + </para> + + <para>Il appara�t donc �vident qu'il faille utiliser plusieurs transactions BDD afin d'impl�menter la + conversation. Dans ce cas, maintenir l'isolation des processus d'affaire devient + partiellement la responsabilit� de la couche applicative. Ainsi, la dur�e de vie d'une conversation + devrait englober celle d'une ou de plusieurs transactions de base de donn�es. Celle-ci sera + atomique seulement si l'�criture des donn�es mises � jour est faite exclusivement par la derni�re + transaction BDD la composant. Toutes les autres sous transactions BD ne doivent faire que la lecture de + donn�es. Ceci est relativement facile � mettre en place, surtout avec l'utilisation de certaines + fonctionnalit�s d'Hibernate: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Versionnage Automatique</emphasis> + - Hibernate peut g�rer automatiquement les acc�s concurrents de mani�re optimiste et d�tecter si + une modification concurrente s'est produite durant le temps de r�flexion d'un usager. + </para> + </listitem> + <listitem> + <para> + <emphasis>Objets D�tach�s</emphasis> + - Si vous d�cidez d'utiliser le paradigme + <emphasis>session-par-requ�te</emphasis> + discut� plus haut, toutes les entit�s charg�es en m�moire deviendront des objets d�tach�s durant + le temps de r�flexion de l'usager. Hibernate vous permet de rattacher ces objets et de persister + les modifications y ayant �t� apport�es. Ce pattern est appel�: + <emphasis>session-per- request-with-detached-objects</emphasis> + (litt�ralement: session- par-requ�te-avec-objets-d�tach�s). Le versionnage automatique est + utilis� afin d'isoler les modifications concurrentes. + </para> + </listitem> + <listitem> + <para> + <emphasis>Session Longues (conversation)</emphasis> + - Une + <literal>Session</literal> Hibernate peut �tre d�connect�e de la couche JDBC sous-jacente apr�s que commit() ait �t� appel� + sur une transaction � la base de donn�es et reconnect�e lors d'une nouvelle requ�te-client. Ce + pattern s'appelle: + <emphasis>session-per-conversation</emphasis> + (Litt�ralement: session-par- conversation) et rend superflu le rattachement des + objets. Le versionnage automatique est utilis� afin d'isoler les modifications concurrentes. + </para> + </listitem> + </itemizedlist> + + <para>Les deux patterns + <emphasis>session-per-request-with- detached- objects</emphasis> + (session-par-requ�te-avec-objets- d�tach�s) et + <emphasis>session-per-conversation</emphasis> + (session-par-conversation) ont chacun leurs avantages et d�savantages qui seront expos�s + dans ce m�me chapitre, dans la section au sujet du contr�le optimiste de concurrence. + </para> + + </sect2> + + <sect2 id="transactions-basics-identity"> + <title>L'identit� des objets</title> + + <para>Une application peut acc�der � la m�me entit� persistante de mani�re concurrente dans deux + <literal>Session</literal> s diff�rentes. Toutefois, une instance d'une classe persistante n'est jamais partag�e par deux instances + distinctes de la classe + <literal>Session</literal> . Il existe donc deux notions de l'identit� d'un objet: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>Identit� BD</term> + <listitem> + <para> + <literal>foo.getId().equals( bar.getId() )</literal> </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Identit� JVM</term> + <listitem> + <para> + <literal>foo==bar</literal> </para> + </listitem> + </varlistentry> + </variablelist> + + <para>Ainsi, pour des objets attach�s � une + <literal>Session</literal> <emphasis>pr�cise</emphasis> + (dans la cadre d'ex�cution (scope) d'une instance de + <literal>Session</literal> ), ces deux notions d'identit� sont �quivalentes et garanties par Hibernate. Par contre, si une + application peut acc�der de mani�re concurrente � la m�me entit� persistante dans deux sessions + diff�rentes, les deux instances seront en fait diff�rentes (en ce qui a trait � l'identit� JVM). Les + conflits sont r�solus automatiquement par approche optimiste gr�ce au syst�me de versionnage automatique + lorsque + <literal>Session.flush()</literal> ou + <literal>Transaction.commit()</literal> est appel�. + </para> + + <para>Cette approche permet de rel�guer � Hibernate et � la base de donn�es sous-jacente le soin de g�rer + les probl�mes d'acc�s concurrents. Cette mani�re de faire assure �galement une meilleure extensibilit� + de l'application puisque assurer l'identit� JVM dans un thread ne n�cessite pas de m�canismes de + verrouillage co�teux ou d'autres dispositifs de synchronisation. Une application n'aura jamais le besoin + de synchroniser des objets d'affaire tant qu'elle peut garantir qu'un seul thread aura acc�s � une + instance de + <literal>Session</literal> . Dans le cadre d'ex�cution d'un objet + <literal>Session</literal> , l'application peut utiliser en toute s�curit� <literal>== + </literal> pour comparer des objets. + </para> + + <para> + Une application qui utiliserait <literal>==</literal> � l'ext�rieur du cadre d'ex�cution d'une <literal>Session</literal> + pourrait obtenir des r�sultats inattendus et causer certains effets de bords. Par exemple, si vous mettez 2 + objets dans le m�me <literal>Set</literal> , ceux-ci pourraient avoir la m�me identit� BD (i.e. ils repr�sentent le m�me enregistrement), mais leur + identit� JVM pourrait �tre diff�rente (elle ne peut, par d�finition, pas �tre garantie sur deux objets + d�tach�s). Le d�veloppeur doit donc red�finir l'impl�mentation des m�thodes <literal>equals()</literal> et <literal>hashcode()</literal> + dans les classes persistantes et y adjoindre sa propre notion d'identit�. Il existe toutefois une + restriction: Il ne faut jamais utiliser uniquement l'identifiant de la base de donn�es dans l'impl�mentation + de l'�galit�; Il faut utiliser une cl� d'affaire, g�n�ralement une combinaison de plusieurs attributs + uniques, si possible immuables. Les identifiants de base de donn�es vont changer si un objet transitoire + (transient) devient persistant. Si une instance transitoire est contenue dans un <literal>Set</literal> , + changer le hashcode brisera le contrat du <literal>Set</literal> . Les attributs pour les cl�s d'affaire + n'ont pas � �tre aussi stables que des cl�s primaires de bases de + donn�es. Il suffit simplement qu'elles soient stables tant et aussi longtemps que les objets sont dans le + m�me <literal>Set</literal> . Veuillez consulter le site web Hibernate pour des discussions plus pointues � ce sujet. Notez que ce + concept n'est pas propre � Hibernate mais bien g�n�ral � l'impl�mentation de l'identit� et de l'�galit� en + Java. + </para> + </sect2> + + + <sect2 id="transactions-basics-issues"> + <title>Probl�mes communs</title> + + <para>Bien qu'il puisse y avoir quelques rares exceptions � cette r�gle, il est recommand� de ne jamais utiliser + les anti-patterns + <emphasis>session-per- user-session</emphasis> + et + <emphasis>session-per-application</emphasis> + . Vous trouverez ici- bas quelques probl�mes que vous risquez de rencontrer si vous en faite l?utilisation. + (Ces probl�mes pourraient quand m�me survenir avec des patterns recommand�s) Assurez-vous de bien comprendre + les implications de chacun des patterns avant de prendre votre d�cision. + </para> + + <itemizedlist> + <listitem> + <para>L'objet + <literal>Session</literal> n?est pas con�u pour �tre utilis� par de multiples threads. En cons�quence, les objets + potentiellement multi-thread comme les requ�tes HTTP, les EJB Session et Swing Worker, risquent de + provoquer des conditions de course dans la + <literal>Session</literal> si celle-ci est partag�e. Dans un environnement web classique, il serait pr�f�rable de synchroniser + les acc�s � la session http afin d?�viter qu?un usager ne recharge une page assez rapidement pour + que deux requ�tes s?ex�cutant dans des threads concurrents n?utilisent la m�me + <literal>Session</literal> . + </para> + </listitem> + <listitem> + <para>Lorsque Hibernate lance une exception, le roll back de la transaction en cours doit �tre effectu� + et la + <literal>Session</literal> doit �tre imm�diatement ferm�e. (Ceci sera explor� plus tard dans le chapitre.) Si la + <literal>Session</literal> est directement associ�e � une application, il faut arr�ter l?application. Le roll back de la + transaction ne remettra pas les objets dans leur �tat du d�but de la transaction. Ainsi, ceux-ci + pourraient �tre d�synchronis�s d?avec les enregistrements. (G�n�ralement, cela ne cause pas de r�els + probl�mes puisque la plupart des exceptions sont non traitables et requi�rent la reprise du + processus d?affaire ayant �chou�.) + </para> + </listitem> + <listitem> + <para>La + <literal>Session</literal> met en m�moire cache tous les objets persistants (les objets surveill�s et dont l'�tat est g�r� par + Hibernate.) Si la + <literal>Session</literal> est ouverte ind�finiment ou si une trop grande quantit� d'objets y est charg�e, l?utilisation de la + m�moire peut potentiellement cro�tre jusqu?� atteindre le maximum allouable � l?application + (java.lang.OutOfMemoryError.) Une solution � ce probl�me est d?appeler les m�thodes + <literal>Session.clear()</literal> et + <literal>Session.evict()</literal> pour g�rer la m�moire cache de la + <literal>Session</literal> . Vous pouvez �galement utiliser des stored procedures si vous devez lancer des traitements sur de + grandes quantit�s d?informations. Certaines solutions sont d�crites ici : + <xref linkend="batch"/> + . Garder une + <literal>Session</literal> ouverte pour toute la dur�e d?une session usager augmente �galement consid�rablement le risque de + travailler avec de l?information p�rim�e. + </para> + </listitem> + </itemizedlist> + + </sect2> +</sect1> + +<sect1 id="transactions-demarcation"> + <title>D�marcation des transactions</title> + + <para>La d�marcation des transactions est importante dans le design d?une application. Aucune communication avec la + base de donn�es ne peut �tre effectu�e � l?ext�rieur du cadre d?une transaction. (Il semble que ce concept soit + mal compris par plusieurs d�veloppeurs trop habitu�s � utiliser le mode auto-commit.) M�me si certains niveaux + d'isolation et certaines possibilit�s offertes par les bases de donn�es permettent de l?�viter, il n'est jamais + d�savantageux de toujours explicitement indiquer les bornes de transaction pour les op�rations complexes comme + pour les op�rations simples de lecture.</para> + + <para>Une application utilisant Hibernate peut s'ex�cuter dans un environnement l�ger n?offrant pas la gestion + automatique des transactions (application autonome, application web simple ou applications Swing) ou dans un + environnement J2EE offrant des services de gestion automatique des transactions JTA. Dans un environnement + simple, Hibernate a g�n�ralement la responsabilit� de la gestion de son propre pool de connexions � la base de + donn�es. Le d�veloppeur de l'application doit manuellement d�limiter les transactions. En d'autres mots, il + appartient au d�veloppeur de g�rer les appels � + <literal>Transaction.begin()</literal> + , + <literal>Transaction.commit()</literal> + et + <literal>Transaction.rollback()</literal> + . Un environnement transactionnel J2EE (serveur d'application J2EE) doit offrir la gestion des transactions au + niveau du container J2EE. Les bornes de transaction peuvent normalement �tre d�finies de mani�re d�clarative + dans les descripteurs de d�ploiement d'EJB Session, par exemple. La gestion programmatique des transactions n'y + est donc pas n�cessaire. M�me les appels � + <literal>Session.flush()</literal> + sont faits automatiquement. + </para> + + <para>Il peut �tre requis d'avoir une couche de persistance portable. Hibernate offre donc une API appel�e + <literal>Transaction</literal> + qui sert d'enveloppe pour le syst�me de transaction natif de l'environnement de d�ploiement. Il n'est pas + obligatoire d'utiliser cette API mais il est fortement conseill� de le faire, sauf lors de l'utilisation de CMT + Session Bean (EJB avec transactions g�r�es automatiquement par le container EJB). + </para> + + <para>Il existe quatre �tapes disctinctes lors de la fermeture d'une + <literal>Session</literal> + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para>flush de la session</para> + </listitem> + <listitem> + <para>commit de la transaction</para> + </listitem> + <listitem> + <para>Fermeture de la session (Close)</para> + </listitem> + <listitem> + <para>Gestion des exceptions</para> + </listitem> + </itemizedlist> + + <para>La synchronisation de bdd depuis la session (flush) a d�j� �t� expliqu�, nous nous attarderons maintenant � la d�marcation des + transactions et � la gestion des exceptions dans les environnements l�gers et les environnements J2EE.</para> + + + <sect2 id="transactions-demarcation-nonmanaged" revision="2"> + <title>Environnement non manag�</title> + + <para> + Si la couche de persistance Hibernate s'ex�cute dans un environnement non manag�, les connexions � la base de + donn�es seront g�n�ralement prises en charge par le m�canisme de pool d'Hibernate. La gestion de la session + et de la transaction se fera donc de la mani�re suivante:</para> + + <programlisting><![CDATA[// Non-managed environment idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + Vous n'avez pas � invoquer <literal>flush()</literal> explicitement sur la <literal>Session</literal> - + l'appel de <literal>commit()</literal> d�clenchera automatiquement la synchronisation (selon le <xref linkend="objectstate-flushing">FlushMode</xref> + de la session. Un appel � <literal>close()</literal> marque la fin de la session. + La cons�quence directe est que la connexion � la base de donn�es sera relach�e par la session. + Ce code est portable est fonctionne dans les environnements non manag� ET les environnements JTA. + </para> + + <para> + Une solution plus flexible est la gestion par contexte fourni par Hibernate que nous avons + d�j� rencontr�: + </para> + + <programlisting><![CDATA[// Non-managed environment idiom with getCurrentSession() +try { + factory.getCurrentSession().beginTransaction(); + + // do some work + ... + + factory.getCurrentSession().getTransaction().commit(); +} +catch (RuntimeException e) { + factory.getCurrentSession().getTransaction().rollback(); + throw e; // or display error message +}]]></programlisting> + + <para> + Vous ne verrez probablement jamais ces exemples de code dans les applications; + les exceptions fatales (exceptions du syst�me) ne devraient �tre trait�es que + dans la couche la plus "haute". En d'autres termes, le code qui ex�cute les appels + � Hibernate (� la couche de persistance) et le code qui g�re les + <literal>RuntimeException</literal> (qui ne peut g�n�ralement effectuer qu'un nettoyage et une sortie) + sont dans des couches diff�rentes. La gestion du contexte courant par Hibernate peut + simplifier notablement ce design, puisque vous devez acc�der � la gestion des exceptions + de la <literal>SessionFactory</literal>, ce qui est d�crit plus tard dans ce chapitre. + </para> + + <para> + Notez que vous devriez s�lectionner <literal>org.hibernate.transaction.JDBCTransactionFactory</literal> + (le d�faut), pour le second exemple <literal>"thread"</literal> comme + <literal>hibernate.current_session_context_class</literal>. + </para> + + </sect2> + + <sect2 id="transactions-demarcation-jta" revision="2"> + <title>Utilisation de JTA</title> + + <para>Si votre couche de persistance s'ex�cute dans un serveur d'application (par exemple, derri�re un EJB + Session Bean), toutes les datasource utilis�es par Hibernate feront automatiquement partie de transactions + JTA globales. Hibernate propose deux strat�gies pour r�ussir cette int�gration.</para> + + <para> + Si vous utilisez des transactions g�r�es par un EJB (bean managed transactions - BMT), Hibernate informera + le serveur d'application du d�but et de la fin des transactions si vous utilisez l'API <literal>Transaction</literal> . + Ainsi, le code de gestion des transactions sera identique dans les deux types d'environnements. + </para> + + <programlisting><![CDATA[// BMT idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para>Ou encore, avec la gestion automatique de contexte:</para> + + <programlisting><![CDATA[// BMT idiom with getCurrentSession() +try { + factory.getCurrentSession().beginTransaction(); + + // do some work + ... + + factory.getCurrentSession().getTransaction().commit(); +} +catch (RuntimeException e) { + factory.getCurrentSession().getTransaction().rollback(); + throw e; // or display error message +}]]></programlisting> + + <para> + Avec CMT, la d�marcation des transactions est faite dans les descripteurs de d�ploiement des Beans Sessions et non + de mani�re programmmatique, ceci r�duit le code: + </para> + + <programlisting><![CDATA[// CMT idiom + Session sess = factory.getCurrentSession(); + + // do some work + ... +]]></programlisting> + + <para> + Dans un EJB CMT m�me le rollback intervient automatiquement, puisqu'une <literal>RuntimeException</literal> + non trait�e et soulev�e par une m�thode d'un bean session indique au conteneur d'annuler la transaction + globale. <emphasis>Ceci veut donc dire que vous n'avez pas � utiliser l'API <literal>Transaction</literal> d'Hibernate + dans CMT.</emphasis> + </para> + + <para> + Notez que le fichier de configuration Hibernate devrait contenir les valeurs + <literal>org.hibernate.transaction.JTATransactionFactory</literal> dans un environnement BMT ou + <literal>org.hibernate.transaction.CMTTransactionFactory</literal> dans un environnement CMT l� o� vous + configurez votre transaction factory Hibernate. + N'oubliez pas non plus de sp�cifier le param�tre <literal>org.hibernate.transaction.manager_lookup_class</literal> . + De plus, assurez vous de fixez votre <literal>hibernate.current_session_context_class</literal> soit � <literal>"jta"</literal> + ou de ne pas le configurer (compatibilit� avec les versions pr�c�dentes). + </para> + + <para> + La m�thode <literal>getCurrentSession()</literal> a un inconv�nient dans les environnement JTA. + Il y a une astuce qui est d'utiliser un mode de lib�ration de connexion <literal>after_statement</literal> , + qui est alors utilis� par d�faut. Du � une �trange limitation de la spec JTA, il n'est pas possible + pour Hibernate de nettoyer et ferme automatiquement un <literal>ScrollableResults</literal> ouvert + ou une instance d'<literal>Iterator</literal> retourn�s <literal>scroll()</literal> ou + <literal>iterate()</literal>. Vous <emphasis>devez</emphasis> lib�rer le curseur base de donn�es + sous jacent ou invoquer <literal>Hibernate.close(Iterator)</literal> explicitement depuis un + bloc <literal>finally</literal>. (Bien sur, la plupart des applications peuvent �viter + d'uiliser <literal>scroll()</literal> ou <literal>iterate()</literal> dans un code CMT.) + </para> + + </sect2> + + <sect2 id="transactions-demarcation-exceptions"> + <title>Gestion des exceptions</title> + + <para> + Si une <literal>Session</literal> lance une exception (incluant les exceptions du type <literal>SQLException</literal> + ou d'un sous-type), vous devez imm�diatement faire le rollback de la transaction, appeler <literal>Session.close()</literal> + et rel�cher les r�f�rences sur l'objet <literal>Session</literal> . La <literal>Session</literal> contient des m�thodes + pouvant la mettre dans un �tat inutilisable. Vous devez consid�rer qu'<emphasis>aucune</emphasis> + exception lanc�e par Hibernate n'est traitable. Assurez-vous de fermer la session en faisant l'appel � + <literal>close()</literal> dans un bloc <literal>finally</literal> . + </para> + + <para> + L'exception <literal>HibernateException</literal> , qui englobe la plupart des exceptions pouvant survenir dans la + couche de persistance Hibernate, est une exception non v�rifi�e (Ceci n'�tait pas le cas dans certaines versions ant�rieures de Hibernate.) Il est de + notre avis que nous ne devrions pas forcer un d�veloppeur � g�rer une exception qu'il ne peut de toute fa�on + pas traiter dans une couche technique. Dans la plupart des applications, les exceptions non v�rifi�es et les + exceptions fatales sont g�r�es en amont du processus (dans les couches hautes) et un message d'erreur est + alors affich� � l'usager (ou un traitement alternatif est invoqu�.) Veuillez noter qu'Hibernate peut + �galement lancer des exceptions non v�rifi�es d'un autre type que <literal>HibernateException</literal> . Celles-ci sont + �galement non traitables et vous devez les traiter comme telles. + </para> + + <para> + Hibernate englobe les <literal>SQLException</literal> s lanc�es lors des interactions directes avec la base de donn�es + dans des exceptions de type: <literal>JDBCException</literal> . En fait, Hibernate essaiera de convertir l'exception dans + un sous-type plus significatif de <literal>JDBCException</literal> . L'exception <literal>SQLException</literal> sous-jacente + est toujours disponible via la m�thode <literal>JDBCException.getCause()</literal> . Cette conversion est faite par un objet + de type <literal>SQLExceptionConverter</literal> , qui est rattach� � l'objet <literal>SessionFactory</literal> . + Par d�faut, le <literal>SQLExceptionConverter</literal> est associ� au dialecte de BD configur� dans Hibernate. Toutefois, + il est possible de fournir sa propre impl�mentation de l'interface. (Veuillez vous r�f�rer � la javadoc sur la classe + <literal>SQLExceptionConverterFactory</literal> pour plus de d�tails. Les sous-types standard de <literal>JDBCException</literal> sont: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>JDBCConnectionException</literal> - Indique une erreur de communication avec la couche JDBC sous-jacente. + </para> + </listitem> + <listitem> + <para> + <literal>SQLGrammarException</literal> - Indique un probl�me de grammaire ou de syntaxe avec la requ�te SQL envoy�e. + </para> + </listitem> + <listitem> + <para> + <literal>ConstraintViolationException</literal> - Indique une violation de contrainte d'int�grit�. + </para> + </listitem> + <listitem> + <para> + <literal>LockAcquisitionException</literal> - Indique une erreur de verrouillage lors de l'�x�cution de la requ�te. + </para> + </listitem> + <listitem> + <para> + <literal>GenericJDBCException</literal> - Indique une erreur g�n�rique JDBC d'une autre cat�gorie. + </para> + </listitem> + </itemizedlist> + + </sect2> + + <sect2 id="transactions-demarcation-timeout"> + <title>Timeout de transaction</title> + + <para>L'un des avantages fournis par les environnements transactionnels JTA (tels les containers EJB) est la + gestion du timeout de transaction. La gestion des d�passements de temps de transaction vise � s'assurer + qu'une transaction agissant incorrectement ne viendra pas bloquer ind�finiment les ressources de + l'application. Hibernate ne peut fournir cette fonctionnalit� dans un environnement transactionnel non-JTA. + Par contre, Hibernate g�re les op�rations d'acc�s aux donn�es en allouant un temps maximal aux requ�tes pour + s'ex�cuter. Ainsi, une requ�te cr�ant de l'inter blocage ou retournant de tr�s grandes quantit�s + d'information pourrait �tre interrompue. Dans un environnement transactionnel JTA, Hibernate peut d�l�guer + au gestionnaire de transaction le soin de g�rer les d�passements de temps. Cette fonctionnalit� est + abstraite par l'objet <literal>Transaction</literal> . + </para> + + <programlisting><![CDATA[ + Session sess = factory.openSession(); + try { + //mettre le timeout � 3 secondes. + sess.getTransaction().setTimeout(3); + sess.getTransaction().begin(); + + // Effectuer le travail ... + + sess.getTransaction().commit() + } + catch (RuntimeException e) { + if ( sess.getTransaction().isActive() ) { + sess.getTransaction().rollback(); + } + throw e; + // ou afficher le message d'erreur. + } + finally { + sess.close(); + }]]></programlisting> + + + <para> + Notez que <literal>setTimeout()</literal> ne peut pas �tre appel� d'un EJB CMT, puisque le timeout + des transaction doit �tre sp�cifi� de mani�re d�clarative. + </para> + + </sect2> + +</sect1> + +<sect1 id="transactions-optimistic"> + <title>Contr�le de consurrence optimiste</title> + + <para>La gestion optimiste des acc�s concurrents avec versionnage est la seule approche pouvant garantir + l'extensibilit� des applications � haut niveau de charge. Le syst�me de versionnage utilise des num�ros de + version ou l'horodatage pour d�tecter les mises � jour causant des conflits avec d'autres actualisations + ant�rieures. Hibernate propose trois approches pour l'�criture de code applicatif utilisant la gestion optimiste + d'acc�s concurrents. Le cas d'utilisation d�crit plus bas fait mention de conversation, + mais le versionnage peut �galement am�liorer la qualit� d'une application en pr�venant la perte de mises � + jour.</para> + + <sect2 id="transactions-optimistic-manual"> + <title>Gestion du versionnage au niveau applicatif</title> + + <para>Dans cet exemple d'impl�mentation utilisant peu les fonctionnalit�s d'Hibernate, chaque interaction avec + la base de donn�es se fait en utilisant une nouvelle <literal>Session</literal> et le d�veloppeur doit recharger + les donn�es persistantes � partir de la BD avant de les manipuler. Cette + impl�mentation force l'application � v�rifier la version des objets afin de maintenir l'isolation + transactionnelle. Cette approche, semblable � celle retrouv�e pour les EJB, est la moins efficace de celles + pr�sent�es dans ce chapitre. + </para> + + <programlisting> + <![CDATA[// foo est une instance charg�e ant�rieurement par une autre + Session session = factory.openSession(); + Transaction t = session.beginTransaction(); + + int oldVersion = foo.getVersion(); + session.load( foo, foo.getKey() ); // Charger l'�tat courant + + if ( oldVersion != foo.getVersion() ) + throw new StaleObjectStateException(); + + foo.setProperty("bar"); + t.commit(); + session.close();]]></programlisting> + + <para>Le mapping de la propri�t� <literal>version</literal> est fait via <literal><version></literal> et + Hibernate l'incr�mentera automatiquement � chaque flush() si l'entit� doit �tre mise � jour. + </para> + + + <para>Bien s�r, si votre application ne fait pas face � beaucoup d'acc�s concurrents et ne n�cessite pas + l'utilisation du versionnage, cette approche peut �galement �tre utilis�e, il n'y a qu'� ignorer le code + reli� au versionnage. Dans ce cas, la strat�gie du + <emphasis>last commit wins</emphasis> + (litt�ralement: le dernier commit l'emporte) sera utilis�e pour les conversations (longues transactions applicatives). + Gardez � l'esprit que cette approche pourrait rendre perplexe les utilisateurs de l'application car ils + pourraient perdre des donn�es mises � jour sans qu'aucun message d'erreur ne leur soit pr�sent� et sans + avoir la possibilit� de fusionner les donn�es. + </para> + + <para>Il est clair que la gestion manuelle de la v�rification du versionnage des objets ne peut �tre effectu�e + que dans certains cas triviaux et que cette approche n'est pas valable pour la plupart des applications. De + mani�re g�n�rale, les applications ne cherchent pas � actualiser de simples objets sans relations, elles le + font g�n�ralement pour de larges graphes d'objets. Pour toute application utilisant le paradigme des conversations + ou des objets d�tach�s, Hibernate peut g�rer automatiquement la v�rification des versions + d'objets.</para> + + </sect2> + + <sect2 id="transactions-optimistic-longsession"> + <title>Les sessions longues et le versionnage automatique.</title> + + <para>Dans ce sc�nario, une seule instance de <literal>Session</literal> et des objets persistants est utilis�e + pour toute l'application. Hibernate v�rifie la version des objets + persistants avant d'effectuer le flush() et lance une exception si une modification concurrente est + d�tect�e. Il appartient alors au d�veloppeur de g�rer l'exception. Les traitements alternatifs g�n�ralement + propos�s sont alors de permettre � l'usager de faire la fusion des donn�es ou de lui offrir de recommencer + son travail � partie des donn�es les plus r�centes dans la BD. + </para> + + <para>Il est � noter que lorsqu'une application est en attente d'une action de la part de l?usager, La <literal>Session</literal> + n'est pas connect�e � la couche JDBC sous-jacente. C'est la mani�re la plus efficace de g�rer les acc�s � la + base de donn�es. L'application ne devrait pas se pr�occuper du versionnage des objets, de la r�association + des objets d�tach�s, ni du rechargement de tous les objets � chaque transaction. + </para> + + <programlisting> + <![CDATA[// foo est une instance charg�e ant�rieurement par une autre session + + session.reconnect();// Obtention d'une nouvelle connexion JDBC + Transaction t = session.beginTransaction(); + foo.setProperty("bar"); + t.commit(); //Terminer la transaction, propager les changements et v�rifier les versions. + session.disconnect(); // Retourner la connexion JDBC + ]]></programlisting> + + + <para>L'objet <literal>foo</literal> sait quel objet <literal>Session</literal> l'a charg�. <literal>Session.reconnect()</literal> + obtient une nouvelle connexion (celle-ci peut �tre �galement fournie) et permet � la session de continuer + son travail. La m�thode <literal>Session.disconnect()</literal> d�connecte la session de la connexion JDBC et + retourne celle-ci au pool de connexion (� moins que vous ne + lui ayez fourni vous m�me la connexion.) Apr�s la reconnexion, afin de forcer la v�rification du versionnage + de certaines entit�s que vous ne cherchez pas � actualiser, vous pouvez faire un appel � <literal>Session.lock()</literal> + en mode <literal>LockMode.READ</literal> pour tout objet ayant pu �tre modifi� par une autre transaction. Il n'est pas n�cessaire de verrouiller les + donn�es que vous d�sirez mettre � jour. + </para> + + <para>Si des appels implicites aux m�thodes <literal>disconnect()</literal> et <literal>reconnect()</literal> sont trop + co�teux, vous pouvez les �viter en utilisant <literal>hibernate.connection.release_mode</literal> . + </para> + + <para>Ce pattern peut pr�senter des probl�mes si la <literal>Session</literal> est trop volumineuse pour �tre + stock�e entre les actions de l'usager. Plus sp�cifiquement, une session <literal>HttpSession</literal> se doit + d'�tre la plus petite possible. Puisque la <literal>Session</literal> joue obligatoirement le r�le de m�moire + cache de premier niveau et contient � ce titre tous les objets + charg�s, il est pr�f�rable de n'utiliser cette strat�gie que pour quelques cycles de requ�tes car les objets + risquent d'y �tre rapidement p�rim�s. + </para> + + <para>Notez que la <literal>Session</literal> d�connect�e devrait �tre conserv�e pr�s de la couche de persistance. Autrement dit, utilisez un EJB stateful + pour conserver la <literal>Session</literal> et �vitez de la s�rialiser et de la transf�rer � la couche de pr�sentation (i.e. Il est pr�f�rable de ne pas + la conserver dans la session <literal>HttpSession</literal> .) + </para> + + </sect2> + + <sect2 id="transactions-optimistic-detached"> + <title>Les objets d�tach�s et le versionnage automatique</title> + + <para>Chaque interaction avec le syst�me de persistance se fait via une nouvelle <literal>Session</literal> . + Toutefois, les m�mes instances d'objets persistants sont r�utilis�es pour chacune de ces interactions. + L'application doit pouvoir manipuler l'�tat des instances d�tach�es ayant �t� charg�es ant�rieurement via + une autre session. Pour ce faire, ces objets persistants doivent �tre rattach�s � la <literal>Session</literal> + courante en utilisant <literal>Session.update()</literal> , <literal>Session.saveOrUpdate()</literal> , ou <literal>Session.merge()</literal> . + </para> + + <programlisting> + <![CDATA[// foo est une instance charg�e ant�rieurement par une autre session + + foo.setProperty("bar"); + session = factory.openSession(); + Transaction t = session.beginTransaction(); + session.saveOrUpdate(foo); //Utiliser merge() si "foo" pourrait avoir �t� charg� pr�c�dement + t.commit(); + session.close();]]> </programlisting> + + + <para>Encore une fois, Hibernate v�rifiera la version des instances devant �tre actualis�es durant le flush(). + Une exception sera lanc�e si des conflits sont d�tect�s.</para> + + <para>Vous pouvez �galement utiliser <literal>lock()</literal> au lieu de <literal>update()</literal> et + utiliser le mode <literal>LockMode.READ</literal> (qui lancera une v�rification de version, en ignorant tous les niveaux de m�moire cache) si vous �tes + certain que l'objet n'a pas �t� modifi�. + </para> + + </sect2> + + <sect2 id="transactions-optimistic-customizing"> + <title>Personnaliser le versionnage automatique</title> + + <para>Vous pouvez d�sactiver l'incr�mentation automatique du num�ro de version de certains attributs et + collections en mettant la valeur du param�tre de mapping <literal>optimistic-lock</literal> � + false. Hibernate cessera ainsi d'incr�menter leur num�ro de version s'ils sont mis � jour. + </para> + + <para>Certaines entreprises poss�dent de vieux syst�mes dont les sch�mas de bases de donn�es sont statiques et + ne peuvent �tre modifi�s. Il existe aussi des cas o� plusieurs applications doivent acc�der � la m�me base + de donn�es, mais certaines d'entre elles ne peuvent g�rer les num�ros de version ou les champs horodat�s. + Dans les deux cas, le versionnage ne peut �tre implant� par le rajout d'une colonne dans la base de donn�es. + Afin de forcer la v�rification de version dans un syst�me sans en faire le mapping, mais en for�ant une + comparaison des �tats de tous les attributs d'une entit�, vous pouvez utiliser l'attribut <literal>optimistic- lock="all"</literal> + sous l'�l�ment <literal><class></literal> . Veuillez noter que cette mani�re de g�rer le versionnage ne peut �tre utilis�e que si l'application + utilises de longues sessions, lui permettant de comparer l'ancien �tat et le nouvel �tat d'une entit�. + L'utilisation d'un pattern <literal>session-per-request-with-detached- objects</literal> devient alors impossible. + </para> + + <para>Il peut �tre souhaitable de permettre les modifications concurrentes lorsque des champs distincts sont + modifi�s. En mettant la propri�t� <literal>optimistic-lock="dirty"</literal> dans l'�l�ment <literal><class></literal> , + Hibernate ne fera la comparaison que des champs devant �tre actualis�s lors du flush(). + </para> + + <para>Dans les deux cas: en utilisant une colonne de version/horodat�e ou via la comparaison de l'�tat complet + de l'objet ou de ses champs modifi�s, Hibernate ne cr�era qu'une seule commande d'UPDATE par entit� avec la + clause WHERE appropri�e pour mettre � jour l'entit� + <emphasis>ET</emphasis> + en v�rifier la version. Si vous utilisez la persistance transitive pour propager l'�v�nement de rattachement + � des entit�s associ�es, il est possible qu'Hibernate g�n�re des commandes d'UPDATE inutiles. Ceci n'est + g�n�ralement pas un probl�me, mais certains d�clencheurs + <emphasis>on update</emphasis> + dans la base de donn�es pourraient �tre activ�s m�me si aucun changement n'�tait r�ellement persist� sur des + objets associ�s. Vous pouvez personnaliser ce comportement en indiquant <literal>select-before- update="true"</literal> + dans l'�l�ment de mapping <literal><class></literal> . Ceci forcera Hibernate � faire le SELECT de l'instance + afin de s'assurer que l'entit� doit r�ellement �tre + actualis�e avant de lancer la commande d'UPDATE. + </para> + + </sect2> + +</sect1> + +<sect1 id="transactions-locking"> + <title>Verouillage pessimiste</title> + + <para>Il n'est n�cessaire de s'attarder � la strat�gie de verrouillage des entit�s dans une application utilisant + Hibernate. Il est g�n�ralement suffisant de d�finir le niveau d'isolation pour les connexions JDBC et de laisser + ensuite la base de donn�e effectuer son travail. Toutefois, certains utilisateurs avanc�s peuvent vouloir + obtenir un verrouillage pessimiste exclusif sur un enregistrement et le r�obtenir au lancement d'une nouvelle + transaction.</para> + + <para>Hibernate utilisera toujours le m�canisme de verrouillage de la base de donn�es et ne verrouillera jamais les + objets en m�moire!</para> + + <para>La classe + <literal>LockMode</literal> + d�finit les diff�rents niveaux de verrouillage pouvant �tre obtenus par Hibernate. Le verrouillage est obtenu + par les m�canismes suivants: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>LockMode.WRITE</literal> est obtenu automatiquement quand Hibernate actualise ou insert un enregistrement. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.UPGRADE</literal> peut �tre obtenu de mani�re explicite via la requ�te en utilisant + <literal>SELECT ... FOR UPDATE</literal> sur une base de donn�es supportant cette syntaxe. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.UPGRADE_NOWAIT</literal> peut �tre obtenu de mani�re explicite en utilisant + <literal>SELECT ... FOR UPDATE NOWAIT</literal> sur Oracle. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.READ</literal> est obtenu automatiquement quand Hibernate lit des donn�es dans un contexte d'isolation + <literal>Repeatable Read</literal> ou + <literal>Serializable</literal> . Peut �tre r�obtenu explicitement via une requ�te. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.NONE</literal> repr�sente l'absence de verouillage. Tous les objets migrent vers ce mode a la fin d'une + <literal>Transaction</literal> . Les objets associ�s � une session via un appel � + <literal>saveOrUpdate()</literal> commencent �galement leur cycle de vie dans cet �tat. + </para> + </listitem> + </itemizedlist> + + <para>Les niveaux de verrouillage peuvent �tre explicitement obtenus de l'une des mani�res suivantes:</para> + + <itemizedlist spacing="compact"> + <listitem> + <para>Un appel � + <literal>Session.load()</literal> , en sp�cifiant un niveau verrouillage + <literal>LockMode</literal> . + </para> + </listitem> + <listitem> + <para>Un appel � + <literal>Session.lock()</literal> . + </para> + </listitem> + <listitem> + <para>Une appel � + <literal>Query.setLockMode()</literal> . + </para> + </listitem> + </itemizedlist> + + <para>Si + <literal>Session.load()</literal> + est appel� avec le param�tre de niveau de verouillage + <literal>UPGRADE</literal> + ou + <literal>UPGRADE_NOWAIT</literal> + et que l'objet demand� n'est pas pr�sent dans la session, celui-ci sera charg� � l'aide d'une requ�te + <literal>SELECT ... FOR UPDATE</literal> + . Si la m�thode + <literal>load()</literal> + est appel�e pour un objet d�j� en session avec un verrouillage moindre que celui demand�, Hibernate appellera la + m�thode + <literal>lock()</literal> + pour cet objet. + </para> + + <para> + <literal>Session.lock()</literal> + effectue une v�rification de version si le niveau de verrouillage est + <literal>READ</literal> + , + <literal>UPGRADE</literal> + ou + <literal>UPGRADE_NOWAIT</literal> + . (Dans le cas des niveaux + <literal>UPGRADE</literal> + ou + <literal>UPGRADE_NOWAIT</literal> + , une requ�te + <literal>SELECT ... FOR UPDATE</literal> + sera utilis�e.) + </para> + + <para>Si une base de donn�es ne supporte pas le niveau de verrouillage demand�, Hibernate utilisera un niveau + alternatif convenable au lieux de lancer une exception. Ceci assurera la portabilit� de votre + application.</para> +</sect1> + + <sect1 id="transactions-connection-release"> + <title>Mode de lib�ration de Connection</title> + + <para> + Le comportement original (2.x) d'Hibernate pour la gestion des connexions JDBC + �tait que la <literal>Session</literal> obtenait une connexion d�s qu'elle en avait + besoin et la lib�rait une fois la session ferm�e. + Hibernate 3 a introduit les modes de lib�ration de connexion pour indiquer � la session + comment g�rer les transactions JDBC. Notez que la discussion suivante n'est pertinente + que pour des connexions fournies par un <literal>ConnectionProvider</literal>, celles g�r�es + par l'utilisateur sont en dehors du scope de cette discussion. Les diff�rents modes + sont d�finies par <literal>org.hibernate.ConnectionReleaseMode</literal>: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ON_CLOSE</literal> - est essentiellement le comportement pass�. + La session Hibernate obtient une connexion lorsqu'elle en a besoin et la garde + jusqu'� ce que la session se ferme. + </para> + </listitem> + <listitem> + <para> + <literal>AFTER_TRANSACTION</literal> - indique de relacher la connexion apr�s qu'une + <literal>org.hibernate.Transaction</literal> se soit achev�e. + </para> + </listitem> + <listitem> + <para> + <literal>AFTER_STATEMENT</literal> (aussi appel� lib�ration brutale) - indique de relacher + les connexions apr�s chaque ex�cution d'un statement. Ce relachement aggressif est annul� + si ce statement laisse des ressources associ�es � une session donn�e ouvertes, actuellement + ceci n'arrive que lors de l'utilisation de <literal>org.hibernate.ScrollableResults</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + Le param�tre de configuration <literal>hibernate.connection.release_mode</literal> est utilis� + pour sp�cifier quel mode de lib�ration doit �tre utiliser. Les valeurs possibles sont: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>auto</literal> (valeur par d�faut) - ce choix d�l�gue le choix de lib�ration + � la m�thode <literal>org.hibernate.transaction.TransactionFactory.getDefaultReleaseMode()</literal> + Pour la JTATransactionFactory, elle retourne ConnectionReleaseMode.AFTER_STATEMENT; pour + JDBCTransactionFactory, elle retourne ConnectionReleaseMode.AFTER_TRANSACTION. C'est rarement + une bonne id�e de changer ce comportement par d�faut puisque les erreurs soulev�es par ce + param�trage tend � prouver une erreur dans le code de l'utilisateur. + </para> + </listitem> + <listitem> + <para> + <literal>on_close</literal> - indique d'utiliser ConnectionReleaseMode.ON_CLOSE. Ce param�trage + existe pour garantir la compatibilit� avec les versions pr�c�dentes, mais ne devrait plus �tre utilis�. + </para> + </listitem> + <listitem> + <para> + <literal>after_transaction</literal> - indique d'utiliser ConnectionReleaseMode.AFTER_TRANSACTION. + Ne devrait pas �tre utilis� dans les environnements JTA. Notez aussi qu'avec + ConnectionReleaseMode.AFTER_TRANSACTION, si une session est consid�r�e comme �tant en mode auto-commit + les connexions seront relach�es comme si le mode �tait AFTER_STATEMENT. + </para> + </listitem> + <listitem> + <para> + <literal>after_statement</literal> - indique d'utiliser ConnectionReleaseMode.AFTER_STATEMENT. + Additonnellement, le <literal>ConnectionProvider</literal> utilis� est consult� pour savoir s'il supporte + ce param�trage (<literal>supportsAggressiveRelease()</literal>). Si ce n'est pas le cas, le mode de + lib�ration est r� initialis� � ConnectionReleaseMode.AFTER_TRANSACTION. + Ce param�trage n'est s�r que dans les environnements o� il est possible d'obtenir � nouveau + la m�me connexion JDBC � chaque fois que l'on fait un appel de <literal>ConnectionProvider.getConnection()</literal> + ou dans les envrionnements auto-commit o� il n'est pas important d'obtenir plusieurs fois la + m�me connexion. + </para> + </listitem> + </itemizedlist> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/tutorial.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/tutorial.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/tutorial.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/tutorial.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,1576 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="tutorial"> + <title>Introduction � Hibernate</title> + + <sect1 id="tutorial-intro" revision="1"> + <title>Pr�face</title> + + <para> + Ce chapitre est un didacticiel introductif destin� aux nouveaux utilisateurs + d'Hibernate. Nous commen�ons avec une simple application en ligne de commande + utilisant une base de donn�es en m�moire, et la d�veloppons en �tapes faciles + � comprendre. + </para> + + <para> + Ce didacticiel est destin� aux nouveaux utilisateurs d'Hibernate mais requiert + des connaissances Java et SQL. Il est bas� sur un didacticiel de Michael Gloegl, + les biblioth�ques tierces que nous nommons sont pour les JDK 1.4 et 5.0. Vous + pourriez avoir besoin d'autres biblioth�ques pour le JDK 1.3. + </para> + + <para> + Le code source de ce tutoriel est inclus dans la distribution dans le r�pertoire + <literal>doc/reference/tutorial/</literal>. + </para> + + </sect1> + + <sect1 id="tutorial-firstapp" revision="1"> + <title>Partie 1 - Premi�re application Hibernate</title> + + <para> + D'abord, nous cr�erons une simple application Hibernate en console. Nous utilisons + une base de donn�es en m�moire (HSQL DB), donc nous n'avons pas � installer de + serveur de base de donn�es. + </para> + + <para> + Supposons que nous ayons besoin d'une petite application de base de donn�es qui + puisse stocker des �v�nements que nous voulons suivre, et des informations � propos + des h�tes de ces �v�nements. + </para> + + <para> + La premi�re chose que nous faisons est de configurer notre r�pertoire de + d�veloppement et de mettre toutes les biblioth�ques dont nous avons besoin dedans. + T�l�chargez la distribution Hibernate � partir du site web d'Hibernate. + Extrayez le paquet et placez toutes les biblioth�ques requises trouv�es dans + <literal>/lib</literal> dans le r�pertoire <literal>/lib</literal> de votre + nouveau r�pertoire de travail. Il devrait ressembler � �a : + </para> + + <programlisting><![CDATA[. ++lib + antlr.jar + cglib-full.jar + asm.jar + asm-attrs.jars + commons-collections.jar + commons-logging.jar + ehcache.jar + hibernate3.jar + jta.jar + dom4j.jar + log4j.jar ]]></programlisting> + + <para> + Ceci est l'ensemble minimum de biblioth�ques requises (notez que nous avons aussi + copi� hibernate3.jar, l'archive principale) pour Hibernate. Lisez le fichier + <literal>README.txt</literal> dans le r�pertoire <literal>lib/</literal> de la + distribution Hibernate pour plus d'informations � propos des bilioth�ques tierces + requises et optionnelles. (En fait, log4j n'est pas requis mais pr�f�r� par beaucoup + de d�veloppeurs.) + </para> + + <para> + Ensuite, nous cr�ons une classe qui r�pr�sente l'�v�nement que nous voulons + stocker dans notre base de donn�es. + </para> + + <sect2 id="tutorial-firstapp-firstclass" revision="1"> + <title>La premi�re classe</title> + + <para> + Notre premi�re classe persistante est une simple classe JavaBean avec + quelques propri�t�s : + </para> + + <programlisting><![CDATA[package events; + +import java.util.Date; + +public class Event { + private Long id; + + private String title; + private Date date; + + public Event() {} + + public Long getId() { + return id; + } + + private void setId(Long id) { + this.id = id; + } + + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public String getTitle() { + return title; + } + + public void setTitle(String title) { + this.title = title; + } +}]]></programlisting> + + <para> + Vous pouvez voir que cette classe utilise les conventions de nommage standard JavaBean + pour les m�thodes getter/setter des propri�t�s, ainsi qu'une visibilit� priv�e + pour les champs. Ceci est la conception recommand�e - mais pas obligatoire. Hibernate peut + aussi acc�der aux champs directement, le b�n�fice des m�thodes d'acc�s est la robustesse + pour la refonte de code. Le constructeur sans argument est requis pour instancier + un objet de cette classe via reflexion. + </para> + + <para> + La propri�t� <literal>id</literal> contient la valeur d'un identifiant unique pour un + �v�nement particulier. Toutes les classes d'entit�s persistantes (ainsi que les classes + d�pendantes de moindre importance) auront besoin d'une telle propri�t� identifiante si nous + voulons utiliser l'ensemble complet des fonctionnalit�s d'Hibernate. En fait, la plupart des + applications (surtout les applications web) ont besoin de distinguer des objets par des + identifiants, donc vous devriez consid�rer �a comme une fonctionnalit� plut�t que comme une + limitation. Cependant, nous ne manipulons g�n�ralement pas l'identit� d'un objet, dor�navant + la m�thode setter devrait �tre priv�e. Seul Hibernate assignera les identifiants lorsqu'un + objet est sauvegard�. Vous pouvez voir qu'Hibernate peut acc�der aux m�thodes publiques, + priv�es et prot�g�es, ainsi qu'aux champs (publics, priv�s, prot�g�s) directement. Le choix + vous est laiss�, et vous pouvez l'ajuster � la conception de votre application. + </para> + + <para> + Le constructeur sans argument est requis pour toutes les classes persistantes ; + Hibernate doit cr�er des objets pour vous en utilisant la r�flexion Java. Le + constructeur peut �tre priv�, cependant, la visibilit� du paquet est requise + pour la g�n�ration de proxy � l'ex�cution et une r�cup�ration des donn�es efficaces + sans instrumentation du bytecode. + </para> + + <para> + Placez ce fichier source Java dans un r�pertoire appel� <literal>src</literal> + dans le dossier de d�veloppement. Ce r�pertoire devrait maintenant ressembler + � �a : + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate et biblioth�ques tierces> ++src + +events + Event.java]]></programlisting> + + + <para> + Dans la prochaine �tape, nous informons Hibernate de cette classe persistante. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-mapping" revision="1"> + <title>Le fichier de mapping</title> + + <para> + Hibernate a besoin de savoir comment charger et stocker des objets d'une classe + persistante. C'est l� qu'intervient le fichier de mapping Hibernate. Le fichier + de mapping indique � Hibernate � quelle table dans la base de donn�es il doit + acc�der, et quelles colonnes de cette table il devra utiliser. + </para> + + <para> + La structure basique de ce fichier de mapping ressemble � �a : + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping> +[...] +</hibernate-mapping>]]></programlisting> + + <para> + Notez que la DTD Hibernate est tr�s sophistiqu�e. Vous pouvez l'utiliser + pour l'auto-compl�tement des �l�ments et des attributs de mapping XML dans + votre �diteur ou votre IDE. Vous devriez aussi ouvrir le fichier DTD dans + votre �diteur de texte - c'est le moyen le plus facile d'obtenir une vue + d'ensemble de tous les �l�ments et attributs, et de voir les valeurs par + d�faut, ainsi que quelques commentaires. Notez qu'Hibernate ne chargera + pas le fichier DTD � partir du web, mais regardera d'abord dans le classpath + de l'application. Le fichier DTD est inclus dans <literal>hibernate3.jar</literal> + ainsi que dans le r�pertoire <literal>src</literal> de la distribution + Hibernate. + </para> + + <para> + Nous omettrons la d�claration de la DTD dans les exemples futurs pour + raccourcir le code. Bien s�r il n'est pas optionnel. + </para> + + <para> + Entre les deux balises <literal>hibernate-mapping</literal>, incluez un + �l�ment <literal>class</literal>. Toutes les classes d'entit�s persistantes + (encore une fois, il pourrait y avoir des classes d�pendantes plus tard, + qui ne sont pas des entit�s m�re) ont besoin d'un mapping vers une table + de la base de donn�es SQL : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Event" table="EVENTS"> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Plus loin, nous disons � Hibernate comment persister et charger un objet de la classe + <literal>Event</literal> dans la table <literal>EVENTS</literal>, chaque instance est + repr�sent�e par une ligne dans cette table. Maintenant nous continuons avec le mapping de + la propri�t� de l'identifiant unique vers la clef primaire de la table. De plus, comme + nous ne voulons pas nous occuper de la gestion de cet identifiant, nous utilisons une + strat�gie de g�n�ration d'identifiant d'Hibernate pour la colonne de la clef primaire + subrog�e : + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="increment"/> + </id> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + L'�l�ment <literal>id</literal> est la d�claration de la propri�t� de l'identifiant, + <literal>name="id"</literal> d�clare le nom de la propri�t� Java - Hibernate + utilisera les m�thodes getter et setter pour acc�der � la propri�t�. L'attribut + <literal>column</literal> indique � Hibernate quelle colonne de la table + <literal>EVENTS</literal> nous utilisons pour cette clef primaire. L'�l�ment + <literal>generator</literal> imbriqu� sp�cifie la strat�gie de g�n�ration de + l'identifiant, dans ce cas nous avons utilis� <literal>increment</literal>, + laquelle est une m�thode tr�s simple utile surtout pour les tests + (et didacticiels). Hibernate supporte aussi les identifiants g�n�r�s par les + bases de donn�es, globalement uniques, ainsi que les identifiants assign�s par + l'application (ou n'importe quelle strat�gie que vous avez �crit en extension). + </para> + + <para> + Finalement nous incluons des d�clarations pour les propri�t�s persistantes de la classe + dans le fichier de mapping. Par d�faut, aucune propri�t� de la classe n'est consid�r�e + comme persistante : + </para> + + <programlisting><![CDATA[ +<hibernate-mapping> + + <class name="Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="increment"/> + </id> + <property name="date" type="timestamp" column="EVENT_DATE"/> + <property name="title"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Comme avec l'�l�ment <literal>id</literal>, l'attribut <literal>name</literal> + de l'�l�ment <literal>property</literal> indique � Hibernate quels getters/setters + utiliser. + </para> + + <para> + Pourquoi le mapping de la propri�t� <literal>date</literal> inclut + l'attribut <literal>column</literal>, mais pas <literal>title</literal> ? + Sans l'attribut <literal>column</literal> Hibernate utilise par d�faut + le nom de la propri�t� comme nom de colonne. Ca fonctionne bien pour + <literal>title</literal>. Cependant, <literal>date</literal> est un mot clef + r�serv� dans la plupart des bases de donn�es, donc nous utilisons un nom + diff�rent pour le mapping. + </para> + + <para> + La prochaine chose int�ressante est que le mapping de <literal>title</literal> + manque aussi d'un attribut <literal>type</literal>. Les types que nous d�clarons + et utilisons dans les fichiers de mapping ne sont pas, comme vous pourriez vous + y attendre, des types de donn�es Java. Ce ne sont pas, non plus, des types de + base de donn�es SQL. Ces types sont donc appel�s des <emphasis>types de mapping + Hibernate</emphasis>, des convertisseurs qui peuvent traduire des types Java en + types SQL et vice versa. De plus, Hibernate tentera de d�terminer la bonne conversion + et le type de mapping lui-m�me si l'attribut <literal>type</literal> n'est pas + pr�sent dans le mapping. Dans certains cas, cette d�tection automatique (utilisant + la r�flexion sur la classe Java) pourrait ne pas donner la valeur attendue ou + dont vous avez besoin. C'est le cas avec la propri�t� <literal>date</literal>. + Hibernate ne peut pas savoir si la propri�t� "mappera" une colonne SQL de type + <literal>date</literal>, <literal>timestamp</literal> ou <literal>time</literal>. + Nous d�clarons que nous voulons conserver des informations avec une date compl�te + et l'heure en mappant la propri�t� avec un <literal>timestamp</literal>. + </para> + + <para> + Ce fichier de mapping devrait �tre sauvegard� en tant que <literal>Event.hbm.xml</literal>, + juste dans le r�pertoire � c�t� du fichier source de la classe Java <literal>Event</literal>. + Le nommage des fichiers de mapping peut �tre arbitraire, cependant le suffixe + <literal>hbm.xml</literal> est devenu une convention dans la communaut� des + d�veloppeurs Hibernate. La structure du r�pertoire devrait ressembler � �a : + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate et biblioth�ques tierces> ++src + Event.java + Event.hbm.xml]]></programlisting> + + <para> + Nous poursuivons avec la configuration principale d'Hibernate. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-configuration" revision="1"> + <title>Configuration d'Hibernate</title> + + <para> + Nous avons maintenant une classe persistante et son fichier de mapping. Il est temps de + configurer Hibernate. Avant �a, nous avons besoin d'une base de donn�es. HSQL DB, un + SGBD SQL bas� sur Java et travaillant en m�moire, peut �tre t�l�charg� � partir du site + web de HSQL. En fait, vous avez seulement besoin de <literal>hsqldb.jar</literal>. Placez + ce fichier dans le r�pertoire <literal>lib/</literal> du dossier de d�veloppement. + </para> + + <para> + Cr�ez un r�pertoire appel� <literal>data</literal> � la racine du r�pertoire de d�veloppement - + c'est l� que HSQL DB stockera ses fichiers de donn�es. D�marrez maintenant votre base de donn�es + en ex�cutant <literal>java -classpath lib/hsqldb.jar org.hsqldb.Server</literal> dans votre r�pertoire de travail. + Vous observez qu'elle d�marre et ouvre une socket TCP/IP, c'est l� que notre application + se connectera plus tard. Si vous souhaitez d�marrez � partir d'une nouvelle base de donn�es + pour ce tutoriel (faites <literal>CTRL + C</literal> dans la fen�tre the window), effacez + le r�pertoire <literal>data/</literal> et red�marrez HSQL DB � nouveau. + + </para> + + <para> + Hibernate est la couche de votre application qui se connecte � cette base de donn�es, + donc il a besoin des informations de connexion. Les connexions sont �tablies � travers + un pool de connexions JDBC, que nous devons aussi configurer. La distribution Hibernate + contient diff�rents outils de gestion de pools de connexions JDBC open source, mais + pour ce didacticiel nous utiliserons le pool de connexions int�gr� � Hibernate. Notez + que vous devez copier les biblioth�ques requises dans votre classpath et utiliser + une configuration de pool de connexions diff�rente si vous voulez utiliser + un logiciel de gestion de pools JDBC tiers avec une qualit� de production. + </para> + + <para> + Pour la configuration d'Hibernate, nous pouvons utiliser un simple fichier + <literal>hibernate.properties</literal>, un fichier <literal>hibernate.cfg.xml</literal> + l�g�rement plus sophistiqu�, ou m�me une configuration compl�te par programmation. La + plupart des utilisateurs pr�f�rent le fichier de configuration XML : + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <session-factory> + +  + <property name="connection.driver_class">org.hsqldb.jdbcDriver</property> + <property name="connection.url">jdbc:hsqldb:hsql://localhost</property> + <property name="connection.username">sa</property> + <property name="connection.password"></property> + +  + <property name="connection.pool_size">1</property> + +  + <property name="dialect">org.hibernate.dialect.HSQLDialect</property> + +  + <property name="current_session_context_class">thread</property> + +  + <property name="cache.provider_class">org.hibernate.cache.NoCacheProvider</property> + +  + <property name="show_sql">true</property> + +  + <property name="hbm2ddl.auto">create</property> + + <mapping resource="events/Event.hbm.xml"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + <para> + Notez que cette configuration XML utilise une DTD diff�rente. Nous configurons + une <literal>SessionFactory</literal> d'Hibernate - une fabrique globale responsable + d'une base de donn�es particuli�re. Si vous avez plusieurs base de donn�es, utilisez + plusieurs configurations <literal><session-factory></literal>, g�n�ralement + dans des fichiers de configuration diff�rents (pour un d�marrage plus facile). + </para> + + <para> + Les quatre premiers �l�ments <literal>property</literal> contiennent la configuration + n�cessaire pour la connexion JDBC. L'�l�ment <literal>property</literal> du dialecte + sp�cifie quelle variante du SQL Hibernate va g�n�rer. La gestion automatique des sessions + d'Hibernate pour les contextes de persistance sera d�taill�e tr�s vite. + L'option <literal>hbm2ddl.auto</literal> active la g�n�ration automatique des sch�mas de + base de donn�es - directement dans la base de donn�es. Cela peut bien s�r aussi �tre + d�sactiv� (en supprimant l'option de configuration) ou redirig� vers un fichier avec + l'aide de la t�che Ant <literal>SchemaExport</literal>. Finalement, nous ajoutons + le(s) fichier(s) de mapping pour les classes persistantes. + </para> + + <para> + Copiez ce fichier dans le r�pertoire source, il terminera dans la racine + du classpath. Hibernate cherchera automatiquement, au d�marrage, un fichier appel� + <literal>hibernate.cfg.xml</literal> dans la racine du classpath. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-ant" revision="1"> + <title>Construction avec Ant</title> + + <para> + Nous allons maintenant construire le didacticiel avec Ant. Vous aurez besoin d'avoir Ant + d'install� - r�cup�rez-le � partir de <ulink url="http://ant.apache.org/bindownload.cgi"> la page + de t�l�chargement de Ant</ulink>. Comment installer Ant ne sera pas couvert ici. R�f�rez-vous + au <ulink url="http://ant.apache.org/manual/index.html">manuel d'Ant</ulink>. Apr�s que + vous aurez install� Ant, nous pourrons commencer � cr�er le fichier de construction. Il + s'appellera <literal>build.xml</literal> et sera plac� directement dans le r�pertoire de + d�veloppement. + </para> + + <para> + Un fichier de construction basique ressemble � �a : + </para> + + <programlisting><![CDATA[<project name="hibernate-tutorial" default="compile"> + + <property name="sourcedir" value="${basedir}/src"/> + <property name="targetdir" value="${basedir}/bin"/> + <property name="librarydir" value="${basedir}/lib"/> + + <path id="libraries"> + <fileset dir="${librarydir}"> + <include name="*.jar"/> + </fileset> + </path> + + <target name="clean"> + <delete dir="${targetdir}"/> + <mkdir dir="${targetdir}"/> + </target> + + <target name="compile" depends="clean, copy-resources"> + <javac srcdir="${sourcedir}" + destdir="${targetdir}" + classpathref="libraries"/> + </target> + + <target name="copy-resources"> + <copy todir="${targetdir}"> + <fileset dir="${sourcedir}"> + <exclude name="**/*.java"/> + </fileset> + </copy> + </target> + +</project>]]></programlisting> + + <para> + Cela dira � Ant d'ajouter tous les fichiers du r�pertoire lib finissant par + <literal>.jar</literal> dans le classpath utilis� pour la compilation. Cela copiera aussi + tous les fichiers source non Java dans le r�pertoire cible, par exemple les fichiers de + configuration et de mapping d'Hibernate. Si vous lancez Ant maintenant, vous devriez + obtenir cette sortie : + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant +Buildfile: build.xml + +copy-resources: + [copy] Copying 2 files to C:\hibernateTutorial\bin + +compile: + [javac] Compiling 1 source file to C:\hibernateTutorial\bin + +BUILD SUCCESSFUL +Total time: 1 second ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-firstapp-helpers" revision="3"> + <title>D�marrage et aides</title> + + <para> + Il est temps de charger et de stocker quelques objets <literal>Event</literal>, + mais d'abord nous devons compl�ter la configuration avec du code + d'infrastructure. Nous devons d�marrer Hibernate. Ce d�marrage inclut la construction + d'un objet <literal>SessionFactory</literal> global et le stocker quelque part + facile d'acc�s dans le code de l'application. Une <literal>SessionFactory</literal> + peut ouvrir des nouvelles <literal>Session</literal>s. Une <literal>Session</literal> + repr�sente une unit� de travail simplement "thread�e", la <literal>SessionFactory</literal> + est un objet global "thread-safe", instanci� une seule fois. + </para> + + <para> + Nous cr�erons une classe d'aide <literal>HibernateUtil</literal> qui s'occupe du + d�marrage et rend la gestion des <literal>Session</literal>s plus facile. + Regardons l'impl�mentation : + </para> + + <programlisting><![CDATA[package util; + +import org.hibernate.*; +import org.hibernate.cfg.*; + +public class HibernateUtil { + public static final SessionFactory sessionFactory; + + static { + try { + // Cr�ation de la SessionFactory � partir de hibernate.cfg.xml + sessionFactory = new Configuration().configure().buildSessionFactory(); + } catch (Throwable ex) { + // Make sure you log the exception, as it might be swallowed + System.err.println("Initial SessionFactory creation failed." + ex); + throw new ExceptionInInitializerError(ex); + } + } + + public static final ThreadLocal session = new ThreadLocal(); + + public static SessionFactory getSessionFactory() { + return sessionFactory; + } +}]]></programlisting> + + <para> + Cette classe ne produit pas seulement la <literal>SessionFactory</literal> globale + dans un initialiseur statique (appel� une seule fois par la JVM lorsque la classe + est charg�e), elle masque le fait qu'elle exploite un singleton. Elle pourrait aussi + obtenir la <literal>SessionFactory</literal> depuis JNDI dans un serveur d'applications. + </para> + + <para> + Si vous nommez la <literal>SessionFactory</literal> dans votre fichier de configuration, + Hibernate tentera la r�cup�ration depuis JNDI. Pour �viter ce code, vous pouvez aussi + utiliser un d�ploiement JMX et laisser le conteneur (compatible JMX) instancier et lier + un <literal>HibernateService</literal> � JNDI. Ces options avanc�es sont d�taill�es dans + la documentation de r�f�rence Hibernate. + </para> + + <para> + Placez <literal>HibernateUtil.java</literal> dans le r�pertoire source de d�veloppement, + et ensuite <literal>Event.java</literal> : + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java + Event.hbm.xml + +util + HibernateUtil.java + hibernate.cfg.xml ++data +build.xml]]></programlisting> + + <para> + Cela devrait encore compiler sans probl�me. Nous avons finalement besoin de configurer + le syst�me de "logs" - Hibernate utilise commons-logging et vous laisse le choix entre + log4j et le syst�me de logs du JDK 1.4. La plupart des d�veloppeurs pr�f�rent log4j : + copiez <literal>log4j.properties</literal> de la distribution d'Hibernate (il est dans + le r�pertoire <literal>etc/</literal>) dans votre r�pertoire <literal>src</literal>, + puis faites de m�me avec <literal>hibernate.cfg.xml</literal>. Regardez la configuration + d'exemple et changez les param�tres si vous voulez une sortie plus verbeuse. Par d�faut, + seul le message de d�marrage d'Hibernate est affich� sur la sortie standard. + </para> + + <para> + L'infrastructure de ce didacticiel est compl�te - et nous sommes pr�ts � effectuer un + travail r�el avec Hibernate. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-workingpersistence" revision="4"> + <title>Charger et stocker des objets</title> + + <para> + Finalement nous pouvons utiliser Hibernate pour charger et stocker des objets. + Nous �crivons une classe <literal>EventManager</literal> avec une m�thode + <literal>main()</literal> : + </para> + + <programlisting><![CDATA[package events; +import org.hibernate.Session; + +import java.util.Date; + +import util.HibernateUtil; + +public class EventManager { + + public static void main(String[] args) { + EventManager mgr = new EventManager(); + + if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); + } + + HibernateUtil.getSessionFactory().close(); + } + + private void createAndStoreEvent(String title, Date theDate) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + + session.beginTransaction(); + + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + session.save(theEvent); + + session.getTransaction().commit(); + }]]></programlisting> + + <para> + Nous cr�ons un nouvel objet <literal>Event</literal>, et le remettons � Hibernate. + Hibernate s'occupe maintenant du SQL et ex�cute les <literal>INSERT</literal>s + dans la base de donn�es. Regardons le code de gestion de la <literal>Session</literal> + et de la <literal>Transaction</literal> avant de lancer �a. + </para> + + <para> + Une <literal>Session</literal> est une unit� de travail. Pour le moment, nous allons faire + les choses simplement et assumer une granularit� un-un entre une <literal>Session</literal> + hibernate et une transaction � la base de donn�es. Pour isoler notre code du syst�me de transaction + sous-jacent (dans notre cas, du pure JDBC, mais cela pourrait �tre JTA), nous utilisons l'API + <literal>Transaction</literal> qui est disponible depuis la <literal>Session</literal> Hibernate. + </para> + + <para> + Que fait <literal>sessionFactory.getCurrentSession()</literal> ? Premi�rement, vous pouvez + l'invoquer autant de fois que vous le voulez et n'importe o� du moment que vous avez votre + <literal>SessionFactory</literal> (facile gr�ce � <literal>HibernateUtil</literal>). + La m�thode <literal>getCurrentSession()</literal> renvoie toujours l'unit� de travail courante. + Souvenez vous que nous avons bascul� notre option de configuration au m�canisme bas� sur le "thread" + dans <literal>hibernate.cfg.xml</literal>. Par cons�quent, le scope de l'unit� de travail + courante est le thread java courant d'ex�cution. Ceci n'est pas totalement vrai. Une + <literal>Session</literal> commence lorsqu'elle est vraiment utilis�e la premi�re fois, + Lorsque nous appelons pour la premi�re fois <literal>getCurrentSession()</literal>. + Ensuite, elle est li�e, par Hibernate, au thread courant. Lorsque la transaction s'ach�ve + (commit ou rollback), Hibernate d�lie la <literal>Session</literal> du thread et la ferme + pour vous. Si vous invoquez <literal>getCurrentSession()</literal> une autre fois, vous obtenez + une nouvelle <literal>Session</literal> et pouvez entamer une nouvelle unit� de travail. + Ce mod�le de programmation "<emphasis>thread-bound</emphasis>" est le moyen le plus + populaire d'utiliser Hibernate. + </para> + + <para> + Lisez <xref linkend="transactions"/> pour plus d'informations sur la gestion des transactions et leur d�marcations. + Nous n'avons pas g�r� les erreurs et rollback sur l'exemple pr�c�dent. + </para> + + <para> + Pour lancer cette premi�re routine, nous devons ajouter une cible appelable dans + le fichier de construction de Ant : + </para> + + <programlisting><![CDATA[<target name="run" depends="compile"> + <java fork="true" classname="events.EventManager" classpathref="libraries"> + <classpath path="${targetdir}"/> + <arg value="${action}"/> + </java> +</target>]]></programlisting> + + <para> + La valeur de l'argument <literal>action</literal> correspond � la ligne de commande + qui appelle la cible : + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant run -Daction=store]]></programlisting> + + <para> + Vous devriez voir, apr�s la compilation, Hibernate d�marrer et, en fonction de votre + configuration, beaucoup de traces sur la sortie. � la fin vous trouverez la ligne suivante : + </para> + + <programlisting><![CDATA[[java] Hibernate: insert into EVENTS (EVENT_DATE, title, EVENT_ID) values (?, ?, ?)]]></programlisting> + + <para> + C'est l'<literal>INSERT</literal> ex�cut� par Hibernate, les points d'interrogation + repr�sentent les param�tres JDBC li�s. Pour voir les valeurs li�es aux arguments, ou + pour r�duire la verbosit� des traces, v�rifier votre <literal>log4j.properties</literal>. + </para> + + <para> + Maintenant nous aimerions aussi lister les �v�nements stock�s, donc nous ajoutons une + option � la m�thode principale : + </para> + + <programlisting><![CDATA[if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); +} +else if (args[0].equals("list")) { + List events = mgr.listEvents(); + for (int i = 0; i < events.size(); i++) { + Event theEvent = (Event) events.get(i); + System.out.println("Event: " + theEvent.getTitle() + + " Time: " + theEvent.getDate()); + } +}]]></programlisting> + + <para> + Nous ajoutons aussi une nouvelle m�thode <literal>listEvents()</literal> : + </para> + + <programlisting><![CDATA[private List listEvents() { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + + session.beginTransaction(); + + List result = session.createQuery("from Event").list(); + + session.getTransaction().commit(); + + return result; +}]]></programlisting> + + <para> + Ce que nous faisons ici c'est utiliser une requ�te HQL (Hibernate Query Language) pour + charger tous les objets <literal>Event</literal> existants de la base de donn�es. + Hibernate g�n�rera le SQL appropri�, l'enverra � la base de donn�es et peuplera des + objets <literal>Event</literal> avec les donn�es. Vous pouvez cr�er des requ�tes plus + complexes avec HQL, bien s�r. + </para> + + <para> + Maintenant, pour ex�cuter et tester tout �a, suivez ces �tapes : + </para> + + <itemizedlist> + <listitem> + <para> + Ex�cutez <literal>ant run -Daction=store</literal> pour stocker quelque + chose dans la base de donn�es et, bien s�r, pour g�n�rer, avant, le sch�ma + de la base de donn�es gr�ce � hbm2ddl. + </para> + </listitem> + <listitem> + <para> + Maintenant d�sactivez hbm2ddl en commentant la propri�t� dans votre fichier + <literal>hibernate.cfg.xml</literal>. G�n�ralement vous la laissez seulement + activ�e dans des tests unitaires en continu, mais une autre ex�cution de hbm2ddl + <emphasis>effacerait</emphasis> tout ce que vous avez stock� - le param�tre de + configuration <literal>create</literal> se traduit en fait par "supprimer toutes les + tables du sch�ma, puis re-cr�er toutes les tables, lorsque la SessionFactory est + construite". + </para> + </listitem> + </itemizedlist> + + <para> + Si maintenant vous appelez Ant avec <literal>-Daction=list</literal>, vous devriez voir + les �v�nements que vous avez stock�s jusque l�. Vous pouvez bien s�r aussi appeler l'action + <literal>store</literal> plusieurs fois. + </para> + + </sect2> + + </sect1> + + <sect1 id="tutorial-associations"> + <title>Partie 2 - Mapper des associations</title> + + <para> + Nous avons mapp� une classe d'une entit� persistante vers une table. Partons de l� et + ajoutons quelques associations de classe. D'abord nous ajouterons des gens � notre + application, et stockerons une liste d'�v�nements auxquels ils participent. + </para> + + <sect2 id="tutorial-associations-mappinguser" revision="1"> + <title>Mapper la classe Person</title> + + <para> + La premi�re version de la classe <literal>Person</literal> est simple : + </para> + + <programlisting><![CDATA[package events; + +public class Person { + + private Long id; + private int age; + private String firstname; + private String lastname; + + public Person() {} + + // Accessor methods for all properties, private setter for 'id' + +}]]></programlisting> + + <para> + Cr�ez un nouveau fichier de mapping appel� <literal>Person.hbm.xml</literal> + (n'oubliez pas la r�f�rence � la DTD) + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="native"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Finalement, ajoutez la nouveau mapping � la configuration d'Hibernate : + </para> + + <programlisting><![CDATA[<mapping resource="events/Event.hbm.xml"/> +<mapping resource="events/Person.hbm.xml"/>]]></programlisting> + <para> + Nous allons maintenant cr�er une association entre ces deux entit�s. �videmment, + des personnes peuvent participer aux �v�nements, et des �v�nements ont des participants. + Les questions de conception que nous devons traiter sont : direction, cardinalit� et comportement + de la collection. + </para> + + </sect2> + + <sect2 id="tutorial-associations-unidirset" revision="2"> + <title>Une association unidirectionnelle bas�e sur Set</title> + + <para> + Nous allons ajouter une collection d'�v�nements � la classe <literal>Person</literal>. De + cette mani�re nous pouvons facilement naviguer dans les �v�nements d'une personne + particuli�re, sans ex�cuter une requ�te explicite - en appelant + <literal>aPerson.getEvents()</literal>. Nous utilisons une collection Java, un + <literal>Set</literal>, parce que la collection ne contiendra pas d'�l�ments dupliqu�s et + l'ordre ne nous importe pas. + </para> + + <para> + Nous avons besoin d'une association unidirectionnelle, pluri-valu�e, impl�ment�e avec + un <literal>Set</literal>. �crivons le code pour �a dans les classes Java et mappons les : + </para> + + <programlisting><![CDATA[public class Person { + + private Set events = new HashSet(); + + public Set getEvents() { + return events; + } + + public void setEvents(Set events) { + this.events = events; + } +}]]></programlisting> + + <para> + D'abord nous mappons cette association, mais pensez � l'autre c�t�. Clairement, nous pouvons + la laisser unidirectionnelle. Ou alors, nous pourrions cr�er une autre collection sur + <literal>Event</literal>, si nous voulons �tre capable de la parcourir de mani�re + bidirectionnelle, c'est-�-dire avoir <literal>anEvent.getParticipants()</literal>. + Ce n'est pas n�cessaire d'un point de vue fonctionnel. Vous pourrez toujours ex�cuter une requ�te + explicite pour r�cup�rer les participants d'un "event" particulier. Ce choix de conception + vous est laiss�, mais ce qui reste certains est la cardinalit� de l'association: "plusieurs" + des deux c�t�s, nous appelons cela une association <emphasis>many-to-many</emphasis>. + Par cons�quent nous utilisons un mapping Hibernate many-to-many: + </para> + + <programlisting><![CDATA[<class name="events.Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="native"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + + <set name="events" table="PERSON_EVENT"> + <key column="PERSON_ID"/> + <many-to-many column="EVENT_ID" class="Event"/> + </set> + +</class>]]></programlisting> + + <para> + Hibernate supporte toutes sortes de mapping de collection, un <literal><set></literal> + �tant le plus commun. Pour une association many-to-many (ou une relation + d'entit� <emphasis>n:m</emphasis>), une table d'association est requise. Chaque ligne dans cette table repr�sente un lien entre une personne et un �v�nement. Le nom de la table est + configur� avec l'attribut <literal>table</literal> de l'�l�ment <literal>set</literal>. Le + nom de la colonne identifiant dans l'association, du c�t� de la personne, est d�fini avec + l'�l�ment <literal><key></literal>, et le nom de la colonne pour l'�v�nement dans + l'attribut <literal>column</literal> de <literal><many-to-many></literal>. Vous + devez aussi donner � Hibernate la classe des objets de votre collection (c'est-�-dire : la + classe de l'autre c�t� de la collection). + </para> + + <para> + Le sch�ma de base de donn�es pour ce mapping est donc : + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | + |_____________| |__________________| | PERSON | + | | | | |_____________| + | *EVENT_ID | <--> | *EVENT_ID | | | + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | + |_____________| | FIRSTNAME | + | LASTNAME | + |_____________| + ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-associations-working" revision="1"> + <title>Travailler avec l'association</title> + + <para> + R�unissons quelques personnes et quelques �v�nements dans une nouvelle m�thode dans + <literal>EventManager</literal> : + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + Event anEvent = (Event) session.load(Event.class, eventId); + + aPerson.getEvents().add(anEvent); + + session.getTransaction().commit(); +}]]></programlisting> + + <para> + Apr�s le chargement d'une <literal>Person</literal> et d'un <literal>Event</literal>, modifiez + simplement la collection en utilisant les m�thodes normales de la collection. Comme vous + pouvez le voir, il n'y a pas d'appel explicite � <literal>update()</literal> ou + <literal>save()</literal>, Hibernate d�tecte automatiquement que la collection a �t� + modifi�e et a besoin d'�tre mise � jour. Ceci est appel� <emphasis>la v�rification sale + automatique</emphasis> (NdT : "automatic dirty checking"), et vous pouvez aussi l'essayer en + modifiant le nom ou la propri�t� date de n'importe lequel de vos objets. Tant qu'ils sont dans + un �tat <emphasis>persistant</emphasis>, c'est-�-dire, li�s � une <literal>Session</literal> Hibernate + particuli�re (c-�-d qu'ils ont juste �t� charg�s ou sauvegard�s dans une unit� de travail), + Hibernate surveille les changements et ex�cute le SQL correspondant. Le processus de + synchronisation de l'�tat de la m�moire avec la base de donn�es, g�n�ralement seulement � la fin + d'une unit� de travail, est appel� <emphasis>flushing</emphasis>. Dans notre code, l'unit� de travail + s'ach�ve par un commit (ou rollback) de la transaction avec la base de donn�es - comme d�fini + par notre option <literal>thread</literal> de configuration pour la classe <literal>CurrentSessionContext</literal>. + </para> + + <para> + Vous pourriez bien s�r charger une personne et un �v�nement dans diff�rentes unit�s de travail. Ou + vous modifiez un objet � l'ext�rieur d'une <literal>Session</literal>, s'il n'est pas dans un �tat + persistant (s'il �tait persistant avant, nous appelons cet �tat <emphasis>d�tach�</emphasis>). + Vous pouvez m�me modifier une collection lorsqu'elle est d�tach�e: + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session + .createQuery("select p from Person p left join fetch p.events where p.id = :pid") + .setParameter("pid", personId) + .uniqueResult(); // Eager fetch the collection so we can use it detached + + Event anEvent = (Event) session.load(Event.class, eventId); + + session.getTransaction().commit(); + + // End of first unit of work + + aPerson.getEvents().add(anEvent); // aPerson (and its collection) is detached + + // Begin second unit of work + + Session session2 = HibernateUtil.getSessionFactory().getCurrentSession(); + session2.beginTransaction(); + + session2.update(aPerson); // Reattachment of aPerson + + session2.getTransaction().commit(); +}]]></programlisting> + + <para> + L'appel � <literal>update</literal> rend un objet d�tach� � nouveau persistant, vous pourriez + dire qu'il le lie � une unit� de travail, ainsi toutes les modifications (ajout, suppression) que vous avez faites + pendant qu'il �tait d�tach� peuvent �tre sauvegard�es dans la base de donn�es + (il se peut que vous ayez besoin de modifier quelques unes des m�thodes pr�c�dentes + pour retourner cet identifiant). + </para> + + <programlisting><![CDATA[else if (args[0].equals("addpersontoevent")) { + Long eventId = mgr.createAndStoreEvent("My Event", new Date()); + Long personId = mgr.createAndStorePerson("Foo", "Bar"); + mgr.addPersonToEvent(personId, eventId); + System.out.println("Added person " + personId + " to event " + eventId);]]></programlisting> + + <para> + Ce n'est pas tr�s utile dans notre situation actuelle, mais c'est un concept important + que vous pouvez mettre dans votre propre application. + Pour le moment, compl�tez cet exercice en ajoutant une nouvelle action � la m�thode + principale des <literal>EventManager</literal>s et appelez la � partir de la ligne de + commande. Si vous avez besoin des identifiants d'une personne et d'un �v�nement - la + m�thode <literal>save()</literal> les retourne. + </para> + + <para> + C'�tait un exemple d'une association entre deux classes de m�me importance, deux entit�s. + Comme mentionn� plus t�t, il y a d'autres classes et d'autres types dans un mod�le typique, + g�n�ralement "moins importants". Vous en avez d�j� vu certains, comme un <literal>int</literal> + ou une <literal>String</literal>. Nous appelons ces classes des <emphasis>types de valeur</emphasis>, + et leurs instances <emphasis>d�pendent</emphasis> d'une entit� particuli�re. Des instances de ces + types n'ont pas leur propre identit�, elles ne sont pas non plus partag�es entre des entit�s (deux + personnes ne r�f�rencent pas le m�me objet <literal>firstname</literal>, m�me si elles ont le + m�me pr�nom). Bien s�r, des types de valeur ne peuvent pas seulement �tre trouv�s dans + le JDK (en fait, dans une application Hibernate toutes les classes du JDK sont consid�r�es + comme des types de valeur), vous pouvez aussi �crire vous-m�me des classes d�pendantes, + <literal>Address</literal> ou <literal>MonetaryAmount</literal>, par exemple. + </para> + + <para> + Vous pouvez aussi concevoir une collection de types de valeur. C'est conceptuellement tr�s + diff�rent d'une collection de r�f�rences vers d'autres entit�s, mais tr�s ressemblant en Java. + </para> + + </sect2> + + <sect2 id="tutorial-associations-valuecollections"> + <title>Collection de valeurs</title> + + <para> + Nous ajoutons une collection d'objets de type de valeur � l'entit� <literal>Person</literal>. + Nous voulons stocker des adresses email, donc le type que nous utilisons est <literal>String</literal>, + et la collection est encore un <literal>Set</literal> : + </para> + <programlisting><![CDATA[private Set emailAddresses = new HashSet(); + +public Set getEmailAddresses() { + return emailAddresses; +} + +public void setEmailAddresses(Set emailAddresses) { + this.emailAddresses = emailAddresses; +}]]></programlisting> + + <para> + Le mapping de ce <literal>Set</literal> : + </para> + + <programlisting><![CDATA[<set name="emailAddresses" table="PERSON_EMAIL_ADDR"> + <key column="PERSON_ID"/> + <element type="string" column="EMAIL_ADDR"/> +</set>]]></programlisting> + + <para> + La diff�rence compar�e au mapping vu plus t�t est la partie <literal>element</literal>, + laquelle dit � Hibernate que la collection ne contient pas de r�f�rences vers une autre entit�, + mais une collection d'�l�ments de type <literal>String</literal> (le nom en minuscule vous + indique que c'est un type/convertisseur du mapping Hibernate). Une fois encore, l'attribut + <literal>table</literal> de l'�l�ment <literal>set</literal> d�termine le nom de la table pour la + collection. L'�l�ment <literal>key</literal> d�finit le nom de la colonne de la clef �trang�re + dans la table de la collection. L'attribut <literal>column</literal> dans l'�l�ment + <literal>element</literal> d�finit le nom de la colonne o� les valeurs de <literal>String</literal> + seront r�ellement stock�es. + </para> + + <para> + Regardons le sch�ma mis � jour : + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | ___________________ + |_____________| |__________________| | PERSON | | | + | | | | |_____________| | PERSON_EMAIL_ADDR | + | *EVENT_ID | <--> | *EVENT_ID | | | |___________________| + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | | *EMAIL_ADDR | + |_____________| | FIRSTNAME | |___________________| + | LASTNAME | + |_____________| + ]]></programlisting> + + <para> + Vous pouvez voir que la clef primaire de la table de la collection est en fait une + clef compos�e, utilisant deux colonnes. Ceci implique aussi qu'il ne peut pas y avoir + d'adresses email dupliqu�es par personne, ce qui est exactement la s�mantique dont + nous avons besoin pour un ensemble en Java. + </para> + + <para> + Vous pouvez maintenant tester et ajouter des �l�ments � cette collection, juste comme + nous l'avons fait avant en liant des personnes et des �v�nements. C'est le m�me code + en Java. + </para> + + <programlisting><![CDATA[private void addEmailToPerson(Long personId, String emailAddress) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + + // The getEmailAddresses() might trigger a lazy load of the collection + aPerson.getEmailAddresses().add(emailAddress); + + session.getTransaction().commit(); +}]]></programlisting> + + <para> + Cette fois ci, nous n'avons pas utilis� une requ�te de chargement agressif (<emphasis>fetch</emphasis>) + pour initialiser la collection. Par cons�quent, l'invocation du getter d�clenchera un + select suppl�mentaire pour l'initialiser. Traquez les logs SQL et tentez d'optimiser + ce cas avec un chargement aggressif. + </para> + + </sect2> + + <sect2 id="tutorial-associations-bidirectional" revision="1"> + <title>Associations bidirectionnelles</title> + + <para> + Ensuite nous allons mapper une association bidirectionnelle - faire fonctionner + l'association entre une personne et un �v�nement � partir des deux c�t�s en Java. + Bien s�r, le sch�ma de la base de donn�es ne change pas, nous avons toujours une pluralit� + many-to-many. Une base de donn�es relationnelle est plus flexible qu'un langage de + programmation r�seau, donc elle n'a pas besoin de direction de navigation - les donn�es + peuvent �tre vues et r�cup�r�es de toutes les mani�res possibles. + </para> + + <para> + D'abord, ajouter une collection de participants � la classe <literal>Event</literal> : + </para> + + <programlisting><![CDATA[private Set participants = new HashSet(); + +public Set getParticipants() { + return participants; +} + +public void setParticipants(Set participants) { + this.participants = participants; +}]]></programlisting> + + <para> + Maintenant mapper ce c�t� de l'association aussi, dans <literal>Event.hbm.xml</literal>. + </para> + + <programlisting><![CDATA[<set name="participants" table="PERSON_EVENT" inverse="true"> + <key column="EVENT_ID"/> + <many-to-many column="PERSON_ID" class="events.Person"/> +</set>]]></programlisting> + + <para> + Comme vous le voyez, ce sont des mappings de <literal>set</literal>s normaux dans les + deux documents de mapping. Notez que les noms de colonne dans <literal>key</literal> et + <literal>many-to-many</literal> sont invers�s dans les 2 documents de mapping. L'ajout + le plus important ici est l'attribut <literal>inverse="true"</literal> dans l'�l�ment + <literal>set</literal> du mapping de la collection des <literal>Event</literal>s. + </para> + + <para> + Ce que signifie qu'Hibernate devrait prendre l'autre c�t� - la classe <literal>Person</literal> - + s'il a besoin de renseigner des informations � propos du lien entre les deux. Ce sera + beaucoup plus facile � comprendre une fois que vous verrez comment le lien bidirectionnel + entre les deux entit�s est cr��. + </para> + + </sect2> + + <sect2 id="tutorial-associations-usingbidir"> + <title>Travailler avec des liens bidirectionnels</title> + + <para> + Premi�rement, gardez � l'esprit qu'Hibernate n'affecte pas la s�mantique normale de Java. + Comment avons-nous cr�� un lien entre une <literal>Person</literal> et un <literal>Event</literal> + dans l'exemple unidirectionnel ? Nous avons ajout� une instance de <literal>Event</literal> + � la collection des r�f�rences d'�v�nement d'une instance de <literal>Person</literal>. Donc, + �videmment, si vous voulons rendre ce lien bidirectionnel, nous devons faire la m�me chose de + l'autre c�t� - ajouter une r�f�rence de <literal>Person</literal> � la collection d'un + <literal>Event</literal>. Cette "configuration du lien des deux c�t�s" est absolument + n�cessaire et vous ne devriez jamais oublier de le faire. + </para> + + <para> + Beaucoup de d�veloppeurs programment de mani�re d�fensive et cr�ent des + m�thodes de gestion de lien pour affecter correctement les deux c�t�s, + par exemple dans <literal>Person</literal> : + </para> + + <programlisting><![CDATA[protected Set getEvents() { + return events; +} + +protected void setEvents(Set events) { + this.events = events; +} + +public void addToEvent(Event event) { + this.getEvents().add(event); + event.getParticipants().add(this); +} + +public void removeFromEvent(Event event) { + this.getEvents().remove(event); + event.getParticipants().remove(this); +}]]></programlisting> + + <para> + Notez que les m�thodes get et set pour la collection sont maintenant prot�g�es - ceci permet � des + classes du m�me paquet et aux sous-classes d'acc�der encore aux m�thodes, mais emp�che n'importe qui + d'autre de mettre le d�sordre directement dans les collections (enfin, presque). Vous devriez + probablement faire de m�me avec la collection de l'autre c�t�. + </para> + + <para> + Et � propos de l'attribut de mapping <literal>inverse</literal> ? Pour vous, et pour Java, un lien + bidirectionnel est simplement une mani�re de configurer correctement les r�f�rences des deux c�t�s. + Hibernate n'a cependant pas assez d'informations pour ordonner correctement les expressions SQL + <literal>INSERT</literal> et <literal>UPDATE</literal> (pour �viter les violations de contrainte), et + a besoin d'aide pour g�rer proprement les associations bidirectionnelles. Rendre + <literal>inverse</literal> un c�t� d'une assocation dit � Hibernate de l'ignorer essentiellement, pour + le consid�rer comme un <emphasis>miroir</emphasis> de l'autre c�t�. C'est tout ce qui est n�cessaire � + Hibernate pour d�couvrir tout des probl�mes de transformation d'un mod�le de navigation + directionnelle vers un sch�ma SQL de base de donn�es. Les r�gles dont vous devez vous souvenir sont : + toutes les associations bidirectionnelles ont besoin d'un c�t� marqu� <literal>inverse</literal>. + Dans une association un-vers-plusieurs vous pouvez choisir n'importe quel c�t�, il n'y a pas de + diff�rence. + </para> + + </sect2> + </sect1> + + <sect1 id="tutorial-webapp"> + <title>Part 3 - L'application web EventManager</title> + + <para> + Une application web Hibernate utilise la <literal>Session</literal> et <literal>Transaction</literal> + comme une application standalone. Cependant, quelques patterns sont utiles. Nous allons coder une + <literal>EventManagerServlet</literal>. Cette servlet peut lister tous les �v�nements stock�s dans + la base de donn�es, et fournir une formulaire HTML pour saisir d'autres �v�nements. + </para> + + <sect2 id="tutorial-webapp-servlet"> + <title>Ecrire la servlet de base</title> + + <para> + Cr�ons une nouvelle classe dans notre r�pertoire source, dans le package <literal>events</literal>: + </para> + + <programlisting><![CDATA[package events; + +// Imports + +public class EventManagerServlet extends HttpServlet { + + private final SimpleDateFormat dateFormatter = + new SimpleDateFormat("dd.MM.yyyy"); + + // Servlet code +}]]></programlisting> + + <para> + Le <literal>dateFormatter</literal> est un outil que nous utiliserons plus tard pour convertir les objets + <literal>Date</literal> depuis et vers des chaines de caract�res. Il est propice de n'avoir qu'un + formatter comme membre de la servlet. + </para> + + <para> + La servlet n'accepte que les requ�tes HTTP <literal>GET</literal>, la m�thode � impl�menter est donc + <literal>doGet()</literal>: + </para> + + <programlisting><![CDATA[protected void doGet(HttpServletRequest request, + HttpServletResponse response) + throws ServletException, IOException { + + try { + // Begin unit of work + HibernateUtil.getSessionFactory() + .getCurrentSession().beginTransaction(); + + // Process request and render page... + + // End unit of work + HibernateUtil.getSessionFactory() + .getCurrentSession().getTransaction().commit(); + + } catch (Exception ex) { + HibernateUtil.getSessionFactory() + .getCurrentSession().getTransaction().rollback(); + throw new ServletException(ex); + } + +}]]></programlisting> + + <para> + La pattern que nous utilisons ici est appel� <emphasis>session-per-request</emphasis>. + Lorsqu'une requ�te touche la servlet, une nouvelle <literal>Session</literal> hibernate est + ouverte � l'invocationde <literal>getCurrentSession()</literal> sur la + <literal>SessionFactory</literal>. Ensuite, une transaction avec la base de donn�es est d�marr�e— + tous les acc�s � la base de donn�es interviennent au sein de la transactiton, peu importe que les donn�es + soient lues ou �crites (nous n'utilisons pas le mode auto-commit dans les applications). + </para> + + <para> + Ensuite, les actions possibles de la requ�tes sont ex�cut�es et la r�ponse HTML + est rendue. Nous en parlerons plus tard. + </para> + + <para> + Enfin, l'unit� de travail s'ach�ve lorsque l'ex�cution et le rendu sont achev�s. + Si un probl�me survient lors de ces deux phases, une exception est soulev�e et la + transaction avec la base de donn�es subit un rollback. Voila pour le pattern + <literal>session-per-request</literal>. Au lieu d'un code de d�marcation de transaction + au sein de chaque servlet, vous pouvez �crire un filtre de servlet. + Voir le site Hibernate et le Wiki pour plus d'information sur ce pattern, appel� + <emphasis>Open Session in View</emphasis>— vous en aurez besoin d�s que vous + utiliserez des JSPs et non plus des servlets pour le rendu de vos vues. + </para> + + </sect2> + + <sect2 id="tutorial-webapp-processing"> + <title>Proc�der et rendre</title> + + <para> + Impl�mentons l'ex�cution de la requ�te et le rendu de la page. + </para> + +<programlisting><![CDATA[// Write HTML header +PrintWriter out = response.getWriter(); +out.println("<html><head><title>Event Manager</title></head><body>"); + +// Handle actions +if ( "store".equals(request.getParameter("action")) ) { + + String eventTitle = request.getParameter("eventTitle"); + String eventDate = request.getParameter("eventDate"); + + if ( "".equals(eventTitle) || "".equals(eventDate) ) { + out.println("<b><i>Please enter event title and date.</i></b>"); + } else { + createAndStoreEvent(eventTitle, dateFormatter.parse(eventDate)); + out.println("<b><i>Added event.</i></b>"); + } +} + +// Print page +printEventForm(out); +listEvents(out); + +// Write HTML footer +out.println("</body></html>"); +out.flush(); +out.close();]]></programlisting> + + <para> + Ce style de code avec un mix de Java et d'HTML ne serait pas scalable + dans une application plus complexe—gardez � l'esprit que nous ne faisons qu'illustrer + les concepts basiques d'Hibernate dans ce tutoriel. Ce code affiche une en t�te et un pied de page + HTML. Dans cette page, sont affich�s un formulaire pour la saisie d'�v�nements ainsi + qu'une liste de tous les �v�nements de la base de donn�es. La premi�re m�thode + est triviale est ne fait que sortir de l'HTML: + </para> + + <programlisting><![CDATA[private void printEventForm(PrintWriter out) { + out.println("<h2>Add new event:</h2>"); + out.println("<form>"); + out.println("Title: <input name='eventTitle' length='50'/><br/>"); + out.println("Date (e.g. 24.12.2009): <input name='eventDate' length='10'/><br/>"); + out.println("<input type='submit' name='action' value='store'/>"); + out.println("</form>"); +}]]></programlisting> + + <para> + La m�thode <literal>listEvents()</literal> utilise la + <literal>Session</literal> Hibernate li�e au thread courant pour ex�cuter la + requ�te: + </para> + + <programlisting><![CDATA[private void listEvents(PrintWriter out) { + List result = HibernateUtil.getSessionFactory() + .getCurrentSession().createCriteria(Event.class).list(); + if (result.size() > 0) { + out.println("<h2>Events in database:</h2>"); + out.println("<table border='1'>"); + out.println("<tr>"); + out.println("<th>Event title</th>"); + out.println("<th>Event date</th>"); + out.println("</tr>"); + for (Iterator it = result.iterator(); it.hasNext();) { + Event event = (Event) it.next(); + out.println("<tr>"); + out.println("<td>" + event.getTitle() + "</td>"); + out.println("<td>" + dateFormatter.format(event.getDate()) + "</td>"); + out.println("</tr>"); + } + out.println("</table>"); + } +}]]></programlisting> + + <para> + FEnfin, l'action <literal>store</literal> renvoie � la m�thode + <literal>createAndStoreEvent()</literal>, qui utilise aussi la + <literal>Session</literal> du thread courant: + </para> + + <programlisting><![CDATA[protected void createAndStoreEvent(String title, Date theDate) { + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + HibernateUtil.getSessionFactory() + .getCurrentSession().save(theEvent); +}]]></programlisting> + + <para> + La servlet est faite. Une requ�te � la servlet sera ex�cut�e par une seule + <literal>Session</literal> et <literal>Transaction</literal>. Comme pour une application + standalone, Hibernate peut automatiquement lier ces objets au thread courant d'ex�cution. + Cela vous laisse la libert� de s�parer votre code en couches et d'acc�der � la + <literal>SessionFactory</literal> par le moyen que vous voulez. + G�n�ralement, vous utiliserez des conceptions plus sophistiqu�es et d�placerez + le code d'acc�s aux donn�es dans une couche DAO. Voir le wiki Hibernate pour plus + d'exemples. + </para> + + </sect2> + + <sect2 id="tutorial-webapp-deploy"> + <title>D�ployer et tester</title> + + <para> + Pour d�ployer cette application, vous devez cr�er une archive Web, un War. Ajoutez + la cible Ant suivante dans votre <literal>build.xml</literal>: + </para> + +<programlisting><![CDATA[<target name="war" depends="compile"> + <war destfile="hibernate-tutorial.war" webxml="web.xml"> + <lib dir="${librarydir}"> + <exclude name="servlet.jar"/> + </lib> + + <classes dir="${targetdir}"/> + </war> +</target>]]></programlisting> + + <para> + Cette cible cr�� un fichier nomm� <literal>hibernate-tutorial.war</literal> + dans le r�pertoire de votre projet. Elle package les biblioth�ques et le descripteur <literal>web.xml</literal> + qui est attendu dans le r�pertoire racine de votre projet: + </para> + + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<web-app version="2.4" + xmlns="http://java.sun.com/xml/ns/j2ee" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> + + <servlet> + <servlet-name>Event Manager</servlet-name> + <servlet-class>events.EventManagerServlet</servlet-class> + </servlet> + + <servlet-mapping> + <servlet-name>Event Manager</servlet-name> + <url-pattern>/eventmanager</url-pattern> + </servlet-mapping> +</web-app>]]></programlisting> + + <para> + Avant de compiler et d�ployer l'application web, notez qu'une biblioth�que suppl�mentaire + est requise: <literal>servlet.jar</literal>. C'est le kit de d�veloppement de Servlet Java, + si vous ne disposez pas de cette biblioth�que, prenez la sur le + <ulink url="http://java.sun.com/products/servlet/archive.html">site de Sun</ulink> et copiez la + dans votre r�pertoire des biblioth�ques. Cependant, elle ne sera utilis�e uniquement pour la + compilation et sera exclue du paackage WAR. + </para> + + <para> + Pour construire et d�ployer, appelez <literal>ant war</literal> dans votre projet et + copier le fichier <literal>hibernate-tutorial.war</literal> dans le r�pertoire <literal>webapp</literal> de tomcat + Si vous n'avez pas install� Tomcat, t�l�chargez le et suivez la notice d'installation. + Vous n'avez pas � modifier la configuration Tomcat pour d�ployer cette application. + </para> + + <para> + Une fois l'application d�ploy�e et Tomcat lanc�, acc�dez � l'application via + <literal>http://localhost:8080/hibernate-tutorial/eventmanager</literal>. + Assurez vous de consulter les traces tomcat pour observer l'initialisation + d'Hibernate � la premi�re requ�te touchant votre servlet (l'initialisation statique dans <literal>HibernateUtil</literal> + est invoqu�e) et pour v�rifier qu'aucune exception ne survienne. + </para> + + </sect2> + + </sect1> + + <sect1 id="tutorial-summary" revision="1"> + <title>R�sum�</title> + + <para> + Ce didacticiel a couvert les bases de l'�criture d'une simple application Hibernate ainsi qu'une petite application web. + </para> + + <para> + Si vous �tes d�j� confiants avec Hibernate, continuez � parcourir les sujets que vous trouvez + int�ressants � travers la table des mati�res de la documentation de r�f�rence - les plus + demand�s sont le traitement transactionnel (<xref linkend="transactions"/>), la performance + des r�cup�rations d'information (<xref linkend="performance"/>), ou l'utilisation de l'API + (<xref linkend="objectstate"/>) et les fonctionnalit�s des requ�tes (<xref linkend="objectstate-querying"/>). + </para> + + <para> + N'oubliez pas de v�rifier le site web d'Hibernate pour d'autres didacticiels (plus sp�cialis�s). + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/content/xml.xml (from rev 14070, core/trunk/documentation/manual/fr-FR/src/main/docbook/modules/xml.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/content/xml.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/content/xml.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,292 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<chapter id="xml"> + <title>Mapping XML</title> + + <para><emphasis> + Notez que cette fonctionnalit� est exp�rimentale dans Hibernate 3.0 et + est en d�veloppement extr�mement actif. + </emphasis></para> + + <sect1 id="xml-intro" revision="1"> + <title>Travailler avec des donn�es XML</title> + + <para> + Hibernate vous laisse travailler avec des donn�es XML persistantes de la + m�me mani�re que vous travaillez avec des POJOs persistants. Un arbre XML + peut �tre vu comme une autre mani�re de repr�senter les donn�es relationnelles + au niveau objet, � la place des POJOs. + </para> + + <para> + Hibernate supporte dom4j en tant qu'API pour la manipulation des arbres XML. + Vous pouvez �crire des requ�tes qui r�cup�rent des arbres dom4j � partie de la + base de donn�es, et avoir toutes les modifications que vous faites sur l'arbre + automatiquement synchronis�es dans la base de donn�es. Vous pouvez m�me prendre + un document XML, l'analyser en utilisant dom4j, et l'�crire dans la base de + donn�es via les op�rations basiques d'Hibernate : + <literal>persist(), saveOrUpdate(), merge(), delete(), replicate()</literal> + (merge() n'est pas encore support�). + </para> + + <para> + Cette fonctionnalit� a plusieurs applications dont l'import/export de donn�es, + l'externalisation d'entit�s via JMS ou SOAP et les rapports XSLT. + </para> + + <para> + Un simple mapping peut �tre utilis� pour simultan�ment mapper les propri�t�s + d'une classe et les noeuds d'un document XML vers la base de donn�es, ou, + si il n'y a pas de classe � mapper, il peut �tre utilis� juste pour mapper + le XML. + </para> + + <sect2 id="xml-intro-mapping"> + <title>Sp�cifier le mapping XML et le mapping d'une classe ensemble</title> + + <para> + Voici un exemple de mapping d'un POJO et du XML simultan�ment : + </para> + + <programlisting><![CDATA[<class name="Account" + table="ACCOUNTS" + node="account"> + + <id name="accountId" + column="ACCOUNT_ID" + node="@id"/> + + <many-to-one name="customer" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false"/> + + <property name="balance" + column="BALANCE" + node="balance"/> + + ... + +</class>]]></programlisting> + </sect2> + + <sect2 id="xml-onlyxml"> + <title>Sp�cifier seulement un mapping XML</title> + + <para> + Voici un exemple dans lequel il n'y a pas de class POJO : + </para> + + <programlisting><![CDATA[<class entity-name="Account" + table="ACCOUNTS" + node="account"> + + <id name="id" + column="ACCOUNT_ID" + node="@id" + type="string"/> + + <many-to-one name="customerId" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false" + entity-name="Customer"/> + + <property name="balance" + column="BALANCE" + node="balance" + type="big_decimal"/> + + ... + +</class>]]></programlisting> + + <para> + Ce mapping vous permet d'acc�der aux donn�es comme un arbre dom4j, ou comme + un graphe de paire nom de propri�t�/valeur (<literal>Map</literal>s java). Les + noms des propri�t�s sont des constructions purement logiques qui peuvent �tre + r�f�r�es des dans requ�tes HQL. + </para> + + </sect2> + + </sect1> + + <sect1 id="xml-mapping" revision="1"> + <title>M�tadonn�es du mapping XML</title> + + <para> + Plusieurs �l�ments du mapping Hibernate acceptent l'attribut <literal>node</literal>. + Ceci vous permet de sp�cifier le nom d'un attribut XML ou d'un �l�ment qui + contient la propri�t� ou les donn�es de l'entit�. Le format de l'attribut + <literal>node</literal> doit �tre un des suivants : + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para><literal>"element-name"</literal> - mappe vers l'�l�ment XML nomm�</para> + </listitem> + <listitem> + <para><literal>"@attribute-name"</literal> - mappe vers l'attribut XML nomm�</para> + </listitem> + <listitem> + <para><literal>"."</literal> - mappe vers le parent de l'�l�ment</para> + </listitem> + <listitem> + <para> + <literal>"element-name/@attribute-name"</literal> - + mappe vers l'�l�ment nomm� de l'attribut nomm� + </para> + </listitem> + </itemizedlist> + + <para> + Pour des collections et de simples associations valu�es, il y a un attribut + <literal>embed-xml</literal> suppl�mentaire. Si <literal>embed-xml="true"</literal>, + qui est la valeur par d�faut, l'arbre XML pour l'entit� associ�e (ou la collection + des types de valeurs) sera embarqu�e directement dans l'arbre XML pour l'entit� qui + poss�de l'association. Sinon, si <literal>embed-xml="false"</literal>, alors + seule la valeur de l'identifiant r�f�renc� appara�tra dans le XML pour de simples + associations de points, et les collections n'appra�tront simplement pas. + </para> + + <para> + Vous devriez faire attention � ne pas laisser <literal>embed-xml="true"</literal> + pour trop d'associations, puisque XML ne traite pas bien les liens circurlaires. + </para> + + <programlisting><![CDATA[<class name="Customer" + table="CUSTOMER" + node="customer"> + + <id name="id" + column="CUST_ID" + node="@id"/> + + <map name="accounts" + node="." + embed-xml="true"> + <key column="CUSTOMER_ID" + not-null="true"/> + <map-key column="SHORT_DESC" + node="@short-desc" + type="string"/> + <one-to-many entity-name="Account" + embed-xml="false" + node="account"/> + </map> + + <component name="name" + node="name"> + <property name="firstName" + node="first-name"/> + <property name="initial" + node="initial"/> + <property name="lastName" + node="last-name"/> + </component> + + ... + +</class>]]></programlisting> + + <para> + dans ce cas, nous avons d�cid� d'embarquer la collection d'identifiants de compte, + mais pas les donn�es actuelles du compte. La requ�te HQL suivante : + </para> + + <programlisting><![CDATA[from Customer c left join fetch c.accounts where c.lastName like :lastName]]></programlisting> + + <para> + devrait retourner l'ensemble de donn�es suivant : + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account short-desc="Savings">987632567</account> + <account short-desc="Credit Card">985612323</account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + <para> + Si vous positionnez <literal>embed-xml="true"</literal> sur le mapping + <literal><one-to-many></literal>, les donn�es pourraient + ressembler plus � �a : + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account id="987632567" short-desc="Savings"> + <customer id="123456789"/> + <balance>100.29</balance> + </account> + <account id="985612323" short-desc="Credit Card"> + <customer id="123456789"/> + <balance>-2370.34</balance> + </account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + </sect1> + + + <sect1 id="xml-manipulation" revision="1"> + <title>Manipuler des donn�es XML</title> + + <para> + Relisons et mettons � jour des documents XML dans l'application. Nous faisons + �a en obtenant une session dom4j : + </para> + + <programlisting><![CDATA[Document doc = ....; + +Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +List results = dom4jSession + .createQuery("from Customer c left join fetch c.accounts where c.lastName like :lastName") + .list(); +for ( int i=0; i<results.size(); i++ ) { + //add the customer data to the XML document + Element customer = (Element) results.get(i); + doc.getRootElement().add(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <programlisting><![CDATA[Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +Element cust = (Element) dom4jSession.get("Customer", customerId); +for ( int i=0; i<results.size(); i++ ) { + Element customer = (Element) results.get(i); + //change the customer name in the XML and database + Element name = customer.element("name"); + name.element("first-name").setText(firstName); + name.element("initial").setText(initial); + name.element("last-name").setText(lastName); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + Il est extr�mement utile de combiner cette fonctionnalit� avec l'op�ration + <literal>replicate()</literal> d'Hibernate pour impl�menter des imports/exports + de donn�es XML. + </para> + + </sect1> + +</chapter> + Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.zargo =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/AuthorWork.zargo ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.zargo =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/CustomerOrderProduct.zargo ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.zargo =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/EmployerEmployee.zargo ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.svg =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.svg (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/images/full_cream.svg 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,429 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> + +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="354.331" + height="336.614" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,5.25349)" + style="font-size:12;" + id="g659"> + <rect + width="212.257" + height="57.2441" + x="17.9576" + y="100.132" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + transform="matrix(0.743454,0,0,0.482981,6.46949,52.2178)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <rect + width="325.86" + height="63.6537" + x="17.4083" + y="15.194" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="325.86" + height="63.6537" + x="13.6713" + y="12.4966" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + <g + transform="matrix(1.14345,0,0,0.729078,-1.67818,105.325)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <text + x="170.824753" + y="58.402939" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="170.824997" + y="58.402901" + id="tspan360"> +Application</tspan> + </text> + <text + x="178.076340" + y="364.281433" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="178.076004" + y="364.281006" + id="tspan421"> +Database</tspan> + </text> + <text + x="68.605331" + y="138.524582" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="68.605301" + y="138.524994" + id="tspan384"> +SessionFactory</tspan> + </text> + <rect + width="67.0014" + height="101.35" + x="196.927" + y="89.2389" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect387" /> + <rect + width="67.0014" + height="101.35" + x="194.633" + y="86.4389" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect388" /> + <text + x="249.108841" + y="173.885559" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text389"> + <tspan + x="249.108994" + y="173.886002" + id="tspan392"> +Session</tspan> + </text> + <rect + width="73.0355" + height="101.35" + x="270.995" + y="90.0018" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect395" /> + <rect + width="73.0355" + height="101.35" + x="267.869" + y="87.2018" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect396" /> + <text + x="328.593658" + y="174.715622" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text397"> + <tspan + x="328.593994" + y="174.716003" + id="tspan563"> +Transaction</tspan> + </text> + <g + transform="matrix(0.29544,0,0,0.397877,9.70533,103.96)" + style="font-size:12;" + id="g565"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect566" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect567" /> + </g> + <text + x="25.592752" + y="204.497803" + transform="scale(0.823795,0.823795)" + style="font-size:10;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text568"> + <tspan + x="25.592800" + y="204.498001" + id="tspan662"> +TransactionFactory</tspan> + </text> + <g + transform="matrix(0.298082,0,0,0.397877,99.6898,103.96)" + style="font-size:12;" + id="g573"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect574" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect575" /> + </g> + <text + x="134.030670" + y="205.532791" + transform="scale(0.823795,0.823795)" + style="font-size:10;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text576"> + <tspan + x="134.031006" + y="205.533005" + id="tspan664"> +ConnectionProvider</tspan> + </text> + <g + transform="matrix(1.14345,0,0,0.729078,-1.67818,38.9539)" + style="font-size:12;" + id="g587"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect588" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect589" /> + </g> + <rect + width="90.951" + height="44.4829" + x="25.6196" + y="206.028" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect594" /> + <rect + width="90.951" + height="44.4829" + x="24.4229" + y="204.135" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect595" /> + <text + x="85.575645" + y="282.300354" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text596"> + <tspan + x="85.575600" + y="282.299988" + id="tspan607"> +JNDI</tspan> + </text> + <rect + width="90.951" + height="44.4829" + x="236.937" + y="206.791" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect610" /> + <rect + width="90.951" + height="44.4829" + x="235.741" + y="204.898" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect611" /> + <text + x="342.093201" + y="283.226410" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text612"> + <tspan + x="342.092987" + y="283.226013" + id="tspan621"> +JTA</tspan> + </text> + <rect + width="90.951" + height="44.4829" + x="130.134" + y="206.791" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect616" /> + <rect + width="90.951" + height="44.4829" + x="128.937" + y="204.898" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect617" /> + <text + x="212.445343" + y="283.226410" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text618"> + <tspan + x="212.445007" + y="283.226013" + id="tspan623"> +JDBC</tspan> + </text> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,6.19341)" + style="font-size:12;" + id="g637"> + <g + transform="matrix(0.499515,0,0,0.415467,-0.237339,5.61339)" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="33.749969" + y="50.589706" + style="font-size:11;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="33.750000" + y="50.589699" + id="tspan635"> +Transient Objects</tspan> + </text> + </g> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,5.25349)" + style="font-size:12;" + id="g644"> + <g + transform="matrix(0.297486,0,0,0.516482,230.251,36.9178)" + id="g364"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect365" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect366" /> + </g> + <text + x="277.123230" + y="85.155571" + style="font-size:11;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text367"> + <tspan + x="277.122986" + y="85.155602" + id="tspan631"> +Persistent</tspan> + <tspan + x="277.122986" + y="96.155602" + id="tspan633"> +Objects</tspan> + </text> + </g> +</svg> Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/hibernate_logo_a.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/hibernate_logo_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.svg =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.svg (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/images/lite.svg 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,334 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> + +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="318.898" + height="248.031" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <rect + width="291.837" + height="57.0074" + x="17.3169" + y="18.646" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="291.837" + height="57.0074" + x="13.9703" + y="16.2302" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + <g + transform="matrix(0.326107,0,0,0.765831,9.59261,8.98517)" + style="font-size:12;" + id="g161"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <g + transform="matrix(1.02406,0,0,0.652953,0.223384,39.9254)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <g + transform="matrix(0.449834,0,0,0.338463,-3.15909,9.73319)" + style="font-size:12;" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="302.277679" + y="65.943230" + transform="scale(0.73778,0.73778)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="302.277954" + y="65.943184" + id="tspan360"> +Application</tspan> + </text> + <text + x="36.235924" + y="63.796055" + transform="scale(0.73778,0.73778)" + style="font-size:14;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="36.235950" + y="63.796051" + id="tspan427"> +Transient Objects</tspan> + </text> + <text + x="180.416245" + y="290.543701" + transform="scale(0.73778,0.73778)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="180.415939" + y="290.543549" + id="tspan421"> +Database</tspan> + </text> + <text + x="25.037701" + y="179.154755" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="25.037655" + y="179.154648" + id="tspan384"> +SessionFactory</tspan> + </text> + <g + transform="matrix(0.252763,0,0,0.765831,109.104,8.98517)" + style="font-size:12;" + id="g386"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect387" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect388" /> + </g> + <g + transform="matrix(0.297394,0,0,0.572692,101.502,21.6359)" + style="font-size:12;" + id="g364"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect365" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect366" /> + </g> + <text + x="202.746506" + y="102.992203" + transform="scale(0.73778,0.73778)" + style="font-size:14;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text367"> + <tspan + x="202.746948" + y="102.992249" + id="tspan423"> +Persistent</tspan> + <tspan + x="202.746948" + y="116.992355" + id="tspan425"> +Objects</tspan> + </text> + <text + x="174.458496" + y="180.080795" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text389"> + <tspan + x="174.458618" + y="180.080338" + id="tspan392"> +Session</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,188.675,8.98517)" + style="font-size:12;" + id="g394"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect395" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect396" /> + </g> + <text + x="260.413269" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text397"> + <tspan + x="260.412964" + y="179.154343" + id="tspan400"> +JDBC</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,229.156,8.98517)" + style="font-size:12;" + id="g405"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect406" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect407" /> + </g> + <text + x="320.606903" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text408"> + <tspan + x="320.606964" + y="179.154343" + id="tspan417"> +JNDI</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,269.281,8.98517)" + style="font-size:12;" + id="g411"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect412" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect413" /> + </g> + <text + x="377.096313" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text414"> + <tspan + x="377.096008" + y="179.154999" + id="tspan145"> +JTA</tspan> + </text> +</svg> Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.svg =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.svg (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/images/overview.svg 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,250 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> + +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="248.031" + height="248.031" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,-3.02123)" + style="font-size:12;" + id="g158"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="17.3527" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="15.3883" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + </g> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,3.04452)" + style="font-size:12;" + id="g161"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,8.0993)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <g + transform="matrix(0.771934,0,0,0.543505,2.59104,21.1103)" + style="font-size:12;" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="105.392174" + y="56.568123" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="105.392273" + y="56.568146" + id="tspan186"> +Application</tspan> + </text> + <text + x="81.820183" + y="103.149330" + transform="scale(0.771934,0.771934)" + style="font-size:20;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="81.820213" + y="103.149727" + id="tspan206"> +Persistent Objects</tspan> + </text> + <text + x="111.548180" + y="278.927887" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="111.547874" + y="278.927551" + id="tspan200"> +Database</tspan> + </text> + <text + x="94.436180" + y="153.805740" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="94.436180" + y="153.805740" + id="tspan221"> +HIBERNATE</tspan> + </text> + <g + transform="matrix(0.771934,0,0,0.771934,2.59083,1.02261)" + style="font-size:12;" + id="g254"> + <g + transform="translate(4.58374,2.61928)" + id="g176"> + <g + transform="matrix(0.571429,0,0,0.67347,-10.6174,117.093)" + id="g170"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect171" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect172" /> + </g> + <g + transform="matrix(0.571429,0,0,0.67347,138.682,117.093)" + id="g173"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect174" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect175" /> + </g> + </g> + <text + x="47.259438" + y="182.367538" + style="font-weight:bold;stroke-width:1pt;font-family:Courier;" + id="text191"> + <tspan + x="47.259399" + y="182.367996" + id="tspan212"> +hibernate.</tspan> + <tspan + x="47.259399" + y="194.367996" + id="tspan214"> +properties</tspan> + </text> + <text + x="198.523010" + y="188.260941" + style="font-weight:normal;stroke-width:1pt;font-family:helvetica;" + id="text194"> + <tspan + id="tspan195"> +XML Mapping</tspan> + </text> + </g> +</svg> Copied: core/trunk/documentation/manual/fr-FR/src/main/docbook/legal_notice.xml (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml) =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/legal_notice.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/legal_notice.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,52 @@ +<?xml version='1.0'?> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + + +<legalnotice id="Legal_Notice"> + <title>Legal Notice</title> + <para> + <address> + <street>1801 Varsity Drive</street> + <city>Raleigh</city>, <state>NC</state><postcode>27606-2072</postcode><country>USA</country> + <phone>Phone: +1 919 754 3700</phone> + <phone>Phone: 888 733 4281</phone> + <fax>Fax: +1 919 754 3701</fax> + <pob>PO Box 13588</pob><city>Research Triangle Park</city>, <state>NC</state><postcode>27709</postcode><country>USA</country> + </address> + </para> + <para> + Copyright <trademark class="copyright"></trademark> 2007 by Red Hat, Inc. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</ulink>). + </para> + <para> + Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. + </para> + <para> + Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder. + </para> + <para> + Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat, Inc. in the United States and other countries. + </para> + <para> + All other trademarks referenced herein are the property of their respective owners. + </para> + <para> + The GPG fingerprint of the security(a)redhat.com key is: + </para> + <para> + CA 20 86 86 2B D6 9D FC 65 F6 EC C4 21 91 80 CD DB 42 A6 0E + </para> +</legalnotice> \ No newline at end of file Deleted: core/trunk/documentation/manual/fr-FR/src/main/docbook/master.xml =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/master.xml 2007-10-09 18:14:35 UTC (rev 14073) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/master.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -1,188 +0,0 @@ -<?xml version='1.0' encoding="iso-8859-1"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" - "../support/docbook-dtd/docbookx.dtd" -[ -<!ENTITY tutorial SYSTEM "modules/tutorial.xml"> -<!ENTITY architecture SYSTEM "modules/architecture.xml"> -<!ENTITY configuration SYSTEM "modules/configuration.xml"> -<!ENTITY persistent-classes SYSTEM "modules/persistent_classes.xml"> -<!ENTITY basic-mapping SYSTEM "modules/basic_mapping.xml"> -<!ENTITY collection-mapping SYSTEM "modules/collection_mapping.xml"> -<!ENTITY association-mapping SYSTEM "modules/association_mapping.xml"> -<!ENTITY component-mapping SYSTEM "modules/component_mapping.xml"> -<!ENTITY inheritance-mapping SYSTEM "modules/inheritance_mapping.xml"> -<!ENTITY session-api SYSTEM "modules/session_api.xml"> -<!ENTITY transactions SYSTEM "modules/transactions.xml"> -<!ENTITY events SYSTEM "modules/events.xml"> -<!ENTITY batch SYSTEM "modules/batch.xml"> -<!ENTITY query-hql SYSTEM "modules/query_hql.xml"> -<!ENTITY query-criteria SYSTEM "modules/query_criteria.xml"> -<!ENTITY query-sql SYSTEM "modules/query_sql.xml"> -<!ENTITY filters SYSTEM "modules/filters.xml"> -<!ENTITY xml SYSTEM "modules/xml.xml"> -<!ENTITY performance SYSTEM "modules/performance.xml"> -<!ENTITY toolset-guide SYSTEM "modules/toolset_guide.xml"> -<!ENTITY example-parentchild SYSTEM "modules/example_parentchild.xml"> -<!ENTITY example-weblog SYSTEM "modules/example_weblog.xml"> -<!ENTITY example-mappings SYSTEM "modules/example_mappings.xml"> -<!ENTITY best-practices SYSTEM "modules/best_practices.xml"> -]> - -<book lang="fr"> - - <bookinfo> - <title>HIBERNATE - Persistance relationnelle en Java standard</title> - <subtitle>Documentation de r�f�rence d'Hibernate</subtitle> - <releaseinfo>3.3.0.beta1</releaseinfo> - </bookinfo> - - <toc/> - - <preface id="preface" revision="2"> - <title>Pr�face</title> - <para> - Traducteur(s): Vincent Ricard, Sebastien Cesbron, Michael Courcy, Vincent Gigu�re, Baptiste Mathus, Emmanuel Bernard, Anthony Patricio - </para> - <para> - Travailler dans les deux univers que sont l'orient� objet et la base de donn�es - relationnelle peut �tre lourd et consommateur en temps dans le monde de - l'entreprise d'aujourd'hui. Hibernate est un outil de mapping objet/relationnel - pour le monde Java. Le terme mapping objet/relationnel (ORM) d�crit la technique - consistant � faire le lien entre la repr�sentation objet des donn�es - et sa repr�sentation relationnelle bas�e sur un sch�ma SQL. - </para> - - <para> - Non seulement, Hibernate s'occupe du transfert des classes Java dans les tables - de la base de donn�es (et des types de donn�es Java dans les types de donn�es SQL), - mais il permet de requ�ter les donn�es et propose des moyens de les r�cup�rer. - Il peut donc r�duire de mani�re significative le temps de d�veloppement qui - aurait �t� autrement perdu dans une manipulation manuelle des donn�es via SQL - et JDBC. - </para> - - <para> - Le but d'Hibernate est de lib�rer le d�veloppeur de 95 pourcent des t�ches de - programmation li�es � la persistance des donn�es communes. Hibernate n'est - probablement pas la meilleure solution pour les applications centr�es sur les - donn�es qui n'utilisent que les proc�dures stock�es pour impl�menter la logique - m�tier dans la base de donn�es, il est le plus utile dans les mod�les m�tier orient�s - objets dont la logique m�tier est impl�ment�e dans la couche Java dite interm�diaire. - Cependant, Hibernate vous aidera � supprimer ou � encapsuler le code SQL - sp�cifique � votre base de donn�es et vous aidera sur la t�che commune qu'est - la transformation des donn�es d'une repr�sentation tabulaire � une - repr�sentation sous forme de graphe d'objets. - </para> - - <para> - Si vous �tes nouveau dans Hibernate et le mapping Objet/Relationnel voire m�me en Java, - suivez ces quelques �tapes : - </para> - - <orderedlist> - <listitem> - <para> - Lisez <xref linkend="tutorial"/> pour un didacticiel plus long avec plus d'instructions �tape par �tape. - </para> - </listitem> - <listitem> - <para> - Lisez <xref linkend="architecture"/> pour comprendre les environnements dans lesquels - Hibernate peut �tre utilis�. - </para> - </listitem> - <listitem> - <para> - Regardez le r�pertoire <literal>eg</literal> de la distribution Hibernate, il contient - une application simple et autonome. Copiez votre pilote JDBC dans le r�pertoire - <literal>lib/</literal> et �ditez <literal>src/hibernate.properties</literal>, en - positionnant correctement les valeurs pour votre base de donn�es. A partir d'une - invite de commande dans le r�pertoire de la distribution, tapez <literal>ant eg</literal> - (cela utilise Ant), ou sous Windows tapez <literal>build eg</literal>. - </para> - </listitem> - <listitem> - <para> - Fa�tes de cette documentation de r�f�rence votre principale source d'information. - Pensez � lire <emphasis>Java Persistence with Hibernate</emphasis> - (http://www.manning.com/bauer2) si vous avez besoin de plus d'aide avec le design - d'applications ou si vous pr�f�rez un tutoriel pas � pas. Visitez aussi - http://caveatemptor.hibernate.org et t�l�chargez l'application exemple - pour Java Persistence with Hibernate. - </para> - </listitem> - <listitem> - <para> - Les questions les plus fr�quemment pos�es (FAQs) trouvent leur r�ponse sur le - site web Hibernate. - </para> - </listitem> - <listitem> - <para> - Des d�mos, exemples et tutoriaux de tierces personnes sont r�f�renc�s sur - le site web Hibernate. - </para> - </listitem> - <listitem> - <para> - La zone communautaire (Community Area) du site web Hibernate est une - bonne source d'information sur les design patterns et sur diff�rentes - solutions d'int�gration d'Hibernate (Tomcat, JBoss, Spring Framework, Struts, - EJB, etc). - </para> - </listitem> - </orderedlist> - - <para> - Si vous avez des questions, utilisez le forum utilisateurs du site web Hibernate. - Nous utilisons �galement l'outil de gestion des incidents JIRA pour tout ce qui - est rapports de bogue et demandes d'�volution. Si vous �tes int�ress� par le - d�veloppement d'Hibernate, joignez-vous � la liste de diffusion de d�veloppement. - </para> - - <para> - Le d�veloppement commercial, le support de production et les formations � Hibernate - sont propos�s par JBoss Inc (voir http://www.hibernate.org/SupportTraining/). Hibernate - est un projet Open Source professionnel et un composant critique de la suite de produits - JBoss Enterprise Middleware System (JEMS). - </para> - - </preface> - - &tutorial; - - &architecture; - - &configuration; - - &persistent-classes; - - &basic-mapping; - &collection-mapping; - &association-mapping; - &component-mapping; - &inheritance-mapping; - - &session-api; - &transactions; - &events; - &batch; - - &query-hql; - &query-criteria; - &query-sql; - &filters; - &xml; - - &performance; - - &toolset-guide; - - &example-parentchild; - &example-weblog; - &example-mappings; - - &best-practices; - -</book> - Added: core/trunk/documentation/manual/fr-FR/src/main/docbook/translators.xml =================================================================== --- core/trunk/documentation/manual/fr-FR/src/main/docbook/translators.xml (rev 0) +++ core/trunk/documentation/manual/fr-FR/src/main/docbook/translators.xml 2007-10-09 18:28:36 UTC (rev 14074) @@ -0,0 +1,34 @@ +<?xml version='1.0'?> + +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<authorgroup id="AuthorGroup"> + <othercredit class="translator"> + <firstname>Vincent</firstname> + <surname>Ricard</surname> + </othercredit> + <othercredit class="translator"> + <firstname>Sebastien</firstname> + <surname>Cesbron</surname> + </othercredit> + <othercredit class="translator"> + <firstname>Michael</firstname> + <surname>Courcy</surname> + </othercredit> + <othercredit class="translator"> + <firstname>Vincent</firstname> + <surname>Giguère</surname> + </othercredit> + <othercredit class="translator"> + <firstname>Baptiste</firstname> + <surname>Mathus</surname> + </othercredit> + <othercredit class="translator"> + <firstname>Emmanuel</firstname> + <surname>Bernard</surname> + </othercredit> + <othercredit class="translator"> + <firstname>Anthony</firstname> + <surname>Patricio</surname> + </othercredit> +</authorgroup> \ No newline at end of file

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14073 - in core/trunk/documentation/manual/en-US/src/main/docbook: content and 1 other directory.

by hibernate-commits＠lists.jboss.org

Author: steve.ebersole(a)jboss.com Date: 2007-10-09 14:14:35 -0400 (Tue, 09 Oct 2007) New Revision: 14073 Added: core/trunk/documentation/manual/en-US/src/main/docbook/Hibernate_Reference.xml core/trunk/documentation/manual/en-US/src/main/docbook/author_group.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/ core/trunk/documentation/manual/en-US/src/main/docbook/content/architecture.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/association_mapping.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/basic_mapping.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/batch.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/best_practices.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/collection_mapping.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/component_mapping.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/configuration.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/events.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/example_mappings.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/example_parentchild.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/example_weblog.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/filters.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/inheritance_mapping.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/performance.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/persistent_classes.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/preface.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/query_criteria.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/query_hql.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/query_sql.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/session_api.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/toolset_guide.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/transactions.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/tutorial.xml core/trunk/documentation/manual/en-US/src/main/docbook/content/xml.xml core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml Removed: core/trunk/documentation/manual/en-US/src/main/docbook/master.xml core/trunk/documentation/manual/en-US/src/main/docbook/modules/ Log: new docbook layout Added: core/trunk/documentation/manual/en-US/src/main/docbook/Hibernate_Reference.xml =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/Hibernate_Reference.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/Hibernate_Reference.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,90 @@ +<?xml version='1.0' encoding="iso-8859-1"?> + +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY versionNumber "3.3.0.alpha1"> + <!ENTITY copyrightYear "2004"> + <!ENTITY copyrightHolder "Red Hat Middleware, LLC."> +]> + +<book> + + <bookinfo> + <title>HIBERNATE - Relational Persistence for Idiomatic Java</title> + <subtitle>Hibernate Reference Documentation</subtitle> + <releaseinfo>&versionNumber;</releaseinfo> + <productnumber>&versionNumber;</productnumber> + <issuenum>1</issuenum> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/hibernate_logo_a.png" align="center" /> + </imageobject> + <imageobject role="html"> + <imagedata fileref="images/hibernate_logo_a.png" depth="3cm" /> + </imageobject> + </mediaobject> + <copyright> + <year>&copyrightYear;</year> + <holder>&copyrightHolder;</holder> + </copyright> +  + <xi:include href="legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </bookinfo> + + <toc/> + + <xi:include href="content/preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/tutorial.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/persistent_classes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/basic_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/collection_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/association_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/component_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/inheritance_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/session_api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/transactions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/batch.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/query_hql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_criteria.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_sql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/filters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/xml.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/performance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/toolset_guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/example_parentchild.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_weblog.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_mappings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/best_practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</book> + Added: core/trunk/documentation/manual/en-US/src/main/docbook/author_group.xml =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/author_group.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/author_group.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,30 @@ +<?xml version='1.0'?> + +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<authorgroup id="AuthorGroup"> + <collab> + <collabname>The Hibernate team</collabname> + </collab> +  +</authorgroup> \ No newline at end of file Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/architecture.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/architecture.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/architecture.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/architecture.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,373 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + + +<chapter id="architecture"> + + <title>Architecture</title> + + <sect1 id="architecture-overview" revision="1"> + <title>Overview</title> + + <para> + A (very) high-level view of the Hibernate architecture: + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/overview.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/overview.png" format="PNG" align="center"/> + </imageobject> + </mediaobject> + + <para> + This diagram shows Hibernate using the database and configuration data to + provide persistence services (and persistent objects) to the application. + </para> + + <para> + We would like to show a more detailed view of the runtime architecture. + Unfortunately, Hibernate is flexible and supports several approaches. We will + show the two extremes. The "lite" architecture has the application + provide its own JDBC connections and manage its own transactions. This approach + uses a minimal subset of Hibernate's APIs: + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/lite.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/lite.png" format="PNG" align="center"/> + </imageobject> + </mediaobject> + + <para> + The "full cream" architecture abstracts the application away from the + underlying JDBC/JTA APIs and lets Hibernate take care of the details. + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="../images/full_cream.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../images/full_cream.png" format="PNG" align="center"/> + </imageobject> + </mediaobject> + + <para> + Heres some definitions of the objects in the diagrams: + + <variablelist spacing="compact"> + <varlistentry> + <term>SessionFactory (<literal>org.hibernate.SessionFactory</literal>)</term> + <listitem> + <para> + A threadsafe (immutable) cache of compiled mappings for a single database. + A factory for <literal>Session</literal> and a client of + <literal>ConnectionProvider</literal>. Might hold an optional (second-level) + cache of data that is reusable between transactions, at a + process- or cluster-level. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Session (<literal>org.hibernate.Session</literal>)</term> + <listitem> + <para> + A single-threaded, short-lived object representing a conversation between + the application and the persistent store. Wraps a JDBC connection. Factory + for <literal>Transaction</literal>. Holds a mandatory (first-level) cache + of persistent objects, used when navigating the object graph or looking up + objects by identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Persistent objects and collections</term> + <listitem> + <para> + Short-lived, single threaded objects containing persistent state and business + function. These might be ordinary JavaBeans/POJOs, the only special thing about + them is that they are currently associated with (exactly one) + <literal>Session</literal>. As soon as the <literal>Session</literal> is closed, + they will be detached and free to use in any application layer (e.g. directly + as data transfer objects to and from presentation). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Transient and detached objects and collections</term> + <listitem> + <para> + Instances of persistent classes that are not currently associated with a + <literal>Session</literal>. They may have been instantiated by + the application and not (yet) persisted or they may have been instantiated by a + closed <literal>Session</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Transaction (<literal>org.hibernate.Transaction</literal>)</term> + <listitem> + <para> + (Optional) A single-threaded, short-lived object used by the application to + specify atomic units of work. Abstracts application from underlying JDBC, + JTA or CORBA transaction. A <literal>Session</literal> might span several + <literal>Transaction</literal>s in some cases. However, transaction demarcation, + either using the underlying API or <literal>Transaction</literal>, is never + optional! + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ConnectionProvider (<literal>org.hibernate.connection.ConnectionProvider</literal>)</term> + <listitem> + <para> + (Optional) A factory for (and pool of) JDBC connections. Abstracts application from + underlying <literal>Datasource</literal> or <literal>DriverManager</literal>. + Not exposed to application, but can be extended/implemented by the developer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>TransactionFactory (<literal>org.hibernate.TransactionFactory</literal>)</term> + <listitem> + <para> + (Optional) A factory for <literal>Transaction</literal> instances. Not exposed to the + application, but can be extended/implemented by the developer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Extension Interfaces</emphasis></term> + <listitem> + <para> + Hibernate offers many optional extension interfaces you can implement to customize + the behavior of your persistence layer. See the API documentation for details. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + Given a "lite" architecture, the application bypasses the + <literal>Transaction</literal>/<literal>TransactionFactory</literal> and/or + <literal>ConnectionProvider</literal> APIs to talk to JTA or JDBC directly. + </para> + </sect1> + + <sect1 id="architecture-states" revision="1"> + <title>Instance states</title> + <para> + An instance of a persistent classes may be in one of three different states, + which are defined with respect to a <emphasis>persistence context</emphasis>. + The Hibernate <literal>Session</literal> object is the persistence context: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>transient</term> + <listitem> + <para> + The instance is not, and has never been associated with + any persistence context. It has no persistent identity + (primary key value). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>persistent</term> + <listitem> + <para> + The instance is currently associated with a persistence + context. It has a persistent identity (primary key value) + and, perhaps, a corresponding row in the database. For a + particular persistence context, Hibernate + <emphasis>guarantees</emphasis> that persistent identity + is equivalent to Java identity (in-memory location of the + object). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>detached</term> + <listitem> + <para> + The instance was once associated with a persistence + context, but that context was closed, or the instance + was serialized to another process. It has a persistent + identity and, perhaps, a corrsponding row in the database. + For detached instances, Hibernate makes no guarantees + about the relationship between persistent identity and + Java identity. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 id="architecture-jmx" revision="1"> + <title>JMX Integration</title> + + <para> + JMX is the J2EE standard for management of Java components. Hibernate may be managed via + a JMX standard service. We provide an MBean implementation in the distribution, + <literal>org.hibernate.jmx.HibernateService</literal>. + </para> + + <para> + For an example how to deploy Hibernate as a JMX service on the JBoss Application Server, + please see the JBoss User Guide. On JBoss AS, you also get these benefits if you deploy + using JMX: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Session Management:</emphasis> The Hibernate <literal>Session</literal>'s life cycle + can be automatically bound to the scope of a JTA transaction. This means you no + longer have to manually open and close the <literal>Session</literal>, this + becomes the job of a JBoss EJB interceptor. You also don't have to worry about + transaction demarcation in your code anymore (unless you'd like to write a portable + persistence layer of course, use the optional Hibernate <literal>Transaction</literal> + API for this). You call the <literal>HibernateContext</literal> to access a + <literal>Session</literal>. + </para> + </listitem> + <listitem> + <para> + <emphasis>HAR deployment:</emphasis> Usually you deploy the Hibernate JMX service using a JBoss + service deployment descriptor (in an EAR and/or SAR file), it supports all the usual + configuration options of a Hibernate <literal>SessionFactory</literal>. However, you still + have to name all your mapping files in the deployment descriptor. If you decide to use + the optional HAR deployment, JBoss will automatically detect all mapping files in your + HAR file. + </para> + </listitem> + </itemizedlist> + + <para> + Consult the JBoss AS user guide for more information about these options. + </para> + + <para> + Another feature available as a JMX service are runtime Hibernate statistics. See + <xref linkend="configuration-optional-statistics"/>. + </para> + </sect1> + + <sect1 id="architecture-jca" revision="1"> + <title>JCA Support</title> + <para> + Hibernate may also be configured as a JCA connector. Please see the website for more + details. Please note that Hibernate JCA support is still considered experimental. + </para> + </sect1> + + <sect1 id="architecture-current-session" revision="2"> + <title>Contextual Sessions</title> + <para> + Most applications using Hibernate need some form of "contextual" sessions, where a given + session is in effect throughout the scope of a given context. However, across applications + the definition of what constitutes a context is typically different; and different contexts + define different scopes to the notion of current. Applications using Hibernate prior + to version 3.0 tended to utilize either home-grown <literal>ThreadLocal</literal>-based + contextual sessions, helper classes such as <literal>HibernateUtil</literal>, or utilized + third-party frameworks (such as Spring or Pico) which provided proxy/interception-based contextual sessions. + </para> + <para> + Starting with version 3.0.1, Hibernate added the <literal>SessionFactory.getCurrentSession()</literal> + method. Initially, this assumed usage of <literal>JTA</literal> transactions, where the + <literal>JTA</literal> transaction defined both the scope and context of a current session. + The Hibernate team maintains that, given the maturity of the numerous stand-alone + <literal>JTA TransactionManager</literal> implementations out there, most (if not all) + applications should be using <literal>JTA</literal> transaction management whether or not + they are deployed into a <literal>J2EE</literal> container. Based on that, the + <literal>JTA</literal>-based contextual sessions is all you should ever need to use. + </para> + <para> + However, as of version 3.1, the processing behind + <literal>SessionFactory.getCurrentSession()</literal> is now pluggable. To that + end, a new extension interface (<literal>org.hibernate.context.CurrentSessionContext</literal>) + and a new configuration parameter (<literal>hibernate.current_session_context_class</literal>) + have been added to allow pluggability of the scope and context of defining current sessions. + </para> + <para> + See the Javadocs for the <literal>org.hibernate.context.CurrentSessionContext</literal> + interface for a detailed discussion of its contract. It defines a single method, + <literal>currentSession()</literal>, by which the implementation is responsible for + tracking the current contextual session. Out-of-the-box, Hibernate comes with three + implementations of this interface. + </para> + + <itemizedlist> + <listitem> + <para> + <literal>org.hibernate.context.JTASessionContext</literal> - current sessions + are tracked and scoped by a <literal>JTA</literal> transaction. The processing + here is exactly the same as in the older JTA-only approach. See the Javadocs + for details. + </para> + </listitem> + <listitem> + <para> + <literal>org.hibernate.context.ThreadLocalSessionContext</literal> - current + sessions are tracked by thread of execution. Again, see the Javadocs for details. + </para> + </listitem> + <listitem> + <para> + <literal>org.hibernate.context.ManagedSessionContext</literal> - current + sessions are tracked by thread of execution. However, you are responsible to + bind and unbind a <literal>Session</literal> instance with static methods + on this class, it does never open, flush, or close a <literal>Session</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + The first two implementations provide a "one session - one database transaction" programming + model, also known and used as <emphasis>session-per-request</emphasis>. The beginning + and end of a Hibernate session is defined by the duration of a database transaction. + If you use programatic transaction demarcation in plain JSE without JTA, you are adviced to + use the Hibernate <literal>Transaction</literal> API to hide the underlying transaction system + from your code. If you use JTA, use the JTA interfaces to demarcate transactions. If you + execute in an EJB container that supports CMT, transaction boundaries are defined declaratively + and you don't need any transaction or session demarcation operations in your code. + Refer to <xref linkend="transactions"/> for more information and code examples. + </para> + + <para> + The <literal>hibernate.current_session_context_class</literal> configuration parameter + defines which <literal>org.hibernate.context.CurrentSessionContext</literal> implementation + should be used. Note that for backwards compatibility, if this config param is not set + but a <literal>org.hibernate.transaction.TransactionManagerLookup</literal> is configured, + Hibernate will use the <literal>org.hibernate.context.JTASessionContext</literal>. + Typically, the value of this parameter would just name the implementation class to + use; for the three out-of-the-box implementations, however, there are three corresponding + short names, "jta", "thread", and "managed". + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/association_mapping.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/association_mapping.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/association_mapping.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/association_mapping.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,626 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="associations"> + + <title>Association Mappings</title> + + <sect1 id="assoc-intro" revision="1"> + <title>Introduction</title> + + <para> + Association mappings are the often most difficult thing to get right. In + this section we'll go through the canonical cases one by one, starting + with unidirectional mappings, and then considering the bidirectional cases. + We'll use <literal>Person</literal> and <literal>Address</literal> in all + the examples. + </para> + + <para> + We'll classify associations by whether or not they map to an intervening + join table, and by multiplicity. + </para> + + <para> + Nullable foreign keys are not considered good practice in traditional data + modelling, so all our examples use not null foreign keys. This is not a + requirement of Hibernate, and the mappings will all work if you drop the + nullability constraints. + </para> + + </sect1> + + <sect1 id="assoc-unidirectional" revision="1"> + <title>Unidirectional associations</title> + + <sect2 id="assoc-unidirectional-m21"> + <title>many to one</title> + + <para> + A <emphasis>unidirectional many-to-one association</emphasis> is the most + common kind of unidirectional association. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-121"> + <title>one to one</title> + + <para> + A <emphasis>unidirectional one-to-one association on a foreign key</emphasis> + is almost identical. The only difference is the column unique constraint. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + A <emphasis>unidirectional one-to-one association on a primary key</emphasis> + usually uses a special id generator. (Notice that we've reversed the direction + of the association in this example.) + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-12m"> + <title>one to many</title> + + <para> + A <emphasis>unidirectional one-to-many association on a foreign key</emphasis> + is a very unusual case, and is not really recommended. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses"> + <key column="personId" + not-null="true"/> + <one-to-many class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( addressId bigint not null primary key, personId bigint not null ) + ]]></programlisting> + + <para> + We think it's better to use a join table for this kind of association. + </para> + + </sect2> + + </sect1> + + <sect1 id="assoc-unidirectional-join" revision="1"> + <title>Unidirectional associations with join tables</title> + + <sect2 id="assoc-unidirectional-join-12m"> + <title>one to many</title> + + <para> + A <emphasis>unidirectional one-to-many association on a join table</emphasis> + is much preferred. Notice that by specifying <literal>unique="true"</literal>, + we have changed the multiplicity from many-to-many to one-to-many. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m21"> + <title>many to one</title> + + <para> + A <emphasis>unidirectional many-to-one association on a join table</emphasis> + is quite common when the association is optional. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-121"> + <title>one to one</title> + + <para> + A <emphasis>unidirectional one-to-one association on a join table</emphasis> + is extremely unusual, but possible. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m2m"> + <title>many to many</title> + + <para> + Finally, we have a <emphasis>unidirectional many-to-many association</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional" revision="1"> + <title>Bidirectional associations</title> + + <sect2 id="assoc-bidirectional-m21" revision="2"> + <title>one to many / many to one</title> + + <para> + A <emphasis>bidirectional many-to-one association</emphasis> is the + most common kind of association. (This is the standard parent/child + relationship.) + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true"> + <key column="addressId"/> + <one-to-many class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + If you use a <literal>List</literal> (or other indexed collection) you need + to set the <literal>key</literal> column of the foreign key to <literal>not null</literal>, + and let Hibernate manage the association from the collections side to maintain the index + of each element (making the other side virtually inverse by setting + <literal>update="false"</literal> and <literal>insert="false"</literal>): + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"/> + ... + <many-to-one name="address" + column="addressId" + not-null="true" + insert="false" + update="false"/> +</class> + +<class name="Address"> + <id name="id"/> + ... + <list name="people"> + <key column="addressId" not-null="true"/> + <list-index column="peopleIdx"/> + <one-to-many class="Person"/> + </list> +</class>]]></programlisting> + + <para> + It is important that you define <literal>not-null="true"</literal> on the + <literal><key></literal> element of the collection mapping if the + underlying foreign key column is <literal>NOT NULL</literal>. Don't only + declare <literal>not-null="true"</literal> on a possible nested + <literal><column></literal> element, but on the <literal><key></literal> + element. + </para> + + </sect2> + + <sect2 id="assoc-bidirectional-121"> + <title>one to one</title> + + <para> + A <emphasis>bidirectional one-to-one association on a foreign key</emphasis> + is quite common. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <one-to-one name="person" + property-ref="address"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + A <emphasis>bidirectional one-to-one association on a primary key</emphasis> + uses the special id generator. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <one-to-one name="address"/> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" + constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional-join" revision="1"> + <title>Bidirectional associations with join tables</title> + + <sect2 id="assoc-bidirectional-join-12m"> + <title>one to many / many to one</title> + + <para> + A <emphasis>bidirectional one-to-many association on a join table</emphasis>. + Note that the <literal>inverse="true"</literal> can go on either end of the + association, on the collection, or on the join. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" + table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + inverse="true" + optional="true"> + <key column="addressId"/> + <many-to-one name="person" + column="personId" + not-null="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-121"> + <title>one to one</title> + + <para> + A <emphasis>bidirectional one-to-one association on a join table</emphasis> + is extremely unusual, but possible. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true" + inverse="true"> + <key column="addressId" + unique="true"/> + <many-to-one name="person" + column="personId" + not-null="true" + unique="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-m2m" revision="1"> + <title>many to many</title> + + <para> + Finally, we have a <emphasis>bidirectional many-to-many association</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true" table="PersonAddress"> + <key column="addressId"/> + <many-to-many column="personId" + class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-complex"> + <title>More complex association mappings</title> + + <para> + More complex association joins are <emphasis>extremely</emphasis> rare. + Hibernate makes it possible to handle more complex situations using + SQL fragments embedded in the mapping document. For example, if a table + with historical account information data defines + <literal>accountNumber</literal>, <literal>effectiveEndDate</literal> + and <literal>effectiveStartDate</literal>columns, mapped as follows: + </para> + + <programlisting><![CDATA[<properties name="currentAccountKey"> + <property name="accountNumber" type="string" not-null="true"/> + <property name="currentAccount" type="boolean"> + <formula>case when effectiveEndDate is null then 1 else 0 end</formula> + </property> +</properties> +<property name="effectiveEndDate" type="date"/> +<property name="effectiveStateDate" type="date" not-null="true"/>]]></programlisting> + + <para> + Then we can map an association to the <emphasis>current</emphasis> instance + (the one with null <literal>effectiveEndDate</literal>) using: + </para> + + <programlisting><![CDATA[<many-to-one name="currentAccountInfo" + property-ref="currentAccountKey" + class="AccountInfo"> + <column name="accountNumber"/> + <formula>'1'</formula> +</many-to-one>]]></programlisting> + + <para> + In a more complex example, imagine that the association between + <literal>Employee</literal> and <literal>Organization</literal> is maintained + in an <literal>Employment</literal> table full of historical employment data. + Then an association to the employee's <emphasis>most recent</emphasis> employer + (the one with the most recent <literal>startDate</literal>) might be mapped this way: + </para> + + <programlisting><![CDATA[<join> + <key column="employeeId"/> + <subselect> + select employeeId, orgId + from Employments + group by orgId + having startDate = max(startDate) + </subselect> + <many-to-one name="mostRecentEmployer" + class="Organization" + column="orgId"/> +</join>]]></programlisting> + + <para> + You can get quite creative with this functionality, but it is usually more practical + to handle these kinds of cases using HQL or a criteria query. + </para> + + </sect1> + + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/basic_mapping.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/basic_mapping.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/basic_mapping.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/basic_mapping.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,3565 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY mdash "-"> +]> + +<chapter id="mapping"> + <title>Basic O/R Mapping</title> + + <sect1 id="mapping-declaration" revision="2"> + <title>Mapping declaration</title> + + <para> + Object/relational mappings are usually defined in an XML document. The mapping + document is designed to be readable and hand-editable. The mapping language is + Java-centric, meaning that mappings are constructed around persistent class + declarations, not table declarations. + </para> + + <para> + Note that, even though many Hibernate users choose to write the XML by hand, + a number of tools exist to generate the mapping document, including XDoclet, + Middlegen and AndroMDA. + </para> + + <para> + Lets kick off with an example mapping: + </para> + + <programlisting id="mapping-declaration-ex1" revision="1"><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" + table="cats" + discriminator-value="C"> + + <id name="id"> + <generator class="native"/> + </id> + + <discriminator column="subclass" + type="character"/> + + <property name="weight"/> + + <property name="birthdate" + type="date" + not-null="true" + update="false"/> + + <property name="color" + type="eg.types.ColorUserType" + not-null="true" + update="false"/> + + <property name="sex" + not-null="true" + update="false"/> + + <property name="litterId" + column="litterId" + update="false"/> + + <many-to-one name="mother" + column="mother_id" + update="false"/> + + <set name="kittens" + inverse="true" + order-by="litter_id"> + <key column="mother_id"/> + <one-to-many class="Cat"/> + </set> + + <subclass name="DomesticCat" + discriminator-value="D"> + + <property name="name" + type="string"/> + + </subclass> + + </class> + + <class name="Dog"> +  + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + We will now discuss the content of the mapping document. We will only describe the + document elements and attributes that are used by Hibernate at runtime. The mapping + document also contains some extra optional attributes and elements that affect the + database schemas exported by the schema export tool. (For example the <literal> + not-null</literal> attribute.) + </para> + + + + <sect2 id="mapping-declaration-doctype" revision="3"> + <title>Doctype</title> + + <para> + All XML mappings should declare the doctype shown. The actual DTD may be found + at the URL above, in the directory <literal>hibernate-x.x.x/src/org/hibernate + </literal> or in <literal>hibernate3.jar</literal>. Hibernate will always look for + the DTD in its classpath first. If you experience lookups of the DTD using an + Internet connection, check your DTD declaration against the contents of your + claspath. + </para> + + <sect3 id="mapping-declaration-entity-resolution"> + <title>EntityResolver</title> + <para> + As mentioned previously, Hibernate will first attempt to resolve DTDs in its classpath. The + manner in which it does this is by registering a custom <literal>org.xml.sax.EntityResolver</literal> + implementation with the SAXReader it uses to read in the xml files. This custom + <literal>EntityResolver</literal> recognizes two different systemId namespaces. + </para> + <itemizedlist> + <listitem> + <para> + a <literal>hibernate namespace</literal> is recognized whenever the + resolver encounteres a systemId starting with + <literal>http://hibernate.sourceforge.net/</literal>; the resolver + attempts to resolve these entities via the classlaoder which loaded + the Hibernate classes. + </para> + </listitem> + <listitem> + <para> + a <literal>user namespace</literal> is recognized whenever the + resolver encounteres a systemId using a <literal>classpath://</literal> + URL protocol; the resolver will attempt to resolve these entities + via (1) the current thread context classloader and (2) the + classloader which loaded the Hibernate classes. + </para> + </listitem> + </itemizedlist> + <para> + An example of utilizing user namespacing: + </para> + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" [ + <!ENTITY types SYSTEM "classpath://your/domain/types.xml"> +]> + +<hibernate-mapping package="your.domain"> + <class name="MyEntity"> + <id name="id" type="my-custom-id-type"> + ... + </id> + <class> + &types; +</hibernate-mapping>]]></programlisting> + <para> + Where <literal>types.xml</literal> is a resource in the <literal>your.domain</literal> + package and contains a custom <xref linkend="mapping-types-custom">typedef</xref>. + </para> + </sect3> + </sect2> + + <sect2 id="mapping-declaration-mapping" revision="3"> + <title>hibernate-mapping</title> + + <para> + This element has several optional attributes. The <literal>schema</literal> and + <literal>catalog</literal> attributes specify that tables referred to in this mapping + belong to the named schema and/or catalog. If specified, tablenames will be qualified + by the given schema and catalog names. If missing, tablenames will be unqualified. + The <literal>default-cascade</literal> attribute specifies what cascade style + should be assumed for properties and collections which do not specify a + <literal>cascade</literal> attribute. The <literal>auto-import</literal> attribute lets us + use unqualified class names in the query language, by default. + </para> + + <programlistingco> + <areaspec> + <area id="hm1" coords="2 55"/> + <area id="hm2" coords="3 55"/> + <area id="hm3" coords="4 55"/> + <area id="hm4" coords="5 55"/> + <area id="hm5" coords="6 55"/> + <area id="hm6" coords="7 55"/> + <area id="hm7" coords="8 55"/> + </areaspec> + <programlisting><![CDATA[<hibernate-mapping + schema="schemaName" + catalog="catalogName" + default-cascade="cascade_style" + default-access="field|property|ClassName" + default-lazy="true|false" + auto-import="true|false" + package="package.name" + />]]></programlisting> + <calloutlist> + <callout arearefs="hm1"> + <para> + <literal>schema</literal> (optional): The name of a database schema. + </para> + </callout> + <callout arearefs="hm2"> + <para> + <literal>catalog</literal> (optional): The name of a database catalog. + </para> + </callout> + <callout arearefs="hm3"> + <para> + <literal>default-cascade</literal> (optional - defaults to <literal>none</literal>): + A default cascade style. + </para> + </callout> + <callout arearefs="hm4"> + <para> + <literal>default-access</literal> (optional - defaults to <literal>property</literal>): + The strategy Hibernate should use for accessing all properties. Can be a custom + implementation of <literal>PropertyAccessor</literal>. + </para> + </callout> + <callout arearefs="hm5"> + <para> + <literal>default-lazy</literal> (optional - defaults to <literal>true</literal>): + The default value for unspecifed <literal>lazy</literal> attributes of class and + collection mappings. + </para> + </callout> + <callout arearefs="hm6"> + <para> + <literal>auto-import</literal> (optional - defaults to <literal>true</literal>): + Specifies whether we can use unqualified class names (of classes in this mapping) + in the query language. + </para> + </callout> + <callout arearefs="hm7"> + <para> + <literal>package</literal> (optional): Specifies a package prefix to assume for + unqualified class names in the mapping document. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + If you have two persistent classes with the same (unqualified) name, you should set + <literal>auto-import="false"</literal>. Hibernate will throw an exception if you attempt + to assign two classes to the same "imported" name. + </para> + + <para> + Note that the <literal>hibernate-mapping</literal> element allows you to nest + several persistent <literal><class></literal> mappings, as shown above. + It is however good practice (and expected by some tools) to map only a single + persistent class (or a single class hierarchy) in one mapping file and name + it after the persistent superclass, e.g. <literal>Cat.hbm.xml</literal>, + <literal>Dog.hbm.xml</literal>, or if using inheritance, + <literal>Animal.hbm.xml</literal>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-class" revision="3"> + <title>class</title> + + <para> + You may declare a persistent class using the <literal>class</literal> element: + </para> + + <programlistingco> + <areaspec> + <area id="class1" coords="2 55"/> + <area id="class2" coords="3 55" /> + <area id="class3" coords="4 55"/> + <area id="class4" coords="5 55" /> + <area id="class5" coords="6 55"/> + <area id="class6" coords="7 55" /> + <area id="class7" coords="8 55"/> + <area id="class8" coords="9 55" /> + <area id="class9" coords="10 55" /> + <area id="class10" coords="11 55"/> + <area id="class11" coords="12 55"/> + <area id="class12" coords="13 55"/> + <area id="class13" coords="14 55"/> + <area id="class14" coords="15 55"/> + <area id="class15" coords="16 55"/> + <area id="class16" coords="17 55"/> + <area id="class17" coords="18 55"/> + <area id="class18" coords="19 55"/> + <area id="class19" coords="20 55"/> + <area id="class20" coords="21 55"/> + <area id="class21" coords="22 55"/> + </areaspec> + <programlisting><![CDATA[<class + name="ClassName" + table="tableName" + discriminator-value="discriminator_value" + mutable="true|false" + schema="owner" + catalog="catalog" + proxy="ProxyInterface" + dynamic-update="true|false" + dynamic-insert="true|false" + select-before-update="true|false" + polymorphism="implicit|explicit" + where="arbitrary sql where condition" + persister="PersisterClass" + batch-size="N" + optimistic-lock="none|version|dirty|all" + lazy="true|false" + entity-name="EntityName" + check="arbitrary sql check condition" + rowid="rowid" + subselect="SQL expression" + abstract="true|false" + node="element-name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="class1"> + <para> + <literal>name</literal> (optional): The fully qualified Java class name of the + persistent class (or interface). If this attribute is missing, it is assumed + that the mapping is for a non-POJO entity. + </para> + </callout> + <callout arearefs="class2"> + <para> + <literal>table</literal> (optional - defaults to the unqualified class name): The + name of its database table. + </para> + </callout> + <callout arearefs="class3"> + <para> + <literal>discriminator-value</literal> (optional - defaults to the class name): A value + that distiguishes individual subclasses, used for polymorphic behaviour. Acceptable + values include <literal>null</literal> and <literal>not null</literal>. + </para> + </callout> + <callout arearefs="class4"> + <para> + <literal>mutable</literal> (optional, defaults to <literal>true</literal>): Specifies + that instances of the class are (not) mutable. + </para> + </callout> + <callout arearefs="class5"> + <para> + <literal>schema</literal> (optional): Override the schema name specified by + the root <literal><hibernate-mapping></literal> element. + </para> + </callout> + <callout arearefs="class6"> + <para> + <literal>catalog</literal> (optional): Override the catalog name specified by + the root <literal><hibernate-mapping></literal> element. + </para> + </callout> + <callout arearefs="class7"> + <para> + <literal>proxy</literal> (optional): Specifies an interface to use for lazy + initializing proxies. You may specify the name of the class itself. + </para> + </callout> + <callout arearefs="class8"> + <para> + <literal>dynamic-update</literal> (optional, defaults to <literal>false</literal>): + Specifies that <literal>UPDATE</literal> SQL should be generated at runtime and + contain only those columns whose values have changed. + </para> + </callout> + <callout arearefs="class9"> + <para> + <literal>dynamic-insert</literal> (optional, defaults to <literal>false</literal>): + Specifies that <literal>INSERT</literal> SQL should be generated at runtime and + contain only the columns whose values are not null. + </para> + </callout> + <callout arearefs="class10"> + <para> + <literal>select-before-update</literal> (optional, defaults to <literal>false</literal>): + Specifies that Hibernate should <emphasis>never</emphasis> perform an SQL <literal>UPDATE</literal> + unless it is certain that an object is actually modified. In certain cases (actually, only + when a transient object has been associated with a new session using <literal>update()</literal>), + this means that Hibernate will perform an extra SQL <literal>SELECT</literal> to determine + if an <literal>UPDATE</literal> is actually required. + </para> + </callout> + <callout arearefs="class11"> + <para> + <literal>polymorphism</literal> (optional, defaults to <literal>implicit</literal>): + Determines whether implicit or explicit query polymorphism is used. + </para> + </callout> + <callout arearefs="class12"> + <para> + <literal>where</literal> (optional) specify an arbitrary SQL <literal>WHERE</literal> + condition to be used when retrieving objects of this class + </para> + </callout> + <callout arearefs="class13"> + <para> + <literal>persister</literal> (optional): Specifies a custom <literal>ClassPersister</literal>. + </para> + </callout> + <callout arearefs="class14"> + <para> + <literal>batch-size</literal> (optional, defaults to <literal>1</literal>) specify a "batch size" + for fetching instances of this class by identifier. + </para> + </callout> + <callout arearefs="class15"> + <para> + <literal>optimistic-lock</literal> (optional, defaults to <literal>version</literal>): + Determines the optimistic locking strategy. + </para> + </callout> + <callout arearefs="class16"> + <para> + <literal>lazy</literal> (optional): Lazy fetching may be completely disabled by setting + <literal>lazy="false"</literal>. + </para> + </callout> + <callout arearefs="class17"> + <para> + <literal>entity-name</literal> (optional, defaults to the class name): Hibernate3 + allows a class to be mapped multiple times (to different tables, potentially), + and allows entity mappings that are represented by Maps or XML at the Java level. + In these cases, you should provide an explicit arbitrary name for the entity. See + <xref linkend="persistent-classes-dynamicmodels"/> and <xref linkend="xml"/> + for more information. + </para> + </callout> + <callout arearefs="class18"> + <para> + <literal>check</literal> (optional): A SQL expression used to generate a multi-row + <emphasis>check</emphasis> constraint for automatic schema generation. + </para> + </callout> + <callout arearefs="class19"> + <para> + <literal>rowid</literal> (optional): Hibernate can use so called ROWIDs on databases + which support. E.g. on Oracle, Hibernate can use the <literal>rowid</literal> extra + column for fast updates if you set this option to <literal>rowid</literal>. A ROWID + is an implementation detail and represents the physical location of a stored tuple. + </para> + </callout> + <callout arearefs="class20"> + <para> + <literal>subselect</literal> (optional): Maps an immutable and read-only entity + to a database subselect. Useful if you want to have a view instead of a base table, + but don't. See below for more information. + </para> + </callout> + <callout arearefs="class21"> + <para> + <literal>abstract</literal> (optional): Used to mark abstract superclasses in + <literal><union-subclass></literal> hierarchies. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + It is perfectly acceptable for the named persistent class to be an interface. You would then + declare implementing classes of that interface using the <literal><subclass></literal> + element. You may persist any <emphasis>static</emphasis> inner class. You should specify the + class name using the standard form ie. <literal>eg.Foo$Bar</literal>. + </para> + + <para> + Immutable classes, <literal>mutable="false"</literal>, may not be updated or deleted by the + application. This allows Hibernate to make some minor performance optimizations. + </para> + + <para> + The optional <literal>proxy</literal> attribute enables lazy initialization of persistent + instances of the class. Hibernate will initially return CGLIB proxies which implement + the named interface. The actual persistent object will be loaded when a method of the + proxy is invoked. See "Initializing collections and proxies" below. + </para> + + <para><emphasis>Implicit</emphasis> polymorphism means that instances of the class will be returned + by a query that names any superclass or implemented interface or the class and that instances + of any subclass of the class will be returned by a query that names the class itself. + <emphasis>Explicit</emphasis> polymorphism means that class instances will be returned only + by queries that explicitly name that class and that queries that name the class will return + only instances of subclasses mapped inside this <literal><class></literal> declaration + as a <literal><subclass></literal> or <literal><joined-subclass></literal>. For + most purposes the default, <literal>polymorphism="implicit"</literal>, is appropriate. + Explicit polymorphism is useful when two different classes are mapped to the same table + (this allows a "lightweight" class that contains a subset of the table columns). + </para> + + <para> + The <literal>persister</literal> attribute lets you customize the persistence strategy used for + the class. You may, for example, specify your own subclass of + <literal>org.hibernate.persister.EntityPersister</literal> or you might even provide a + completely new implementation of the interface + <literal>org.hibernate.persister.ClassPersister</literal> that implements persistence via, + for example, stored procedure calls, serialization to flat files or LDAP. See + <literal>org.hibernate.test.CustomPersister</literal> for a simple example (of "persistence" + to a <literal>Hashtable</literal>). + </para> + + <para> + Note that the <literal>dynamic-update</literal> and <literal>dynamic-insert</literal> + settings are not inherited by subclasses and so may also be specified on the + <literal><subclass></literal> or <literal><joined-subclass></literal> elements. + These settings may increase performance in some cases, but might actually decrease + performance in others. Use judiciously. + </para> + + <para> + Use of <literal>select-before-update</literal> will usually decrease performance. It is very + useful to prevent a database update trigger being called unnecessarily if you reattach a + graph of detached instances to a <literal>Session</literal>. + </para> + + <para> + If you enable <literal>dynamic-update</literal>, you will have a choice of optimistic + locking strategies: + </para> + <itemizedlist> + <listitem> + <para> + <literal>version</literal> check the version/timestamp columns + </para> + </listitem> + <listitem> + <para> + <literal>all</literal> check all columns + </para> + </listitem> + <listitem> + <para> + <literal>dirty</literal> check the changed columns, allowing some concurrent updates + </para> + </listitem> + <listitem> + <para> + <literal>none</literal> do not use optimistic locking + </para> + </listitem> + </itemizedlist> + <para> + We <emphasis>very</emphasis> strongly recommend that you use version/timestamp + columns for optimistic locking with Hibernate. This is the optimal strategy with + respect to performance and is the only strategy that correctly handles modifications + made to detached instances (ie. when <literal>Session.merge()</literal> is used). + </para> + + <para> + There is no difference between a view and a base table for a Hibernate mapping, as + expected this is transparent at the database level (note that some DBMS don't support + views properly, especially with updates). Sometimes you want to use a view, but can't + create one in the database (ie. with a legacy schema). In this case, you can map an + immutable and read-only entity to a given SQL subselect expression: + </para> + + <programlisting><![CDATA[<class name="Summary"> + <subselect> + select item.name, max(bid.amount), count(*) + from item + join bid on bid.item_id = item.id + group by item.name + </subselect> + <synchronize table="item"/> + <synchronize table="bid"/> + <id name="name"/> + ... +</class>]]></programlisting> + + <para> + Declare the tables to synchronize this entity with, ensuring that auto-flush happens + correctly, and that queries against the derived entity do not return stale data. + The <literal><subselect></literal> is available as both as an attribute and + a nested mapping element. + </para> + + </sect2> + + <sect2 id="mapping-declaration-id" revision="4"> + <title>id</title> + + <para> + Mapped classes <emphasis>must</emphasis> declare the primary key column of the database + table. Most classes will also have a JavaBeans-style property holding the unique identifier + of an instance. The <literal><id></literal> element defines the mapping from that + property to the primary key column. + </para> + + <programlistingco> + <areaspec> + <area id="id1" coords="2 70"/> + <area id="id2" coords="3 70" /> + <area id="id3" coords="4 70"/> + <area id="id4" coords="5 70" /> + <area id="id5" coords="6 70" /> + </areaspec> + <programlisting><![CDATA[<id + name="propertyName" + type="typename" + column="column_name" + unsaved-value="null|any|none|undefined|id_value" + access="field|property|ClassName"> + node="element-name|@attribute-name|element/@attribute|." + + <generator class="generatorClass"/> +</id>]]></programlisting> + <calloutlist> + <callout arearefs="id1"> + <para> + <literal>name</literal> (optional): The name of the identifier property. + </para> + </callout> + <callout arearefs="id2"> + <para> + <literal>type</literal> (optional): A name that indicates the Hibernate type. + </para> + </callout> + <callout arearefs="id3"> + <para> + <literal>column</literal> (optional - defaults to the property name): The + name of the primary key column. + </para> + </callout> + <callout arearefs="id4"> + <para> + <literal>unsaved-value</literal> (optional - defaults to a "sensible" value): + An identifier property value that indicates that an instance is newly instantiated + (unsaved), distinguishing it from detached instances that were saved or loaded + in a previous session. + </para> + </callout> + <callout arearefs="id5"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + If the <literal>name</literal> attribute is missing, it is assumed that the class has no + identifier property. + </para> + + <para> + The <literal>unsaved-value</literal> attribute is almost never needed in Hibernate3. + </para> + + <para> + There is an alternative <literal><composite-id></literal> declaration to allow access to + legacy data with composite keys. We strongly discourage its use for anything else. + </para> + + <sect3 id="mapping-declaration-id-generator" revision="2"> + <title>Generator</title> + + <para> + The optional <literal><generator></literal> child element names a Java class used + to generate unique identifiers for instances of the persistent class. If any parameters + are required to configure or initialize the generator instance, they are passed using the + <literal><param></literal> element. + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="org.hibernate.id.TableHiLoGenerator"> + <param name="table">uid_table</param> + <param name="column">next_hi_value_column</param> + </generator> +</id>]]></programlisting> + + <para> + All generators implement the interface <literal>org.hibernate.id.IdentifierGenerator</literal>. + This is a very simple interface; some applications may choose to provide their own specialized + implementations. However, Hibernate provides a range of built-in implementations. There are shortcut + names for the built-in generators: + + <variablelist> + <varlistentry> + <term><literal>increment</literal></term> + <listitem> + <para> + generates identifiers of type <literal>long</literal>, <literal>short</literal> or + <literal>int</literal> that are unique only when no other process is inserting data + into the same table. + <emphasis>Do not use in a cluster.</emphasis> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>identity</literal></term> + <listitem> + <para> + supports identity columns in DB2, MySQL, MS SQL Server, Sybase and + HypersonicSQL. The returned identifier is of type <literal>long</literal>, + <literal>short</literal> or <literal>int</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>sequence</literal></term> + <listitem> + <para> + uses a sequence in DB2, PostgreSQL, Oracle, SAP DB, McKoi or a generator + in Interbase. The returned identifier is of type <literal>long</literal>, + <literal>short</literal> or <literal>int</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>hilo</literal></term> + <listitem> + <para id="mapping-declaration-id-hilodescription" revision="1"> + uses a hi/lo algorithm to efficiently generate identifiers of + type <literal>long</literal>, <literal>short</literal> or <literal>int</literal>, + given a table and column (by default <literal>hibernate_unique_key</literal> and + <literal>next_hi</literal> respectively) as a source of hi values. The hi/lo + algorithm generates identifiers that are unique only for a particular database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>seqhilo</literal></term> + <listitem> + <para> + uses a hi/lo algorithm to efficiently generate identifiers of type + <literal>long</literal>, <literal>short</literal> or <literal>int</literal>, + given a named database sequence. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>uuid</literal></term> + <listitem> + <para> + uses a 128-bit UUID algorithm to generate identifiers of type string, + unique within a network (the IP address is used). The UUID is encoded + as a string of hexadecimal digits of length 32. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>guid</literal></term> + <listitem> + <para> + uses a database-generated GUID string on MS SQL Server and MySQL. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>native</literal></term> + <listitem> + <para> + picks <literal>identity</literal>, <literal>sequence</literal> or + <literal>hilo</literal> depending upon the capabilities of the + underlying database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>assigned</literal></term> + <listitem> + <para> + lets the application to assign an identifier to the object before + <literal>save()</literal> is called. This is the default strategy + if no <literal><generator></literal> element is specified. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>select</literal></term> + <listitem> + <para> + retrieves a primary key assigned by a database trigger by selecting + the row by some unique key and retrieving the primary key value. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>foreign</literal></term> + <listitem> + <para> + uses the identifier of another associated object. Usually used in conjunction + with a <literal><one-to-one></literal> primary key association. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>sequence-identity</literal></term> + <listitem> + <para> + a specialized sequence generation strategy which utilizes a + database sequence for the actual value generation, but combines + this with JDBC3 getGeneratedKeys to actually return the generated + identifier value as part of the insert statement execution. This + strategy is only known to be supported on Oracle 10g drivers + targetted for JDK 1.4. Note comments on these insert statements + are disabled due to a bug in the Oracle drivers. + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + </sect3> + + <sect3 id="mapping-declaration-id-hilo" revision="1"> + <title>Hi/lo algorithm</title> + <para> + The <literal>hilo</literal> and <literal>seqhilo</literal> generators provide two alternate + implementations of the hi/lo algorithm, a favorite approach to identifier generation. The + first implementation requires a "special" database table to hold the next available "hi" value. + The second uses an Oracle-style sequence (where supported). + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="hilo"> + <param name="table">hi_value</param> + <param name="column">next_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="seqhilo"> + <param name="sequence">hi_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + + <para> + Unfortunately, you can't use <literal>hilo</literal> when supplying your own + <literal>Connection</literal> to Hibernate. When Hibernate is using an application + server datasource to obtain connections enlisted with JTA, you must properly configure + the <literal>hibernate.transaction.manager_lookup_class</literal>. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-uuid"> + <title>UUID algorithm</title> + <para> + The UUID contains: IP address, startup time of the JVM (accurate to a quarter + second), system time and a counter value (unique within the JVM). It's not + possible to obtain a MAC address or memory address from Java code, so this is + the best we can do without using JNI. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-sequences"> + <title>Identity columns and sequences</title> + <para> + For databases which support identity columns (DB2, MySQL, Sybase, MS SQL), you + may use <literal>identity</literal> key generation. For databases that support + sequences (DB2, Oracle, PostgreSQL, Interbase, McKoi, SAP DB) you may use + <literal>sequence</literal> style key generation. Both these strategies require + two SQL queries to insert a new object. + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="sequence"> + <param name="sequence">person_id_sequence</param> + </generator> +</id>]]></programlisting> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id" unsaved-value="0"> + <generator class="identity"/> +</id>]]></programlisting> + + <para> + For cross-platform development, the <literal>native</literal> strategy will + choose from the <literal>identity</literal>, <literal>sequence</literal> and + <literal>hilo</literal> strategies, dependant upon the capabilities of the + underlying database. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-assigned"> + <title>Assigned identifiers</title> + <para> + If you want the application to assign identifiers (as opposed to having + Hibernate generate them), you may use the <literal>assigned</literal> generator. + This special generator will use the identifier value already assigned to the + object's identifier property. This generator is used when the primary key + is a natural key instead of a surrogate key. This is the default behavior + if you do no specify a <literal><generator></literal> element. + </para> + + <para> + Choosing the <literal>assigned</literal> generator makes Hibernate use + <literal>unsaved-value="undefined"</literal>, forcing Hibernate to go to + the database to determine if an instance is transient or detached, unless + there is a version or timestamp property, or you define + <literal>Interceptor.isUnsaved()</literal>. + </para> + </sect3> + + <sect3 id="mapping-declaration-id-select"> + <title>Primary keys assigned by triggers</title> + <para> + For legacy schemas only (Hibernate does not generate DDL with triggers). + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="select"> + <param name="key">socialSecurityNumber</param> + </generator> +</id>]]></programlisting> + + <para> + In the above example, there is a unique valued property named + <literal>socialSecurityNumber</literal> defined by the class, as a + natural key, and a surrogate key named <literal>person_id</literal> + whose value is generated by a trigger. + </para> + + </sect3> + + </sect2> + + <sect2 id="mapping-declaration-id-enhanced"> + <title>Enhanced identifier generators</title> + + <para> + Starting with release 3.2.3, there are 2 new generators which represent a re-thinking of 2 different + aspects of identifier generation. The first aspect is database portability; the second is optimization + (not having to query the database for every request for a new identifier value). These two new + generators are intended to take the place of some of the named generators described above (starting + in 3.3.x); however, they are included in the current releases and can be referenced by FQN. + </para> + + <para> + The first of these new generators is <literal>org.hibernate.id.enhanced.SequenceStyleGenerator</literal> + which is intended firstly as a replacement for the <literal>sequence</literal> generator and secondly as + a better portability generator than <literal>native</literal> (because <literal>native</literal> + (generally) chooses between <literal>identity</literal> and <literal>sequence</literal> which have + largely different semantics which can cause subtle isssues in applications eyeing portability). + <literal>org.hibernate.id.enhanced.SequenceStyleGenerator</literal> however achieves portability in + a different manner. It chooses between using a table or a sequence in the database to store its + incrementing values depending on the capabilities of the dialect being used. The difference between this + and <literal>native</literal> is that table-based and sequence-based storage have the same exact + semantic (in fact sequences are exactly what Hibernate tries to emmulate with its table-based + generators). This generator has a number of configuration parameters: + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>sequence_name</literal> (optional, defaults to <literal>hibernate_sequence</literal>): + The name of the sequence (or table) to be used. + </para> + </listitem> + <listitem> + <para> + <literal>initial_value</literal> (optional, defaults to <literal>1</literal>): The initial + value to be retrieved from the sequence/table. In sequence creation terms, this is analogous + to the clause typical named "STARTS WITH". + </para> + </listitem> + <listitem> + <para> + <literal>increment_size</literal> (optional, defaults to <literal>1</literal>): The value by + which subsequent calls to the sequence/table should differ. In sequence creation terms, this + is analogous to the clause typical named "INCREMENT BY". + </para> + </listitem> + <listitem> + <para> + <literal>force_table_use</literal> (optional, defaults to <literal>false</literal>): Should + we force the use of a table as the backing structure even though the dialect might support + sequence? + </para> + </listitem> + <listitem> + <para> + <literal>value_column</literal> (optional, defaults to <literal>next_val</literal>): Only + relevant for table structures! The name of the column on the table which is used to + hold the value. + </para> + </listitem> + <listitem> + <para> + <literal>optimizer</literal> (optional, defaults to <literal>none</literal>): + See <xref linkend="mapping-declaration-id-enhanced-optimizers"/> + </para> + </listitem> + </itemizedlist> + </para> + <para> + The second of these new generators is <literal>org.hibernate.id.enhanced.TableGenerator</literal> which + is intended firstly as a replacement for the <literal>table</literal> generator (although it actually + functions much more like <literal>org.hibernate.id.MultipleHiLoPerTableGenerator</literal>) and secondly + as a re-implementation of <literal>org.hibernate.id.MultipleHiLoPerTableGenerator</literal> utilizing the + notion of pluggable optimiziers. Essentially this generator defines a table capable of holding + a number of different increment values simultaneously by using multiple distinctly keyed rows. This + generator has a number of configuration parameters: + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>table_name</literal> (optional, defaults to <literal>hibernate_sequences</literal>): + The name of the table to be used. + </para> + </listitem> + <listitem> + <para> + <literal>value_column_name</literal> (optional, defaults to <literal>next_val</literal>): + The name of the column on the table which is used to hold the value. + </para> + </listitem> + <listitem> + <para> + <literal>segment_column_name</literal> (optional, defaults to <literal>sequence_name</literal>): + The name of the column on the table which is used to hold the "segement key". This is the + value which distinctly identifies which increment value to use. + </para> + </listitem> + <listitem> + <para> + <literal>segment_value</literal> (optional, defaults to <literal>default</literal>): + The "segment key" value for the segment from which we want to pull increment values for + this generator. + </para> + </listitem> + <listitem> + <para> + <literal>segment_value_length</literal> (optional, defaults to <literal>255</literal>): + Used for schema generation; the column size to create this segment key column. + </para> + </listitem> + <listitem> + <para> + <literal>initial_value</literal> (optional, defaults to <literal>1</literal>): + The initial value to be retrieved from the table. + </para> + </listitem> + <listitem> + <para> + <literal>increment_size</literal> (optional, defaults to <literal>1</literal>): + The value by which subsequent calls to the table should differ. + </para> + </listitem> + <listitem> + <para> + <literal>optimizer</literal> (optional, defaults to <literal></literal>): + See <xref linkend="mapping-declaration-id-enhanced-optimizers"/> + </para> + </listitem> + </itemizedlist> + </para> + </sect2> + + <sect2 id="mapping-declaration-id-enhanced-optimizers"> + <title>Identifier generator optimization</title> + <para> + For identifier generators which store values in the database, it is inefficient for them to hit the + database on each and every call to generate a new identifier value. Instead, you'd ideally want to + group a bunch of them in memory and only hit the database when you have exhausted your in-memory + value group. This is the role of the pluggable optimizers. Currently only the two enhanced generators + (<xref linkend="mapping-declaration-id-enhanced"/> support this notion. + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>none</literal> (generally this is the default if no optimizer was specified): This + says to not perform any optimizations, and hit the database each and every request. + </para> + </listitem> + <listitem> + <para> + <literal>hilo</literal>: applies a hi/lo algorithm around the database retrieved values. The + values from the database for this optimizer are expected to be sequential. The values + retrieved from the database structure for this optimizer indicates the "group number"; the + <literal>increment_size</literal> is multiplied by that value in memory to define a group + "hi value". + </para> + </listitem> + <listitem> + <para> + <literal>pooled</literal>: like was discussed for <literal>hilo</literal>, this optimizers + attempts to minimize the number of hits to the database. Here, however, we simply store + the starting value for the "next group" into the database structure rather than a sequential + value in combination with an in-memory grouping algorithm. <literal>increment_size</literal> + here refers to the values coming from the database. + </para> + </listitem> + </itemizedlist> + </para> + </sect2> + + <sect2 id="mapping-declaration-compositeid" revision="3"> + <title>composite-id</title> + + <programlisting><![CDATA[<composite-id + name="propertyName" + class="ClassName" + mapped="true|false" + access="field|property|ClassName"> + node="element-name|." + + <key-property name="propertyName" type="typename" column="column_name"/> + <key-many-to-one name="propertyName class="ClassName" column="column_name"/> + ...... +</composite-id>]]></programlisting> + + <para> + For a table with a composite key, you may map multiple properties of the class + as identifier properties. The <literal><composite-id></literal> element + accepts <literal><key-property></literal> property mappings and + <literal><key-many-to-one></literal> mappings as child elements. + </para> + + <programlisting><![CDATA[<composite-id> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + + <para> + Your persistent class <emphasis>must</emphasis> override <literal>equals()</literal> + and <literal>hashCode()</literal> to implement composite identifier equality. It must + also implements <literal>Serializable</literal>. + </para> + + <para> + Unfortunately, this approach to composite identifiers means that a persistent object + is its own identifier. There is no convenient "handle" other than the object itself. + You must instantiate an instance of the persistent class itself and populate its + identifier properties before you can <literal>load()</literal> the persistent state + associated with a composite key. We call this approach an <emphasis>embedded</emphasis> + composite identifier, and discourage it for serious applications. + </para> + + <para> + A second approach is what we call a <emphasis>mapped</emphasis> composite identifier, + where the identifier properties named inside the <literal><composite-id></literal> + element are duplicated on both the persistent class and a separate identifier class. + </para> + + <programlisting><![CDATA[<composite-id class="MedicareId" mapped="true"> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + + <para> + In this example, both the composite identifier class, <literal>MedicareId</literal>, + and the entity class itself have properties named <literal>medicareNumber</literal> + and <literal>dependent</literal>. The identifier class must override + <literal>equals()</literal> and <literal>hashCode()</literal> and implement. + <literal>Serializable</literal>. The disadvantage of this approach is quite + obvious—code duplication. + </para> + + <para> + The following attributes are used to specify a mapped composite identifier: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mapped</literal> (optional, defaults to <literal>false</literal>): + indicates that a mapped composite identifier is used, and that the contained + property mappings refer to both the entity class and the composite identifier + class. + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (optional, but required for a mapped composite identifier): + The class used as a composite identifier. + </para> + </listitem> + </itemizedlist> + + <para> + We will describe a third, even more convenient approach where the composite identifier + is implemented as a component class in <xref linkend="components-compositeid"/>. The + attributes described below apply only to this alternative approach: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>name</literal> (optional, required for this approach): A property of + component type that holds the composite identifier (see chapter 9). + </para> + </listitem> + <listitem> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): + The strategy Hibernate should use for accessing the property value. + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (optional - defaults to the property type determined by + reflection): The component class used as a composite identifier (see next section). + </para> + </listitem> + </itemizedlist> + + <para> + This third approach, an <emphasis>identifier component</emphasis> is the one we recommend + for almost all applications. + </para> + + </sect2> + + <sect2 id="mapping-declaration-discriminator" revision="3"> + <title>discriminator</title> + + <para> + The <literal><discriminator></literal> element is required for polymorphic persistence + using the table-per-class-hierarchy mapping strategy and declares a discriminator column of the + table. The discriminator column contains marker values that tell the persistence layer what + subclass to instantiate for a particular row. A restricted set of types may be used: + <literal>string</literal>, <literal>character</literal>, <literal>integer</literal>, + <literal>byte</literal>, <literal>short</literal>, <literal>boolean</literal>, + <literal>yes_no</literal>, <literal>true_false</literal>. + </para> + + <programlistingco> + <areaspec> + <area id="discriminator1" coords="2 60"/> + <area id="discriminator2" coords="3 60" /> + <area id="discriminator3" coords="4 60" /> + <area id="discriminator4" coords="5 60" /> + <area id="discriminator5" coords="6 60" /> + </areaspec> + <programlisting><![CDATA[<discriminator + column="discriminator_column" + type="discriminator_type" + force="true|false" + insert="true|false" + formula="arbitrary sql expression" +/>]]></programlisting> + <calloutlist> + <callout arearefs="discriminator1"> + <para> + <literal>column</literal> (optional - defaults to <literal>class</literal>) the + name of the discriminator column. + </para> + </callout> + <callout arearefs="discriminator2"> + <para> + <literal>type</literal> (optional - defaults to <literal>string</literal>) a + name that indicates the Hibernate type + </para> + </callout> + <callout arearefs="discriminator3"> + <para> + <literal>force</literal> (optional - defaults to <literal>false</literal>) + "force" Hibernate to specify allowed discriminator values even when retrieving + all instances of the root class. + </para> + </callout> + <callout arearefs="discriminator4"> + <para> + <literal>insert</literal> (optional - defaults to <literal>true</literal>) + set this to <literal>false</literal> if your discriminator column is also part + of a mapped composite identifier. (Tells Hibernate to not include the column + in SQL <literal>INSERT</literal>s.) + </para> + </callout> + <callout arearefs="discriminator5"> + <para> + <literal>formula</literal> (optional) an arbitrary SQL expression that is + executed when a type has to be evaluated. Allows content-based discrimination. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Actual values of the discriminator column are specified by the + <literal>discriminator-value</literal> attribute of the <literal><class></literal> and + <literal><subclass></literal> elements. + </para> + + <para> + The <literal>force</literal> attribute is (only) useful if the table contains rows with + "extra" discriminator values that are not mapped to a persistent class. This will not + usually be the case. + </para> + + <para> + Using the <literal>formula</literal> attribute you can declare an arbitrary SQL expression + that will be used to evaluate the type of a row: + </para> + + <programlisting><![CDATA[<discriminator + formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end" + type="integer"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-version" revision="4"> + <title>version (optional)</title> + + <para> + The <literal><version></literal> element is optional and indicates that + the table contains versioned data. This is particularly useful if you plan to + use <emphasis>long transactions</emphasis> (see below). + </para> + + <programlistingco> + <areaspec> + <area id="version1" coords="2 70"/> + <area id="version2" coords="3 70"/> + <area id="version3" coords="4 70"/> + <area id="version4" coords="5 70"/> + <area id="version5" coords="6 70"/> + <area id="version6" coords="7 70"/> + <area id="version7" coords="8 70"/> + </areaspec> + <programlisting><![CDATA[<version + column="version_column" + name="propertyName" + type="typename" + access="field|property|ClassName" + unsaved-value="null|negative|undefined" + generated="never|always" + insert="true|false" + node="element-name|@attribute-name|element/@attribute|." +/>]]></programlisting> + <calloutlist> + <callout arearefs="version1"> + <para> + <literal>column</literal> (optional - defaults to the property name): The name + of the column holding the version number. + </para> + </callout> + <callout arearefs="version2"> + <para> + <literal>name</literal>: The name of a property of the persistent class. + </para> + </callout> + <callout arearefs="version3"> + <para> + <literal>type</literal> (optional - defaults to <literal>integer</literal>): + The type of the version number. + </para> + </callout> + <callout arearefs="version4"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="version5"> + <para> + <literal>unsaved-value</literal> (optional - defaults to <literal>undefined</literal>): + A version property value that indicates that an instance is newly instantiated + (unsaved), distinguishing it from detached instances that were saved or loaded + in a previous session. (<literal>undefined</literal> specifies that the identifier + property value should be used.) + </para> + </callout> + <callout arearefs="version6"> + <para> + <literal>generated</literal> (optional - defaults to <literal>never</literal>): + Specifies that this version property value is actually generated by the database. + See the discussion of <xref linkend="mapping-generated">generated properties</xref>. + </para> + </callout> + <callout arearefs="version7"> + <para> + <literal>insert</literal> (optional - defaults to <literal>true</literal>): + Specifies whether the version column should be included in SQL insert statements. + May be set to <literal>false</literal> if and only if the database column + is defined with a default value of <literal>0</literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Version numbers may be of Hibernate type <literal>long</literal>, <literal>integer</literal>, + <literal>short</literal>, <literal>timestamp</literal> or <literal>calendar</literal>. + </para> + + <para> + A version or timestamp property should never be null for a detached instance, so + Hibernate will detect any instance with a null version or timestamp as transient, + no matter what other <literal>unsaved-value</literal> strategies are specified. + <emphasis>Declaring a nullable version or timestamp property is an easy way to avoid + any problems with transitive reattachment in Hibernate, especially useful for people + using assigned identifiers or composite keys!</emphasis> + </para> + </sect2> + + <sect2 id="mapping-declaration-timestamp" revision="4" > + <title>timestamp (optional)</title> + + <para> + The optional <literal><timestamp></literal> element indicates that the table contains + timestamped data. This is intended as an alternative to versioning. Timestamps are by nature + a less safe implementation of optimistic locking. However, sometimes the application might + use the timestamps in other ways. + </para> + + <programlistingco> + <areaspec> + <area id="timestamp1" coords="2 70"/> + <area id="timestamp2" coords="3 70" /> + <area id="timestamp3" coords="4 70" /> + <area id="timestamp4" coords="5 70" /> + <area id="timestamp5" coords="6 70" /> + <area id="timestamp6" coords="7 70" /> + </areaspec> + <programlisting><![CDATA[<timestamp + column="timestamp_column" + name="propertyName" + access="field|property|ClassName" + unsaved-value="null|undefined" + source="vm|db" + generated="never|always" + node="element-name|@attribute-name|element/@attribute|." +/>]]></programlisting> + <calloutlist> + <callout arearefs="timestamp1"> + <para> + <literal>column</literal> (optional - defaults to the property name): The name + of a column holding the timestamp. + </para> + </callout> + <callout arearefs="timestamp2"> + <para> + <literal>name</literal>: The name of a JavaBeans style property of + Java type <literal>Date</literal> or <literal>Timestamp</literal> of the + persistent class. + </para> + </callout> + <callout arearefs="timestamp3"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="timestamp4"> + <para> + <literal>unsaved-value</literal> (optional - defaults to <literal>null</literal>): + A version property value that indicates that an instance is newly instantiated + (unsaved), distinguishing it from detached instances that were saved or loaded + in a previous session. (<literal>undefined</literal> specifies that the identifier + property value should be used.) + </para> + </callout> + <callout arearefs="timestamp5"> + <para> + <literal>source</literal> (optional - defaults to <literal>vm</literal>): + From where should Hibernate retrieve the timestamp value? From the database, + or from the current JVM? Database-based timestamps incur an overhead because + Hibernate must hit the database in order to determine the "next value", + but will be safer for use in clustered environments. Note also, that not + all <literal>Dialect</literal>s are known to support retrieving of the + database's current timestamp, while others might be unsafe for usage + in locking due to lack of precision (Oracle 8 for example). + </para> + </callout> + <callout arearefs="timestamp6"> + <para> + <literal>generated</literal> (optional - defaults to <literal>never</literal>): + Specifies that this timestamp property value is actually generated by the database. + See the discussion of <xref linkend="mapping-generated">generated properties</xref>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Note that <literal><timestamp></literal> is equivalent to + <literal><version type="timestamp"></literal>. And + <literal><timestamp source="db"></literal> is equivalent to + <literal><version type="dbtimestamp"></literal> + </para> + </sect2> + + + <sect2 id="mapping-declaration-property" revision="4"> + <title>property</title> + + <para> + The <literal><property></literal> element declares a persistent, JavaBean style + property of the class. + </para> + + <programlistingco> + <areaspec> + <area id="property1" coords="2 70"/> + <area id="property2" coords="3 70"/> + <area id="property3" coords="4 70"/> + <areaset id="property4-5" coords=""> + <area id="property4" coords='5 70'/> + <area id="property5" coords='6 70'/> + </areaset> + <area id="property6" coords="7 70"/> + <area id="property7" coords="8 70"/> + <area id="property8" coords="9 70"/> + <area id="property9" coords="10 70"/> + <area id="property10" coords="11 70"/> + <area id="property11" coords="12 70"/> + <area id="property12" coords="13 70"/> + </areaspec> + <programlisting><![CDATA[<property + name="propertyName" + column="column_name" + type="typename" + update="true|false" + insert="true|false" + formula="arbitrary SQL expression" + access="field|property|ClassName" + lazy="true|false" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + generated="never|insert|always" + node="element-name|@attribute-name|element/@attribute|." + index="index_name" + unique_key="unique_key_id" + length="L" + precision="P" + scale="S" +/>]]></programlisting> + <calloutlist> + <callout arearefs="property1"> + <para> + <literal>name</literal>: the name of the property, with an initial lowercase + letter. + </para> + </callout> + <callout arearefs="property2"> + <para> + <literal>column</literal> (optional - defaults to the property name): the name + of the mapped database table column. This may also be specified by nested + <literal><column></literal> element(s). + </para> + </callout> + <callout arearefs="property3"> + <para> + <literal>type</literal> (optional): a name that indicates the Hibernate type. + </para> + </callout> + <callout arearefs="property4-5"> + <para> + <literal>update, insert</literal> (optional - defaults to <literal>true</literal>) : + specifies that the mapped columns should be included in SQL <literal>UPDATE</literal> + and/or <literal>INSERT</literal> statements. Setting both to <literal>false</literal> + allows a pure "derived" property whose value is initialized from some other + property that maps to the same colum(s) or by a trigger or other application. + </para> + </callout> + <callout arearefs="property6"> + <para> + <literal>formula</literal> (optional): an SQL expression that defines the value for a + <emphasis>computed</emphasis> property. Computed properties do not have a column + mapping of their own. + </para> + </callout> + <callout arearefs="property7"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="property8"> + <para> + <literal>lazy</literal> (optional - defaults to <literal>false</literal>): Specifies + that this property should be fetched lazily when the instance variable is first + accessed (requires build-time bytecode instrumentation). + </para> + </callout> + <callout arearefs="property9"> + <para> + <literal>unique</literal> (optional): Enable the DDL generation of a unique + constraint for the columns. Also, allow this to be the target of + a <literal>property-ref</literal>. + </para> + </callout> + <callout arearefs="property10"> + <para> + <literal>not-null</literal> (optional): Enable the DDL generation of a nullability + constraint for the columns. + </para> + </callout> + <callout arearefs="property11"> + <para> + <literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>): + Specifies that updates to this property do or do not require acquisition of the + optimistic lock. In other words, determines if a version increment should occur when + this property is dirty. + </para> + </callout> + <callout arearefs="property12"> + <para> + <literal>generated</literal> (optional - defaults to <literal>never</literal>): + Specifies that this property value is actually generated by the database. + See the discussion of <xref linkend="mapping-generated">generated properties</xref>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + <emphasis>typename</emphasis> could be: + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + The name of a Hibernate basic type (eg. <literal>integer, string, character, + date, timestamp, float, binary, serializable, object, blob</literal>). + </para> + </listitem> + <listitem> + <para> + The name of a Java class with a default basic type (eg. <literal>int, float, + char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob</literal>). + </para> + </listitem> + <listitem> + <para> + The name of a serializable Java class. + </para> + </listitem> + <listitem> + <para> + The class name of a custom type (eg. <literal>com.illflow.type.MyCustomType</literal>). + </para> + </listitem> + </orderedlist> + + <para> + If you do not specify a type, Hibernate will use reflection upon the named + property to take a guess at the correct Hibernate type. Hibernate will try to + interpret the name of the return class of the property getter using rules 2, 3, + 4 in that order. However, this is not always enough. + In certain cases you will still need the <literal>type</literal> + attribute. (For example, to distinguish between <literal>Hibernate.DATE</literal> and + <literal>Hibernate.TIMESTAMP</literal>, or to specify a custom type.) + </para> + + <para> + The <literal>access</literal> attribute lets you control how Hibernate will access + the property at runtime. By default, Hibernate will call the property get/set pair. + If you specify <literal>access="field"</literal>, Hibernate will bypass the get/set + pair and access the field directly, using reflection. You may specify your own + strategy for property access by naming a class that implements the interface + <literal>org.hibernate.property.PropertyAccessor</literal>. + </para> + + <para> + An especially powerful feature are derived properties. These properties are by + definition read-only, the property value is computed at load time. You declare + the computation as a SQL expression, this translates to a <literal>SELECT</literal> + clause subquery in the SQL query that loads an instance: + </para> + + <programlisting><![CDATA[ +<property name="totalPrice" + formula="( SELECT SUM (li.quantity*p.price) FROM LineItem li, Product p + WHERE li.productId = p.productId + AND li.customerId = customerId + AND li.orderNumber = orderNumber )"/>]]></programlisting> + + <para> + Note that you can reference the entities own table by not declaring an alias on + a particular column (<literal>customerId</literal> in the given example). Also note + that you can use the nested <literal><formula></literal> mapping element + if you don't like to use the attribute. + </para> + + </sect2> + + <sect2 id="mapping-declaration-manytoone" revision="5"> + <title>many-to-one</title> + + <para> + An ordinary association to another persistent class is declared using a + <literal>many-to-one</literal> element. The relational model is a + many-to-one association: a foreign key in one table is referencing + the primary key column(s) of the target table. + </para> + + <programlistingco> + <areaspec> + <area id="manytoone1" coords="2 70"/> + <area id="manytoone2" coords="3 70"/> + <area id="manytoone3" coords="4 70"/> + <area id="manytoone4" coords="5 70"/> + <area id="manytoone5" coords="6 70"/> + <areaset id="manytoone6-7" coords=""> + <area id="manytoone6" coords='7 70'/> + <area id="manytoone7" coords='8 70'/> + </areaset> + <area id="manytoone8" coords="9 70"/> + <area id="manytoone9" coords="10 70"/> + <area id="manytoone10" coords="11 70"/> + <area id="manytoone11" coords="12 70"/> + <area id="manytoone12" coords="13 70"/> + <area id="manytoone13" coords="14 70"/> + <area id="manytoone14" coords="15 70"/> + <area id="manytoone15" coords="16 70"/> + <area id="manytoone16" coords="17 70"/> + </areaspec> + <programlisting><![CDATA[<many-to-one + name="propertyName" + column="column_name" + class="ClassName" + cascade="cascade_style" + fetch="join|select" + update="true|false" + insert="true|false" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + lazy="proxy|no-proxy|false" + not-found="ignore|exception" + entity-name="EntityName" + formula="arbitrary SQL expression" + node="element-name|@attribute-name|element/@attribute|." + embed-xml="true|false" + index="index_name" + unique_key="unique_key_id" + foreign-key="foreign_key_name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="manytoone1"> + <para> + <literal>name</literal>: The name of the property. + </para> + </callout> + <callout arearefs="manytoone2"> + <para> + <literal>column</literal> (optional): The name of the foreign key column. + This may also be specified by nested <literal><column></literal> + element(s). + </para> + </callout> + <callout arearefs="manytoone3"> + <para> + <literal>class</literal> (optional - defaults to the property type + determined by reflection): The name of the associated class. + </para> + </callout> + <callout arearefs="manytoone4"> + <para> + <literal>cascade</literal> (optional): Specifies which operations should + be cascaded from the parent object to the associated object. + </para> + </callout> + <callout arearefs="manytoone5"> + <para> + <literal>fetch</literal> (optional - defaults to <literal>select</literal>): + Chooses between outer-join fetching or sequential select fetching. + </para> + </callout> + <callout arearefs="manytoone6-7"> + <para> + <literal>update, insert</literal> (optional - defaults to <literal>true</literal>) + specifies that the mapped columns should be included in SQL <literal>UPDATE</literal> + and/or <literal>INSERT</literal> statements. Setting both to <literal>false</literal> + allows a pure "derived" association whose value is initialized from some other + property that maps to the same colum(s) or by a trigger or other application. + </para> + </callout> + <callout arearefs="manytoone8"> + <para> + <literal>property-ref</literal>: (optional) The name of a property of the associated + class that is joined to this foreign key. If not specified, the primary key of + the associated class is used. + </para> + </callout> + <callout arearefs="manytoone9"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="manytoone10"> + <para> + <literal>unique</literal> (optional): Enable the DDL generation of a unique + constraint for the foreign-key column. Also, allow this to be the target of + a <literal>property-ref</literal>. This makes the association multiplicity + effectively one to one. + </para> + </callout> + <callout arearefs="manytoone11"> + <para> + <literal>not-null</literal> (optional): Enable the DDL generation of a nullability + constraint for the foreign key columns. + </para> + </callout> + <callout arearefs="manytoone12"> + <para> + <literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>): + Specifies that updates to this property do or do not require acquisition of the + optimistic lock. In other words, dertermines if a version increment should occur when + this property is dirty. + </para> + </callout> + <callout arearefs="manytoone13"> + <para> + <literal>lazy</literal> (optional - defaults to <literal>proxy</literal>): + By default, single point associations are proxied. <literal>lazy="no-proxy"</literal> + specifies that the property should be fetched lazily when the instance variable + is first accessed (requires build-time bytecode instrumentation). + <literal>lazy="false"</literal> specifies that the association will always + be eagerly fetched. + </para> + </callout> + <callout arearefs="manytoone14"> + <para> + <literal>not-found</literal> (optional - defaults to <literal>exception</literal>): + Specifies how foreign keys that reference missing rows will be handled: + <literal>ignore</literal> will treat a missing row as a null association. + </para> + </callout> + <callout arearefs="manytoone15"> + <para> + <literal>entity-name</literal> (optional): The entity name of the associated class. + </para> + </callout> + </calloutlist> + <callout arearefs="manytoone16"> + <para> + <literal>formula</literal> (optional): an SQL expression that defines the value for a + <emphasis>computed</emphasis> foreign key. + </para> + </callout> + </programlistingco> + + <para> + Setting a value of the <literal>cascade</literal> attribute to any meaningful + value other than <literal>none</literal> will propagate certain operations to the + associated object. The meaningful values are the names of Hibernate's basic + operations, <literal>persist, merge, delete, save-update, evict, replicate, lock, + refresh</literal>, as well as the special values <literal>delete-orphan</literal> + and <literal>all</literal> and comma-separated combinations of operation + names, for example, <literal>cascade="persist,merge,evict"</literal> or + <literal>cascade="all,delete-orphan"</literal>. See <xref linkend="objectstate-transitive"/> + for a full explanation. Note that single valued associations (many-to-one and + one-to-one associations) do not support orphan delete. + </para> + + <para> + A typical <literal>many-to-one</literal> declaration looks as simple as this: + </para> + + <programlisting><![CDATA[<many-to-one name="product" class="Product" column="PRODUCT_ID"/>]]></programlisting> + + <para> + The <literal>property-ref</literal> attribute should only be used for mapping legacy + data where a foreign key refers to a unique key of the associated table other than + the primary key. This is an ugly relational model. For example, suppose the + <literal>Product</literal> class had a unique serial number, that is not the primary + key. (The <literal>unique</literal> attribute controls Hibernate's DDL generation with + the SchemaExport tool.) + </para> + + <programlisting><![CDATA[<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>]]></programlisting> + + <para> + Then the mapping for <literal>OrderItem</literal> might use: + </para> + + <programlisting><![CDATA[<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>]]></programlisting> + + <para> + This is certainly not encouraged, however. + </para> + + <para> + If the referenced unique key comprises multiple properties of the associated entity, you should + map the referenced properties inside a named <literal><properties></literal> element. + </para> + + <para> + If the referenced unique key is the property of a component, you may specify a property path: + </para> + + <programlisting><![CDATA[<many-to-one name="owner" property-ref="identity.ssn" column="OWNER_SSN"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-onetoone" revision="3"> + <title>one-to-one</title> + + <para> + A one-to-one association to another persistent class is declared using a + <literal>one-to-one</literal> element. + </para> + + <programlistingco> + <areaspec> + <area id="onetoone1" coords="2 70"/> + <area id="onetoone2" coords="3 70"/> + <area id="onetoone3" coords="4 70"/> + <area id="onetoone4" coords="5 70"/> + <area id="onetoone5" coords="6 70"/> + <area id="onetoone6" coords="7 70"/> + <area id="onetoone7" coords="8 70"/> + <area id="onetoone8" coords="9 70"/> + <area id="onetoone9" coords="10 70"/> + <area id="onetoone10" coords="11 70"/> + </areaspec> + <programlisting><![CDATA[<one-to-one + name="propertyName" + class="ClassName" + cascade="cascade_style" + constrained="true|false" + fetch="join|select" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + formula="any SQL expression" + lazy="proxy|no-proxy|false" + entity-name="EntityName" + node="element-name|@attribute-name|element/@attribute|." + embed-xml="true|false" + foreign-key="foreign_key_name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="onetoone1"> + <para> + <literal>name</literal>: The name of the property. + </para> + </callout> + <callout arearefs="onetoone2"> + <para> + <literal>class</literal> (optional - defaults to the property type + determined by reflection): The name of the associated class. + </para> + </callout> + <callout arearefs="onetoone3"> + <para> + <literal>cascade</literal> (optional) specifies which operations should + be cascaded from the parent object to the associated object. + </para> + </callout> + <callout arearefs="onetoone4"> + <para> + <literal>constrained</literal> (optional) specifies that a foreign key constraint + on the primary key of the mapped table references the table of the associated + class. This option affects the order in which <literal>save()</literal> and + <literal>delete()</literal> are cascaded, and determines whether the association + may be proxied (it is also used by the schema export tool). + </para> + </callout> + <callout arearefs="onetoone5"> + <para> + <literal>fetch</literal> (optional - defaults to <literal>select</literal>): + Chooses between outer-join fetching or sequential select fetching. + </para> + </callout> + <callout arearefs="onetoone6"> + <para> + <literal>property-ref</literal>: (optional) The name of a property of the associated class + that is joined to the primary key of this class. If not specified, the primary key of + the associated class is used. + </para> + </callout> + <callout arearefs="onetoone7"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="onetoone8"> + <para> + <literal>formula</literal> (optional): Almost all one to one associations map to the + primary key of the owning entity. In the rare case that this is not the case, you may + specify a some other column, columns or expression to join on using an SQL formula. (See + <literal>org.hibernate.test.onetooneformula</literal> for an example.) + </para> + </callout> + <callout arearefs="onetoone9"> + <para> + <literal>lazy</literal> (optional - defaults to <literal>proxy</literal>): + By default, single point associations are proxied. <literal>lazy="no-proxy"</literal> + specifies that the property should be fetched lazily when the instance variable + is first accessed (requires build-time bytecode instrumentation). + <literal>lazy="false"</literal> specifies that the association will always + be eagerly fetched. <emphasis>Note that if <literal>constrained="false"</literal>, + proxying is impossible and Hibernate will eager fetch the association!</emphasis> + </para> + </callout> + <callout arearefs="onetoone10"> + <para> + <literal>entity-name</literal> (optional): The entity name of the associated class. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + There are two varieties of one-to-one association: + </para> + <itemizedlist> + <listitem><para> + primary key associations + </para></listitem> + <listitem><para> + unique foreign key associations + </para></listitem> + </itemizedlist> + + <para> + Primary key associations don't need an extra table column; if two rows are related by + the association then the two table rows share the same primary key value. So if you want + two objects to be related by a primary key association, you must make sure that they + are assigned the same identifier value! + </para> + + <para> + For a primary key association, add the following mappings to <literal>Employee</literal> and + <literal>Person</literal>, respectively. + </para> + + <programlisting><![CDATA[<one-to-one name="person" class="Person"/>]]></programlisting> + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" constrained="true"/>]]></programlisting> + + <para> + Now we must ensure that the primary keys of related rows in the PERSON and + EMPLOYEE tables are equal. We use a special Hibernate identifier generation strategy + called <literal>foreign</literal>: + </para> + + <programlisting><![CDATA[<class name="person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="foreign"> + <param name="property">employee</param> + </generator> + </id> + ... + <one-to-one name="employee" + class="Employee" + constrained="true"/> +</class>]]></programlisting> + + <para> + A newly saved instance of <literal>Person</literal> is then assigned the same primary + key value as the <literal>Employee</literal> instance refered with the <literal>employee</literal> + property of that <literal>Person</literal>. + </para> + + <para> + Alternatively, a foreign key with a unique constraint, from <literal>Employee</literal> to + <literal>Person</literal>, may be expressed as: + </para> + + <programlisting><![CDATA[<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>]]></programlisting> + + <para> + And this association may be made bidirectional by adding the following to the + <literal>Person</literal> mapping: + </para> + + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" property-ref="person"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-naturalid"> + <title>natural-id</title> + + <programlisting><![CDATA[<natural-id mutable="true|false"/> + <property ... /> + <many-to-one ... /> + ...... +</natural-id>]]></programlisting> + + <para> + Even though we recommend the use of surrogate keys as primary keys, you should still try + to identify natural keys for all entities. A natural key is a property or combination of + properties that is unique and non-null. If it is also immutable, even better. Map the + properties of the natural key inside the <literal><natural-id></literal> element. + Hibernate will generate the necessary unique key and nullability constraints, and your + mapping will be more self-documenting. + </para> + + <para> + We strongly recommend that you implement <literal>equals()</literal> and + <literal>hashCode()</literal> to compare the natural key properties of the entity. + </para> + + <para> + This mapping is not intended for use with entities with natural primary keys. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mutable</literal> (optional, defaults to <literal>false</literal>): + By default, natural identifier properties as assumed to be immutable (constant). + </para> + </listitem> + </itemizedlist> + + </sect2> + + <sect2 id="mapping-declaration-component" revision="2"> + <title>component, dynamic-component</title> + + <para> + The <literal><component></literal> element maps properties of a + child object to columns of the table of a parent class. Components may, in + turn, declare their own properties, components or collections. See + "Components" below. + </para> + + <programlistingco> + <areaspec> + <area id="component1" coords="2 45"/> + <area id="component2" coords="3 45"/> + <area id="component3" coords="4 45"/> + <area id="component4" coords="5 45"/> + <area id="component5" coords="6 45"/> + <area id="component6" coords="7 45"/> + <area id="component7" coords="8 45"/> + <area id="component8" coords="9 45"/> + </areaspec> + <programlisting><![CDATA[<component + name="propertyName" + class="className" + insert="true|false" + update="true|false" + access="field|property|ClassName" + lazy="true|false" + optimistic-lock="true|false" + unique="true|false" + node="element-name|." +> + + <property ...../> + <many-to-one .... /> + ........ +</component>]]></programlisting> + <calloutlist> + <callout arearefs="component1"> + <para> + <literal>name</literal>: The name of the property. + </para> + </callout> + <callout arearefs="component2"> + <para> + <literal>class</literal> (optional - defaults to the property type + determined by reflection): The name of the component (child) class. + </para> + </callout> + <callout arearefs="component3"> + <para> + <literal>insert</literal>: Do the mapped columns appear in SQL + <literal>INSERT</literal>s? + </para> + </callout> + <callout arearefs="component4"> + <para> + <literal>update</literal>: Do the mapped columns appear in SQL + <literal>UPDATE</literal>s? + </para> + </callout> + <callout arearefs="component5"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="component6"> + <para> + <literal>lazy</literal> (optional - defaults to <literal>false</literal>): Specifies + that this component should be fetched lazily when the instance variable is first + accessed (requires build-time bytecode instrumentation). + </para> + </callout> + <callout arearefs="component7"> + <para> + <literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>): + Specifies that updates to this component do or do not require acquisition of the + optimistic lock. In other words, determines if a version increment should occur when + this property is dirty. + </para> + </callout> + <callout arearefs="component8"> + <para> + <literal>unique</literal> (optional - defaults to <literal>false</literal>): + Specifies that a unique constraint exists upon all mapped columns of the + component. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + The child <literal><property></literal> tags map properties of the + child class to table columns. + </para> + + <para> + The <literal><component></literal> element allows a <literal><parent></literal> + subelement that maps a property of the component class as a reference back to the + containing entity. + </para> + + <para> + The <literal><dynamic-component></literal> element allows a <literal>Map</literal> + to be mapped as a component, where the property names refer to keys of the map, see + <xref linkend="components-dynamic"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-properties" revision="2"> + <title>properties</title> + + <para> + The <literal><properties></literal> element allows the definition of a named, + logical grouping of properties of a class. The most important use of the construct + is that it allows a combination of properties to be the target of a + <literal>property-ref</literal>. It is also a convenient way to define a multi-column + unique constraint. + </para> + + <programlistingco> + <areaspec> + <area id="properties1" coords="2 45"/> + <area id="properties2" coords="3 45"/> + <area id="properties3" coords="4 45"/> + <area id="properties4" coords="5 45"/> + <area id="properties5" coords="6 45"/> + </areaspec> + <programlisting><![CDATA[<properties + name="logicalName" + insert="true|false" + update="true|false" + optimistic-lock="true|false" + unique="true|false" +> + + <property ...../> + <many-to-one .... /> + ........ +</properties>]]></programlisting> + <calloutlist> + <callout arearefs="properties1"> + <para> + <literal>name</literal>: The logical name of the grouping - + <emphasis>not</emphasis> an actual property name. + </para> + </callout> + <callout arearefs="properties2"> + <para> + <literal>insert</literal>: Do the mapped columns appear in SQL + <literal>INSERT</literal>s? + </para> + </callout> + <callout arearefs="properties3"> + <para> + <literal>update</literal>: Do the mapped columns appear in SQL + <literal>UPDATE</literal>s? + </para> + </callout> + <callout arearefs="properties4"> + <para> + <literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>): + Specifies that updates to these properties do or do not require acquisition of the + optimistic lock. In other words, determines if a version increment should occur when + these properties are dirty. + </para> + </callout> + <callout arearefs="properties5"> + <para> + <literal>unique</literal> (optional - defaults to <literal>false</literal>): + Specifies that a unique constraint exists upon all mapped columns of the + component. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + For example, if we have the following <literal><properties></literal> mapping: + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="personNumber"/> + ... + <properties name="name" + unique="true" update="false"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </properties> +</class>]]></programlisting> + + <para> + Then we might have some legacy data association which refers to this unique key of + the <literal>Person</literal> table, instead of to the primary key: + </para> + + <programlisting><![CDATA[<many-to-one name="person" + class="Person" property-ref="name"> + <column name="firstName"/> + <column name="initial"/> + <column name="lastName"/> +</many-to-one>]]></programlisting> + + <para> + We don't recommend the use of this kind of thing outside the context of mapping + legacy data. + </para> + + </sect2> + + <sect2 id="mapping-declaration-subclass" revision="4"> + <title>subclass</title> + + <para> + Finally, polymorphic persistence requires the declaration of each subclass of + the root persistent class. For the table-per-class-hierarchy + mapping strategy, the <literal><subclass></literal> declaration is used. + </para> + + <programlistingco> + <areaspec> + <area id="subclass1" coords="2 55"/> + <area id="subclass2" coords="3 55"/> + <area id="subclass3" coords="4 55"/> + <area id="subclass4" coords="5 55"/> + </areaspec> + <programlisting><![CDATA[<subclass + name="ClassName" + discriminator-value="discriminator_value" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + entity-name="EntityName" + node="element-name" + extends="SuperclassName"> + + <property .... /> + ..... +</subclass>]]></programlisting> + <calloutlist> + <callout arearefs="subclass1"> + <para> + <literal>name</literal>: The fully qualified class name of the subclass. + </para> + </callout> + <callout arearefs="subclass2"> + <para> + <literal>discriminator-value</literal> (optional - defaults to the class name): A + value that distiguishes individual subclasses. + </para> + </callout> + <callout arearefs="subclass3"> + <para> + <literal>proxy</literal> (optional): Specifies a class or interface to use for + lazy initializing proxies. + </para> + </callout> + <callout arearefs="subclass4"> + <para> + <literal>lazy</literal> (optional, defaults to <literal>true</literal>): Setting + <literal>lazy="false"</literal> disables the use of lazy fetching. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Each subclass should declare its own persistent properties and subclasses. + <literal><version></literal> and <literal><id></literal> properties + are assumed to be inherited from the root class. Each subclass in a heirarchy must + define a unique <literal>discriminator-value</literal>. If none is specified, the + fully qualified Java class name is used. + </para> + + <para> + For information about inheritance mappings, see <xref linkend="inheritance"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-joinedsubclass" revision="3"> + <title>joined-subclass</title> + + <para> + Alternatively, each subclass may be mapped to its own table (table-per-subclass + mapping strategy). Inherited state is retrieved by joining with the table of the + superclass. We use the <literal><joined-subclass></literal> element. + </para> + + <programlistingco> + <areaspec> + <area id="joinedsubclass1" coords="2 45"/> + <area id="joinedsubclass2" coords="3 45"/> + <area id="joinedsubclass3" coords="4 45"/> + <area id="joinedsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<joined-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName" + node="element-name"> + + <key .... > + + <property .... /> + ..... +</joined-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="joinedsubclass1"> + <para> + <literal>name</literal>: The fully qualified class name of the subclass. + </para> + </callout> + <callout arearefs="joinedsubclass2"> + <para> + <literal>table</literal>: The name of the subclass table. + </para> + </callout> + <callout arearefs="joinedsubclass3"> + <para> + <literal>proxy</literal> (optional): Specifies a class or interface to use + for lazy initializing proxies. + </para> + </callout> + <callout arearefs="joinedsubclass4"> + <para> + <literal>lazy</literal> (optional, defaults to <literal>true</literal>): Setting + <literal>lazy="false"</literal> disables the use of lazy fetching. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + No discriminator column is required for this mapping strategy. Each subclass must, + however, declare a table column holding the object identifier using the + <literal><key></literal> element. The mapping at the start of the chapter + would be re-written as: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" table="CATS"> + <id name="id" column="uid" type="long"> + <generator class="hilo"/> + </id> + <property name="birthdate" type="date"/> + <property name="color" not-null="true"/> + <property name="sex" not-null="true"/> + <property name="weight"/> + <many-to-one name="mate"/> + <set name="kittens"> + <key column="MOTHER"/> + <one-to-many class="Cat"/> + </set> + <joined-subclass name="DomesticCat" table="DOMESTIC_CATS"> + <key column="CAT"/> + <property name="name" type="string"/> + </joined-subclass> + </class> + + <class name="eg.Dog"> +  + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + For information about inheritance mappings, see <xref linkend="inheritance"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-unionsubclass" revision="2"> + <title>union-subclass</title> + + <para> + A third option is to map only the concrete classes of an inheritance hierarchy + to tables, (the table-per-concrete-class strategy) where each table defines all + persistent state of the class, including inherited state. In Hibernate, it is + not absolutely necessary to explicitly map such inheritance hierarchies. You + can simply map each class with a separate <literal><class></literal> + declaration. However, if you wish use polymorphic associations (e.g. an association + to the superclass of your hierarchy), you need to + use the <literal><union-subclass></literal> mapping. + </para> + + <programlistingco> + <areaspec> + <area id="unionsubclass1" coords="2 45"/> + <area id="unionsubclass2" coords="3 45"/> + <area id="unionsubclass3" coords="4 45"/> + <area id="unionsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<union-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + abstract="true|false" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName" + node="element-name"> + + <property .... /> + ..... +</union-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="unionsubclass1"> + <para> + <literal>name</literal>: The fully qualified class name of the subclass. + </para> + </callout> + <callout arearefs="unionsubclass2"> + <para> + <literal>table</literal>: The name of the subclass table. + </para> + </callout> + <callout arearefs="unionsubclass3"> + <para> + <literal>proxy</literal> (optional): Specifies a class or interface to use + for lazy initializing proxies. + </para> + </callout> + <callout arearefs="unionsubclass4"> + <para> + <literal>lazy</literal> (optional, defaults to <literal>true</literal>): Setting + <literal>lazy="false"</literal> disables the use of lazy fetching. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + No discriminator column or key column is required for this mapping strategy. + </para> + + <para> + For information about inheritance mappings, see <xref linkend="inheritance"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-join" revision="3"> + <title>join</title> + + <para> + Using the <literal><join></literal> element, it is possible to map + properties of one class to several tables, when there's a 1-to-1 relationship between the tables. + </para> + + <programlistingco> + <areaspec> + <area id="join1" coords="2 50"/> + <area id="join2" coords="3 50"/> + <area id="join3" coords="4 50"/> + <area id="join4" coords="5 50"/> + <area id="join5" coords="6 50"/> + <area id="join6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<join + table="tablename" + schema="owner" + catalog="catalog" + fetch="join|select" + inverse="true|false" + optional="true|false"> + + <key ... /> + + <property ... /> + ... +</join>]]></programlisting> + + <calloutlist> + <callout arearefs="join1"> + <para> + <literal>table</literal>: The name of the joined table. + </para> + </callout> + <callout arearefs="join2"> + <para> + <literal>schema</literal> (optional): Override the schema name specified by + the root <literal><hibernate-mapping></literal> element. + </para> + </callout> + <callout arearefs="join3"> + <para> + <literal>catalog</literal> (optional): Override the catalog name specified by + the root <literal><hibernate-mapping></literal> element. + </para> + </callout> + <callout arearefs="join4"> + <para> + <literal>fetch</literal> (optional - defaults to <literal>join</literal>): + If set to <literal>join</literal>, the default, Hibernate will use an inner join + to retrieve a <literal><join></literal> defined by a class or its superclasses + and an outer join for a <literal><join></literal> defined by a subclass. + If set to <literal>select</literal> then Hibernate will use a sequential select for + a <literal><join></literal> defined on a subclass, which will be issued only + if a row turns out to represent an instance of the subclass. Inner joins will still + be used to retrieve a <literal><join></literal> defined by the class and its + superclasses. + </para> + </callout> + <callout arearefs="join5"> + <para> + <literal>inverse</literal> (optional - defaults to <literal>false</literal>): + If enabled, Hibernate will not try to insert or update the properties defined + by this join. + </para> + </callout> + <callout arearefs="join6"> + <para> + <literal>optional</literal> (optional - defaults to <literal>false</literal>): + If enabled, Hibernate will insert a row only if the properties defined by this + join are non-null and will always use an outer join to retrieve the properties. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + For example, the address information for a person can be mapped to a separate + table (while preserving value type semantics for all properties): + </para> + + <programlisting><![CDATA[<class name="Person" + table="PERSON"> + + <id name="id" column="PERSON_ID">...</id> + + <join table="ADDRESS"> + <key column="ADDRESS_ID"/> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </join> + ...]]></programlisting> + + <para> + This feature is often only useful for legacy data models, we recommend fewer + tables than classes and a fine-grained domain model. However, it is useful + for switching between inheritance mapping strategies in a single hierarchy, as + explained later. + </para> + + </sect2> + + <sect2 id="mapping-declaration-key"> + <title>key</title> + + <para> + We've seen the <literal><key></literal> element crop up a few times + now. It appears anywhere the parent mapping element defines a join to + a new table, and defines the foreign key in the joined table, that references + the primary key of the original table. + </para> + + <programlistingco> + <areaspec> + <area id="key1" coords="2 50"/> + <area id="key2" coords="3 50"/> + <area id="key3" coords="4 50"/> + <area id="key4" coords="5 50"/> + <area id="key5" coords="6 50"/> + <area id="key6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<key + column="columnname" + on-delete="noaction|cascade" + property-ref="propertyName" + not-null="true|false" + update="true|false" + unique="true|false" +/>]]></programlisting> + + <calloutlist> + <callout arearefs="key1"> + <para> + <literal>column</literal> (optional): The name of the foreign key column. + This may also be specified by nested <literal><column></literal> + element(s). + </para> + </callout> + <callout arearefs="key2"> + <para> + <literal>on-delete</literal> (optional, defaults to <literal>noaction</literal>): + Specifies whether the foreign key constraint has database-level cascade delete + enabled. + </para> + </callout> + <callout arearefs="key3"> + <para> + <literal>property-ref</literal> (optional): Specifies that the foreign key refers + to columns that are not the primary key of the orginal table. (Provided for + legacy data.) + </para> + </callout> + <callout arearefs="key4"> + <para> + <literal>not-null</literal> (optional): Specifies that the foreign key columns + are not nullable (this is implied whenever the foreign key is also part of the + primary key). + </para> + </callout> + <callout arearefs="key5"> + <para> + <literal>update</literal> (optional): Specifies that the foreign key should never + be updated (this is implied whenever the foreign key is also part of the primary + key). + </para> + </callout> + <callout arearefs="key6"> + <para> + <literal>unique</literal> (optional): Specifies that the foreign key should have + a unique constraint (this is implied whenever the foreign key is also the primary key). + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + We recommend that for systems where delete performance is important, all keys should be + defined <literal>on-delete="cascade"</literal>, and Hibernate will use a database-level + <literal>ON CASCADE DELETE</literal> constraint, instead of many individual + <literal>DELETE</literal> statements. Be aware that this feature bypasses Hibernate's + usual optimistic locking strategy for versioned data. + </para> + + <para> + The <literal>not-null</literal> and <literal>update</literal> attributes are useful when + mapping a unidirectional one to many association. If you map a unidirectional one to many + to a non-nullable foreign key, you <emphasis>must</emphasis> declare the key column using + <literal><key not-null="true"></literal>. + </para> + + </sect2> + + <sect2 id="mapping-column" revision="4"> + <title>column and formula elements</title> + <para> + Any mapping element which accepts a <literal>column</literal> attribute will alternatively + accept a <literal><column></literal> subelement. Likewise, <literal><formula></literal> + is an alternative to the <literal>formula</literal> attribute. + </para> + + <programlisting><![CDATA[<column + name="column_name" + length="N" + precision="N" + scale="N" + not-null="true|false" + unique="true|false" + unique-key="multicolumn_unique_key_name" + index="index_name" + sql-type="sql_type_name" + check="SQL expression" + default="SQL expression"/>]]></programlisting> + + <programlisting><![CDATA[<formula>SQL expression</formula>]]></programlisting> + + <para> + <literal>column</literal> and <literal>formula</literal> attributes may even be combined + within the same property or association mapping to express, for example, exotic join + conditions. + </para> + + <programlisting><![CDATA[<many-to-one name="homeAddress" class="Address" + insert="false" update="false"> + <column name="person_id" not-null="true" length="10"/> + <formula>'MAILING'</formula> +</many-to-one>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-import"> + <title>import</title> + + <para> + Suppose your application has two persistent classes with the same name, and you don't want to + specify the fully qualified (package) name in Hibernate queries. Classes may be "imported" + explicitly, rather than relying upon <literal>auto-import="true"</literal>. You may even import + classes and interfaces that are not explicitly mapped. + </para> + + <programlisting><![CDATA[<import class="java.lang.Object" rename="Universe"/>]]></programlisting> + + <programlistingco> + <areaspec> + <area id="import1" coords="2 40"/> + <area id="import2" coords="3 40"/> + </areaspec> + <programlisting><![CDATA[<import + class="ClassName" + rename="ShortName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="import1"> + <para> + <literal>class</literal>: The fully qualified class name of of any Java class. + </para> + </callout> + <callout arearefs="import2"> + <para> + <literal>rename</literal> (optional - defaults to the unqualified class name): + A name that may be used in the query language. + </para> + </callout> + </calloutlist> + </programlistingco> + + </sect2> + + <sect2 id="mapping-types-anymapping" revision="2"> + <title>any</title> + + <para> + There is one further type of property mapping. The <literal><any></literal> mapping element + defines a polymorphic association to classes from multiple tables. This type of mapping always + requires more than one column. The first column holds the type of the associated entity. + The remaining columns hold the identifier. It is impossible to specify a foreign key constraint + for this kind of association, so this is most certainly not meant as the usual way of mapping + (polymorphic) associations. You should use this only in very special cases (eg. audit logs, + user session data, etc). + </para> + + <para> + The <literal>meta-type</literal> attribute lets the application specify a custom type that + maps database column values to persistent classes which have identifier properties of the + type specified by <literal>id-type</literal>. You must specify the mapping from values of + the meta-type to class names. + </para> + + <programlisting><![CDATA[<any name="being" id-type="long" meta-type="string"> + <meta-value value="TBL_ANIMAL" class="Animal"/> + <meta-value value="TBL_HUMAN" class="Human"/> + <meta-value value="TBL_ALIEN" class="Alien"/> + <column name="table_name"/> + <column name="id"/> +</any>]]></programlisting> + + <programlistingco> + <areaspec> + <area id="any1" coords="2 50"/> + <area id="any2" coords="3 50"/> + <area id="any3" coords="4 50"/> + <area id="any4" coords="5 50"/> + <area id="any5" coords="6 50"/> + <area id="any6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<any + name="propertyName" + id-type="idtypename" + meta-type="metatypename" + cascade="cascade_style" + access="field|property|ClassName" + optimistic-lock="true|false" +> + <meta-value ... /> + <meta-value ... /> + ..... + <column .... /> + <column .... /> + ..... +</any>]]></programlisting> + <calloutlist> + <callout arearefs="any1"> + <para> + <literal>name</literal>: the property name. + </para> + </callout> + <callout arearefs="any2"> + <para> + <literal>id-type</literal>: the identifier type. + </para> + </callout> + <callout arearefs="any3"> + <para> + <literal>meta-type</literal> (optional - defaults to <literal>string</literal>): + Any type that is allowed for a discriminator mapping. + </para> + </callout> + <callout arearefs="any4"> + <para> + <literal>cascade</literal> (optional- defaults to <literal>none</literal>): + the cascade style. + </para> + </callout> + <callout arearefs="any5"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the property value. + </para> + </callout> + <callout arearefs="any6"> + <para> + <literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>): + Specifies that updates to this property do or do not require acquisition of the + optimistic lock. In other words, define if a version increment should occur if this + property is dirty. + </para> + </callout> + </calloutlist> + </programlistingco> + + </sect2> + + </sect1> + + <sect1 id="mapping-types"> + <title>Hibernate Types</title> + + <sect2 id="mapping-types-entitiesvalues" revision="1"> + <title>Entities and values</title> + + <para> + To understand the behaviour of various Java language-level objects with respect + to the persistence service, we need to classify them into two groups: + </para> + + <para> + An <emphasis>entity</emphasis> exists independently of any other objects holding + references to the entity. Contrast this with the usual Java model where an + unreferenced object is garbage collected. Entities must be explicitly saved and + deleted (except that saves and deletions may be <emphasis>cascaded</emphasis> + from a parent entity to its children). This is different from the ODMG model of + object persistence by reachablity - and corresponds more closely to how + application objects are usually used in large systems. Entities support + circular and shared references. They may also be versioned. + </para> + + <para> + An entity's persistent state consists of references to other entities and + instances of <emphasis>value</emphasis> types. Values are primitives, + collections (not what's inside a collection), components and certain immutable + objects. Unlike entities, values (in particular collections and components) + <emphasis>are</emphasis> persisted and deleted by reachability. Since value + objects (and primitives) are persisted and deleted along with their containing + entity they may not be independently versioned. Values have no independent + identity, so they cannot be shared by two entities or collections. + </para> + + <para> + Up until now, we've been using the term "persistent class" to refer to + entities. We will continue to do that. Strictly speaking, however, not all + user-defined classes with persistent state are entities. A + <emphasis>component</emphasis> is a user defined class with value semantics. + A Java property of type <literal>java.lang.String</literal> also has value + semantics. Given this definition, we can say that all types (classes) provided + by the JDK have value type semantics in Java, while user-defined types may + be mapped with entity or value type semantics. This decision is up to the + application developer. A good hint for an entity class in a domain model are + shared references to a single instance of that class, while composition or + aggregation usually translates to a value type. + </para> + + <para> + We'll revisit both concepts throughout the documentation. + </para> + + <para> + The challenge is to map the Java type system (and the developers' definition of + entities and value types) to the SQL/database type system. The bridge between + both systems is provided by Hibernate: for entities we use + <literal><class></literal>, <literal><subclass></literal> and so on. + For value types we use <literal><property></literal>, + <literal><component></literal>, etc, usually with a <literal>type</literal> + attribute. The value of this attribute is the name of a Hibernate + <emphasis>mapping type</emphasis>. Hibernate provides many mappings (for standard + JDK value types) out of the box. You can write your own mapping types and implement your + custom conversion strategies as well, as you'll see later. + </para> + + <para> + All built-in Hibernate types except collections support null semantics. + </para> + + </sect2> + + <sect2 id="mapping-types-basictypes" revision="3"> + <title>Basic value types</title> + + <para> + The built-in <emphasis>basic mapping types</emphasis> may be roughly categorized into + + <variablelist> + <varlistentry> + <term><literal>integer, long, short, float, double, character, byte, + boolean, yes_no, true_false</literal></term> + <listitem> + <para> + Type mappings from Java primitives or wrapper classes to appropriate + (vendor-specific) SQL column types. <literal>boolean, yes_no</literal> + and <literal>true_false</literal> are all alternative encodings for + a Java <literal>boolean</literal> or <literal>java.lang.Boolean</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>string</literal></term> + <listitem> + <para> + A type mapping from <literal>java.lang.String</literal> to + <literal>VARCHAR</literal> (or Oracle <literal>VARCHAR2</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>date, time, timestamp</literal></term> + <listitem> + <para> + Type mappings from <literal>java.util.Date</literal> and its subclasses + to SQL types <literal>DATE</literal>, <literal>TIME</literal> and + <literal>TIMESTAMP</literal> (or equivalent). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>calendar, calendar_date</literal></term> + <listitem> + <para> + Type mappings from <literal>java.util.Calendar</literal> to + SQL types <literal>TIMESTAMP</literal> and <literal>DATE</literal> + (or equivalent). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>big_decimal, big_integer</literal></term> + <listitem> + <para> + Type mappings from <literal>java.math.BigDecimal</literal> and + <literal>java.math.BigInteger</literal> to <literal>NUMERIC</literal> + (or Oracle <literal>NUMBER</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>locale, timezone, currency</literal></term> + <listitem> + <para> + Type mappings from <literal>java.util.Locale</literal>, + <literal>java.util.TimeZone</literal> and + <literal>java.util.Currency</literal> + to <literal>VARCHAR</literal> (or Oracle <literal>VARCHAR2</literal>). + Instances of <literal>Locale</literal> and <literal>Currency</literal> are + mapped to their ISO codes. Instances of <literal>TimeZone</literal> are + mapped to their <literal>ID</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>class</literal></term> + <listitem> + <para> + A type mapping from <literal>java.lang.Class</literal> to + <literal>VARCHAR</literal> (or Oracle <literal>VARCHAR2</literal>). + A <literal>Class</literal> is mapped to its fully qualified name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>binary</literal></term> + <listitem> + <para> + Maps byte arrays to an appropriate SQL binary type. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>text</literal></term> + <listitem> + <para> + Maps long Java strings to a SQL <literal>CLOB</literal> or + <literal>TEXT</literal> type. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>serializable</literal></term> + <listitem> + <para> + Maps serializable Java types to an appropriate SQL binary type. You + may also indicate the Hibernate type <literal>serializable</literal> with + the name of a serializable Java class or interface that does not default + to a basic type. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>clob, blob</literal></term> + <listitem> + <para> + Type mappings for the JDBC classes <literal>java.sql.Clob</literal> and + <literal>java.sql.Blob</literal>. These types may be inconvenient for some + applications, since the blob or clob object may not be reused outside of + a transaction. (Furthermore, driver support is patchy and inconsistent.) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>imm_date, imm_time, imm_timestamp, imm_calendar, imm_calendar_date, + imm_serializable, imm_binary</literal> + </term> + <listitem> + <para> + Type mappings for what are usually considered mutable Java types, where + Hibernate makes certain optimizations appropriate only for immutable + Java types, and the application treats the object as immutable. For + example, you should not call <literal>Date.setTime()</literal> for an + instance mapped as <literal>imm_timestamp</literal>. To change the + value of the property, and have that change made persistent, the + application must assign a new (nonidentical) object to the property. + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + + <para> + Unique identifiers of entities and collections may be of any basic type except + <literal>binary</literal>, <literal>blob</literal> and <literal>clob</literal>. + (Composite identifiers are also allowed, see below.) + </para> + + <para> + The basic value types have corresponding <literal>Type</literal> constants defined on + <literal>org.hibernate.Hibernate</literal>. For example, <literal>Hibernate.STRING</literal> + represents the <literal>string</literal> type. + </para> + + </sect2> + + <sect2 id="mapping-types-custom" revision="2"> + <title>Custom value types</title> + + <para> + It is relatively easy for developers to create their own value types. For example, + you might want to persist properties of type <literal>java.lang.BigInteger</literal> + to <literal>VARCHAR</literal> columns. Hibernate does not provide a built-in type + for this. But custom types are not limited to mapping a property (or collection element) + to a single table column. So, for example, you might have a Java property + <literal>getName()</literal>/<literal>setName()</literal> of type + <literal>java.lang.String</literal> that is persisted to the columns + <literal>FIRST_NAME</literal>, <literal>INITIAL</literal>, <literal>SURNAME</literal>. + </para> + + <para> + To implement a custom type, implement either <literal>org.hibernate.UserType</literal> + or <literal>org.hibernate.CompositeUserType</literal> and declare properties using the + fully qualified classname of the type. Check out + <literal>org.hibernate.test.DoubleStringType</literal> to see the kind of things that + are possible. + </para> + + <programlisting><![CDATA[<property name="twoStrings" type="org.hibernate.test.DoubleStringType"> + <column name="first_string"/> + <column name="second_string"/> +</property>]]></programlisting> + + <para> + Notice the use of <literal><column></literal> tags to map a property to multiple + columns. + </para> + + <para> + The <literal>CompositeUserType</literal>, <literal>EnhancedUserType</literal>, + <literal>UserCollectionType</literal>, and <literal>UserVersionType</literal> + interfaces provide support for more specialized uses. + </para> + + <para> + You may even supply parameters to a <literal>UserType</literal> in the mapping file. To + do this, your <literal>UserType</literal> must implement the + <literal>org.hibernate.usertype.ParameterizedType</literal> interface. To supply parameters + to your custom type, you can use the <literal><type></literal> element in your mapping + files. + </para> + + <programlisting><![CDATA[<property name="priority"> + <type name="com.mycompany.usertypes.DefaultValueIntegerType"> + <param name="default">0</param> + </type> +</property>]]></programlisting> + + <para> + The <literal>UserType</literal> can now retrieve the value for the parameter named + <literal>default</literal> from the <literal>Properties</literal> object passed to it. + </para> + + <para> + If you use a certain <literal>UserType</literal> very often, it may be useful to define a + shorter name for it. You can do this using the <literal><typedef></literal> element. + Typedefs assign a name to a custom type, and may also contain a list of default + parameter values if the type is parameterized. + </para> + + <programlisting><![CDATA[<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero"> + <param name="default">0</param> +</typedef>]]></programlisting> + + <programlisting><![CDATA[<property name="priority" type="default_zero"/>]]></programlisting> + + <para> + It is also possible to override the parameters supplied in a typedef on a case-by-case basis + by using type parameters on the property mapping. + </para> + + <para> + Even though Hibernate's rich range of built-in types and support for components means you + will very rarely <emphasis>need</emphasis> to use a custom type, it is nevertheless + considered good form to use custom types for (non-entity) classes that occur frequently + in your application. For example, a <literal>MonetaryAmount</literal> class is a good + candidate for a <literal>CompositeUserType</literal>, even though it could easily be mapped + as a component. One motivation for this is abstraction. With a custom type, your mapping + documents would be future-proofed against possible changes in your way of representing + monetary values. + </para> + + </sect2> + + </sect1> + + <sect1 id="mapping-entityname"> + <title>Mapping a class more than once</title> + <para> + It is possible to provide more than one mapping for a particular persistent class. In this + case you must specify an <emphasis>entity name</emphasis> do disambiguate between instances + of the two mapped entities. (By default, the entity name is the same as the class name.) + Hibernate lets you specify the entity name when working with persistent objects, when writing + queries, or when mapping associations to the named entity. + </para> + + <programlisting><![CDATA[<class name="Contract" table="Contracts" + entity-name="CurrentContract"> + ... + <set name="history" inverse="true" + order-by="effectiveEndDate desc"> + <key column="currentContractId"/> + <one-to-many entity-name="HistoricalContract"/> + </set> +</class> + +<class name="Contract" table="ContractHistory" + entity-name="HistoricalContract"> + ... + <many-to-one name="currentContract" + column="currentContractId" + entity-name="CurrentContract"/> +</class>]]></programlisting> + + <para> + Notice how associations are now specified using <literal>entity-name</literal> instead of + <literal>class</literal>. + </para> + + </sect1> + + <sect1 id="mapping-quotedidentifiers"> + <title>SQL quoted identifiers</title> + <para> + You may force Hibernate to quote an identifier in the generated SQL by enclosing the table or + column name in backticks in the mapping document. Hibernate will use the correct quotation + style for the SQL <literal>Dialect</literal> (usually double quotes, but brackets for SQL + Server and backticks for MySQL). + </para> + + <programlisting><![CDATA[<class name="LineItem" table="`Line Item`"> + <id name="id" column="`Item Id`"/><generator class="assigned"/></id> + <property name="itemNumber" column="`Item #`"/> + ... +</class>]]></programlisting> + + </sect1> + + + <sect1 id="mapping-alternatives"> + <title>Metadata alternatives</title> + + <para> + XML isn't for everyone, and so there are some alternative ways to define O/R mapping metadata in Hibernate. + </para> + + <sect2 id="mapping-xdoclet"> + <title>Using XDoclet markup</title> + + <para> + Many Hibernate users prefer to embed mapping information directly in sourcecode using + XDoclet <literal>@hibernate.tags</literal>. We will not cover this approach in this + document, since strictly it is considered part of XDoclet. However, we include the + following example of the <literal>Cat</literal> class with XDoclet mappings. + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +/** + * @hibernate.class + * table="CATS" + */ +public class Cat { + private Long id; // identifier + private Date birthdate; + private Cat mother; + private Set kittens + private Color color; + private char sex; + private float weight; + + /* + * @hibernate.id + * generator-class="native" + * column="CAT_ID" + */ + public Long getId() { + return id; + } + private void setId(Long id) { + this.id=id; + } + + /** + * @hibernate.many-to-one + * column="PARENT_ID" + */ + public Cat getMother() { + return mother; + } + void setMother(Cat mother) { + this.mother = mother; + } + + /** + * @hibernate.property + * column="BIRTH_DATE" + */ + public Date getBirthdate() { + return birthdate; + } + void setBirthdate(Date date) { + birthdate = date; + } + /** + * @hibernate.property + * column="WEIGHT" + */ + public float getWeight() { + return weight; + } + void setWeight(float weight) { + this.weight = weight; + } + + /** + * @hibernate.property + * column="COLOR" + * not-null="true" + */ + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + /** + * @hibernate.set + * inverse="true" + * order-by="BIRTH_DATE" + * @hibernate.collection-key + * column="PARENT_ID" + * @hibernate.collection-one-to-many + */ + public Set getKittens() { + return kittens; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kittens.add(kitten); + } + + /** + * @hibernate.property + * column="SEX" + * not-null="true" + * update="false" + */ + public char getSex() { + return sex; + } + void setSex(char sex) { + this.sex=sex; + } +}]]></programlisting> + + <para> + See the Hibernate web site for more examples of XDoclet and Hibernate. + </para> + + </sect2> + + <sect2 id="mapping-annotations" revision="2"> + <title>Using JDK 5.0 Annotations</title> + + <para> + JDK 5.0 introduced XDoclet-style annotations at the language level, type-safe and + checked at compile time. This mechnism is more powerful than XDoclet annotations and + better supported by tools and IDEs. IntelliJ IDEA, for example, supports auto-completion + and syntax highlighting of JDK 5.0 annotations. The new revision of the EJB specification + (JSR-220) uses JDK 5.0 annotations as the primary metadata mechanism for entity beans. + Hibernate3 implements the <literal>EntityManager</literal> of JSR-220 (the persistence API), + support for mapping metadata is available via the <emphasis>Hibernate Annotations</emphasis> + package, as a separate download. Both EJB3 (JSR-220) and Hibernate3 metadata is supported. + </para> + + <para> + This is an example of a POJO class annotated as an EJB entity bean: + </para> + + <programlisting><![CDATA[@Entity(access = AccessType.FIELD) +public class Customer implements Serializable { + + @Id; + Long id; + + String firstName; + String lastName; + Date birthday; + + @Transient + Integer age; + + @Embedded + private Address homeAddress; + + @OneToMany(cascade=CascadeType.ALL) + @JoinColumn(name="CUSTOMER_ID") + Set<Order> orders; + + // Getter/setter and business methods +}]]></programlisting> + + <para> + Note that support for JDK 5.0 Annotations (and JSR-220) is still work in progress and + not completed. Please refer to the Hibernate Annotations module for more details. + </para> + + </sect2> + </sect1> + + <sect1 id="mapping-generated" revision="1"> + <title>Generated Properties</title> + <para> + Generated properties are properties which have their values generated by the + database. Typically, Hibernate applications needed to <literal>refresh</literal> + objects which contain any properties for which the database was generating values. + Marking properties as generated, however, lets the application delegate this + responsibility to Hibernate. Essentially, whenever Hibernate issues an SQL INSERT + or UPDATE for an entity which has defined generated properties, it immediately + issues a select afterwards to retrieve the generated values. + </para> + <para> + Properties marked as generated must additionally be non-insertable and non-updateable. + Only <xref linkend="mapping-declaration-version">versions</xref>, + <xref linkend="mapping-declaration-timestamp">timestamps</xref>, and + <xref linkend="mapping-declaration-property">simple properties</xref> can be marked as + generated. + </para> + <para> + <literal>never</literal> (the default) - means that the given property value + is not generated within the database. + </para> + <para> + <literal>insert</literal> - states that the given property value is generated on + insert, but is not regenerated on subsequent updates. Things like created-date would + fall into this category. Note that even thought + <xref linkend="mapping-declaration-version">version</xref> and + <xref linkend="mapping-declaration-timestamp">timestamp</xref> properties can + be marked as generated, this option is not available there... + </para> + <para> + <literal>always</literal> - states that the property value is generated both + on insert and on update. + </para> + </sect1> + + <sect1 id="mapping-database-object"> + <title>Auxiliary Database Objects</title> + <para> + Allows CREATE and DROP of arbitrary database objects, in conjunction with + Hibernate's schema evolution tools, to provide the ability to fully define + a user schema within the Hibernate mapping files. Although designed specifically + for creating and dropping things like triggers or stored procedures, really any + SQL command that can be run via a <literal>java.sql.Statement.execute()</literal> + method is valid here (ALTERs, INSERTS, etc). There are essentially two modes for + defining auxiliary database objects... + </para> + <para> + The first mode is to explicitly list the CREATE and DROP commands out in the mapping + file: + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <create>CREATE TRIGGER my_trigger ...</create> + <drop>DROP TRIGGER my_trigger</drop> + </database-object> +</hibernate-mapping>]]></programlisting> + <para> + The second mode is to supply a custom class which knows how to construct the + CREATE and DROP commands. This custom class must implement the + <literal>org.hibernate.mapping.AuxiliaryDatabaseObject</literal> interface. + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <definition class="MyTriggerDefinition"/> + </database-object> +</hibernate-mapping>]]></programlisting> + <para> + Additionally, these database objects can be optionally scoped such that they only + apply when certain dialects are used. + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <definition class="MyTriggerDefinition"/> + <dialect-scope name="org.hibernate.dialect.Oracle9Dialect"/> + <dialect-scope name="org.hibernate.dialect.OracleDialect"/> + </database-object> +</hibernate-mapping>]]></programlisting> + </sect1> +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/batch.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/batch.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/batch.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/batch.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,350 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="batch"> + <title>Batch processing</title> + + <para> + A naive approach to inserting 100 000 rows in the database using Hibernate might + look like this: + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); +} +tx.commit(); +session.close();]]></programlisting> + + <para> + This would fall over with an <literal>OutOfMemoryException</literal> somewhere + around the 50 000th row. That's because Hibernate caches all the newly inserted + <literal>Customer</literal> instances in the session-level cache. + </para> + + <para> + In this chapter we'll show you how to avoid this problem. First, however, if you + are doing batch processing, it is absolutely critical that you enable the use of + JDBC batching, if you intend to achieve reasonable performance. Set the JDBC batch + size to a reasonable number (say, 10-50): + </para> + +<programlisting><![CDATA[hibernate.jdbc.batch_size 20]]></programlisting> + + <para id="disablebatching" revision="1"> + Note that Hibernate disables insert batching at the JDBC level transparently if you + use an <literal>identiy</literal> identifier generator. + </para> + + <para> + You also might like to do this kind of work in a process where interaction with + the second-level cache is completely disabled: + </para> + +<programlisting><![CDATA[hibernate.cache.use_second_level_cache false]]></programlisting> + + <para> + However, this is not absolutely necessary, since we can explicitly set the + <literal>CacheMode</literal> to disable interaction with the second-level cache. + </para> + + <sect1 id="batch-inserts"> + <title>Batch inserts</title> + + <para> + When making new objects persistent, you must <literal>flush()</literal> and + then <literal>clear()</literal> the session regularly, to control the size of + the first-level cache. + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); + if ( i % 20 == 0 ) { //20, same as the JDBC batch size + //flush a batch of inserts and release memory: + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-update" > + <title>Batch updates</title> + + <para> + For retrieving and updating data the same ideas apply. In addition, you need to + use <literal>scroll()</literal> to take advantage of server-side cursors for + queries that return many rows of data. + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .setCacheMode(CacheMode.IGNORE) + .scroll(ScrollMode.FORWARD_ONLY); +int count=0; +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + if ( ++count % 20 == 0 ) { + //flush a batch of updates and release memory: + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-statelesssession"> + <title>The StatelessSession interface</title> + <para> + Alternatively, Hibernate provides a command-oriented API that may be used for + streaming data to and from the database in the form of detached objects. A + <literal>StatelessSession</literal> has no persistence context associated + with it and does not provide many of the higher-level life cycle semantics. + In particular, a stateless session does not implement a first-level cache nor + interact with any second-level or query cache. It does not implement + transactional write-behind or automatic dirty checking. Operations performed + using a stateless session do not ever cascade to associated instances. Collections + are ignored by a stateless session. Operations performed via a stateless session + bypass Hibernate's event model and interceptors. Stateless sessions are vulnerable + to data aliasing effects, due to the lack of a first-level cache. A stateless + session is a lower-level abstraction, much closer to the underlying JDBC. + </para> + +<programlisting><![CDATA[StatelessSession session = sessionFactory.openStatelessSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .scroll(ScrollMode.FORWARD_ONLY); +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + session.update(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + Note that in this code example, the <literal>Customer</literal> instances returned + by the query are immediately detached. They are never associated with any persistence + context. + </para> + + <para> + The <literal>insert(), update()</literal> and <literal>delete()</literal> operations + defined by the <literal>StatelessSession</literal> interface are considered to be + direct database row-level operations, which result in immediate execution of a SQL + <literal>INSERT, UPDATE</literal> or <literal>DELETE</literal> respectively. Thus, + they have very different semantics to the <literal>save(), saveOrUpdate()</literal> + and <literal>delete()</literal> operations defined by the <literal>Session</literal> + interface. + </para> + + </sect1> + + <sect1 id="batch-direct" revision="3"> + <title>DML-style operations</title> + + <para> + As already discussed, automatic and transparent object/relational mapping is concerned + with the management of object state. This implies that the object state is available + in memory, hence manipulating (using the SQL <literal>Data Manipulation Language</literal> + (DML) statements: <literal>INSERT</literal>, <literal>UPDATE</literal>, <literal>DELETE</literal>) + data directly in the database will not affect in-memory state. However, Hibernate provides methods + for bulk SQL-style DML statement execution which are performed through the + Hibernate Query Language (<xref linkend="queryhql">HQL</xref>). + </para> + + <para> + The pseudo-syntax for <literal>UPDATE</literal> and <literal>DELETE</literal> statements + is: <literal>( UPDATE | DELETE ) FROM? EntityName (WHERE where_conditions)?</literal>. Some + points to note: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + In the from-clause, the FROM keyword is optional + </para> + </listitem> + <listitem> + <para> + There can only be a single entity named in the from-clause; it can optionally be + aliased. If the entity name is aliased, then any property references must + be qualified using that alias; if the entity name is not aliased, then it is + illegal for any property references to be qualified. + </para> + </listitem> + <listitem> + <para> + No <xref linkend="queryhql-joins-forms">joins</xref> (either implicit or explicit) + can be specified in a bulk HQL query. Sub-queries may be used in the where-clause; + the subqueries, themselves, may contain joins. + </para> + </listitem> + <listitem> + <para> + The where-clause is also optional. + </para> + </listitem> + </itemizedlist> + + <para> + As an example, to execute an HQL <literal>UPDATE</literal>, use the + <literal>Query.executeUpdate()</literal> method (the method is named for + those familiar with JDBC's <literal>PreparedStatement.executeUpdate()</literal>): + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlUpdate = "update Customer c set c.name = :newName where c.name = :oldName"; +// or String hqlUpdate = "update Customer set name = :newName where name = :oldName"; +int updatedEntities = s.createQuery( hqlUpdate ) + .setString( "newName", newName ) + .setString( "oldName", oldName ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + <para> + HQL <literal>UPDATE</literal> statements, by default do not effect the + <xref linkend="mapping-declaration-version">version</xref> + or the <xref linkend="mapping-declaration-timestamp">timestamp</xref> property values + for the affected entities; this is in keeping with the EJB3 specification. However, + you can force Hibernate to properly reset the <literal>version</literal> or + <literal>timestamp</literal> property values through the use of a <literal>versioned update</literal>. + This is achieved by adding the <literal>VERSIONED</literal> keyword after the <literal>UPDATE</literal> + keyword. + </para> +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); +String hqlVersionedUpdate = "update versioned Customer set name = :newName where name = :oldName"; +int updatedEntities = s.createQuery( hqlUpdate ) + .setString( "newName", newName ) + .setString( "oldName", oldName ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + <para> + Note that custom version types (<literal>org.hibernate.usertype.UserVersionType</literal>) + are not allowed in conjunction with a <literal>update versioned</literal> statement. + </para> + + <para> + To execute an HQL <literal>DELETE</literal>, use the same <literal>Query.executeUpdate()</literal> + method: + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlDelete = "delete Customer c where c.name = :oldName"; +// or String hqlDelete = "delete Customer where name = :oldName"; +int deletedEntities = s.createQuery( hqlDelete ) + .setString( "oldName", oldName ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + <para> + The <literal>int</literal> value returned by the <literal>Query.executeUpdate()</literal> + method indicate the number of entities effected by the operation. Consider this may or may not + correlate to the number of rows effected in the database. An HQL bulk operation might result in + multiple actual SQL statements being executed, for joined-subclass, for example. The returned + number indicates the number of actual entities affected by the statement. Going back to the + example of joined-subclass, a delete against one of the subclasses may actually result + in deletes against not just the table to which that subclass is mapped, but also the "root" + table and potentially joined-subclass tables further down the inheritence hierarchy. + </para> + + <para> + The pseudo-syntax for <literal>INSERT</literal> statements is: + <literal>INSERT INTO EntityName properties_list select_statement</literal>. Some + points to note: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Only the INSERT INTO ... SELECT ... form is supported; not the INSERT INTO ... VALUES ... form. + </para> + <para> + The properties_list is analogous to the <literal>column speficiation</literal> + in the SQL <literal>INSERT</literal> statement. For entities involved in mapped + inheritence, only properties directly defined on that given class-level can be + used in the properties_list. Superclass properties are not allowed; and subclass + properties do not make sense. In other words, <literal>INSERT</literal> + statements are inherently non-polymorphic. + </para> + </listitem> + <listitem> + <para> + select_statement can be any valid HQL select query, with the caveat that the return types + must match the types expected by the insert. Currently, this is checked during query + compilation rather than allowing the check to relegate to the database. Note however + that this might cause problems between Hibernate <literal>Type</literal>s which are + <emphasis>equivalent</emphasis> as opposed to <emphasis>equal</emphasis>. This might cause + issues with mismatches between a property defined as a <literal>org.hibernate.type.DateType</literal> + and a property defined as a <literal>org.hibernate.type.TimestampType</literal>, even though the + database might not make a distinction or might be able to handle the conversion. + </para> + </listitem> + <listitem> + <para> + For the id property, the insert statement gives you two options. You can either + explicitly specify the id property in the properties_list (in which case its value + is taken from the corresponding select expression) or omit it from the properties_list + (in which case a generated value is used). This later option is only available when + using id generators that operate in the database; attempting to use this option with + any "in memory" type generators will cause an exception during parsing. Note that + for the purposes of this discussion, in-database generators are considered to be + <literal>org.hibernate.id.SequenceGenerator</literal> (and its subclasses) and + any implementors of <literal>org.hibernate.id.PostInsertIdentifierGenerator</literal>. + The most notable exception here is <literal>org.hibernate.id.TableHiLoGenerator</literal>, + which cannot be used because it does not expose a selectable way to get its values. + </para> + </listitem> + <listitem> + <para> + For properties mapped as either <literal>version</literal> or <literal>timestamp</literal>, + the insert statement gives you two options. You can either specify the property in the + properties_list (in which case its value is taken from the corresponding select expressions) + or omit it from the properties_list (in which case the <literal>seed value</literal> defined + by the <literal>org.hibernate.type.VersionType</literal> is used). + </para> + </listitem> + </itemizedlist> + + <para> + An example HQL <literal>INSERT</literal> statement execution: + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlInsert = "insert into DelinquentAccount (id, name) select c.id, c.name from Customer c where ..."; +int createdEntities = s.createQuery( hqlInsert ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/best_practices.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/best_practices.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/best_practices.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/best_practices.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,226 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="best-practices" revision="3"> + <title>Best Practices</title> + + <variablelist spacing="compact"> + <varlistentry> + <term>Write fine-grained classes and map them using <literal><component></literal>.</term> + <listitem> + <para> + Use an <literal>Address</literal> class to encapsulate <literal>street</literal>, + <literal>suburb</literal>, <literal>state</literal>, <literal>postcode</literal>. + This encourages code reuse and simplifies refactoring. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Declare identifier properties on persistent classes.</term> + <listitem> + <para> + Hibernate makes identifier properties optional. There are all sorts of reasons why + you should use them. We recommend that identifiers be 'synthetic' (generated, with + no business meaning). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Identify natural keys.</term> + <listitem> + <para> + Identify natural keys for all entities, and map them using + <literal><natural-id></literal>. Implement <literal>equals()</literal> and + <literal>hashCode()</literal> to compare the properties that make up the natural key. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Place each class mapping in its own file.</term> + <listitem> + <para> + Don't use a single monolithic mapping document. Map <literal>com.eg.Foo</literal> in + the file <literal>com/eg/Foo.hbm.xml</literal>. This makes particularly good sense in + a team environment. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Load mappings as resources.</term> + <listitem> + <para> + Deploy the mappings along with the classes they map. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Consider externalising query strings.</term> + <listitem> + <para> + This is a good practice if your queries call non-ANSI-standard SQL functions. + Externalising the query strings to mapping files will make the application more + portable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Use bind variables.</term> + <listitem> + <para> + As in JDBC, always replace non-constant values by "?". Never use string manipulation to + bind a non-constant value in a query! Even better, consider using named parameters in + queries. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Don't manage your own JDBC connections.</term> + <listitem> + <para> + Hibernate lets the application manage JDBC connections. This approach should be considered + a last-resort. If you can't use the built-in connections providers, consider providing your + own implementation of <literal>org.hibernate.connection.ConnectionProvider</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Consider using a custom type.</term> + <listitem> + <para> + Suppose you have a Java type, say from some library, that needs to be persisted but doesn't + provide the accessors needed to map it as a component. You should consider implementing + <literal>org.hibernate.UserType</literal>. This approach frees the application + code from implementing transformations to / from a Hibernate type. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Use hand-coded JDBC in bottlenecks.</term> + <listitem> + <para> + In performance-critical areas of the system, some kinds of operations might benefit from + direct JDBC. But please, wait until you <emphasis>know</emphasis> something is a bottleneck. + And don't assume that direct JDBC is necessarily faster. If you need to use direct JDBC, it might + be worth opening a Hibernate <literal>Session</literal> and using that JDBC connection. That + way you can still use the same transaction strategy and underlying connection provider. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Understand <literal>Session</literal> flushing.</term> + <listitem> + <para> + From time to time the Session synchronizes its persistent state with the database. Performance will + be affected if this process occurs too often. You may sometimes minimize unnecessary flushing by + disabling automatic flushing or even by changing the order of queries and other operations within a + particular transaction. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>In a three tiered architecture, consider using detached objects.</term> + <listitem> + <para> + When using a servlet / session bean architecture, you could pass persistent objects loaded in + the session bean to and from the servlet / JSP layer. Use a new session to service each request. + Use <literal>Session.merge()</literal> or <literal>Session.saveOrUpdate()</literal> to + synchronize objects with the database. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>In a two tiered architecture, consider using long persistence contexts.</term> + <listitem> + <para> + Database Transactions have to be as short as possible for best scalability. However, it is often + neccessary to implement long running <emphasis>application transactions</emphasis>, a single + unit-of-work from the point of view of a user. An application transaction might span several + client request/response cycles. It is common to use detached objects to implement application + transactions. An alternative, extremely appropriate in two tiered architecture, is to maintain + a single open persistence contact (session) for the whole life cycle of the application transaction + and simply disconnect from the JDBC connection at the end of each request and reconnect at the + beginning of the subsequent request. Never share a single session across more than one application + transaction, or you will be working with stale data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Don't treat exceptions as recoverable.</term> + <listitem> + <para> + This is more of a necessary practice than a "best" practice. When an exception occurs, roll back + the <literal>Transaction</literal> and close the <literal>Session</literal>. If you don't, Hibernate + can't guarantee that in-memory state accurately represents persistent state. As a special case of this, + do not use <literal>Session.load()</literal> to determine if an instance with the given identifier + exists on the database; use <literal>Session.get()</literal> or a query instead. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Prefer lazy fetching for associations.</term> + <listitem> + <para> + Use eager fetching sparingly. Use proxies and lazy collections for most associations to classes that + are not likely to be completely held in the second-level cache. For associations to cached classes, + where there is an a extremely high probability of a cache hit, explicitly disable eager fetching using + <literal>lazy="false"</literal>. When an join fetching is appropriate to a particular use + case, use a query with a <literal>left join fetch</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Use the <emphasis>open session in view</emphasis> pattern, or a disciplined + <emphasis>assembly phase</emphasis> to avoid problems with unfetched data. + </term> + <listitem> + <para> + Hibernate frees the developer from writing tedious <emphasis>Data Transfer Objects</emphasis> (DTO). + In a traditional EJB architecture, DTOs serve dual purposes: first, they work around the problem + that entity beans are not serializable; second, they implicitly define an assembly phase where + all data to be used by the view is fetched and marshalled into the DTOs before returning control + to the presentation tier. Hibernate eliminates the first purpose. However, you will still need + an assembly phase (think of your business methods as having a strict contract with the presentation + tier about what data is available in the detached objects) unless you are prepared to hold the + persistence context (the session) open across the view rendering process. This is not a limitation + of Hibernate! It is a fundamental requirement of safe transactional data access. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Consider abstracting your business logic from Hibernate.</term> + <listitem> + <para> + Hide (Hibernate) data-access code behind an interface. Combine the <emphasis>DAO</emphasis> and + <emphasis>Thread Local Session</emphasis> patterns. You can even have some classes persisted by + handcoded JDBC, associated to Hibernate via a <literal>UserType</literal>. (This advice is + intended for "sufficiently large" applications; it is not appropriate for an application with + five tables!) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Don't use exotic association mappings.</term> + <listitem> + <para> + Good usecases for a real many-to-many associations are rare. Most of the time you need + additional information stored in the "link table". In this case, it is much better to + use two one-to-many associations to an intermediate link class. In fact, we think that + most associations are one-to-many and many-to-one, you should be careful when using any + other association style and ask yourself if it is really neccessary. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Prefer bidirectional associations.</term> + <listitem> + <para> + Unidirectional associations are more difficult to query. In a large application, almost + all associations must be navigable in both directions in queries. + </para> + </listitem> + </varlistentry> + </variablelist> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/collection_mapping.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/collection_mapping.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/collection_mapping.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/collection_mapping.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1234 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="collections"> + <title>Collection Mapping</title> + + <sect1 id="collections-persistent" revision="3"> + <title>Persistent collections</title> + + <para> + Hibernate requires that persistent collection-valued fields be declared + as an interface type, for example: + </para> + + <programlisting><![CDATA[public class Product { + private String serialNumber; + private Set parts = new HashSet(); + + public Set getParts() { return parts; } + void setParts(Set parts) { this.parts = parts; } + public String getSerialNumber() { return serialNumber; } + void setSerialNumber(String sn) { serialNumber = sn; } +}]]></programlisting> + + <para> + The actual interface might be <literal>java.util.Set</literal>, + <literal>java.util.Collection</literal>, <literal>java.util.List</literal>, + <literal>java.util.Map</literal>, <literal>java.util.SortedSet</literal>, + <literal>java.util.SortedMap</literal> or ... anything you like! (Where + "anything you like" means you will have to write an implementation of + <literal>org.hibernate.usertype.UserCollectionType</literal>.) + </para> + + <para> + Notice how we initialized the instance variable with an instance of + <literal>HashSet</literal>. This is the best way to initialize collection + valued properties of newly instantiated (non-persistent) instances. When + you make the instance persistent - by calling <literal>persist()</literal>, + for example - Hibernate will actually replace the <literal>HashSet</literal> + with an instance of Hibernate's own implementation of <literal>Set</literal>. + Watch out for errors like this: + </para> + + <programlisting><![CDATA[Cat cat = new DomesticCat(); +Cat kitten = new DomesticCat(); +.... +Set kittens = new HashSet(); +kittens.add(kitten); +cat.setKittens(kittens); +session.persist(cat); +kittens = cat.getKittens(); // Okay, kittens collection is a Set +(HashSet) cat.getKittens(); // Error!]]></programlisting> + + <para> + The persistent collections injected by Hibernate behave like + <literal>HashMap</literal>, <literal>HashSet</literal>, + <literal>TreeMap</literal>, <literal>TreeSet</literal> or + <literal>ArrayList</literal>, depending upon the interface type. + </para> + + <para> + Collections instances have the usual behavior of value types. They are + automatically persisted when referenced by a persistent object and + automatically deleted when unreferenced. If a collection is passed from one + persistent object to another, its elements might be moved from one table to + another. Two entities may not share a reference to the same collection + instance. Due to the underlying relational model, collection-valued properties + do not support null value semantics; Hibernate does not distinguish between + a null collection reference and an empty collection. + </para> + + <para> + You shouldn't have to worry much about any of this. Use persistent collections + the same way you use ordinary Java collections. Just make sure you understand + the semantics of bidirectional associations (discussed later). + </para> + + </sect1> + + <sect1 id="collections-mapping" revision="4"> + <title>Collection mappings</title> + + <para> + The Hibernate mapping element used for mapping a collection depends upon + the type of the interface. For example, a <literal><set></literal> + element is used for mapping properties of type <literal>Set</literal>. + </para> + + <programlisting><![CDATA[<class name="Product"> + <id name="serialNumber" column="productSerialNumber"/> + <set name="parts"> + <key column="productSerialNumber" not-null="true"/> + <one-to-many class="Part"/> + </set> +</class>]]></programlisting> + + <para> + Apart from <literal><set></literal>, there is also + <literal><list></literal>, <literal><map></literal>, + <literal><bag></literal>, <literal><array></literal> and + <literal><primitive-array></literal> mapping elements. The + <literal><map></literal> element is representative: + </para> + + <programlistingco> + <areaspec> + <area id="mappingcollection1" coords="2 65"/> + <area id="mappingcollection2" coords="3 65"/> + <area id="mappingcollection3" coords="4 65"/> + <area id="mappingcollection4" coords="5 65"/> + <area id="mappingcollection5" coords="6 65"/> + <area id="mappingcollection6" coords="7 65"/> + <area id="mappingcollection7" coords="8 65"/> + <area id="mappingcollection8" coords="9 65"/> + <area id="mappingcollection9" coords="10 65"/> + <area id="mappingcollection10" coords="11 65"/> + <area id="mappingcollection11" coords="12 65"/> + <area id="mappingcollection12" coords="13 65"/> + <area id="mappingcollection13" coords="14 65"/> + <area id="mappingcollection14" coords="15 65"/> + </areaspec> + <programlisting><![CDATA[<map + name="propertyName" + table="table_name" + schema="schema_name" + lazy="true|extra|false" + inverse="true|false" + cascade="all|none|save-update|delete|all-delete-orphan|delete-orphan" + sort="unsorted|natural|comparatorClass" + order-by="column_name asc|desc" + where="arbitrary sql where condition" + fetch="join|select|subselect" + batch-size="N" + access="field|property|ClassName" + optimistic-lock="true|false" + mutable="true|false" + node="element-name|." + embed-xml="true|false" +> + + <key .... /> + <map-key .... /> + <element .... /> +</map>]]></programlisting> + <calloutlist> + <callout arearefs="mappingcollection1"> + <para> + <literal>name</literal> the collection property name + </para> + </callout> + <callout arearefs="mappingcollection2"> + <para> + <literal>table</literal> (optional - defaults to property name) the + name of the collection table (not used for one-to-many associations) + </para> + </callout> + <callout arearefs="mappingcollection3"> + <para> + <literal>schema</literal> (optional) the name of a table schema to + override the schema declared on the root element + </para> + </callout> + <callout arearefs="mappingcollection4"> + <para> + <literal>lazy</literal> (optional - defaults to <literal>true</literal>) + may be used to disable lazy fetching and specify that the association is + always eagerly fetched, or to enable "extra-lazy" fetching where most + operations do not initialize the collection (suitable for very large + collections) + </para> + </callout> + <callout arearefs="mappingcollection5"> + <para> + <literal>inverse</literal> (optional - defaults to <literal>false</literal>) + mark this collection as the "inverse" end of a bidirectional association + </para> + </callout> + <callout arearefs="mappingcollection6"> + <para> + <literal>cascade</literal> (optional - defaults to <literal>none</literal>) + enable operations to cascade to child entities + </para> + </callout> + <callout arearefs="mappingcollection7"> + <para> + <literal>sort</literal> (optional) specify a sorted collection with + <literal>natural</literal> sort order, or a given comparator class + </para> + </callout> + <callout arearefs="mappingcollection8"> + <para> + <literal>order-by</literal> (optional, JDK1.4 only) specify a table column (or columns) + that define the iteration order of the <literal>Map</literal>, <literal>Set</literal> + or bag, together with an optional <literal>asc</literal> or <literal>desc</literal> + </para> + </callout> + <callout arearefs="mappingcollection9"> + <para> + <literal>where</literal> (optional) specify an arbitrary SQL <literal>WHERE</literal> + condition to be used when retrieving or removing the collection (useful if the + collection should contain only a subset of the available data) + </para> + </callout> + <callout arearefs="mappingcollection10"> + <para> + <literal>fetch</literal> (optional, defaults to <literal>select</literal>) Choose + between outer-join fetching, fetching by sequential select, and fetching by sequential + subselect. + </para> + </callout> + <callout arearefs="mappingcollection11"> + <para> + <literal>batch-size</literal> (optional, defaults to <literal>1</literal>) specify a + "batch size" for lazily fetching instances of this collection. + </para> + </callout> + <callout arearefs="mappingcollection12"> + <para> + <literal>access</literal> (optional - defaults to <literal>property</literal>): The + strategy Hibernate should use for accessing the collection property value. + </para> + </callout> + <callout arearefs="mappingcollection13"> + <para> + <literal>optimistic-lock</literal> (optional - defaults to <literal>true</literal>): + Species that changes to the state of the collection results in increment of the + owning entity's version. (For one to many associations, it is often reasonable to + disable this setting.) + </para> + </callout> + <callout arearefs="mappingcollection14"> + <para> + <literal>mutable</literal> (optional - defaults to <literal>true</literal>): + A value of <literal>false</literal> specifies that the elements of the + collection never change (a minor performance optimization in some cases). + </para> + </callout> + </calloutlist> + </programlistingco> + + <sect2 id="collections-foreignkeys" > + <title>Collection foreign keys</title> + + <para> + Collection instances are distinguished in the database by the foreign key of + the entity that owns the collection. This foreign key is referred to as the + <emphasis>collection key column</emphasis> (or columns) of the collection + table. The collection key column is mapped by the <literal><key></literal> + element. + </para> + + <para> + There may be a nullability constraint on the foreign key column. For most + collections, this is implied. For unidirectional one to many associations, + the foreign key column is nullable by default, so you might need to specify + <literal>not-null="true"</literal>. + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" not-null="true"/>]]></programlisting> + + <para> + The foreign key constraint may use <literal>ON DELETE CASCADE</literal>. + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" on-delete="cascade"/>]]></programlisting> + + <para> + See the previous chapter for a full definition of the <literal><key></literal> + element. + </para> + + </sect2> + + <sect2 id="collections-elements" > + <title>Collection elements</title> + + <para> + Collections may contain almost any other Hibernate type, including all basic types, + custom types, components, and of course, references to other entities. This is an + important distinction: an object in a collection might be handled with "value" + semantics (its life cycle fully depends on the collection owner) or it might be a + reference to another entity, with its own life cycle. In the latter case, only the + "link" between the two objects is considered to be state held by the collection. + </para> + + <para> + The contained type is referred to as the <emphasis>collection element type</emphasis>. + Collection elements are mapped by <literal><element></literal> or + <literal><composite-element></literal>, or in the case of entity references, + with <literal><one-to-many></literal> or <literal><many-to-many></literal>. + The first two map elements with value semantics, the next two are used to map entity + associations. + </para> + + </sect2> + + <sect2 id="collections-indexed"> + <title>Indexed collections</title> + + <para> + All collection mappings, except those with set and bag semantics, need an + <emphasis>index column</emphasis> in the collection table - a column that maps to an + array index, or <literal>List</literal> index, or <literal>Map</literal> key. The + index of a <literal>Map</literal> may be of any basic type, mapped with + <literal><map-key></literal>, it may be an entity reference mapped with + <literal><map-key-many-to-many></literal>, or it may be a composite type, + mapped with <literal><composite-map-key></literal>. The index of an array or + list is always of type <literal>integer</literal> and is mapped using the + <literal><list-index></literal> element. The mapped column contains + sequential integers (numbered from zero, by default). + </para> + + <programlistingco> + <areaspec> + <area id="index1" coords="2 45"/> + <area id="index2" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<list-index + column="column_name" + base="0|1|..."/>]]></programlisting> + <calloutlist> + <callout arearefs="index1"> + <para> + <literal>column_name</literal> (required): The name of the column holding the + collection index values. + </para> + </callout> + <callout arearefs="index1"> + <para> + <literal>base</literal> (optional, defaults to <literal>0</literal>): The value + of the index column that corresponds to the first element of the list or array. + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="mapkey1" coords="2 45"/> + <area id="mapkey2" coords="3 45"/> + <area id="mapkey3" coords="4 45"/> + </areaspec> + <programlisting><![CDATA[<map-key + column="column_name" + formula="any SQL expression" + type="type_name" + node="@attribute-name" + length="N"/>]]></programlisting> + <calloutlist> + <callout arearefs="mapkey1"> + <para> + <literal>column</literal> (optional): The name of the column holding the + collection index values. + </para> + </callout> + <callout arearefs="mapkey2"> + <para> + <literal>formula</literal> (optional): A SQL formula used to evaluate the + key of the map. + </para> + </callout> + <callout arearefs="mapkey3"> + <para> + <literal>type</literal> (reguired): The type of the map keys. + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="indexmanytomany1" coords="2 45"/> + <area id="indexmanytomany2" coords="3 45"/> + <area id="indexmanytomany3" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<map-key-many-to-many + column="column_name" + formula="any SQL expression" + class="ClassName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="indexmanytomany1"> + <para> + <literal>column</literal> (optional): The name of the foreign key + column for the collection index values. + </para> + </callout> + <callout arearefs="indexmanytomany2"> + <para> + <literal>formula</literal> (optional): A SQL formula used to evaluate the + foreign key of the map key. + </para> + </callout> + <callout arearefs="indexmanytomany3"> + <para> + <literal>class</literal> (required): The entity class used as the map key. + </para> + </callout> + </calloutlist> + </programlistingco> + + + <para> + If your table doesn't have an index column, and you still wish to use <literal>List</literal> + as the property type, you should map the property as a Hibernate <emphasis><bag></emphasis>. + A bag does not retain its order when it is retrieved from the database, but it may be + optionally sorted or ordered. + </para> + + </sect2> + + <para> + There are quite a range of mappings that can be generated for collections, covering + many common relational models. We suggest you experiment with the schema generation tool + to get a feeling for how various mapping declarations translate to database tables. + </para> + + <sect2 id="collections-ofvalues" revision="2"> + <title>Collections of values and many-to-many associations</title> + + <para> + Any collection of values or many-to-many association requires a dedicated + <emphasis>collection table</emphasis> with a foreign key column or columns, + <emphasis>collection element column</emphasis> or columns and possibly + an index column or columns. + </para> + + <para> + For a collection of values, we use the <literal><element></literal> tag. + </para> + + <programlistingco> + <areaspec> + <area id="element1b" coords="2 50"/> + <area id="element2b" coords="3 50"/> + <area id="element3b" coords="4 50"/> + </areaspec> + <programlisting><![CDATA[<element + column="column_name" + formula="any SQL expression" + type="typename" + length="L" + precision="P" + scale="S" + not-null="true|false" + unique="true|false" + node="element-name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="element1b"> + <para> + <literal>column</literal> (optional): The name of the column holding the + collection element values. + </para> + </callout> + <callout arearefs="element2b"> + <para> + <literal>formula</literal> (optional): An SQL formula used to evaluate the + element. + </para> + </callout> + <callout arearefs="element3b"> + <para> + <literal>type</literal> (required): The type of the collection element. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + A <emphasis>many-to-many association</emphasis> is specified using the + <literal><many-to-many></literal> element. + </para> + + <programlistingco> + <areaspec> + <area id="manytomany1" coords="2 60"/> + <area id="manytomany2" coords="3 60"/> + <area id="manytomany3" coords="4 60"/> + <area id="manytomany4" coords="5 60"/> + <area id="manytomany5" coords="6 60"/> + <area id="manytomany6" coords="7 60"/> + <area id="manytomany7" coords="8 60"/> + <area id="manytomany8" coords="9 60"/> + </areaspec> + <programlisting><![CDATA[<many-to-many + column="column_name" + formula="any SQL expression" + class="ClassName" + fetch="select|join" + unique="true|false" + not-found="ignore|exception" + entity-name="EntityName" + property-ref="propertyNameFromAssociatedClass" + node="element-name" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="manytomany1"> + <para> + <literal>column</literal> (optional): The name of the element foreign key column. + </para> + </callout> + <callout arearefs="manytomany2"> + <para> + <literal>formula</literal> (optional): An SQL formula used to evaluate the element + foreign key value. + </para> + </callout> + <callout arearefs="manytomany3"> + <para> + <literal>class</literal> (required): The name of the associated class. + </para> + </callout> + <callout arearefs="manytomany4"> + <para> + <literal>fetch</literal> (optional - defaults to <literal>join</literal>): + enables outer-join or sequential select fetching for this association. This + is a special case; for full eager fetching (in a single <literal>SELECT</literal>) + of an entity and its many-to-many relationships to other entities, you would + enable <literal>join</literal> fetching not only of the collection itself, + but also with this attribute on the <literal><many-to-many></literal> + nested element. + </para> + </callout> + <callout arearefs="manytomany5"> + <para> + <literal>unique</literal> (optional): Enable the DDL generation of a unique + constraint for the foreign-key column. This makes the association multiplicity + effectively one to many. + </para> + </callout> + <callout arearefs="manytomany6"> + <para> + <literal>not-found</literal> (optional - defaults to <literal>exception</literal>): + Specifies how foreign keys that reference missing rows will be handled: + <literal>ignore</literal> will treat a missing row as a null association. + </para> + </callout> + <callout arearefs="manytomany7"> + <para> + <literal>entity-name</literal> (optional): The entity name of the associated class, + as an alternative to <literal>class</literal>. + </para> + </callout> + <callout arearefs="manytomany8"> + <para> + <literal>property-ref</literal>: (optional) The name of a property of the associated + class that is joined to this foreign key. If not specified, the primary key of + the associated class is used. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Some examples, first, a set of strings: + </para> + + <programlisting><![CDATA[<set name="names" table="person_names"> + <key column="person_id"/> + <element column="person_name" type="string"/> +</set>]]></programlisting> + + <para> + A bag containing integers (with an iteration order determined by the + <literal>order-by</literal> attribute): + </para> + + <programlisting><![CDATA[<bag name="sizes" + table="item_sizes" + order-by="size asc"> + <key column="item_id"/> + <element column="size" type="integer"/> +</bag>]]></programlisting> + + <para> + An array of entities - in this case, a many to many association: + </para> + + <programlisting><![CDATA[<array name="addresses" + table="PersonAddress" + cascade="persist"> + <key column="personId"/> + <list-index column="sortOrder"/> + <many-to-many column="addressId" class="Address"/> +</array>]]></programlisting> + + <para> + A map from string indices to dates: + </para> + + <programlisting><![CDATA[<map name="holidays" + table="holidays" + schema="dbo" + order-by="hol_name asc"> + <key column="id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + A list of components (discussed in the next chapter): + </para> + + <programlisting><![CDATA[<list name="carComponents" + table="CarComponents"> + <key column="carId"/> + <list-index column="sortOrder"/> + <composite-element class="CarComponent"> + <property name="price"/> + <property name="type"/> + <property name="serialNumber" column="serialNum"/> + </composite-element> +</list>]]></programlisting> + + </sect2> + + <sect2 id="collections-onetomany"> + <title>One-to-many associations</title> + + <para> + A <emphasis>one to many association</emphasis> links the tables of two classes + via a foreign key, with no intervening collection table. This mapping loses + certain semantics of normal Java collections: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + An instance of the contained entity class may not belong to more than + one instance of the collection + </para> + </listitem> + <listitem> + <para> + An instance of the contained entity class may not appear at more than + one value of the collection index + </para> + </listitem> + </itemizedlist> + + <para> + An association from <literal>Product</literal> to <literal>Part</literal> requires + existence of a foreign key column and possibly an index column to the <literal>Part</literal> + table. A <literal><one-to-many></literal> tag indicates that this is a one to many + association. + </para> + + <programlistingco> + <areaspec> + <area id="onetomany1" coords="2 60"/> + <area id="onetomany2" coords="3 60"/> + <area id="onetomany3" coords="4 60"/> + </areaspec> + <programlisting><![CDATA[<one-to-many + class="ClassName" + not-found="ignore|exception" + entity-name="EntityName" + node="element-name" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="onetomany1"> + <para> + <literal>class</literal> (required): The name of the associated class. + </para> + </callout> + <callout arearefs="onetomany2"> + <para> + <literal>not-found</literal> (optional - defaults to <literal>exception</literal>): + Specifies how cached identifiers that reference missing rows will be handled: + <literal>ignore</literal> will treat a missing row as a null association. + </para> + </callout> + <callout arearefs="onetomany3"> + <para> + <literal>entity-name</literal> (optional): The entity name of the associated class, + as an alternative to <literal>class</literal>. + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Notice that the <literal><one-to-many></literal> element does not need to + declare any columns. Nor is it necessary to specify the <literal>table</literal> + name anywhere. + </para> + + <para> + <emphasis>Very important note:</emphasis> If the foreign key column of a + <literal><one-to-many></literal> association is declared <literal>NOT NULL</literal>, + you must declare the <literal><key></literal> mapping + <literal>not-null="true"</literal> or <emphasis>use a bidirectional association</emphasis> + with the collection mapping marked <literal>inverse="true"</literal>. See the discussion + of bidirectional associations later in this chapter. + </para> + + <para> + This example shows a map of <literal>Part</literal> entities by name (where + <literal>partName</literal> is a persistent property of <literal>Part</literal>). + Notice the use of a formula-based index. + </para> + + <programlisting><![CDATA[<map name="parts" + cascade="all"> + <key column="productId" not-null="true"/> + <map-key formula="partName"/> + <one-to-many class="Part"/> +</map>]]></programlisting> + </sect2> + + </sect1> + + <sect1 id="collections-advancedmappings"> + <title>Advanced collection mappings</title> + + <sect2 id="collections-sorted" revision="2"> + <title>Sorted collections</title> + + <para> + Hibernate supports collections implementing <literal>java.util.SortedMap</literal> and + <literal>java.util.SortedSet</literal>. You must specify a comparator in the mapping file: + </para> + + <programlisting><![CDATA[<set name="aliases" + table="person_aliases" + sort="natural"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" sort="my.custom.HolidayComparator"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + Allowed values of the <literal>sort</literal> attribute are <literal>unsorted</literal>, + <literal>natural</literal> and the name of a class implementing + <literal>java.util.Comparator</literal>. + </para> + + <para> + Sorted collections actually behave like <literal>java.util.TreeSet</literal> or + <literal>java.util.TreeMap</literal>. + </para> + + <para> + If you want the database itself to order the collection elements use the + <literal>order-by</literal> attribute of <literal>set</literal>, <literal>bag</literal> + or <literal>map</literal> mappings. This solution is only available under + JDK 1.4 or higher (it is implemented using <literal>LinkedHashSet</literal> or + <literal>LinkedHashMap</literal>). This performs the ordering in the SQL query, + not in memory. + </para> + + <programlisting><![CDATA[<set name="aliases" table="person_aliases" order-by="lower(name) asc"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" order-by="hol_date, hol_name"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date type="date"/> +</map>]]></programlisting> + + <para> + Note that the value of the <literal>order-by</literal> attribute is an SQL ordering, not + a HQL ordering! + </para> + + <para> + Associations may even be sorted by some arbitrary criteria at runtime using a collection + <literal>filter()</literal>. + </para> + + <programlisting><![CDATA[sortedUsers = s.createFilter( group.getUsers(), "order by this.name" ).list();]]></programlisting> + + </sect2> + + <sect2 id="collections-bidirectional" revision="1"> + <title>Bidirectional associations</title> + + <para> + A <emphasis>bidirectional association</emphasis> allows navigation from both + "ends" of the association. Two kinds of bidirectional association are + supported: + + <variablelist> + <varlistentry> + <term>one-to-many</term> + <listitem> + <para> + set or bag valued at one end, single-valued at the other + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>many-to-many</term> + <listitem> + <para> + set or bag valued at both ends + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + + <para> + You may specify a bidirectional many-to-many association simply by mapping two + many-to-many associations to the same database table and declaring one end as + <emphasis>inverse</emphasis> (which one is your choice, but it can not be an + indexed collection). + </para> + + <para> + Here's an example of a bidirectional many-to-many association; each category can + have many items and each item can be in many categories: + </para> + + <programlisting><![CDATA[<class name="Category"> + <id name="id" column="CATEGORY_ID"/> + ... + <bag name="items" table="CATEGORY_ITEM"> + <key column="CATEGORY_ID"/> + <many-to-many class="Item" column="ITEM_ID"/> + </bag> +</class> + +<class name="Item"> + <id name="id" column="ITEM_ID"/> + ... + +  + <bag name="categories" table="CATEGORY_ITEM" inverse="true"> + <key column="ITEM_ID"/> + <many-to-many class="Category" column="CATEGORY_ID"/> + </bag> +</class>]]></programlisting> + + <para> + Changes made only to the inverse end of the association are <emphasis>not</emphasis> + persisted. This means that Hibernate has two representations in memory for every + bidirectional association, one link from A to B and another link from B to A. This + is easier to understand if you think about the Java object model and how we create + a many-to-many relationship in Java: + </para> + + <programlisting><![CDATA[ +category.getItems().add(item); // The category now "knows" about the relationship +item.getCategories().add(category); // The item now "knows" about the relationship + +session.persist(item); // The relationship won't be saved! +session.persist(category); // The relationship will be saved]]></programlisting> + + <para> + The non-inverse side is used to save the in-memory representation to the database. + </para> + + <para> + You may define a bidirectional one-to-many association by mapping a one-to-many association + to the same table column(s) as a many-to-one association and declaring the many-valued + end <literal>inverse="true"</literal>. + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + Mapping one end of an association with <literal>inverse="true"</literal> doesn't + affect the operation of cascades, these are orthogonal concepts! + </para> + + </sect2> + + <sect2 id="collections-indexedbidirectional"> + <title>Bidirectional associations with indexed collections</title> + <para> + A bidirectional association where one end is represented as a <literal><list></literal> + or <literal><map></literal> requires special consideration. If there is a property of + the child class which maps to the index column, no problem, we can continue using + <literal>inverse="true"</literal> on the collection mapping: + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children" inverse="true"> + <key column="parent_id"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <property name="name" + not-null="true"/> + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + But, if there is no such property on the child class, we can't think of the association as + truly bidirectional (there is information available at one end of the association that is + not available at the other end). In this case, we can't map the collection + <literal>inverse="true"</literal>. Instead, we could use the following mapping: + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children"> + <key column="parent_id" + not-null="true"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + insert="false" + update="false" + not-null="true"/> +</class>]]></programlisting> + + <para> + Note that in this mapping, the collection-valued end of the association is responsible for + updates to the foreign key. TODO: Does this really result in some unnecessary update statements? + </para> + + </sect2> + + <sect2 id="collections-ternary"> + <title>Ternary associations</title> + + <para> + There are three possible approaches to mapping a ternary association. One is to use a + <literal>Map</literal> with an association as its index: + </para> + + <programlisting><![CDATA[<map name="contracts"> + <key column="employer_id" not-null="true"/> + <map-key-many-to-many column="employee_id" class="Employee"/> + <one-to-many class="Contract"/> +</map>]]></programlisting> + + <programlisting><![CDATA[<map name="connections"> + <key column="incoming_node_id"/> + <map-key-many-to-many column="outgoing_node_id" class="Node"/> + <many-to-many column="connection_id" class="Connection"/> +</map>]]></programlisting> + + <para> + A second approach is to simply remodel the association as an entity class. This + is the approach we use most commonly. + </para> + + <para> + A final alternative is to use composite elements, which we will discuss later. + </para> + + </sect2> + + <sect2 id="collections-idbag" revision="1"> + <title><literal>Using an <idbag></literal></title> + + <para> + If you've fully embraced our view that composite keys are a bad thing and that + entities should have synthetic identifiers (surrogate keys), then you might + find it a bit odd that the many to many associations and collections of values + that we've shown so far all map to tables with composite keys! Now, this point + is quite arguable; a pure association table doesn't seem to benefit much from + a surrogate key (though a collection of composite values <emphasis>might</emphasis>). + Nevertheless, Hibernate provides a feature that allows you to map many to many + associations and collections of values to a table with a surrogate key. + </para> + + <para> + The <literal><idbag></literal> element lets you map a <literal>List</literal> + (or <literal>Collection</literal>) with bag semantics. + </para> + +<programlisting><![CDATA[<idbag name="lovers" table="LOVERS"> + <collection-id column="ID" type="long"> + <generator class="sequence"/> + </collection-id> + <key column="PERSON1"/> + <many-to-many column="PERSON2" class="Person" fetch="join"/> +</idbag>]]></programlisting> + + <para> + As you can see, an <literal><idbag></literal> has a synthetic id generator, + just like an entity class! A different surrogate key is assigned to each collection + row. Hibernate does not provide any mechanism to discover the surrogate key value + of a particular row, however. + </para> + + <para> + Note that the update performance of an <literal><idbag></literal> is + <emphasis>much</emphasis> better than a regular <literal><bag></literal>! + Hibernate can locate individual rows efficiently and update or delete them + individually, just like a list, map or set. + </para> + + <para> + In the current implementation, the <literal>native</literal> identifier generation + strategy is not supported for <literal><idbag></literal> collection identifiers. + </para> + + </sect2> + + </sect1> + +  + +  + + <sect1 id="collections-example" revision="1"> + <title>Collection examples</title> + + <para> + The previous sections are pretty confusing. So lets look at an example. This + class: + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; + +public class Parent { + private long id; + private Set children; + + public long getId() { return id; } + private void setId(long id) { this.id=id; } + + private Set getChildren() { return children; } + private void setChildren(Set children) { this.children=children; } + + .... + .... +}]]></programlisting> + + <para> + has a collection of <literal>Child</literal> instances. If each + child has at most one parent, the most natural mapping is a + one-to-many association: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + This maps to the following table definitions: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255), parent_id bigint ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + If the parent is <emphasis>required</emphasis>, use a bidirectional one-to-many + association: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Notice the <literal>NOT NULL</literal> constraint: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null + primary key, + name varchar(255), + parent_id bigint not null ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + Alternatively, if you absolutely insist that this association should be unidirectional, + you can declare the <literal>NOT NULL</literal> constraint on the <literal><key></literal> + mapping: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + On the other hand, if a child might have multiple parents, a many-to-many + association is appropriate: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" table="childset"> + <key column="parent_id"/> + <many-to-many class="Child" column="child_id"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Table definitions: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255) ) +create table childset ( parent_id bigint not null, + child_id bigint not null, + primary key ( parent_id, child_id ) ) +alter table childset add constraint childsetfk0 (parent_id) references parent +alter table childset add constraint childsetfk1 (child_id) references child]]></programlisting> + + <para> + For more examples and a complete walk-through a parent/child relationship mapping, + see <xref linkend="example-parentchild"/>. + </para> + + <para> + Even more exotic association mappings are possible, we will catalog all possibilities + in the next chapter. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/component_mapping.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/component_mapping.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/component_mapping.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/component_mapping.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,405 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="components"> + <title>Component Mapping</title> + + <para> + The notion of a <emphasis>component</emphasis> is re-used in several different contexts, + for different purposes, throughout Hibernate. + </para> + + <sect1 id="components-dependentobjects" revision="2" > + <title>Dependent objects</title> + + <para> + A component is a contained object that is persisted as a value type, not an entity + reference. The term "component" refers to the object-oriented notion of composition + (not to architecture-level components). For example, you might model a person like this: + </para> + + <programlisting><![CDATA[public class Person { + private java.util.Date birthday; + private Name name; + private String key; + public String getKey() { + return key; + } + private void setKey(String key) { + this.key=key; + } + public java.util.Date getBirthday() { + return birthday; + } + public void setBirthday(java.util.Date birthday) { + this.birthday = birthday; + } + public Name getName() { + return name; + } + public void setName(Name name) { + this.name = name; + } + ...... + ...... +}]]></programlisting> + +<programlisting><![CDATA[public class Name { + char initial; + String first; + String last; + public String getFirst() { + return first; + } + void setFirst(String first) { + this.first = first; + } + public String getLast() { + return last; + } + void setLast(String last) { + this.last = last; + } + public char getInitial() { + return initial; + } + void setInitial(char initial) { + this.initial = initial; + } +}]]></programlisting> + + <para> + Now <literal>Name</literal> may be persisted as a component of + <literal>Person</literal>. Notice that <literal>Name</literal> defines getter + and setter methods for its persistent properties, but doesn't need to declare + any interfaces or identifier properties. + </para> + + <para> + Our Hibernate mapping would look like: + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name">  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + <para> + The person table would have the columns <literal>pid</literal>, + <literal>birthday</literal>, + <literal>initial</literal>, + <literal>first</literal> and + <literal>last</literal>. + </para> + + <para> + Like all value types, components do not support shared references. In other words, two + persons could have the same name, but the two person objects would contain two independent + name ojects, only "the same" by value. The null value semantics of a component are + <emphasis>ad hoc</emphasis>. When reloading the containing object, Hibernate will assume + that if all component columns are null, then the entire component is null. This should + be okay for most purposes. + </para> + + <para> + The properties of a component may be of any Hibernate type (collections, many-to-one + associations, other components, etc). Nested components should <emphasis>not</emphasis> + be considered an exotic usage. Hibernate is intended to support a very fine-grained + object model. + </para> + + <para> + The <literal><component></literal> element allows a <literal><parent></literal> + subelement that maps a property of the component class as a reference back to the + containing entity. + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name" unique="true"> + <parent name="namedPerson"/>  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-incollections" revision="1"> + <title>Collections of dependent objects</title> + + <para> + Collections of components are supported (eg. an array of type + <literal>Name</literal>). Declare your component collection by + replacing the <literal><element></literal> tag with a + <literal><composite-element></literal> tag. + </para> + + <programlisting><![CDATA[<set name="someNames" table="some_names" lazy="true"> + <key column="id"/> + <composite-element class="eg.Name">  + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </composite-element> +</set>]]></programlisting> + + <para> + Note: if you define a <literal>Set</literal> of composite elements, it is + very important to implement <literal>equals()</literal> and + <literal>hashCode()</literal> correctly. + </para> + + <para> + Composite elements may contain components but not collections. If your + composite element itself contains + components, use the <literal><nested-composite-element></literal> + tag. This is a pretty exotic case - a collection of components which + themselves have components. By this stage you should be asking yourself + if a one-to-many association is more appropriate. Try remodelling the + composite element as an entity - but note that even though the Java model + is the same, the relational model and persistence semantics are still + slightly different. + </para> + + <para> + Please note that a composite element mapping doesn't support null-able properties + if you're using a <literal><set></literal>. Hibernate + has to use each columns value to identify a record when deleting objects + (there is no separate primary key column in the composite element table), + which is not possible with null values. You have to either use only + not-null properties in a composite-element or choose a + <literal><list></literal>, <literal><map></literal>, + <literal><bag></literal> or <literal><idbag></literal>. + </para> + + <para> + A special case of a composite element is a composite element with a nested + <literal><many-to-one></literal> element. A mapping like this allows + you to map extra columns of a many-to-many association table to the + composite element class. The following is a many-to-many association + from <literal>Order</literal> to <literal>Item</literal> where + <literal>purchaseDate</literal>, <literal>price</literal> and + <literal>quantity</literal> are properties of the association: + </para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.Purchase"> + <property name="purchaseDate"/> + <property name="price"/> + <property name="quantity"/> + <many-to-one name="item" class="eg.Item"/>  + </composite-element> + </set> +</class>]]></programlisting> + + <para> + Of course, there can't be a reference to the purchae on the other side, for + bidirectional association navigation. Remember that components are value types and + don't allow shared references. A single <literal>Purchase</literal> can be in the + set of an <literal>Order</literal>, but it can't be referenced by the <literal>Item</literal> + at the same time. + </para> + + <para>Even ternary (or quaternary, etc) associations are possible:</para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.OrderLine"> + <many-to-one name="purchaseDetails class="eg.Purchase"/> + <many-to-one name="item" class="eg.Item"/> + </composite-element> + </set> +</class>]]></programlisting> + + <para> + Composite elements may appear in queries using the same syntax as + associations to other entities. + </para> + + </sect1> + + <sect1 id="components-asmapindex"> + <title>Components as Map indices</title> + + <para> + The <literal><composite-map-key></literal> element lets you map a + component class as the key of a <literal>Map</literal>. Make sure you override + <literal>hashCode()</literal> and <literal>equals()</literal> correctly on + the component class. + </para> + </sect1> + + <sect1 id="components-compositeid" revision="1"> + <title>Components as composite identifiers</title> + + <para> + You may use a component as an identifier of an entity class. Your component + class must satisfy certain requirements: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + It must implement <literal>java.io.Serializable</literal>. + </para> + </listitem> + <listitem> + <para> + It must re-implement <literal>equals()</literal> and + <literal>hashCode()</literal>, consistently with the database's + notion of composite key equality. + </para> + </listitem> + </itemizedlist> + + <para> + <emphasis>Note: in Hibernate3, the second requirement is not an absolutely hard + requirement of Hibernate. But do it anyway.</emphasis> + </para> + + <para> + You can't use an <literal>IdentifierGenerator</literal> to generate composite keys. + Instead the application must assign its own identifiers. + </para> + + <para> + Use the <literal><composite-id></literal> tag (with nested + <literal><key-property></literal> elements) in place of the usual + <literal><id></literal> declaration. For example, the + <literal>OrderLine</literal> class has a primary key that depends upon + the (composite) primary key of <literal>Order</literal>. + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + + <composite-id name="id" class="OrderLineId"> + <key-property name="lineId"/> + <key-property name="orderId"/> + <key-property name="customerId"/> + </composite-id> + + <property name="name"/> + + <many-to-one name="order" class="Order" + insert="false" update="false"> + <column name="orderId"/> + <column name="customerId"/> + </many-to-one> + .... + +</class>]]></programlisting> + + <para> + Now, any foreign keys referencing the <literal>OrderLine</literal> table are also + composite. You must declare this in your mappings for other classes. An association + to <literal>OrderLine</literal> would be mapped like this: + </para> + + <programlisting><![CDATA[<many-to-one name="orderLine" class="OrderLine"> + + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> +</many-to-one>]]></programlisting> + + <para> + (Note that the <literal><column></literal> tag is an alternative to the + <literal>column</literal> attribute everywhere.) + </para> + + <para> + A <literal>many-to-many</literal> association to <literal>OrderLine</literal> also + uses the composite foreign key: + </para> + + <programlisting><![CDATA[<set name="undeliveredOrderLines"> + <key column name="warehouseId"/> + <many-to-many class="OrderLine"> + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </many-to-many> +</set>]]></programlisting> + + <para> + The collection of <literal>OrderLine</literal>s in <literal>Order</literal> would + use: + </para> + + <programlisting><![CDATA[<set name="orderLines" inverse="true"> + <key> + <column name="orderId"/> + <column name="customerId"/> + </key> + <one-to-many class="OrderLine"/> +</set>]]></programlisting> + + <para> + (The <literal><one-to-many></literal> element, as usual, declares no columns.) + </para> + + <para> + If <literal>OrderLine</literal> itself owns a collection, it also has a composite + foreign key. + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + .... + .... + <list name="deliveryAttempts"> + <key>  + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </key> + <list-index column="attemptId" base="1"/> + <composite-element class="DeliveryAttempt"> + ... + </composite-element> + </set> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-dynamic" revision="1"> + <title>Dynamic components</title> + + <para> + You may even map a property of type <literal>Map</literal>: + </para> + + <programlisting><![CDATA[<dynamic-component name="userAttributes"> + <property name="foo" column="FOO" type="string"/> + <property name="bar" column="BAR" type="integer"/> + <many-to-one name="baz" class="Baz" column="BAZ_ID"/> +</dynamic-component>]]></programlisting> + + <para> + The semantics of a <literal><dynamic-component></literal> mapping are identical + to <literal><component></literal>. The advantage of this kind of mapping is + the ability to determine the actual properties of the bean at deployment time, just + by editing the mapping document. Runtime manipulation of the mapping document is + also possible, using a DOM parser. Even better, you can access (and change) Hibernate's + configuration-time metamodel via the <literal>Configuration</literal> object. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/configuration.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/configuration.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/configuration.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/configuration.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1746 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY mdash "-"> +]> + +<chapter id="session-configuration" revision="1"> + <title>Configuration</title> + + <para> + Because Hibernate is designed to operate in many different environments, there + are a large number of configuration parameters. Fortunately, most have sensible + default values and Hibernate is distributed with an example + <literal>hibernate.properties</literal> file in <literal>etc/</literal> that shows + the various options. Just put the example file in your classpath and customize it. + </para> + + <sect1 id="configuration-programmatic" revision="1"> + <title>Programmatic configuration</title> + + <para> + An instance of <literal>org.hibernate.cfg.Configuration</literal> + represents an entire set of mappings of an application's Java types to an + SQL database. The <literal>Configuration</literal> is used to build an + (immutable) <literal>SessionFactory</literal>. The mappings are compiled + from various XML mapping files. + </para> + + <para> + You may obtain a <literal>Configuration</literal> instance by instantiating + it directly and specifying XML mapping documents. If the mapping files are + in the classpath, use <literal>addResource()</literal>: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addResource("Item.hbm.xml") + .addResource("Bid.hbm.xml");]]></programlisting> + + <para> + An alternative (sometimes better) way is to specify the mapped class, and + let Hibernate find the mapping document for you: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class);]]></programlisting> + + <para> + Then Hibernate will look for mapping files named + <literal>/org/hibernate/auction/Item.hbm.xml</literal> and + <literal>/org/hibernate/auction/Bid.hbm.xml</literal> in the classpath. + This approach eliminates any hardcoded filenames. + </para> + + <para> + A <literal>Configuration</literal> also allows you to specify configuration + properties: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class) + .setProperty("hibernate.dialect", "org.hibernate.dialect.MySQLInnoDBDialect") + .setProperty("hibernate.connection.datasource", "java:comp/env/jdbc/test") + .setProperty("hibernate.order_updates", "true");]]></programlisting> + + <para> + This is not the only way to pass configuration properties to Hibernate. + The various options include: + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + Pass an instance of <literal>java.util.Properties</literal> to + <literal>Configuration.setProperties()</literal>. + </para> + </listitem> + <listitem> + <para> + Place <literal>hibernate.properties</literal> in a root directory + of the classpath. + </para> + </listitem> + <listitem> + <para> + Set <literal>System</literal> properties using + <literal>java -Dproperty=value</literal>. + </para> + </listitem> + <listitem> + <para> + Include <literal><property></literal> elements in + <literal>hibernate.cfg.xml</literal> (discussed later). + </para> + </listitem> + </orderedlist> + + <para> + <literal>hibernate.properties</literal> is the easiest approach if you + want to get started quickly. + </para> + + <para> + The <literal>Configuration</literal> is intended as a startup-time object, + to be discarded once a <literal>SessionFactory</literal> is created. + </para> + + </sect1> + + <sect1 id="configuration-sessionfactory"> + <title>Obtaining a SessionFactory</title> + + <para> + When all mappings have been parsed by the <literal>Configuration</literal>, + the application must obtain a factory for <literal>Session</literal> instances. + This factory is intended to be shared by all application threads: + </para> + + <programlisting><![CDATA[SessionFactory sessions = cfg.buildSessionFactory();]]></programlisting> + + <para> + Hibernate does allow your application to instantiate more than one + <literal>SessionFactory</literal>. This is useful if you are using more than + one database. + </para> + + </sect1> + + <sect1 id="configuration-hibernatejdbc" revision="1"> + <title>JDBC connections</title> + + <para> + Usually, you want to have the <literal>SessionFactory</literal> create and pool JDBC + connections for you. If you take this approach, opening a <literal>Session</literal> + is as simple as: + </para> + + <programlisting><![CDATA[Session session = sessions.openSession(); // open a new Session]]></programlisting> + + <para> + As soon as you do something that requires access to the database, a JDBC connection + will be obtained from the pool. + </para> + + <para> + For this to work, we need to pass some JDBC connection properties to Hibernate. + All Hibernate property names and semantics are defined on the class + <literal>org.hibernate.cfg.Environment</literal>. We will now describe the most + important settings for JDBC connection configuration. + </para> + + <para> + Hibernate will obtain (and pool) connections using <literal>java.sql.DriverManager</literal> + if you set the following properties: + </para> + + <table frame="topbot"> + <title>Hibernate JDBC Properties</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.driver_class</literal> + </entry> + <entry> + <emphasis>JDBC driver class</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.url</literal> + </entry> + <entry> + <emphasis>JDBC URL</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>database user</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>database user password</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.pool_size</literal> + </entry> + <entry> + <emphasis>maximum number of pooled connections</emphasis> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Hibernate's own connection pooling algorithm is however quite rudimentary. + It is intended to help you get started and is <emphasis>not intended for use + in a production system</emphasis> or even for performance testing. You should + use a third party pool for best performance and stability. Just replace the + <literal>hibernate.connection.pool_size</literal> property with connection + pool specific settings. This will turn off Hibernate's internal pool. For + example, you might like to use C3P0. + </para> + + <para> + C3P0 is an open source JDBC connection pool distributed along with + Hibernate in the <literal>lib</literal> directory. Hibernate will use its + <literal>C3P0ConnectionProvider</literal> for connection pooling if you set + <literal>hibernate.c3p0.*</literal> properties. If you'd like to use Proxool + refer to the packaged <literal>hibernate.properties</literal> and the Hibernate + web site for more information. + </para> + + <para> + Here is an example <literal>hibernate.properties</literal> file for C3P0: + </para> + + <programlisting id="c3p0-configuration" revision="1"><![CDATA[hibernate.connection.driver_class = org.postgresql.Driver +hibernate.connection.url = jdbc:postgresql://localhost/mydatabase +hibernate.connection.username = myuser +hibernate.connection.password = secret +hibernate.c3p0.min_size=5 +hibernate.c3p0.max_size=20 +hibernate.c3p0.timeout=1800 +hibernate.c3p0.max_statements=50 +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + For use inside an application server, you should almost always configure + Hibernate to obtain connections from an application server + <literal>Datasource</literal> registered in JNDI. You'll need to set at + least one of the following properties: + </para> + + <table frame="topbot"> + <title>Hibernate Datasource Properties</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.datasource</literal> + </entry> + <entry> + <emphasis>datasource JNDI name</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.url</literal> + </entry> + <entry> + <emphasis>URL of the JNDI provider</emphasis> (optional) + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.class</literal> + </entry> + <entry> + <emphasis>class of the JNDI <literal>InitialContextFactory</literal></emphasis> (optional) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>database user</emphasis> (optional) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>database user password</emphasis> (optional) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Here's an example <literal>hibernate.properties</literal> file for an + application server provided JNDI datasource: + </para> + + <programlisting><![CDATA[hibernate.connection.datasource = java:/comp/env/jdbc/test +hibernate.transaction.factory_class = \ + org.hibernate.transaction.JTATransactionFactory +hibernate.transaction.manager_lookup_class = \ + org.hibernate.transaction.JBossTransactionManagerLookup +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + JDBC connections obtained from a JNDI datasource will automatically participate + in the container-managed transactions of the application server. + </para> + + <para> + Arbitrary connection properties may be given by prepending + "<literal>hibernate.connection</literal>" to the property name. For example, you + may specify a <literal>charSet</literal> using <literal>hibernate.connection.charSet</literal>. + </para> + + <para> + You may define your own plugin strategy for obtaining JDBC connections by implementing the + interface <literal>org.hibernate.connection.ConnectionProvider</literal>. You may select + a custom implementation by setting <literal>hibernate.connection.provider_class</literal>. + </para> + + </sect1> + + <sect1 id="configuration-optional" revision="1"> + <title>Optional configuration properties</title> + + <para> + There are a number of other properties that control the behaviour of Hibernate + at runtime. All are optional and have reasonable default values. + </para> + + <para> + <emphasis>Warning: some of these properties are "system-level" only.</emphasis> + System-level properties can be set only via <literal>java -Dproperty=value</literal> or + <literal>hibernate.properties</literal>. They may <emphasis>not</emphasis> be set by + the other techniques described above. + </para> + + <table frame="topbot" id="configuration-optional-properties" revision="8"> + <title>Hibernate Configuration Properties</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.dialect</literal> + </entry> + <entry> + The classname of a Hibernate <literal>Dialect</literal> which + allows Hibernate to generate SQL optimized for a particular + relational database. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>full.classname.of.Dialect</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.show_sql</literal> + </entry> + <entry> + Write all SQL statements to console. This is an alternative + to setting the log category <literal>org.hibernate.SQL</literal> + to <literal>debug</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.format_sql</literal> + </entry> + <entry> + Pretty print the SQL in the log and console. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_schema</literal> + </entry> + <entry> + Qualify unqualified table names with the given schema/tablespace + in generated SQL. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>SCHEMA_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_catalog</literal> + </entry> + <entry> + Qualify unqualified table names with the given catalog + in generated SQL. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>CATALOG_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.session_factory_name</literal> + </entry> + <entry> + The <literal>SessionFactory</literal> will be automatically + bound to this name in JNDI after it has been created. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>jndi/composite/name</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.max_fetch_depth</literal> + </entry> + <entry> + Set a maximum "depth" for the outer join fetch tree + for single-ended associations (one-to-one, many-to-one). + A <literal>0</literal> disables default outer join fetching. + <para> + <emphasis role="strong">eg.</emphasis> + recommended values between <literal>0</literal> and + <literal>3</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_batch_fetch_size</literal> + </entry> + <entry> + Set a default size for Hibernate batch fetching of associations. + <para> + <emphasis role="strong">eg.</emphasis> + recommended values <literal>4</literal>, <literal>8</literal>, + <literal>16</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_entity_mode</literal> + </entry> + <entry> + Set a default mode for entity representation for all sessions + opened from this <literal>SessionFactory</literal> + <para> + <literal>dynamic-map</literal>, <literal>dom4j</literal>, + <literal>pojo</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.order_updates</literal> + </entry> + <entry> + Force Hibernate to order SQL updates by the primary key value + of the items being updated. This will result in fewer transaction + deadlocks in highly concurrent systems. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.generate_statistics</literal> + </entry> + <entry> + If enabled, Hibernate will collect statistics useful for + performance tuning. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_identifier_rollback</literal> + </entry> + <entry> + If enabled, generated identifier properties will be + reset to default values when objects are deleted. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_sql_comments</literal> + </entry> + <entry> + If turned on, Hibernate will generate comments inside the SQL, for + easier debugging, defaults to <literal>false</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-jdbc-properties" revision="8"> + <title>Hibernate JDBC and Connection Properties</title> + <tgroup cols="2"> + + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.jdbc.fetch_size</literal> + </entry> + <entry> + A non-zero value determines the JDBC fetch size (calls + <literal>Statement.setFetchSize()</literal>). + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_size</literal> + </entry> + <entry> + A non-zero value enables use of JDBC2 batch updates by Hibernate. + <para> + <emphasis role="strong">eg.</emphasis> + recommended values between <literal>5</literal> and <literal>30</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_versioned_data</literal> + </entry> + <entry> + Set this property to <literal>true</literal> if your JDBC driver returns + correct row counts from <literal>executeBatch()</literal> (it is usually + safe to turn this option on). Hibernate will then use batched DML for + automatically versioned data. Defaults to <literal>false</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.factory_class</literal> + </entry> + <entry> + Select a custom <literal>Batcher</literal>. Most applications + will not need this configuration property. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.BatcherFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_scrollable_resultset</literal> + </entry> + <entry> + Enables use of JDBC2 scrollable resultsets by Hibernate. + This property is only necessary when using user supplied + JDBC connections, Hibernate uses connection metadata otherwise. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_streams_for_binary</literal> + </entry> + <entry> + Use streams when writing/reading <literal>binary</literal> + or <literal>serializable</literal> types to/from JDBC + (system-level property). + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_get_generated_keys</literal> + </entry> + <entry> + Enable use of JDBC3 <literal>PreparedStatement.getGeneratedKeys()</literal> + to retrieve natively generated keys after insert. Requires JDBC3+ driver + and JRE1.4+, set to false if your driver has problems with the Hibernate + identifier generators. By default, tries to determine the driver capabilities + using connection metadata. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.provider_class</literal> + </entry> + <entry> + The classname of a custom <literal>ConnectionProvider</literal> which provides + JDBC connections to Hibernate. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.ConnectionProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.isolation</literal> + </entry> + <entry> + Set the JDBC transaction isolation level. Check + <literal>java.sql.Connection</literal> for meaningful values but + note that most databases do not support all isolation levels. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>1, 2, 4, 8</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.autocommit</literal> + </entry> + <entry> + Enables autocommit for JDBC pooled connections (not recommended). + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.release_mode</literal> + </entry> + <entry> + Specify when Hibernate should release JDBC connections. By default, + a JDBC connection is held until the session is explicitly closed or + disconnected. For an application server JTA datasource, you should use + <literal>after_statement</literal> to aggressively release connections + after every JDBC call. For a non-JTA connection, it often makes sense to + release the connection at the end of each transaction, by using + <literal>after_transaction</literal>. <literal>auto</literal> will + choose <literal>after_statement</literal> for the JTA and CMT transaction + strategies and <literal>after_transaction</literal> for the JDBC + transaction strategy. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>auto</literal> (default) | <literal>on_close</literal> | + <literal>after_transaction</literal> | <literal>after_statement</literal> + </para> + <para> + Note that this setting only affects <literal>Session</literal>s returned from + <literal>SessionFactory.openSession</literal>. For <literal>Session</literal>s + obtained through <literal>SessionFactory.getCurrentSession</literal>, the + <literal>CurrentSessionContext</literal> implementation configured for use + controls the connection release mode for those <literal>Session</literal>s. + See <xref linkend="architecture-current-session"/> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.<emphasis><propertyName></emphasis></literal> + </entry> + <entry> + Pass the JDBC property <literal>propertyName</literal> + to <literal>DriverManager.getConnection()</literal>. + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.<emphasis><propertyName></emphasis></literal> + </entry> + <entry> + Pass the property <literal>propertyName</literal> to + the JNDI <literal>InitialContextFactory</literal>. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-cache-properties" revision="7"> + <title>Hibernate Cache Properties</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.cache.provider_class</literal> + </entry> + <entry> + The classname of a custom <literal>CacheProvider</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.CacheProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_minimal_puts</literal> + </entry> + <entry> + Optimize second-level cache operation to minimize writes, at the + cost of more frequent reads. This setting is most useful for + clustered caches and, in Hibernate3, is enabled by default for + clustered cache implementations. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_query_cache</literal> + </entry> + <entry> + Enable the query cache, individual queries still have to be set cachable. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_second_level_cache</literal> + </entry> + <entry> + May be used to completely disable the second level cache, which is enabled + by default for classes which specify a <literal><cache></literal> + mapping. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.query_cache_factory</literal> + </entry> + <entry> + The classname of a custom <literal>QueryCache</literal> interface, + defaults to the built-in <literal>StandardQueryCache</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.QueryCache</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.region_prefix</literal> + </entry> + <entry> + A prefix to use for second-level cache region names. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>prefix</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_structured_entries</literal> + </entry> + <entry> + Forces Hibernate to store data in the second-level cache + in a more human-friendly format. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-transaction-properties" revision="9"> + <title>Hibernate Transaction Properties</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.transaction.factory_class</literal> + </entry> + <entry> + The classname of a <literal>TransactionFactory</literal> + to use with Hibernate <literal>Transaction</literal> API + (defaults to <literal>JDBCTransactionFactory</literal>). + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.TransactionFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>jta.UserTransaction</literal> + </entry> + <entry> + A JNDI name used by <literal>JTATransactionFactory</literal> to + obtain the JTA <literal>UserTransaction</literal> from the + application server. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>jndi/composite/name</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.manager_lookup_class</literal> + </entry> + <entry> + The classname of a <literal>TransactionManagerLookup</literal> + - required when JVM-level caching is enabled or when using hilo + generator in a JTA environment. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.TransactionManagerLookup</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.flush_before_completion</literal> + </entry> + <entry> + If enabled, the session will be automatically flushed during the + before completion phase of the transaction. Built-in and + automatic session context management is preferred, see + <xref linkend="architecture-current-session"/>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.auto_close_session</literal> + </entry> + <entry> + If enabled, the session will be automatically closed during the + after completion phase of the transaction. Built-in and + utomatic session context management is preferred, see + <xref linkend="architecture-current-session"/>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-misc-properties" revision="10"> + <title>Miscellaneous Properties</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry>Property name</entry> + <entry>Purpose</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.current_session_context_class</literal> + </entry> + <entry> + Supply a (custom) strategy for the scoping of the "current" + <literal>Session</literal>. See + <xref linkend="architecture-current-session"/> for more + information about the built-in strategies. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>jta</literal> | <literal>thread</literal> | + <literal>managed</literal> | <literal>custom.Class</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.factory_class</literal> + </entry> + <entry> + Chooses the HQL parser implementation. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>org.hibernate.hql.ast.ASTQueryTranslatorFactory</literal> or + <literal>org.hibernate.hql.classic.ClassicQueryTranslatorFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.substitutions</literal> + </entry> + <entry> + Mapping from tokens in Hibernate queries to SQL tokens + (tokens might be function or literal names, for example). + <para> + <emphasis role="strong">eg.</emphasis> + <literal>hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.hbm2ddl.auto</literal> + </entry> + <entry> + Automatically validate or export schema DDL to the database + when the <literal>SessionFactory</literal> is created. With + <literal>create-drop</literal>, the database schema will be + dropped when the <literal>SessionFactory</literal> is closed + explicitly. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>validate</literal> | <literal>update</literal> | + <literal>create</literal> | <literal>create-drop</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cglib.use_reflection_optimizer</literal> + </entry> + <entry> + Enables use of CGLIB instead of runtime reflection (System-level + property). Reflection can sometimes be useful when troubleshooting, + note that Hibernate always requires CGLIB even if you turn off the + optimizer. You can not set this property in <literal>hibernate.cfg.xml</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="configuration-optional-dialects" revision="1"> + <title>SQL Dialects</title> + + <para> + You should always set the <literal>hibernate.dialect</literal> property to the correct + <literal>org.hibernate.dialect.Dialect</literal> subclass for your database. If you + specify a dialect, Hibernate will use sensible defaults for some of the + other properties listed above, saving you the effort of specifying them manually. + </para> + + <table frame="topbot" id="sql-dialects" revision="2"> + <title>Hibernate SQL Dialects (<literal>hibernate.dialect</literal>)</title> + <tgroup cols="2"> + + <thead> + <row> + <entry>RDBMS</entry> + <entry>Dialect</entry> + </row> + </thead> + <tbody> + <row> + <entry>DB2</entry> <entry><literal>org.hibernate.dialect.DB2Dialect</literal></entry> + </row> + <row> + <entry>DB2 AS/400</entry> <entry><literal>org.hibernate.dialect.DB2400Dialect</literal></entry> + </row> + <row> + <entry>DB2 OS390</entry> <entry><literal>org.hibernate.dialect.DB2390Dialect</literal></entry> + </row> + <row> + <entry>PostgreSQL</entry> <entry><literal>org.hibernate.dialect.PostgreSQLDialect</literal></entry> + </row> + <row> + <entry>MySQL</entry> <entry><literal>org.hibernate.dialect.MySQLDialect</literal></entry> + </row> + <row> + <entry>MySQL with InnoDB</entry> <entry><literal>org.hibernate.dialect.MySQLInnoDBDialect</literal></entry> + </row> + <row> + <entry>MySQL with MyISAM</entry> <entry><literal>org.hibernate.dialect.MySQLMyISAMDialect</literal></entry> + </row> + <row> + <entry>Oracle (any version)</entry> <entry><literal>org.hibernate.dialect.OracleDialect</literal></entry> + </row> + <row> + <entry>Oracle 9i/10g</entry> <entry><literal>org.hibernate.dialect.Oracle9Dialect</literal></entry> + </row> + <row> + <entry>Sybase</entry> <entry><literal>org.hibernate.dialect.SybaseDialect</literal></entry> + </row> + <row> + <entry>Sybase Anywhere</entry> <entry><literal>org.hibernate.dialect.SybaseAnywhereDialect</literal></entry> + </row> + <row> + <entry>Microsoft SQL Server</entry> <entry><literal>org.hibernate.dialect.SQLServerDialect</literal></entry> + </row> + <row> + <entry>SAP DB</entry> <entry><literal>org.hibernate.dialect.SAPDBDialect</literal></entry> + </row> + <row> + <entry>Informix</entry> <entry><literal>org.hibernate.dialect.InformixDialect</literal></entry> + </row> + <row> + <entry>HypersonicSQL</entry> <entry><literal>org.hibernate.dialect.HSQLDialect</literal></entry> + </row> + <row> + <entry>Ingres</entry> <entry><literal>org.hibernate.dialect.IngresDialect</literal></entry> + </row> + <row> + <entry>Progress</entry> <entry><literal>org.hibernate.dialect.ProgressDialect</literal></entry> + </row> + <row> + <entry>Mckoi SQL</entry> <entry><literal>org.hibernate.dialect.MckoiDialect</literal></entry> + </row> + <row> + <entry>Interbase</entry> <entry><literal>org.hibernate.dialect.InterbaseDialect</literal></entry> + </row> + <row> + <entry>Pointbase</entry> <entry><literal>org.hibernate.dialect.PointbaseDialect</literal></entry> + </row> + <row> + <entry>FrontBase</entry> <entry><literal>org.hibernate.dialect.FrontbaseDialect</literal></entry> + </row> + <row> + <entry>Firebird</entry> <entry><literal>org.hibernate.dialect.FirebirdDialect</literal></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-outerjoin" revision="4"> + <title>Outer Join Fetching</title> + + <para> + If your database supports ANSI, Oracle or Sybase style outer joins, <emphasis>outer join + fetching</emphasis> will often increase performance by limiting the number of round + trips to and from the database (at the cost of possibly more work performed by + the database itself). Outer join fetching allows a whole graph of objects connected + by many-to-one, one-to-many, many-to-many and one-to-one associations to be retrieved + in a single SQL <literal>SELECT</literal>. + </para> + + <para> + Outer join fetching may be disabled <emphasis>globally</emphasis> by setting + the property <literal>hibernate.max_fetch_depth</literal> to <literal>0</literal>. + A setting of <literal>1</literal> or higher enables outer join fetching for + one-to-one and many-to-one associations which have been mapped with + <literal>fetch="join"</literal>. + </para> + + <para> + See <xref linkend="performance-fetching"/> for more information. + </para> + + </sect2> + + <sect2 id="configuration-optional-binarystreams" revision="1"> + <title>Binary Streams</title> + + <para> + Oracle limits the size of <literal>byte</literal> arrays that may + be passed to/from its JDBC driver. If you wish to use large instances of + <literal>binary</literal> or <literal>serializable</literal> type, you should + enable <literal>hibernate.jdbc.use_streams_for_binary</literal>. + <emphasis>This is a system-level setting only.</emphasis> + </para> + + </sect2> + + <sect2 id="configuration-optional-cacheprovider" revision="2"> + <title>Second-level and query cache</title> + + <para> + The properties prefixed by <literal>hibernate.cache</literal> + allow you to use a process or cluster scoped second-level cache system + with Hibernate. See the <xref linkend="performance-cache"/> for + more details. + </para> + + </sect2> + + <sect2 id="configuration-optional-querysubstitution"> + <title>Query Language Substitution</title> + + <para> + You may define new Hibernate query tokens using <literal>hibernate.query.substitutions</literal>. + For example: + </para> + + <programlisting>hibernate.query.substitutions true=1, false=0</programlisting> + + <para> + would cause the tokens <literal>true</literal> and <literal>false</literal> to be translated to + integer literals in the generated SQL. + </para> + + <programlisting>hibernate.query.substitutions toLowercase=LOWER</programlisting> + + <para> + would allow you to rename the SQL <literal>LOWER</literal> function. + </para> + + </sect2> + + <sect2 id="configuration-optional-statistics" revision="2"> + <title>Hibernate statistics</title> + + <para> + If you enable <literal>hibernate.generate_statistics</literal>, Hibernate will + expose a number of metrics that are useful when tuning a running system via + <literal>SessionFactory.getStatistics()</literal>. Hibernate can even be configured + to expose these statistics via JMX. Read the Javadoc of the interfaces in + <literal>org.hibernate.stats</literal> for more information. + </para> + + </sect2> + </sect1> + + <sect1 id="configuration-logging"> + <title>Logging</title> + + <para> + Hibernate logs various events using Apache commons-logging. + </para> + + <para> + The commons-logging service will direct output to either Apache Log4j + (if you include <literal>log4j.jar</literal> in your classpath) or + JDK1.4 logging (if running under JDK1.4 or above). You may download + Log4j from <literal>http://jakarta.apache.org</literal>. + To use Log4j you will need to place a <literal>log4j.properties</literal> + file in your classpath, an example properties file is distributed with + Hibernate in the <literal>src/</literal> directory. + </para> + + <para> + We strongly recommend that you familiarize yourself with Hibernate's log + messages. A lot of work has been put into making the Hibernate log as + detailed as possible, without making it unreadable. It is an essential + troubleshooting device. The most interesting log categories are the + following: + </para> + + <table frame="topbot" id="log-categories" revision="2"> + <title>Hibernate Log Categories</title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>Category</entry> + <entry>Function</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.SQL</literal></entry> + <entry>Log all SQL DML statements as they are executed</entry> + </row> + <row> + <entry><literal>org.hibernate.type</literal></entry> + <entry>Log all JDBC parameters</entry> + </row> + <row> + <entry><literal>org.hibernate.tool.hbm2ddl</literal></entry> + <entry>Log all SQL DDL statements as they are executed</entry> + </row> + <row> + <entry><literal>org.hibernate.pretty</literal></entry> + <entry> + Log the state of all entities (max 20 entities) associated + with the session at flush time + </entry> + </row> + <row> + <entry><literal>org.hibernate.cache</literal></entry> + <entry>Log all second-level cache activity</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction</literal></entry> + <entry>Log transaction related activity</entry> + </row> + <row> + <entry><literal>org.hibernate.jdbc</literal></entry> + <entry>Log all JDBC resource acquisition</entry> + </row> + <row> + <entry><literal>org.hibernate.hql.ast.AST</literal></entry> + <entry> + Log HQL and SQL ASTs during query parsing + </entry> + </row> + <row> + <entry><literal>org.hibernate.secure</literal></entry> + <entry>Log all JAAS authorization requests</entry> + </row> + <row> + <entry><literal>org.hibernate</literal></entry> + <entry> + Log everything (a lot of information, but very useful for + troubleshooting) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + When developing applications with Hibernate, you should almost always work with + <literal>debug</literal> enabled for the category <literal>org.hibernate.SQL</literal>, + or, alternatively, the property <literal>hibernate.show_sql</literal> enabled. + </para> + + + </sect1> + + <sect1 id="configuration-namingstrategy"> + <title>Implementing a <literal>NamingStrategy</literal></title> + + <para> + The interface <literal>org.hibernate.cfg.NamingStrategy</literal> allows you + to specify a "naming standard" for database objects and schema elements. + </para> + + <para> + You may provide rules for automatically generating database identifiers from + Java identifiers or for processing "logical" column and table names given in + the mapping file into "physical" table and column names. This feature helps + reduce the verbosity of the mapping document, eliminating repetitive noise + (<literal>TBL_</literal> prefixes, for example). The default strategy used by + Hibernate is quite minimal. + </para> + + <para> + You may specify a different strategy by calling + <literal>Configuration.setNamingStrategy()</literal> before adding mappings: + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .setNamingStrategy(ImprovedNamingStrategy.INSTANCE) + .addFile("Item.hbm.xml") + .addFile("Bid.hbm.xml") + .buildSessionFactory();]]></programlisting> + + <para> + <literal>org.hibernate.cfg.ImprovedNamingStrategy</literal> is a built-in + strategy that might be a useful starting point for some applications. + </para> + + </sect1> + + <sect1 id="configuration-xmlconfig" revision="2"> + <title>XML configuration file</title> + + <para> + An alternative approach to configuration is to specify a full configuration in + a file named <literal>hibernate.cfg.xml</literal>. This file can be used as a + replacement for the <literal>hibernate.properties</literal> file or, if both + are present, to override properties. + </para> + + <para> + The XML configuration file is by default expected to be in the root o + your <literal>CLASSPATH</literal>. Here is an example: + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + +  + <session-factory + name="java:hibernate/SessionFactory"> + +  + <property name="connection.datasource">java:/comp/env/jdbc/MyDB</property> + <property name="dialect">org.hibernate.dialect.MySQLDialect</property> + <property name="show_sql">false</property> + <property name="transaction.factory_class"> + org.hibernate.transaction.JTATransactionFactory + </property> + <property name="jta.UserTransaction">java:comp/UserTransaction</property> + +  + <mapping resource="org/hibernate/auction/Item.hbm.xml"/> + <mapping resource="org/hibernate/auction/Bid.hbm.xml"/> + +  + <class-cache class="org.hibernate.auction.Item" usage="read-write"/> + <class-cache class="org.hibernate.auction.Bid" usage="read-only"/> + <collection-cache collection="org.hibernate.auction.Item.bids" usage="read-write"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + As you can see, the advantage of this approach is the externalization of the + mapping file names to configuration. The <literal>hibernate.cfg.xml</literal> + is also more convenient once you have to tune the Hibernate cache. Note that is + your choice to use either <literal>hibernate.properties</literal> or + <literal>hibernate.cfg.xml</literal>, both are equivalent, except for the above + mentioned benefits of using the XML syntax. + </para> + + <para> + With the XML configuration, starting Hibernate is then as simple as + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration().configure().buildSessionFactory();]]></programlisting> + + <para> + You can pick a different XML configuration file using + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .configure("catdb.cfg.xml") + .buildSessionFactory();]]></programlisting> + + </sect1> + + <sect1 id="configuration-j2ee" revision="1"> + <title>J2EE Application Server integration</title> + + <para> + Hibernate has the following integration points for J2EE infrastructure: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Container-managed datasources</emphasis>: Hibernate can use + JDBC connections managed by the container and provided through JNDI. Usually, + a JTA compatible <literal>TransactionManager</literal> and a + <literal>ResourceManager</literal> take care of transaction management (CMT), + esp. distributed transaction handling across several datasources. You may + of course also demarcate transaction boundaries programmatically (BMT) or + you might want to use the optional Hibernate <literal>Transaction</literal> + API for this to keep your code portable. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>Automatic JNDI binding</emphasis>: Hibernate can bind its + <literal>SessionFactory</literal> to JNDI after startup. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>JTA Session binding:</emphasis> The Hibernate <literal>Session</literal> + may be automatically bound to the scope of JTA transactions. Simply + lookup the <literal>SessionFactory</literal> from JNDI and get the current + <literal>Session</literal>. Let Hibernate take care of flushing and closing the + <literal>Session</literal> when your JTA transaction completes. Transaction + demarcation is either declarative (CMT) or programmatic (BMT/UserTransaction). + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>JMX deployment:</emphasis> If you have a JMX capable application server + (e.g. JBoss AS), you can chose to deploy Hibernate as a managed MBean. This saves + you the one line startup code to build your <literal>SessionFactory</literal> from + a <literal>Configuration</literal>. The container will startup your + <literal>HibernateService</literal>, and ideally also take care of service + dependencies (Datasource has to be available before Hibernate starts, etc). + </para> + </listitem> + </itemizedlist> + + <para> + Depending on your environment, you might have to set the configuration option + <literal>hibernate.connection.aggressive_release</literal> to true if your + application server shows "connection containment" exceptions. + </para> + + <sect2 id="configuration-optional-transactionstrategy" revision="3"> + <title>Transaction strategy configuration</title> + + <para> + The Hibernate <literal>Session</literal> API is independent of any transaction + demarcation system in your architecture. If you let Hibernate use JDBC directly, + through a connection pool, you may begin and end your transactions by calling + the JDBC API. If you run in a J2EE application server, you might want to use bean-managed + transactions and call the JTA API and <literal>UserTransaction</literal> when needed. + </para> + + <para> + To keep your code portable between these two (and other) environments we recommend the optional + Hibernate <literal>Transaction</literal> API, which wraps and hides the underlying system. + You have to specify a factory class for <literal>Transaction</literal> instances by setting the + Hibernate configuration property <literal>hibernate.transaction.factory_class</literal>. + </para> + + <para> + There are three standard (built-in) choices: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term><literal>org.hibernate.transaction.JDBCTransactionFactory</literal></term> + <listitem> + <para>delegates to database (JDBC) transactions (default)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.JTATransactionFactory</literal></term> + <listitem> + <para> + delegates to container-managed transaction if an existing transaction is + underway in this context (e.g. EJB session bean method), otherwise + a new transaction is started and bean-managed transaction are used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.CMTTransactionFactory</literal></term> + <listitem> + <para>delegates to container-managed JTA transactions</para> + </listitem> + </varlistentry> + </variablelist> + + <para> + You may also define your own transaction strategies (for a CORBA transaction service, + for example). + </para> + + <para> + Some features in Hibernate (i.e. the second level cache, Contextual Sessions with JTA, etc.) + require access to the JTA <literal>TransactionManager</literal> in a managed environment. + In an application server you have to specify how Hibernate should obtain a reference to the + <literal>TransactionManager</literal>, since J2EE does not standardize a single mechanism: + </para> + + <table frame="topbot" id="jtamanagerlookup" revision="1"> + <title>JTA TransactionManagers</title> + <tgroup cols="2"> + <colspec colwidth="2.5*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry>Transaction Factory</entry> + <entry align="center">Application Server</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.transaction.JBossTransactionManagerLookup</literal></entry> + <entry align="center">JBoss</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WeblogicTransactionManagerLookup</literal></entry> + <entry align="center">Weblogic</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereTransactionManagerLookup</literal></entry> + <entry align="center">WebSphere</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereExtendedJTATransactionLookup</literal></entry> + <entry align="center">WebSphere 6</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.OrionTransactionManagerLookup</literal></entry> + <entry align="center">Orion</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.ResinTransactionManagerLookup</literal></entry> + <entry align="center">Resin</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOTMTransactionManagerLookup</literal></entry> + <entry align="center">JOTM</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOnASTransactionManagerLookup</literal></entry> + <entry align="center">JOnAS</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JRun4TransactionManagerLookup</literal></entry> + <entry align="center">JRun4</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.BESTransactionManagerLookup</literal></entry> + <entry align="center">Borland ES</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-jndi" revision="3"> + <title>JNDI-bound <literal>SessionFactory</literal></title> + + <para> + A JNDI bound Hibernate <literal>SessionFactory</literal> can simplify the lookup + of the factory and the creation of new <literal>Session</literal>s. Note that this + is not related to a JNDI bound <literal>Datasource</literal>, both simply use the + same registry! + </para> + + <para> + If you wish to have the <literal>SessionFactory</literal> bound to a JNDI namespace, specify + a name (eg. <literal>java:hibernate/SessionFactory</literal>) using the property + <literal>hibernate.session_factory_name</literal>. If this property is omitted, the + <literal>SessionFactory</literal> will not be bound to JNDI. (This is especially useful in + environments with a read-only JNDI default implementation, e.g. Tomcat.) + </para> + + <para> + When binding the <literal>SessionFactory</literal> to JNDI, Hibernate will use the values of + <literal>hibernate.jndi.url</literal>, <literal>hibernate.jndi.class</literal> to instantiate + an initial context. If they are not specified, the default <literal>InitialContext</literal> + will be used. + </para> + + <para> + Hibernate will automatically place the <literal>SessionFactory</literal> in JNDI after + you call <literal>cfg.buildSessionFactory()</literal>. This means you will at least have + this call in some startup code (or utility class) in your application, unless you use + JMX deployment with the <literal>HibernateService</literal> (discussed later). + </para> + + <para> + If you use a JNDI <literal>SessionFactory</literal>, an EJB or any other class may + obtain the <literal>SessionFactory</literal> using a JNDI lookup. + </para> + + <para> + We recommend that you bind the <literal>SessionFactory</literal> to JNDI in + a managed environment and use a <literal>static</literal> singleton otherwise. + To shield your application code from these details, we also recommend to hide the + actual lookup code for a <literal>SessionFactory</literal> in a helper class, + such as <literal>HibernateUtil.getSessionFactory()</literal>. Note that such a + class is also a convenient way to startup Hibernate—see chapter 1. + </para> + + </sect2> + + <sect2 id="configuration-j2ee-currentsession" revision="4"> + <title>Current Session context management with JTA</title> + + <para> + The easiest way to handle <literal>Session</literal>s and transactions is + Hibernates automatic "current" <literal>Session</literal> management. + See the discussion of <xref linkend="architecture-current-session">current sessions</xref>. + Using the <literal>"jta"</literal> session context, if there is no Hibernate + <literal>Session</literal> associated with the current JTA transaction, one will + be started and associated with that JTA transaction the first time you call + <literal>sessionFactory.getCurrentSession()</literal>. The <literal>Session</literal>s + retrieved via <literal>getCurrentSession()</literal> in <literal>"jta"</literal> context + will be set to automatically flush before the transaction completes, close + after the transaction completes, and aggressively release JDBC connections + after each statement. This allows the <literal>Session</literal>s to + be managed by the life cycle of the JTA transaction to which it is associated, + keeping user code clean of such management concerns. Your code can either use + JTA programmatically through <literal>UserTransaction</literal>, or (recommended + for portable code) use the Hibernate <literal>Transaction</literal> API to set + transaction boundaries. If you run in an EJB container, declarative transaction + demarcation with CMT is preferred. + </para> + + </sect2> + + <sect2 id="configuration-j2ee-jmx" revision="1"> + <title>JMX deployment</title> + + <para> + The line <literal>cfg.buildSessionFactory()</literal> still has to be executed + somewhere to get a <literal>SessionFactory</literal> into JNDI. You can do this + either in a <literal>static</literal> initializer block (like the one in + <literal>HibernateUtil</literal>) or you deploy Hibernate as a <emphasis>managed + service</emphasis>. + </para> + + <para> + Hibernate is distributed with <literal>org.hibernate.jmx.HibernateService</literal> + for deployment on an application server with JMX capabilities, such as JBoss AS. + The actual deployment and configuration is vendor specific. Here is an example + <literal>jboss-service.xml</literal> for JBoss 4.0.x: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<server> + +<mbean code="org.hibernate.jmx.HibernateService" + name="jboss.jca:service=HibernateFactory,name=HibernateFactory"> + +  + <depends>jboss.jca:service=RARDeployer</depends> + <depends>jboss.jca:service=LocalTxCM,name=HsqlDS</depends> + +  + <attribute name="JndiName">java:/hibernate/SessionFactory</attribute> + +  + <attribute name="Datasource">java:HsqlDS</attribute> + <attribute name="Dialect">org.hibernate.dialect.HSQLDialect</attribute> + +  + <attribute name="TransactionStrategy"> + org.hibernate.transaction.JTATransactionFactory</attribute> + <attribute name="TransactionManagerLookupStrategy"> + org.hibernate.transaction.JBossTransactionManagerLookup</attribute> + <attribute name="FlushBeforeCompletionEnabled">true</attribute> + <attribute name="AutoCloseSessionEnabled">true</attribute> + +  + <attribute name="MaximumFetchDepth">5</attribute> + +  + <attribute name="SecondLevelCacheEnabled">true</attribute> + <attribute name="CacheProviderClass">org.hibernate.cache.EhCacheProvider</attribute> + <attribute name="QueryCacheEnabled">true</attribute> + +  + <attribute name="ShowSqlEnabled">true</attribute> + +  + <attribute name="MapResources">auction/Item.hbm.xml,auction/Category.hbm.xml</attribute> + +</mbean> + +</server>]]></programlisting> + + <para> + This file is deployed in a directory called <literal>META-INF</literal> and packaged + in a JAR file with the extension <literal>.sar</literal> (service archive). You also need + to package Hibernate, its required third-party libraries, your compiled persistent classes, + as well as your mapping files in the same archive. Your enterprise beans (usually session + beans) may be kept in their own JAR file, but you may include this EJB JAR file in the + main service archive to get a single (hot-)deployable unit. Consult the JBoss AS + documentation for more information about JMX service and EJB deployment. + </para> + + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/events.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/events.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/events.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/events.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,268 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="events"> + <title>Interceptors and events</title> + + <para> + It is often useful for the application to react to certain events that occur + inside Hibernate. This allows implementation of certain kinds of generic + functionality, and extension of Hibernate functionality. + </para> + + <sect1 id="objectstate-interceptors" revision="3"> + <title>Interceptors</title> + + <para> + The <literal>Interceptor</literal> interface provides callbacks from the session to the + application allowing the application to inspect and/or manipulate properties of a + persistent object before it is saved, updated, deleted or loaded. One + possible use for this is to track auditing information. For example, the following + <literal>Interceptor</literal> automatically sets the <literal>createTimestamp</literal> + when an <literal>Auditable</literal> is created and updates the + <literal>lastUpdateTimestamp</literal> property when an <literal>Auditable</literal> is + updated. + </para> + + <para> + You may either implement <literal>Interceptor</literal> directly or (better) extend + <literal>EmptyInterceptor</literal>. + </para> + + <programlisting><![CDATA[package org.hibernate.test; + +import java.io.Serializable; +import java.util.Date; +import java.util.Iterator; + +import org.hibernate.EmptyInterceptor; +import org.hibernate.Transaction; +import org.hibernate.type.Type; + +public class AuditInterceptor extends EmptyInterceptor { + + private int updates; + private int creates; + private int loads; + + public void onDelete(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + // do nothing + } + + public boolean onFlushDirty(Object entity, + Serializable id, + Object[] currentState, + Object[] previousState, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + updates++; + for ( int i=0; i < propertyNames.length; i++ ) { + if ( "lastUpdateTimestamp".equals( propertyNames[i] ) ) { + currentState[i] = new Date(); + return true; + } + } + } + return false; + } + + public boolean onLoad(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + if ( entity instanceof Auditable ) { + loads++; + } + return false; + } + + public boolean onSave(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + creates++; + for ( int i=0; i<propertyNames.length; i++ ) { + if ( "createTimestamp".equals( propertyNames[i] ) ) { + state[i] = new Date(); + return true; + } + } + } + return false; + } + + public void afterTransactionCompletion(Transaction tx) { + if ( tx.wasCommitted() ) { + System.out.println("Creations: " + creates + ", Updates: " + updates, "Loads: " + loads); + } + updates=0; + creates=0; + loads=0; + } + +}]]></programlisting> + + <para> + Interceptors come in two flavors: <literal>Session</literal>-scoped and + <literal>SessionFactory</literal>-scoped. + </para> + + <para> + A <literal>Session</literal>-scoped interceptor is specified + when a session is opened using one of the overloaded SessionFactory.openSession() + methods accepting an <literal>Interceptor</literal>. + </para> + + <programlisting><![CDATA[Session session = sf.openSession( new AuditInterceptor() );]]></programlisting> + + <para> + A <literal>SessionFactory</literal>-scoped interceptor is registered with the <literal>Configuration</literal> + object prior to building the <literal>SessionFactory</literal>. In this case, the supplied interceptor + will be applied to all sessions opened from that <literal>SessionFactory</literal>; this is true unless + a session is opened explicitly specifying the interceptor to use. <literal>SessionFactory</literal>-scoped + interceptors must be thread safe, taking care to not store session-specific state since multiple + sessions will use this interceptor (potentially) concurrently. + </para> + + <programlisting><![CDATA[new Configuration().setInterceptor( new AuditInterceptor() );]]></programlisting> + + </sect1> + + <sect1 id="objectstate-events" revision="4"> + <title>Event system</title> + + <para> + If you have to react to particular events in your persistence layer, you may + also use the Hibernate3 <emphasis>event</emphasis> architecture. The event + system can be used in addition or as a replacement for interceptors. + </para> + + <para> + Essentially all of the methods of the <literal>Session</literal> interface correlate + to an event. You have a <literal>LoadEvent</literal>, a <literal>FlushEvent</literal>, etc + (consult the XML configuration-file DTD or the <literal>org.hibernate.event</literal> + package for the full list of defined event types). When a request is made of one of + these methods, the Hibernate <literal>Session</literal> generates an appropriate + event and passes it to the configured event listeners for that type. Out-of-the-box, + these listeners implement the same processing in which those methods always resulted. + However, you are free to implement a customization of one of the listener interfaces + (i.e., the <literal>LoadEvent</literal> is processed by the registered implemenation + of the <literal>LoadEventListener</literal> interface), in which case their + implementation would be responsible for processing any <literal>load()</literal> requests + made of the <literal>Session</literal>. + </para> + + <para> + The listeners should be considered effectively singletons; meaning, they are shared between + requests, and thus should not save any state as instance variables. + </para> + + <para> + A custom listener should implement the appropriate interface for the event it wants to + process and/or extend one of the convenience base classes (or even the default event + listeners used by Hibernate out-of-the-box as these are declared non-final for this + purpose). Custom listeners can either be registered programmatically through the + <literal>Configuration</literal> object, or specified in the Hibernate configuration + XML (declarative configuration through the properties file is not supported). Here's an + example of a custom load event listener: + </para> + + <programlisting><![CDATA[public class MyLoadListener implements LoadEventListener { + // this is the single method defined by the LoadEventListener interface + public void onLoad(LoadEvent event, LoadEventListener.LoadType loadType) + throws HibernateException { + if ( !MySecurity.isAuthorized( event.getEntityClassName(), event.getEntityId() ) ) { + throw MySecurityException("Unauthorized access"); + } + } +}]]></programlisting> + + <para> + You also need a configuration entry telling Hibernate to use the listener in addition + to the default listener: + </para> + +<programlisting><![CDATA[<hibernate-configuration> + <session-factory> + ... + <event type="load"> + <listener class="com.eg.MyLoadListener"/> + <listener class="org.hibernate.event.def.DefaultLoadEventListener"/> + </event> + </session-factory> +</hibernate-configuration>]]></programlisting> + + <para> + Instead, you may register it programmatically: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration(); +LoadEventListener[] stack = { new MyLoadListener(), new DefaultLoadEventListener() }; +cfg.EventListeners().setLoadEventListeners(stack);]]></programlisting> + + <para> + Listeners registered declaratively cannot share instances. If the same class name is + used in multiple <literal><listener/></literal> elements, each reference will + result in a separate instance of that class. If you need the capability to share + listener instances between listener types you must use the programmatic registration + approach. + </para> + + <para> + Why implement an interface and define the specific type during configuration? Well, a + listener implementation could implement multiple event listener interfaces. Having the + type additionally defined during registration makes it easier to turn custom listeners on + or off during configuration. + </para> + + </sect1> + + <sect1 id="objectstate-decl-security" revision="2"> + <title>Hibernate declarative security</title> + <para> + Usually, declarative security in Hibernate applications is managed in a session facade + layer. Now, Hibernate3 allows certain actions to be permissioned via JACC, and authorized + via JAAS. This is optional functionality built on top of the event architecture. + </para> + + <para> + First, you must configure the appropriate event listeners, to enable the use of JAAS + authorization. + </para> + + <programlisting><![CDATA[<listener type="pre-delete" class="org.hibernate.secure.JACCPreDeleteEventListener"/> +<listener type="pre-update" class="org.hibernate.secure.JACCPreUpdateEventListener"/> +<listener type="pre-insert" class="org.hibernate.secure.JACCPreInsertEventListener"/> +<listener type="pre-load" class="org.hibernate.secure.JACCPreLoadEventListener"/>]]></programlisting> + + <para> + Note that <literal><listener type="..." class="..."/></literal> is just a shorthand + for <literal><event type="..."><listener class="..."/></event></literal> + when there is exactly one listener for a particular event type. + </para> + + <para> + Next, still in <literal>hibernate.cfg.xml</literal>, bind the permissions to roles: + </para> + + <programlisting><![CDATA[<grant role="admin" entity-name="User" actions="insert,update,read"/> +<grant role="su" entity-name="User" actions="*"/>]]></programlisting> + + <para> + The role names are the roles understood by your JACC provider. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/example_mappings.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/example_mappings.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/example_mappings.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/example_mappings.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,676 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + + +<chapter id="example-mappings"> + <title>Example: Various Mappings</title> + + <para> + This chapters shows off some more complex association mappings. + </para> + + <sect1 id="example-mappings-emp"> + <title>Employer/Employee</title> + + <para> + The following model of the relationship between <literal>Employer</literal> and + <literal>Employee</literal> uses an actual entity class (<literal>Employment</literal>) + to represent the association. This is done because there might be more than one + period of employment for the same two parties. Components are used to model monetary + values and employee names. + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata fileref="../images/EmployerEmployee.png" format="PNG" align="center" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="../images/EmployerEmployee.png" format="PNG" align="center" width="17cm" /> + </imageobject> + </mediaobject> + + <para> + Heres a possible mapping document: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Employer" table="employers"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employer_id_seq</param> + </generator> + </id> + <property name="name"/> + </class> + + <class name="Employment" table="employment_periods"> + + <id name="id"> + <generator class="sequence"> + <param name="sequence">employment_id_seq</param> + </generator> + </id> + <property name="startDate" column="start_date"/> + <property name="endDate" column="end_date"/> + + <component name="hourlyRate" class="MonetaryAmount"> + <property name="amount"> + <column name="hourly_rate" sql-type="NUMERIC(12, 2)"/> + </property> + <property name="currency" length="12"/> + </component> + + <many-to-one name="employer" column="employer_id" not-null="true"/> + <many-to-one name="employee" column="employee_id" not-null="true"/> + + </class> + + <class name="Employee" table="employees"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employee_id_seq</param> + </generator> + </id> + <property name="taxfileNumber"/> + <component name="name" class="Name"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </component> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + And heres the table schema generated by <literal>SchemaExport</literal>. + </para> + + <programlisting><![CDATA[create table employers ( + id BIGINT not null, + name VARCHAR(255), + primary key (id) +) + +create table employment_periods ( + id BIGINT not null, + hourly_rate NUMERIC(12, 2), + currency VARCHAR(12), + employee_id BIGINT not null, + employer_id BIGINT not null, + end_date TIMESTAMP, + start_date TIMESTAMP, + primary key (id) +) + +create table employees ( + id BIGINT not null, + firstName VARCHAR(255), + initial CHAR(1), + lastName VARCHAR(255), + taxfileNumber VARCHAR(255), + primary key (id) +) + +alter table employment_periods + add constraint employment_periodsFK0 foreign key (employer_id) references employers +alter table employment_periods + add constraint employment_periodsFK1 foreign key (employee_id) references employees +create sequence employee_id_seq +create sequence employment_id_seq +create sequence employer_id_seq]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-authorwork"> + <title>Author/Work</title> + + <para> + Consider the following model of the relationships between <literal>Work</literal>, + <literal>Author</literal> and <literal>Person</literal>. We represent the relationship + between <literal>Work</literal> and <literal>Author</literal> as a many-to-many + association. We choose to represent the relationship between <literal>Author</literal> + and <literal>Person</literal> as one-to-one association. Another possibility would be to + have <literal>Author</literal> extend <literal>Person</literal>. + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata fileref="../images/AuthorWork.png" format="PNG" align="center" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="../images/AuthorWork.png" format="PNG" align="center" width="17cm" /> + </imageobject> + </mediaobject> + + <para> + The following mapping document correctly represents these relationships: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Work" table="works" discriminator-value="W"> + + <id name="id" column="id"> + <generator class="native"/> + </id> + <discriminator column="type" type="character"/> + + <property name="title"/> + <set name="authors" table="author_work"> + <key column name="work_id"/> + <many-to-many class="Author" column name="author_id"/> + </set> + + <subclass name="Book" discriminator-value="B"> + <property name="text"/> + </subclass> + + <subclass name="Song" discriminator-value="S"> + <property name="tempo"/> + <property name="genre"/> + </subclass> + + </class> + + <class name="Author" table="authors"> + + <id name="id" column="id"> +  + <generator class="assigned"/> + </id> + + <property name="alias"/> + <one-to-one name="person" constrained="true"/> + + <set name="works" table="author_work" inverse="true"> + <key column="author_id"/> + <many-to-many class="Work" column="work_id"/> + </set> + + </class> + + <class name="Person" table="persons"> + <id name="id" column="id"> + <generator class="native"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + There are four tables in this mapping. <literal>works</literal>, + <literal>authors</literal> and <literal>persons</literal> hold work, author + and person data respectively. <literal>author_work</literal> is an association + table linking authors to works. Heres the table schema, as generated by + <literal>SchemaExport</literal>. + </para> + + <programlisting><![CDATA[create table works ( + id BIGINT not null generated by default as identity, + tempo FLOAT, + genre VARCHAR(255), + text INTEGER, + title VARCHAR(255), + type CHAR(1) not null, + primary key (id) +) + +create table author_work ( + author_id BIGINT not null, + work_id BIGINT not null, + primary key (work_id, author_id) +) + +create table authors ( + id BIGINT not null generated by default as identity, + alias VARCHAR(255), + primary key (id) +) + +create table persons ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +alter table authors + add constraint authorsFK0 foreign key (id) references persons +alter table author_work + add constraint author_workFK0 foreign key (author_id) references authors +alter table author_work + add constraint author_workFK1 foreign key (work_id) references works]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-customerorderproduct"> + <title>Customer/Order/Product</title> + + <para> + Now consider a model of the relationships between <literal>Customer</literal>, + <literal>Order</literal> and <literal>LineItem</literal> and <literal>Product</literal>. + There is a one-to-many association between <literal>Customer</literal> and + <literal>Order</literal>, but how should we represent <literal>Order</literal> / + <literal>LineItem</literal> / <literal>Product</literal>? I've chosen to map + <literal>LineItem</literal> as an association class representing the many-to-many + association between <literal>Order</literal> and <literal>Product</literal>. In + Hibernate, this is called a composite element. + </para> + + <mediaobject> + <imageobject role="html"> + <imagedata fileref="../images/CustomerOrderProduct.png" format="PNG" align="center" /> + </imageobject> + <imageobject role="fo"> + <imagedata fileref="../images/CustomerOrderProduct.png" format="PNG" align="center" width="17cm" /> + </imageobject> + </mediaobject> + + <para> + The mapping document: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Customer" table="customers"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name"/> + <set name="orders" inverse="true"> + <key column="customer_id"/> + <one-to-many class="Order"/> + </set> + </class> + + <class name="Order" table="orders"> + <id name="id"> + <generator class="native"/> + </id> + <property name="date"/> + <many-to-one name="customer" column="customer_id"/> + <list name="lineItems" table="line_items"> + <key column="order_id"/> + <list-index column="line_number"/> + <composite-element class="LineItem"> + <property name="quantity"/> + <many-to-one name="product" column="product_id"/> + </composite-element> + </list> + </class> + + <class name="Product" table="products"> + <id name="id"> + <generator class="native"/> + </id> + <property name="serialNumber"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + <literal>customers</literal>, <literal>orders</literal>, <literal>line_items</literal> and + <literal>products</literal> hold customer, order, order line item and product data + respectively. <literal>line_items</literal> also acts as an association table linking + orders with products. + </para> + + <programlisting><![CDATA[create table customers ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +create table orders ( + id BIGINT not null generated by default as identity, + customer_id BIGINT, + date TIMESTAMP, + primary key (id) +) + +create table line_items ( + line_number INTEGER not null, + order_id BIGINT not null, + product_id BIGINT, + quantity INTEGER, + primary key (order_id, line_number) +) + +create table products ( + id BIGINT not null generated by default as identity, + serialNumber VARCHAR(255), + primary key (id) +) + +alter table orders + add constraint ordersFK0 foreign key (customer_id) references customers +alter table line_items + add constraint line_itemsFK0 foreign key (product_id) references products +alter table line_items + add constraint line_itemsFK1 foreign key (order_id) references orders]]></programlisting> + + </sect1> + + <sect1 id="misc"> + <title>Miscellaneous example mappings</title> + + <para> + These examples are all taken from the Hibernate test suite. You + will find many other useful example mappings there. Look in the + <literal>test</literal> folder of the Hibernate distribution. + </para> + + <para>TODO: put words around this stuff</para> + + <sect2 id="example-mappings-typed-onetone"> + <title>"Typed" one-to-one association</title> +<programlisting><![CDATA[<class name="Person"> + <id name="name"/> + <one-to-one name="address" + cascade="all"> + <formula>name</formula> + <formula>'HOME'</formula> + </one-to-one> + <one-to-one name="mailingAddress" + cascade="all"> + <formula>name</formula> + <formula>'MAILING'</formula> + </one-to-one> +</class> + +<class name="Address" batch-size="2" + check="addressType in ('MAILING', 'HOME', 'BUSINESS')"> + <composite-id> + <key-many-to-one name="person" + column="personName"/> + <key-property name="type" + column="addressType"/> + </composite-id> + <property name="street" type="text"/> + <property name="state"/> + <property name="zip"/> +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key"> + <title>Composite key example</title> +<programlisting><![CDATA[<class name="Customer"> + + <id name="customerId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="name" not-null="true" length="100"/> + <property name="address" not-null="true" length="200"/> + + <list name="orders" + inverse="true" + cascade="save-update"> + <key column="customerId"/> + <index column="orderNumber"/> + <one-to-many class="Order"/> + </list> + +</class> + +<class name="Order" table="CustomerOrder" lazy="true"> + <synchronize table="LineItem"/> + <synchronize table="Product"/> + + <composite-id name="id" + class="Order$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + </composite-id> + + <property name="orderDate" + type="calendar_date" + not-null="true"/> + + <property name="total"> + <formula> + ( select sum(li.quantity*p.price) + from LineItem li, Product p + where li.productId = p.productId + and li.customerId = customerId + and li.orderNumber = orderNumber ) + </formula> + </property> + + <many-to-one name="customer" + column="customerId" + insert="false" + update="false" + not-null="true"/> + + <bag name="lineItems" + fetch="join" + inverse="true" + cascade="save-update"> + <key> + <column name="customerId"/> + <column name="orderNumber"/> + </key> + <one-to-many class="LineItem"/> + </bag> + +</class> + +<class name="LineItem"> + + <composite-id name="id" + class="LineItem$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + <key-property name="productId" length="10"/> + </composite-id> + + <property name="quantity"/> + + <many-to-one name="order" + insert="false" + update="false" + not-null="true"> + <column name="customerId"/> + <column name="orderNumber"/> + </many-to-one> + + <many-to-one name="product" + insert="false" + update="false" + not-null="true" + column="productId"/> + +</class> + +<class name="Product"> + <synchronize table="LineItem"/> + + <id name="productId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="description" + not-null="true" + length="200"/> + <property name="price" length="3"/> + <property name="numberAvailable"/> + + <property name="numberOrdered"> + <formula> + ( select sum(li.quantity) + from LineItem li + where li.productId = productId ) + </formula> + </property> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key-manytomany"> + <title>Many-to-many with shared composite key attribute</title> +<programlisting><![CDATA[<class name="User" table="`User`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <set name="groups" table="UserGroup"> + <key> + <column name="userName"/> + <column name="org"/> + </key> + <many-to-many class="Group"> + <column name="groupName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> + +<class name="Group" table="`Group`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <property name="description"/> + <set name="users" table="UserGroup" inverse="true"> + <key> + <column name="groupName"/> + <column name="org"/> + </key> + <many-to-many class="User"> + <column name="userName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> +]]></programlisting> + </sect2> + + <sect2 id="example-mappings-content-discrimination"> + <title>Content based discrimination</title> +<programlisting><![CDATA[<class name="Person" + discriminator-value="P"> + + <id name="id" + column="person_id" + unsaved-value="0"> + <generator class="native"/> + </id> + + + <discriminator + type="character"> + <formula> + case + when title is not null then 'E' + when salesperson is not null then 'C' + else 'P' + end + </formula> + </discriminator> + + <property name="name" + not-null="true" + length="80"/> + + <property name="sex" + not-null="true" + update="false"/> + + <component name="address"> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </component> + + <subclass name="Employee" + discriminator-value="E"> + <property name="title" + length="20"/> + <property name="salary"/> + <many-to-one name="manager"/> + </subclass> + + <subclass name="Customer" + discriminator-value="C"> + <property name="comments"/> + <many-to-one name="salesperson"/> + </subclass> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-association-alternatekeys" revision="2"> + <title>Associations on alternate keys</title> +<programlisting><![CDATA[<class name="Person"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="name" length="100"/> + + <one-to-one name="address" + property-ref="person" + cascade="all" + fetch="join"/> + + <set name="accounts" + inverse="true"> + <key column="userId" + property-ref="userId"/> + <one-to-many class="Account"/> + </set> + + <property name="userId" length="8"/> + +</class> + +<class name="Address"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="address" length="300"/> + <property name="zip" length="5"/> + <property name="country" length="25"/> + <many-to-one name="person" unique="true" not-null="true"/> + +</class> + +<class name="Account"> + <id name="accountId" length="32"> + <generator class="uuid"/> + </id> + + <many-to-one name="user" + column="userId" + property-ref="userId"/> + + <property name="type" not-null="true"/> + +</class>]]></programlisting> + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/example_parentchild.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/example_parentchild.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/example_parentchild.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/example_parentchild.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,364 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="example-parentchild"> + <title>Example: Parent/Child</title> + + <para> + One of the very first things that new users try to do with Hibernate is to model a parent / child type + relationship. There are two different approaches to this. For various reasons the most convenient + approach, especially for new users, is to model both <literal>Parent</literal> and <literal>Child</literal> + as entity classes with a <literal><one-to-many></literal> association from <literal>Parent</literal> + to <literal>Child</literal>. (The alternative approach is to declare the <literal>Child</literal> as a + <literal><composite-element></literal>.) Now, it turns out that default semantics of a one to many + association (in Hibernate) are much less close to the usual semantics of a parent / child relationship than + those of a composite element mapping. We will explain how to use a <emphasis>bidirectional one to many + association with cascades</emphasis> to model a parent / child relationship efficiently and elegantly. + It's not at all difficult! + </para> + + <sect1 id="example-parentchild-collections"> + <title>A note about collections</title> + + <para> + Hibernate collections are considered to be a logical part of their owning entity; never of the + contained entities. This is a crucial distinction! It has the following consequences: + </para> + + <itemizedlist> + <listitem> + <para> + When we remove / add an object from / to a collection, the version number of the collection owner + is incremented. + </para> + </listitem> + <listitem> + <para> + If an object that was removed from a collection is an instance of a value type (eg, a composite + element), that object will cease to be persistent and its state will be completely removed from + the database. Likewise, adding a value type instance to the collection will cause its state to be + immediately persistent. + </para> + </listitem> + <listitem> + <para> + On the other hand, if an entity is removed from a collection (a one-to-many or many-to-many + association), it will not be deleted, by default. This behaviour is completely consistent - a + change to the internal state of another entity should not cause the associated entity to vanish! + Likewise, adding an entity to a collection does not cause that entity to become persistent, by + default. + </para> + </listitem> + </itemizedlist> + + <para> + Instead, the default behaviour is that adding an entity to a collection merely creates a link between + the two entities, while removing it removes the link. This is very appropriate for all sorts of cases. + Where it is not appropriate at all is the case of a parent / child relationship, where the life of the + child is bound to the life cycle of the parent. + </para> + + </sect1> + + <sect1 id="example-parentchild-bidir"> + <title>Bidirectional one-to-many</title> + + <para> + Suppose we start with a simple <literal><one-to-many></literal> association from + <literal>Parent</literal> to <literal>Child</literal>. + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + If we were to execute the following code + </para> + + <programlisting><![CDATA[Parent p = .....; +Child c = new Child(); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + Hibernate would issue two SQL statements: + </para> + + <itemizedlist> + <listitem> + <para>an <literal>INSERT</literal> to create the record for <literal>c</literal></para> + </listitem> + <listitem> + <para> + an <literal>UPDATE</literal> to create the link from <literal>p</literal> to + <literal>c</literal> + </para> + </listitem> + </itemizedlist> + + <para> + This is not only inefficient, but also violates any <literal>NOT NULL</literal> constraint on the + <literal>parent_id</literal> column. We can fix the nullability constraint violation by specifying + <literal>not-null="true"</literal> in the collection mapping: + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + However, this is not the recommended solution. + </para> + <para> + The underlying cause of this behaviour is that the link (the foreign key <literal>parent_id</literal>) + from <literal>p</literal> to <literal>c</literal> is not considered part of the state of the + <literal>Child</literal> object and is therefore not created in the <literal>INSERT</literal>. So the + solution is to make the link part of the <literal>Child</literal> mapping. + </para> + + <programlisting><![CDATA[<many-to-one name="parent" column="parent_id" not-null="true"/>]]></programlisting> + + <para> + (We also need to add the <literal>parent</literal> property to the <literal>Child</literal> class.) + </para> + + <para> + Now that the <literal>Child</literal> entity is managing the state of the link, we tell the collection + not to update the link. We use the <literal>inverse</literal> attribute. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + The following code would be used to add a new <literal>Child</literal> + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +c.setParent(p); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + And now, only one SQL <literal>INSERT</literal> would be issued! + </para> + + <para> + To tighten things up a bit, we could create an <literal>addChild()</literal> method of + <literal>Parent</literal>. + </para> + + <programlisting><![CDATA[public void addChild(Child c) { + c.setParent(this); + children.add(c); +}]]></programlisting> + + <para> + Now, the code to add a <literal>Child</literal> looks like + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.save(c); +session.flush();]]></programlisting> + + </sect1> + + <sect1 id="example-parentchild-cascades"> + <title>Cascading life cycle</title> + + <para> + The explicit call to <literal>save()</literal> is still annoying. We will address this by + using cascades. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + This simplifies the code above to + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.flush();]]></programlisting> + + <para> + Similarly, we don't need to iterate over the children when saving or deleting a <literal>Parent</literal>. + The following removes <literal>p</literal> and all its children from the database. + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +session.delete(p); +session.flush();]]></programlisting> + + <para> + However, this code + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +c.setParent(null); +session.flush();]]></programlisting> + + <para> + will not remove <literal>c</literal> from the database; it will ony remove the link to <literal>p</literal> + (and cause a <literal>NOT NULL</literal> constraint violation, in this case). You need to explicitly + <literal>delete()</literal> the <literal>Child</literal>. + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +session.delete(c); +session.flush();]]></programlisting> + + <para> + Now, in our case, a <literal>Child</literal> can't really exist without its parent. So if we remove + a <literal>Child</literal> from the collection, we really do want it to be deleted. For this, we must + use <literal>cascade="all-delete-orphan"</literal>. + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all-delete-orphan"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + Note: even though the collection mapping specifies <literal>inverse="true"</literal>, cascades are + still processed by iterating the collection elements. So if you require that an object be saved, + deleted or updated by cascade, you must add it to the collection. It is not enough to simply call + <literal>setParent()</literal>. + </para> + + </sect1> + + <sect1 id="example-parentchild-update"> + <title>Cascades and <literal>unsaved-value</literal></title> + + <para> + Suppose we loaded up a <literal>Parent</literal> in one <literal>Session</literal>, made some changes + in a UI action and wish to persist these changes in a new session by calling <literal>update()</literal>. + The <literal>Parent</literal> will contain a collection of childen and, since cascading update is enabled, + Hibernate needs to know which children are newly instantiated and which represent existing rows in the + database. Lets assume that both <literal>Parent</literal> and <literal>Child</literal> have genenerated + identifier properties of type <literal>Long</literal>. Hibernate will use the identifier and + version/timestamp property value to determine which of the children are new. (See + <xref linkend="objectstate-saveorupdate"/>.) <emphasis>In Hibernate3, it is no longer necessary to specify + an <literal>unsaved-value</literal> explicitly.</emphasis> + </para> + + <para> + The following code will update <literal>parent</literal> and <literal>child</literal> and insert + <literal>newChild</literal>. + </para> + + <programlisting><![CDATA[//parent and child were both loaded in a previous session +parent.addChild(child); +Child newChild = new Child(); +parent.addChild(newChild); +session.update(parent); +session.flush();]]></programlisting> + + <para> + Well, that's all very well for the case of a generated identifier, but what about assigned identifiers + and composite identifiers? This is more difficult, since Hibernate can't use the identifier property to + distinguish between a newly instantiated object (with an identifier assigned by the user) and an + object loaded in a previous session. In this case, Hibernate will either use the timestamp or version + property, or will actually query the second-level cache or, worst case, the database, to see if the + row exists. + </para> + +  + </sect1> + + <sect1 id="example-parentchild-conclusion"> + <title>Conclusion</title> + + <para> + There is quite a bit to digest here and it might look confusing first time around. However, in practice, + it all works out very nicely. Most Hibernate applications use the parent / child pattern in many places. + </para> + + <para> + We mentioned an alternative in the first paragraph. None of the above issues exist in the case of + <literal><composite-element></literal> mappings, which have exactly the semantics of a parent / child + relationship. Unfortunately, there are two big limitations to composite element classes: composite elements + may not own collections, and they should not be the child of any entity other than the unique parent. + </para> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/example_weblog.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/example_weblog.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/example_weblog.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/example_weblog.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,433 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="example-weblog"> + <title>Example: Weblog Application</title> + + <sect1 id="example-weblog-classes"> + <title>Persistent Classes</title> + + <para> + The persistent classes represent a weblog, and an item posted + in a weblog. They are to be modelled as a standard parent/child + relationship, but we will use an ordered bag, instead of a set. + </para> + + <programlisting><![CDATA[package eg; + +import java.util.List; + +public class Blog { + private Long _id; + private String _name; + private List _items; + + public Long getId() { + return _id; + } + public List getItems() { + return _items; + } + public String getName() { + return _name; + } + public void setId(Long long1) { + _id = long1; + } + public void setItems(List list) { + _items = list; + } + public void setName(String string) { + _name = string; + } +}]]></programlisting> + + <programlisting><![CDATA[package eg; + +import java.text.DateFormat; +import java.util.Calendar; + +public class BlogItem { + private Long _id; + private Calendar _datetime; + private String _text; + private String _title; + private Blog _blog; + + public Blog getBlog() { + return _blog; + } + public Calendar getDatetime() { + return _datetime; + } + public Long getId() { + return _id; + } + public String getText() { + return _text; + } + public String getTitle() { + return _title; + } + public void setBlog(Blog blog) { + _blog = blog; + } + public void setDatetime(Calendar calendar) { + _datetime = calendar; + } + public void setId(Long long1) { + _id = long1; + } + public void setText(String string) { + _text = string; + } + public void setTitle(String string) { + _title = string; + } +}]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-mappings"> + <title>Hibernate Mappings</title> + + <para> + The XML mappings should now be quite straightforward. + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="Blog" + table="BLOGS"> + + <id + name="id" + column="BLOG_ID"> + + <generator class="native"/> + + </id> + + <property + name="name" + column="NAME" + not-null="true" + unique="true"/> + + <bag + name="items" + inverse="true" + order-by="DATE_TIME" + cascade="all"> + + <key column="BLOG_ID"/> + <one-to-many class="BlogItem"/> + + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="BlogItem" + table="BLOG_ITEMS" + dynamic-update="true"> + + <id + name="id" + column="BLOG_ITEM_ID"> + + <generator class="native"/> + + </id> + + <property + name="title" + column="TITLE" + not-null="true"/> + + <property + name="text" + column="TEXT" + not-null="true"/> + + <property + name="datetime" + column="DATE_TIME" + not-null="true"/> + + <many-to-one + name="blog" + column="BLOG_ID" + not-null="true"/> + + </class> + +</hibernate-mapping>]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-code"> + <title>Hibernate Code</title> + + <para> + The following class demonstrates some of the kinds of things + we can do with these classes, using Hibernate. + </para> + + <programlisting><![CDATA[package eg; + +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Iterator; +import java.util.List; + +import org.hibernate.HibernateException; +import org.hibernate.Query; +import org.hibernate.Session; +import org.hibernate.SessionFactory; +import org.hibernate.Transaction; +import org.hibernate.cfg.Configuration; +import org.hibernate.tool.hbm2ddl.SchemaExport; + +public class BlogMain { + + private SessionFactory _sessions; + + public void configure() throws HibernateException { + _sessions = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class) + .buildSessionFactory(); + } + + public void exportTables() throws HibernateException { + Configuration cfg = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class); + new SchemaExport(cfg).create(true, true); + } + + public Blog createBlog(String name) throws HibernateException { + + Blog blog = new Blog(); + blog.setName(name); + blog.setItems( new ArrayList() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.persist(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public BlogItem createBlogItem(Blog blog, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setBlog(blog); + item.setDatetime( Calendar.getInstance() ); + blog.getItems().add(item); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public BlogItem createBlogItem(Long blogid, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setDatetime( Calendar.getInstance() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + Blog blog = (Blog) session.load(Blog.class, blogid); + item.setBlog(blog); + blog.getItems().add(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public void updateBlogItem(BlogItem item, String text) + throws HibernateException { + + item.setText(text); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public void updateBlogItem(Long itemid, String text) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + BlogItem item = (BlogItem) session.load(BlogItem.class, itemid); + item.setText(text); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public List listAllBlogNamesAndItemCounts(int max) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "select blog.id, blog.name, count(blogItem) " + + "from Blog as blog " + + "left outer join blog.items as blogItem " + + "group by blog.name, blog.id " + + "order by max(blogItem.datetime)" + ); + q.setMaxResults(max); + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } + + public Blog getBlogAndAllItems(Long blogid) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + Blog blog = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "left outer join fetch blog.items " + + "where blog.id = :blogid" + ); + q.setParameter("blogid", blogid); + blog = (Blog) q.uniqueResult(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public List listBlogsAndRecentItems() throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "inner join blog.items as blogItem " + + "where blogItem.datetime > :minDate" + ); + + Calendar cal = Calendar.getInstance(); + cal.roll(Calendar.MONTH, false); + q.setCalendar("minDate", cal); + + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/filters.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/filters.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/filters.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/filters.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,149 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="filters"> + <title>Filtering data</title> + + <para> + Hibernate3 provides an innovative new approach to handling data with "visibility" rules. + A <emphasis>Hibernate filter</emphasis> is a global, named, parameterized filter that may be + enabled or disabled for a particular Hibernate session. + </para> + + <sect1 id="objectstate-filters" revision="1"> + <title>Hibernate filters</title> + + <para> + Hibernate3 adds the ability to pre-define filter criteria and attach those filters at both + a class and a collection level. A filter criteria is the ability to define a restriction clause + very similiar to the existing "where" attribute available on the class and various collection + elements. Except these filter conditions can be parameterized. The application can then make + the decision at runtime whether given filters should be enabled and what their parameter + values should be. Filters can be used like database views, but parameterized inside the + application. + </para> + + <para> + In order to use filters, they must first be defined and then attached to the appropriate + mapping elements. To define a filter, use the <literal><filter-def/></literal> element + within a <literal><hibernate-mapping/></literal> element: + </para> + + <programlisting><![CDATA[<filter-def name="myFilter"> + <filter-param name="myFilterParam" type="string"/> +</filter-def>]]></programlisting> + + <para> + Then, this filter can be attached to a class: + </para> + + <programlisting><![CDATA[<class name="myClass" ...> + ... + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</class>]]></programlisting> + + <para> + or, to a collection: + </para> + + <programlisting><![CDATA[<set ...> + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</set>]]></programlisting> + + <para> + or, even to both (or multiples of each) at the same time. + </para> + + <para> + The methods on <literal>Session</literal> are: <literal>enableFilter(String filterName)</literal>, + <literal>getEnabledFilter(String filterName)</literal>, and <literal>disableFilter(String filterName)</literal>. + By default, filters are <emphasis>not</emphasis> enabled for a given session; they must be explcitly + enabled through use of the <literal>Session.enabledFilter()</literal> method, which returns an + instance of the <literal>Filter</literal> interface. Using the simple filter defined above, this + would look like: + </para> + + <programlisting><![CDATA[session.enableFilter("myFilter").setParameter("myFilterParam", "some-value");]]></programlisting> + + <para> + Note that methods on the org.hibernate.Filter interface do allow the method-chaining common to much of Hibernate. + </para> + + <para> + A full example, using temporal data with an effective record date pattern: + </para> + + <programlisting><![CDATA[<filter-def name="effectiveDate"> + <filter-param name="asOfDate" type="date"/> +</filter-def> + +<class name="Employee" ...> +... + <many-to-one name="department" column="dept_id" class="Department"/> + <property name="effectiveStartDate" type="date" column="eff_start_dt"/> + <property name="effectiveEndDate" type="date" column="eff_end_dt"/> +... +  + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> +</class> + +<class name="Department" ...> +... + <set name="employees" lazy="true"> + <key column="dept_id"/> + <one-to-many class="Employee"/> + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> + </set> +</class>]]></programlisting> + + <para> + Then, in order to ensure that you always get back currently effective records, simply + enable the filter on the session prior to retrieving employee data: + </para> + +<programlisting><![CDATA[Session session = ...; +session.enabledFilter("effectiveDate").setParameter("asOfDate", new Date()); +List results = session.createQuery("from Employee as e where e.salary > :targetSalary") + .setLong("targetSalary", new Long(1000000)) + .list(); +]]></programlisting> + + <para> + In the HQL above, even though we only explicitly mentioned a salary constraint on the results, + because of the enabled filter the query will return only currently active employees who have + a salary greater than a million dollars. + </para> + + <para> + Note: if you plan on using filters with outer joining (either through HQL or load fetching) be + careful of the direction of the condition expression. Its safest to set this up for left + outer joining; in general, place the parameter first followed by the column name(s) after + the operator. + </para> + + <para> + After being defined a filter might be attached to multiple entities and/or + collections each with its own condition. That can be tedious when the + conditions are the same each time. Thus <literal><filter-def/></literal> + allows defining a default condition, either as an attribute or CDATA: + </para> + + <programlisting><![CDATA[<filter-def name="myFilter" condition="abc > xyz">...</filter-def> +<filter-def name="myOtherFilter">abc=xyz</filter-def>]]></programlisting> + + <para> + This default condition will then be used whenever the filter is attached to something + without specifying a condition. Note that this means you can give a specific condition + as part of the attachment of the filter which overrides the default condition in that + particular case. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/inheritance_mapping.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/inheritance_mapping.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/inheritance_mapping.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/inheritance_mapping.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,494 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="inheritance"> + <title>Inheritance Mapping</title> + + <sect1 id="inheritance-strategies" revision="3"> + <title>The Three Strategies</title> + + <para> + Hibernate supports the three basic inheritance mapping strategies: + </para> + + <itemizedlist> + <listitem> + <para> + table per class hierarchy + </para> + </listitem> + <listitem> + <para> + table per subclass + </para> + </listitem> + <listitem> + <para> + table per concrete class + </para> + </listitem> + </itemizedlist> + + <para> + In addition, Hibernate supports a fourth, slightly different kind of + polymorphism: + </para> + + <itemizedlist> + <listitem> + <para> + implicit polymorphism + </para> + </listitem> + </itemizedlist> + + <para> + It is possible to use different mapping strategies for different + branches of the same inheritance hierarchy, and then make use of implicit + polymorphism to achieve polymorphism across the whole hierarchy. However, + Hibernate does not support mixing <literal><subclass></literal>, + and <literal><joined-subclass></literal> and + <literal><union-subclass></literal> mappings under the same root + <literal><class></literal> element. It is possible to mix together + the table per hierarchy and table per subclass strategies, under the + the same <literal><class></literal> element, by combining the + <literal><subclass></literal> and <literal><join></literal> + elements (see below). + </para> + + <para> + It is possible to define <literal>subclass</literal>, <literal>union-subclass</literal>, + and <literal>joined-subclass</literal> mappings in separate mapping documents, directly beneath + <literal>hibernate-mapping</literal>. This allows you to extend a class hierachy just by adding + a new mapping file. You must specify an <literal>extends</literal> attribute in the subclass mapping, + naming a previously mapped superclass. Note: Previously this feature made the ordering of the mapping + documents important. Since Hibernate3, the ordering of mapping files does not matter when using the + extends keyword. The ordering inside a single mapping file still needs to be defined as superclasses + before subclasses. + </para> + + <programlisting><![CDATA[ + <hibernate-mapping> + <subclass name="DomesticCat" extends="Cat" discriminator-value="D"> + <property name="name" type="string"/> + </subclass> + </hibernate-mapping>]]></programlisting> + + + <sect2 id="inheritance-tableperclass" > + <title>Table per class hierarchy</title> + + <para> + Suppose we have an interface <literal>Payment</literal>, with implementors + <literal>CreditCardPayment</literal>, <literal>CashPayment</literal>, + <literal>ChequePayment</literal>. The table per hierarchy mapping would + look like: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + Exactly one table is required. There is one big limitation of this mapping + strategy: columns declared by the subclasses, such as <literal>CCTYPE</literal>, + may not have <literal>NOT NULL</literal> constraints. + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass"> + <title>Table per subclass</title> + + <para> + A table per subclass mapping would look like: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <joined-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </joined-subclass> + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + Four tables are required. The three subclass tables have primary + key associations to the superclass table (so the relational model + is actually a one-to-one association). + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass-discriminator" revision="2"> + <title>Table per subclass, using a discriminator</title> + + <para> + Note that Hibernate's implementation of table per subclass requires + no discriminator column. Other object/relational mappers use a + different implementation of table per subclass which requires a type + discriminator column in the superclass table. The approach taken by + Hibernate is much more difficult to implement but arguably more + correct from a relational point of view. If you would like to use + a discriminator column with the table per subclass strategy, you + may combine the use of <literal><subclass></literal> and + <literal><join></literal>, as follow: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + <join table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + <join table="CHEQUE_PAYMENT" fetch="select"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> +</class>]]></programlisting> + + <para> + The optional <literal>fetch="select"</literal> declaration tells Hibernate + not to fetch the <literal>ChequePayment</literal> subclass data using an + outer join when querying the superclass. + </para> + + </sect2> + + <sect2 id="inheritance-mixing-tableperclass-tablepersubclass"> + <title>Mixing table per class hierarchy with table per subclass</title> + + <para> + You may even mix the table per hierarchy and table per subclass strategies + using this approach: + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + For any of these mapping strategies, a polymorphic association to the root + <literal>Payment</literal> class is mapped using + <literal><many-to-one></literal>. + </para> + + <programlisting><![CDATA[<many-to-one name="payment" column="PAYMENT_ID" class="Payment"/>]]></programlisting> + + </sect2> + + <sect2 id="inheritance-tableperconcrete" revision="2"> + <title>Table per concrete class</title> + + <para> + There are two ways we could go about mapping the table per concrete class + strategy. The first is to use <literal><union-subclass></literal>. + </para> + + <programlisting><![CDATA[<class name="Payment"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="sequence"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <union-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </union-subclass> + <union-subclass name="CashPayment" table="CASH_PAYMENT"> + ... + </union-subclass> + <union-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + ... + </union-subclass> +</class>]]></programlisting> + + <para> + Three tables are involved for the subclasses. Each table defines columns for + all properties of the class, including inherited properties. + </para> + + <para> + The limitation of this approach is that if a property is mapped on the + superclass, the column name must be the same on all subclass tables. + (We might relax this in a future release of Hibernate.) The identity + generator strategy is not allowed in union subclass inheritance, indeed + the primary key seed has to be shared accross all unioned subclasses + of a hierarchy. + </para> + + <para> + If your superclass is abstract, map it with <literal>abstract="true"</literal>. + Of course, if it is not abstract, an additional table (defaults to + <literal>PAYMENT</literal> in the example above) is needed to hold instances + of the superclass. + </para> + + </sect2> + + <sect2 id="inheritance-tableperconcreate-polymorphism"> + <title>Table per concrete class, using implicit polymorphism</title> + + <para> + An alternative approach is to make use of implicit polymorphism: + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CREDIT_AMOUNT"/> + ... +</class> + +<class name="CashPayment" table="CASH_PAYMENT"> + <id name="id" type="long" column="CASH_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CASH_AMOUNT"/> + ... +</class> + +<class name="ChequePayment" table="CHEQUE_PAYMENT"> + <id name="id" type="long" column="CHEQUE_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... +</class>]]></programlisting> + + <para> + Notice that nowhere do we mention the <literal>Payment</literal> interface + explicitly. Also notice that properties of <literal>Payment</literal> are + mapped in each of the subclasses. If you want to avoid duplication, consider + using XML entities + (e.g. <literal>[ <!ENTITY allproperties SYSTEM "allproperties.xml"> ]</literal> + in the <literal>DOCTYPE</literal> declartion and + <literal>&allproperties;</literal> in the mapping). + </para> + + <para> + The disadvantage of this approach is that Hibernate does not generate SQL + <literal>UNION</literal>s when performing polymorphic queries. + </para> + + <para> + For this mapping strategy, a polymorphic association to <literal>Payment</literal> + is usually mapped using <literal><any></literal>. + </para> + + <programlisting><![CDATA[<any name="payment" meta-type="string" id-type="long"> + <meta-value value="CREDIT" class="CreditCardPayment"/> + <meta-value value="CASH" class="CashPayment"/> + <meta-value value="CHEQUE" class="ChequePayment"/> + <column name="PAYMENT_CLASS"/> + <column name="PAYMENT_ID"/> +</any>]]></programlisting> + + </sect2> + + <sect2 id="inheritace-mixingpolymorphism"> + <title>Mixing implicit polymorphism with other inheritance mappings</title> + + <para> + There is one further thing to notice about this mapping. Since the subclasses + are each mapped in their own <literal><class></literal> element (and since + <literal>Payment</literal> is just an interface), each of the subclasses could + easily be part of another inheritance hierarchy! (And you can still use polymorphic + queries against the <literal>Payment</literal> interface.) + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="CREDIT_CARD" type="string"/> + <property name="amount" column="CREDIT_AMOUNT"/> + ... + <subclass name="MasterCardPayment" discriminator-value="MDC"/> + <subclass name="VisaPayment" discriminator-value="VISA"/> +</class> + +<class name="NonelectronicTransaction" table="NONELECTRONIC_TXN"> + <id name="id" type="long" column="TXN_ID"> + <generator class="native"/> + </id> + ... + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CASH_AMOUNT"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + Once again, we don't mention <literal>Payment</literal> explicitly. If we + execute a query against the <literal>Payment</literal> interface - for + example, <literal>from Payment</literal> - Hibernate + automatically returns instances of <literal>CreditCardPayment</literal> + (and its subclasses, since they also implement <literal>Payment</literal>), + <literal>CashPayment</literal> and <literal>ChequePayment</literal> but + not instances of <literal>NonelectronicTransaction</literal>. + </para> + + </sect2> + + </sect1> + + <sect1 id="inheritance-limitations"> + <title>Limitations</title> + + <para> + There are certain limitations to the "implicit polymorphism" approach to + the table per concrete-class mapping strategy. There are somewhat less + restrictive limitations to <literal><union-subclass></literal> + mappings. + </para> + + <para> + The following table shows the limitations of table per concrete-class + mappings, and of implicit polymorphism, in Hibernate. + </para> + + <table frame="topbot"> + <title>Features of inheritance mappings</title> + <tgroup cols='8' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <colspec colname='c6' colwidth="1*"/> + <colspec colname='c7' colwidth="1*"/> + <colspec colname='c8' colwidth="1*"/> + <thead> + <row> + <entry>Inheritance strategy</entry> + <entry>Polymorphic many-to-one</entry> + <entry>Polymorphic one-to-one</entry> + <entry>Polymorphic one-to-many</entry> + <entry>Polymorphic many-to-many</entry> + <entry>Polymorphic <literal>load()/get()</literal></entry> + <entry>Polymorphic queries</entry> + <entry>Polymorphic joins</entry> + <entry>Outer join fetching</entry> + </row> + </thead> + <tbody> + <row> + <entry>table per class-hierarchy</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal></entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>supported</emphasis></entry> + </row> + <row> + <entry>table per subclass</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal></entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>supported</emphasis></entry> + </row> + <row> + <entry>table per concrete-class (union-subclass)</entry> + <entry><literal><many-to-one></literal></entry> + <entry><literal><one-to-one></literal></entry> + <entry><literal><one-to-many></literal> (for <literal>inverse="true"</literal> only)</entry> + <entry><literal><many-to-many></literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>supported</emphasis></entry> + </row> + <row> + <entry>table per concrete class (implicit polymorphism)</entry> + <entry><literal><any></literal></entry> + <entry><emphasis>not supported</emphasis></entry> + <entry><emphasis>not supported</emphasis></entry> + <entry><literal><many-to-any></literal></entry> + <entry><literal>s.createCriteria(Payment.class).add( Restrictions.idEq(id) ).uniqueResult()</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><emphasis>not supported</emphasis></entry> + <entry><emphasis>not supported</emphasis></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/performance.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/performance.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/performance.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/performance.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1391 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="performance"> + <title>Improving performance</title> + + <sect1 id="performance-fetching" revision="2"> + <title>Fetching strategies</title> + + <para> + A <emphasis>fetching strategy</emphasis> is the strategy Hibernate will use for + retrieving associated objects if the application needs to navigate the association. + Fetch strategies may be declared in the O/R mapping metadata, or over-ridden by a + particular HQL or <literal>Criteria</literal> query. + </para> + + <para> + Hibernate3 defines the following fetching strategies: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Join fetching</emphasis> - Hibernate retrieves the + associated instance or collection in the same <literal>SELECT</literal>, + using an <literal>OUTER JOIN</literal>. + </para> + </listitem> + <listitem> + <para> + <emphasis>Select fetching</emphasis> - a second <literal>SELECT</literal> + is used to retrieve the associated entity or collection. Unless + you explicitly disable lazy fetching by specifying <literal>lazy="false"</literal>, + this second select will only be executed when you actually access the + association. + </para> + </listitem> + <listitem> + <para> + <emphasis>Subselect fetching</emphasis> - a second <literal>SELECT</literal> + is used to retrieve the associated collections for all entities retrieved in a + previous query or fetch. Unless you explicitly disable lazy fetching by specifying + <literal>lazy="false"</literal>, this second select will only be executed when you + actually access the association. + </para> + </listitem> + <listitem> + <para> + <emphasis>Batch fetching</emphasis> - an optimization strategy + for select fetching - Hibernate retrieves a batch of entity instances + or collections in a single <literal>SELECT</literal>, by specifying + a list of primary keys or foreign keys. + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate also distinguishes between: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Immediate fetching</emphasis> - an association, collection or + attribute is fetched immediately, when the owner is loaded. + </para> + </listitem> + <listitem> + <para> + <emphasis>Lazy collection fetching</emphasis> - a collection is fetched + when the application invokes an operation upon that collection. (This + is the default for collections.) + </para> + </listitem> + <listitem> + <para> + <emphasis>"Extra-lazy" collection fetching</emphasis> - individual + elements of the collection are accessed from the database as needed. + Hibernate tries not to fetch the whole collection into memory unless + absolutely needed (suitable for very large collections) + </para> + </listitem> + <listitem> + <para> + <emphasis>Proxy fetching</emphasis> - a single-valued association is + fetched when a method other than the identifier getter is invoked + upon the associated object. + </para> + </listitem> + <listitem> + <para> + <emphasis>"No-proxy" fetching</emphasis> - a single-valued association is + fetched when the instance variable is accessed. Compared to proxy fetching, + this approach is less lazy (the association is fetched even when only the + identifier is accessed) but more transparent, since no proxy is visible to + the application. This approach requires buildtime bytecode instrumentation + and is rarely necessary. + </para> + </listitem> + <listitem> + <para> + <emphasis>Lazy attribute fetching</emphasis> - an attribute or single + valued association is fetched when the instance variable is accessed. + This approach requires buildtime bytecode instrumentation and is rarely + necessary. + </para> + </listitem> + </itemizedlist> + + <para> + We have two orthogonal notions here: <emphasis>when</emphasis> is the association + fetched, and <emphasis>how</emphasis> is it fetched (what SQL is used). Don't + confuse them! We use <literal>fetch</literal> to tune performance. We may use + <literal>lazy</literal> to define a contract for what data is always available + in any detached instance of a particular class. + </para> + + <sect2 id="performance-fetching-lazy"> + <title>Working with lazy associations</title> + + <para> + By default, Hibernate3 uses lazy select fetching for collections and lazy proxy + fetching for single-valued associations. These defaults make sense for almost + all associations in almost all applications. + </para> + + <para> + <emphasis>Note:</emphasis> if you set + <literal>hibernate.default_batch_fetch_size</literal>, Hibernate will use the + batch fetch optimization for lazy fetching (this optimization may also be enabled + at a more granular level). + </para> + + <para> + However, lazy fetching poses one problem that you must be aware of. Access to a + lazy association outside of the context of an open Hibernate session will result + in an exception. For example: + </para> + + <programlisting><![CDATA[s = sessions.openSession(); +Transaction tx = s.beginTransaction(); + +User u = (User) s.createQuery("from User u where u.name=:userName") + .setString("userName", userName).uniqueResult(); +Map permissions = u.getPermissions(); + +tx.commit(); +s.close(); + +Integer accessLevel = (Integer) permissions.get("accounts"); // Error!]]></programlisting> + + <para> + Since the permissions collection was not initialized when the + <literal>Session</literal> was closed, the collection will not be able to + load its state. <emphasis>Hibernate does not support lazy initialization + for detached objects</emphasis>. The fix is to move the code that reads + from the collection to just before the transaction is committed. + </para> + + <para> + Alternatively, we could use a non-lazy collection or association, + by specifying <literal>lazy="false"</literal> for the association mapping. + However, it is intended that lazy initialization be used for almost all + collections and associations. If you define too many non-lazy associations + in your object model, Hibernate will end up needing to fetch the entire + database into memory in every transaction! + </para> + + <para> + On the other hand, we often want to choose join fetching (which is non-lazy by + nature) instead of select fetching in a particular transaction. We'll now see + how to customize the fetching strategy. In Hibernate3, the mechanisms for + choosing a fetch strategy are identical for single-valued associations and + collections. + </para> + + </sect2> + + <sect2 id="performance-fetching-custom" revision="4"> + <title>Tuning fetch strategies</title> + + <para> + Select fetching (the default) is extremely vulnerable to N+1 selects problems, + so we might want to enable join fetching in the mapping document: + </para> + + <programlisting><![CDATA[<set name="permissions" + fetch="join"> + <key column="userId"/> + <one-to-many class="Permission"/> +</set]]></programlisting> + + <programlisting><![CDATA[<many-to-one name="mother" class="Cat" fetch="join"/>]]></programlisting> + + <para> + The <literal>fetch</literal> strategy defined in the mapping document affects: + </para> + + <itemizedlist> + <listitem> + <para> + retrieval via <literal>get()</literal> or <literal>load()</literal> + </para> + </listitem> + <listitem> + <para> + retrieval that happens implicitly when an association is navigated + </para> + </listitem> + <listitem> + <para> + <literal>Criteria</literal> queries + </para> + </listitem> + <listitem> + <para> + HQL queries if <literal>subselect</literal> fetching is used + </para> + </listitem> + </itemizedlist> + + <para> + No matter what fetching strategy you use, the defined non-lazy graph is guaranteed + to be loaded into memory. Note that this might result in several immediate selects + being used to execute a particular HQL query. + </para> + + <para> + Usually, we don't use the mapping document to customize fetching. Instead, we + keep the default behavior, and override it for a particular transaction, using + <literal>left join fetch</literal> in HQL. This tells Hibernate to fetch + the association eagerly in the first select, using an outer join. In the + <literal>Criteria</literal> query API, you would use + <literal>setFetchMode(FetchMode.JOIN)</literal>. + </para> + + <para> + If you ever feel like you wish you could change the fetching strategy used by + <literal>get()</literal> or <literal>load()</literal>, simply use a + <literal>Criteria</literal> query, for example: + </para> + + <programlisting><![CDATA[User user = (User) session.createCriteria(User.class) + .setFetchMode("permissions", FetchMode.JOIN) + .add( Restrictions.idEq(userId) ) + .uniqueResult();]]></programlisting> + + <para> + (This is Hibernate's equivalent of what some ORM solutions call a "fetch plan".) + </para> + + <para> + A completely different way to avoid problems with N+1 selects is to use the + second-level cache. + </para> + + </sect2> + + <sect2 id="performance-fetching-proxies" revision="2"> + <title>Single-ended association proxies</title> + + <para> + Lazy fetching for collections is implemented using Hibernate's own implementation + of persistent collections. However, a different mechanism is needed for lazy + behavior in single-ended associations. The target entity of the association must + be proxied. Hibernate implements lazy initializing proxies for persistent objects + using runtime bytecode enhancement (via the excellent CGLIB library). + </para> + + <para> + By default, Hibernate3 generates proxies (at startup) for all persistent classes + and uses them to enable lazy fetching of <literal>many-to-one</literal> and + <literal>one-to-one</literal> associations. + </para> + + <para> + The mapping file may declare an interface to use as the proxy interface for that + class, with the <literal>proxy</literal> attribute. By default, Hibernate uses a subclass + of the class. <emphasis>Note that the proxied class must implement a default constructor + with at least package visibility. We recommend this constructor for all persistent classes!</emphasis> + </para> + + <para> + There are some gotchas to be aware of when extending this approach to polymorphic + classes, eg. + </para> + + <programlisting><![CDATA[<class name="Cat" proxy="Cat"> + ...... + <subclass name="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + Firstly, instances of <literal>Cat</literal> will never be castable to + <literal>DomesticCat</literal>, even if the underlying instance is an + instance of <literal>DomesticCat</literal>: + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instantiate a proxy (does not hit the db) +if ( cat.isDomesticCat() ) { // hit the db to initialize the proxy + DomesticCat dc = (DomesticCat) cat; // Error! + .... +}]]></programlisting> + + <para> + Secondly, it is possible to break proxy <literal>==</literal>. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instantiate a Cat proxy +DomesticCat dc = + (DomesticCat) session.load(DomesticCat.class, id); // acquire new DomesticCat proxy! +System.out.println(cat==dc); // false]]></programlisting> + + <para> + However, the situation is not quite as bad as it looks. Even though we now have two references + to different proxy objects, the underlying instance will still be the same object: + </para> + + <programlisting><![CDATA[cat.setWeight(11.0); // hit the db to initialize the proxy +System.out.println( dc.getWeight() ); // 11.0]]></programlisting> + + <para> + Third, you may not use a CGLIB proxy for a <literal>final</literal> class or a class + with any <literal>final</literal> methods. + </para> + + <para> + Finally, if your persistent object acquires any resources upon instantiation (eg. in + initializers or default constructor), then those resources will also be acquired by + the proxy. The proxy class is an actual subclass of the persistent class. + </para> + + <para> + These problems are all due to fundamental limitations in Java's single inheritance model. + If you wish to avoid these problems your persistent classes must each implement an interface + that declares its business methods. You should specify these interfaces in the mapping file. eg. + </para> + + <programlisting><![CDATA[<class name="CatImpl" proxy="Cat"> + ...... + <subclass name="DomesticCatImpl" proxy="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + where <literal>CatImpl</literal> implements the interface <literal>Cat</literal> and + <literal>DomesticCatImpl</literal> implements the interface <literal>DomesticCat</literal>. Then + proxies for instances of <literal>Cat</literal> and <literal>DomesticCat</literal> may be returned + by <literal>load()</literal> or <literal>iterate()</literal>. (Note that <literal>list()</literal> + does not usually return proxies.) + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(CatImpl.class, catid); +Iterator iter = session.createQuery("from CatImpl as cat where cat.name='fritz'").iterate(); +Cat fritz = (Cat) iter.next();]]></programlisting> + + <para> + Relationships are also lazily initialized. This means you must declare any properties to be of + type <literal>Cat</literal>, not <literal>CatImpl</literal>. + </para> + + <para> + Certain operations do <emphasis>not</emphasis> require proxy initialization + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>equals()</literal>, if the persistent class does not override + <literal>equals()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hashCode()</literal>, if the persistent class does not override + <literal>hashCode()</literal> + </para> + </listitem> + <listitem> + <para> + The identifier getter method + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate will detect persistent classes that override <literal>equals()</literal> or + <literal>hashCode()</literal>. + </para> + + <para> + By choosing <literal>lazy="no-proxy"</literal> instead of the default + <literal>lazy="proxy"</literal>, we can avoid the problems associated with typecasting. + However, we will require buildtime bytecode instrumentation, and all operations + will result in immediate proxy initialization. + </para> + + </sect2> + + <sect2 id="performance-fetching-initialization" revision="1"> + <title>Initializing collections and proxies</title> + + <para> + A <literal>LazyInitializationException</literal> will be thrown by Hibernate if an uninitialized + collection or proxy is accessed outside of the scope of the <literal>Session</literal>, ie. when + the entity owning the collection or having the reference to the proxy is in the detached state. + </para> + + <para> + Sometimes we need to ensure that a proxy or collection is initialized before closing the + <literal>Session</literal>. Of course, we can alway force initialization by calling + <literal>cat.getSex()</literal> or <literal>cat.getKittens().size()</literal>, for example. + But that is confusing to readers of the code and is not convenient for generic code. + </para> + + <para> + The static methods <literal>Hibernate.initialize()</literal> and <literal>Hibernate.isInitialized()</literal> + provide the application with a convenient way of working with lazily initialized collections or + proxies. <literal>Hibernate.initialize(cat)</literal> will force the initialization of a proxy, + <literal>cat</literal>, as long as its <literal>Session</literal> is still open. + <literal>Hibernate.initialize( cat.getKittens() )</literal> has a similar effect for the collection + of kittens. + </para> + + <para> + Another option is to keep the <literal>Session</literal> open until all needed + collections and proxies have been loaded. In some application architectures, + particularly where the code that accesses data using Hibernate, and the code that + uses it are in different application layers or different physical processes, it + can be a problem to ensure that the <literal>Session</literal> is open when a + collection is initialized. There are two basic ways to deal with this issue: + </para> + + <itemizedlist> + <listitem> + <para> + In a web-based application, a servlet filter can be used to close the + <literal>Session</literal> only at the very end of a user request, once + the rendering of the view is complete (the <emphasis>Open Session in + View</emphasis> pattern). Of course, this places heavy demands on the + correctness of the exception handling of your application infrastructure. + It is vitally important that the <literal>Session</literal> is closed and the + transaction ended before returning to the user, even when an exception occurs + during rendering of the view. See the Hibernate Wiki for examples of this + "Open Session in View" pattern. + </para> + </listitem> + <listitem> + <para> + In an application with a separate business tier, the business logic must + "prepare" all collections that will be needed by the web tier before + returning. This means that the business tier should load all the data and + return all the data already initialized to the presentation/web tier that + is required for a particular use case. Usually, the application calls + <literal>Hibernate.initialize()</literal> for each collection that will + be needed in the web tier (this call must occur before the session is closed) + or retrieves the collection eagerly using a Hibernate query with a + <literal>FETCH</literal> clause or a <literal>FetchMode.JOIN</literal> in + <literal>Criteria</literal>. This is usually easier if you adopt the + <emphasis>Command</emphasis> pattern instead of a <emphasis>Session Facade</emphasis>. + </para> + </listitem> + <listitem> + <para> + You may also attach a previously loaded object to a new <literal>Session</literal> + with <literal>merge()</literal> or <literal>lock()</literal> before + accessing uninitialized collections (or other proxies). No, Hibernate does not, + and certainly <emphasis>should</emphasis> not do this automatically, since it + would introduce ad hoc transaction semantics! + </para> + </listitem> + </itemizedlist> + + <para> + Sometimes you don't want to initialize a large collection, but still need some + information about it (like its size) or a subset of the data. + </para> + + <para> + You can use a collection filter to get the size of a collection without initializing it: + </para> + + <programlisting><![CDATA[( (Integer) s.createFilter( collection, "select count(*)" ).list().get(0) ).intValue()]]></programlisting> + + <para> + The <literal>createFilter()</literal> method is also used to efficiently retrieve subsets + of a collection without needing to initialize the whole collection: + </para> + + <programlisting><![CDATA[s.createFilter( lazyCollection, "").setFirstResult(0).setMaxResults(10).list();]]></programlisting> + + </sect2> + + <sect2 id="performance-fetching-batch"> + <title>Using batch fetching</title> + + <para> + Hibernate can make efficient use of batch fetching, that is, Hibernate can load several uninitialized + proxies if one proxy is accessed (or collections. Batch fetching is an optimization of the lazy select + fetching strategy. There are two ways you can tune batch fetching: on the class and the collection level. + </para> + + <para> + Batch fetching for classes/entities is easier to understand. Imagine you have the following situation + at runtime: You have 25 <literal>Cat</literal> instances loaded in a <literal>Session</literal>, each + <literal>Cat</literal> has a reference to its <literal>owner</literal>, a <literal>Person</literal>. + The <literal>Person</literal> class is mapped with a proxy, <literal>lazy="true"</literal>. If you now + iterate through all cats and call <literal>getOwner()</literal> on each, Hibernate will by default + execute 25 <literal>SELECT</literal> statements, to retrieve the proxied owners. You can tune this + behavior by specifying a <literal>batch-size</literal> in the mapping of <literal>Person</literal>: + </para> + + <programlisting><![CDATA[<class name="Person" batch-size="10">...</class>]]></programlisting> + + <para> + Hibernate will now execute only three queries, the pattern is 10, 10, 5. + </para> + + <para> + You may also enable batch fetching of collections. For example, if each <literal>Person</literal> has + a lazy collection of <literal>Cat</literal>s, and 10 persons are currently loaded in the + <literal>Sesssion</literal>, iterating through all persons will generate 10 <literal>SELECT</literal>s, + one for every call to <literal>getCats()</literal>. If you enable batch fetching for the + <literal>cats</literal> collection in the mapping of <literal>Person</literal>, Hibernate can pre-fetch + collections: + </para> + + <programlisting><![CDATA[<class name="Person"> + <set name="cats" batch-size="3"> + ... + </set> +</class>]]></programlisting> + + <para> + With a <literal>batch-size</literal> of 3, Hibernate will load 3, 3, 3, 1 collections in four + <literal>SELECT</literal>s. Again, the value of the attribute depends on the expected number of + uninitialized collections in a particular <literal>Session</literal>. + </para> + + <para> + Batch fetching of collections is particularly useful if you have a nested tree of items, ie. + the typical bill-of-materials pattern. (Although a <emphasis>nested set</emphasis> or a + <emphasis>materialized path</emphasis> might be a better option for read-mostly trees.) + </para> + + </sect2> + + <sect2 id="performance-fetching-subselect"> + <title>Using subselect fetching</title> + + <para> + If one lazy collection or single-valued proxy has to be fetched, Hibernate loads all of + them, re-running the original query in a subselect. This works in the same way as + batch-fetching, without the piecemeal loading. + </para> + +  + + </sect2> + + <sect2 id="performance-fetching-lazyproperties"> + <title>Using lazy property fetching</title> + + <para> + Hibernate3 supports the lazy fetching of individual properties. This optimization technique + is also known as <emphasis>fetch groups</emphasis>. Please note that this is mostly a + marketing feature, as in practice, optimizing row reads is much more important than + optimization of column reads. However, only loading some properties of a class might + be useful in extreme cases, when legacy tables have hundreds of columns and the data model + can not be improved. + </para> + + <para> + To enable lazy property loading, set the <literal>lazy</literal> attribute on your + particular property mappings: + </para> + + <programlisting><![CDATA[<class name="Document"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name" not-null="true" length="50"/> + <property name="summary" not-null="true" length="200" lazy="true"/> + <property name="text" not-null="true" length="2000" lazy="true"/> +</class>]]></programlisting> + + <para> + Lazy property loading requires buildtime bytecode instrumentation! If your persistent + classes are not enhanced, Hibernate will silently ignore lazy property settings and + fall back to immediate fetching. + </para> + + <para> + For bytecode instrumentation, use the following Ant task: + </para> + + <programlisting><![CDATA[<target name="instrument" depends="compile"> + <taskdef name="instrument" classname="org.hibernate.tool.instrument.InstrumentTask"> + <classpath path="${jar.path}"/> + <classpath path="${classes.dir}"/> + <classpath refid="lib.class.path"/> + </taskdef> + + <instrument verbose="true"> + <fileset dir="${testclasses.dir}/org/hibernate/auction/model"> + <include name="*.class"/> + </fileset> + </instrument> +</target>]]></programlisting> + + <para> + A different (better?) way to avoid unnecessary column reads, at least for + read-only transactions is to use the projection features of HQL or Criteria + queries. This avoids the need for buildtime bytecode processing and is + certainly a prefered solution. + </para> + + <para> + You may force the usual eager fetching of properties using <literal>fetch all + properties</literal> in HQL. + </para> + + </sect2> + + </sect1> + + <sect1 id="performance-cache" revision="1"> + <title>The Second Level Cache</title> + + <para> + A Hibernate <literal>Session</literal> is a transaction-level cache of persistent data. It is + possible to configure a cluster or JVM-level (<literal>SessionFactory</literal>-level) cache on + a class-by-class and collection-by-collection basis. You may even plug in a clustered cache. Be + careful. Caches are never aware of changes made to the persistent store by another application + (though they may be configured to regularly expire cached data). + </para> + + <para revision="1"> + You have the option to tell Hibernate which caching implementation to use by + specifying the name of a class that implements <literal>org.hibernate.cache.CacheProvider</literal> + using the property <literal>hibernate.cache.provider_class</literal>. Hibernate + comes bundled with a number of built-in integrations with open-source cache providers + (listed below); additionally, you could implement your own and plug it in as + outlined above. Note that versions prior to 3.2 defaulted to use EhCache as the + default cache provider; that is no longer the case as of 3.2. + </para> + + <table frame="topbot" id="cacheproviders" revision="1"> + <title>Cache Providers</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Cache</entry> + <entry>Provider class</entry> + <entry>Type</entry> + <entry>Cluster Safe</entry> + <entry>Query Cache Supported</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (not intended for production use)</entry> + <entry><literal>org.hibernate.cache.HashtableCacheProvider</literal></entry> + <entry>memory</entry> + <entry></entry> + <entry>yes</entry> + </row> + <row> + <entry>EHCache</entry> + <entry><literal>org.hibernate.cache.EhCacheProvider</literal></entry> + <entry>memory, disk</entry> + <entry></entry> + <entry>yes</entry> + </row> + <row> + <entry>OSCache</entry> + <entry><literal>org.hibernate.cache.OSCacheProvider</literal></entry> + <entry>memory, disk</entry> + <entry></entry> + <entry>yes</entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry><literal>org.hibernate.cache.SwarmCacheProvider</literal></entry> + <entry>clustered (ip multicast)</entry> + <entry>yes (clustered invalidation)</entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry><literal>org.hibernate.cache.TreeCacheProvider</literal></entry> + <entry>clustered (ip multicast), transactional</entry> + <entry>yes (replication)</entry> + <entry>yes (clock sync req.)</entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="performance-cache-mapping" revision="2"> + <title>Cache mappings</title> + + <para> + The <literal><cache></literal> element of a class or collection mapping has the + following form: + </para> + + <programlistingco> + <areaspec> + <area id="cache1" coords="2 70"/> + <area id="cache2" coords="3 70"/> + <area id="cache3" coords="4 70"/> + </areaspec> + <programlisting><![CDATA[<cache + usage="transactional|read-write|nonstrict-read-write|read-only" + region="RegionName" + include="all|non-lazy" +/>]]></programlisting> + <calloutlist> + <callout arearefs="cache1"> + <para> + <literal>usage</literal> (required) specifies the caching strategy: + <literal>transactional</literal>, + <literal>read-write</literal>, + <literal>nonstrict-read-write</literal> or + <literal>read-only</literal> + </para> + </callout> + <callout arearefs="cache2"> + <para> + <literal>region</literal> (optional, defaults to the class or + collection role name) specifies the name of the second level cache + region + </para> + </callout> + <callout arearefs="cache3"> + <para> + <literal>include</literal> (optional, defaults to <literal>all</literal>) + <literal>non-lazy</literal> specifies that properties of the entity mapped + with <literal>lazy="true"</literal> may not be cached when attribute-level + lazy fetching is enabled + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + Alternatively (preferrably?), you may specify <literal><class-cache></literal> and + <literal><collection-cache></literal> elements in <literal>hibernate.cfg.xml</literal>. + </para> + + <para> + The <literal>usage</literal> attribute specifies a <emphasis>cache concurrency strategy</emphasis>. + </para> + + </sect2> + + <sect2 id="performance-cache-readonly"> + <title>Strategy: read only</title> + + <para> + If your application needs to read but never modify instances of a persistent class, a + <literal>read-only</literal> cache may be used. This is the simplest and best performing + strategy. It's even perfectly safe for use in a cluster. + </para> + + <programlisting><![CDATA[<class name="eg.Immutable" mutable="false"> + <cache usage="read-only"/> + .... +</class>]]></programlisting> + + </sect2> + + + <sect2 id="performance-cache-readwrite"> + <title>Strategy: read/write</title> + + <para> + If the application needs to update data, a <literal>read-write</literal> cache might be appropriate. + This cache strategy should never be used if serializable transaction isolation level is required. + If the cache is used in a JTA environment, you must specify the property + <literal>hibernate.transaction.manager_lookup_class</literal>, naming a strategy for obtaining the + JTA <literal>TransactionManager</literal>. In other environments, you should ensure that the transaction + is completed when <literal>Session.close()</literal> or <literal>Session.disconnect()</literal> is called. + If you wish to use this strategy in a cluster, you should ensure that the underlying cache implementation + supports locking. The built-in cache providers do <emphasis>not</emphasis>. + </para> + + <programlisting><![CDATA[<class name="eg.Cat" .... > + <cache usage="read-write"/> + .... + <set name="kittens" ... > + <cache usage="read-write"/> + .... + </set> +</class>]]></programlisting> + + </sect2> + + <sect2 id="performance-cache-nonstrict"> + <title>Strategy: nonstrict read/write</title> + + <para> + If the application only occasionally needs to update data (ie. if it is extremely unlikely that two + transactions would try to update the same item simultaneously) and strict transaction isolation is + not required, a <literal>nonstrict-read-write</literal> cache might be appropriate. If the cache is + used in a JTA environment, you must specify <literal>hibernate.transaction.manager_lookup_class</literal>. + In other environments, you should ensure that the transaction is completed when + <literal>Session.close()</literal> or <literal>Session.disconnect()</literal> is called. + </para> + + </sect2> + + <sect2 id="performance-cache-transactional"> + <title>Strategy: transactional</title> + + <para> + The <literal>transactional</literal> cache strategy provides support for fully transactional cache + providers such as JBoss TreeCache. Such a cache may only be used in a JTA environment and you must + specify <literal>hibernate.transaction.manager_lookup_class</literal>. + </para> + + </sect2> + + <para> + None of the cache providers support all of the cache concurrency strategies. The following table shows + which providers are compatible with which concurrency strategies. + </para> + + <table frame="topbot"> + <title>Cache Concurrency Strategy Support</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Cache</entry> + <entry>read-only</entry> + <entry>nonstrict-read-write</entry> + <entry>read-write</entry> + <entry>transactional</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (not intended for production use)</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + </row> + <row> + <entry>EHCache</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + </row> + <row> + <entry>OSCache</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry>yes</entry> + <entry></entry> + <entry></entry> + <entry>yes</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + + <sect1 id="performance-sessioncache" revision="2"> + <title>Managing the caches</title> + + <para> + Whenever you pass an object to <literal>save()</literal>, <literal>update()</literal> + or <literal>saveOrUpdate()</literal> and whenever you retrieve an object using + <literal>load()</literal>, <literal>get()</literal>, <literal>list()</literal>, + <literal>iterate()</literal> or <literal>scroll()</literal>, that object is added + to the internal cache of the <literal>Session</literal>. + </para> + <para> + When <literal>flush()</literal> is subsequently called, the state of that object will + be synchronized with the database. If you do not want this synchronization to occur or + if you are processing a huge number of objects and need to manage memory efficiently, + the <literal>evict()</literal> method may be used to remove the object and its collections + from the first-level cache. + </para> + + <programlisting><![CDATA[ScrollableResult cats = sess.createQuery("from Cat as cat").scroll(); //a huge result set +while ( cats.next() ) { + Cat cat = (Cat) cats.get(0); + doSomethingWithACat(cat); + sess.evict(cat); +}]]></programlisting> + + <para> + The <literal>Session</literal> also provides a <literal>contains()</literal> method to determine + if an instance belongs to the session cache. + </para> + + <para> + To completely evict all objects from the session cache, call <literal>Session.clear()</literal> + </para> + + <para> + For the second-level cache, there are methods defined on <literal>SessionFactory</literal> for + evicting the cached state of an instance, entire class, collection instance or entire collection + role. + </para> + + <programlisting><![CDATA[sessionFactory.evict(Cat.class, catId); //evict a particular Cat +sessionFactory.evict(Cat.class); //evict all Cats +sessionFactory.evictCollection("Cat.kittens", catId); //evict a particular collection of kittens +sessionFactory.evictCollection("Cat.kittens"); //evict all kitten collections]]></programlisting> + + <para> + The <literal>CacheMode</literal> controls how a particular session interacts with the second-level + cache. + </para> + + <itemizedlist> + <listitem> + <para> + <literal>CacheMode.NORMAL</literal> - read items from and write items to the second-level cache + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.GET</literal> - read items from the second-level cache, but don't write to + the second-level cache except when updating data + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.PUT</literal> - write items to the second-level cache, but don't read from + the second-level cache + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.REFRESH</literal> - write items to the second-level cache, but don't read from + the second-level cache, bypass the effect of <literal>hibernate.cache.use_minimal_puts</literal>, forcing + a refresh of the second-level cache for all items read from the database + </para> + </listitem> + </itemizedlist> + + <para> + To browse the contents of a second-level or query cache region, use the <literal>Statistics</literal> + API: + </para> + + <programlisting><![CDATA[Map cacheEntries = sessionFactory.getStatistics() + .getSecondLevelCacheStatistics(regionName) + .getEntries();]]></programlisting> + + <para> + You'll need to enable statistics, and, optionally, force Hibernate to keep the cache entries in a + more human-understandable format: + </para> + + <programlisting><![CDATA[hibernate.generate_statistics true +hibernate.cache.use_structured_entries true]]></programlisting> + + </sect1> + + <sect1 id="performance-querycache" revision="1"> + <title>The Query Cache</title> + + <para> + Query result sets may also be cached. This is only useful for queries that are run + frequently with the same parameters. To use the query cache you must first enable it: + </para> + + <programlisting><![CDATA[hibernate.cache.use_query_cache true]]></programlisting> + + <para> + This setting causes the creation of two new cache regions - one holding cached query + result sets (<literal>org.hibernate.cache.StandardQueryCache</literal>), the other + holding timestamps of the most recent updates to queryable tables + (<literal>org.hibernate.cache.UpdateTimestampsCache</literal>). Note that the query + cache does not cache the state of the actual entities in the result set; it caches + only identifier values and results of value type. So the query cache should always be + used in conjunction with the second-level cache. + </para> + + <para> + Most queries do not benefit from caching, so by default queries are not cached. To + enable caching, call <literal>Query.setCacheable(true)</literal>. This call allows + the query to look for existing cache results or add its results to the cache when + it is executed. + </para> + + <para> + If you require fine-grained control over query cache expiration policies, you may + specify a named cache region for a particular query by calling + <literal>Query.setCacheRegion()</literal>. + </para> + + <programlisting><![CDATA[List blogs = sess.createQuery("from Blog blog where blog.blogger = :blogger") + .setEntity("blogger", blogger) + .setMaxResults(15) + .setCacheable(true) + .setCacheRegion("frontpages") + .list();]]></programlisting> + + <para> + If the query should force a refresh of its query cache region, you should call + <literal>Query.setCacheMode(CacheMode.REFRESH)</literal>. This is particularly useful + in cases where underlying data may have been updated via a separate process (i.e., + not modified through Hibernate) and allows the application to selectively refresh + particular query result sets. This is a more efficient alternative to eviction of + a query cache region via <literal>SessionFactory.evictQueries()</literal>. + </para> + + </sect1> + + <sect1 id="performance-collections"> + <title>Understanding Collection performance</title> + + <para> + We've already spent quite some time talking about collections. + In this section we will highlight a couple more issues about + how collections behave at runtime. + </para> + + <sect2 id="performance-collections-taxonomy"> + <title>Taxonomy</title> + + <para>Hibernate defines three basic kinds of collections:</para> + + <itemizedlist> + <listitem> + <para>collections of values</para> + </listitem> + <listitem> + <para>one to many associations</para> + </listitem> + <listitem> + <para>many to many associations</para> + </listitem> + </itemizedlist> + + <para> + This classification distinguishes the various table and foreign key + relationships but does not tell us quite everything we need to know + about the relational model. To fully understand the relational structure + and performance characteristics, we must also consider the structure of + the primary key that is used by Hibernate to update or delete collection + rows. This suggests the following classification: + </para> + + <itemizedlist> + <listitem> + <para>indexed collections</para> + </listitem> + <listitem> + <para>sets</para> + </listitem> + <listitem> + <para>bags</para> + </listitem> + </itemizedlist> + + <para> + All indexed collections (maps, lists, arrays) have a primary key consisting + of the <literal><key></literal> and <literal><index></literal> + columns. In this case collection updates are usually extremely efficient - + the primary key may be efficiently indexed and a particular row may be efficiently + located when Hibernate tries to update or delete it. + </para> + + <para> + Sets have a primary key consisting of <literal><key></literal> and element + columns. This may be less efficient for some types of collection element, particularly + composite elements or large text or binary fields; the database may not be able to index + a complex primary key as efficently. On the other hand, for one to many or many to many + associations, particularly in the case of synthetic identifiers, it is likely to be just + as efficient. (Side-note: if you want <literal>SchemaExport</literal> to actually create + the primary key of a <literal><set></literal> for you, you must declare all columns + as <literal>not-null="true"</literal>.) + </para> + + <para> + <literal><idbag></literal> mappings define a surrogate key, so they are + always very efficient to update. In fact, they are the best case. + </para> + + <para> + Bags are the worst case. Since a bag permits duplicate element values and has no + index column, no primary key may be defined. Hibernate has no way of distinguishing + between duplicate rows. Hibernate resolves this problem by completely removing + (in a single <literal>DELETE</literal>) and recreating the collection whenever it + changes. This might be very inefficient. + </para> + + <para> + Note that for a one-to-many association, the "primary key" may not be the physical + primary key of the database table - but even in this case, the above classification + is still useful. (It still reflects how Hibernate "locates" individual rows of the + collection.) + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficientupdate"> + <title>Lists, maps, idbags and sets are the most efficient collections to update</title> + + <para> + From the discussion above, it should be clear that indexed collections + and (usually) sets allow the most efficient operation in terms of adding, + removing and updating elements. + </para> + + <para> + There is, arguably, one more advantage that indexed collections have over sets for + many to many associations or collections of values. Because of the structure of a + <literal>Set</literal>, Hibernate doesn't ever <literal>UPDATE</literal> a row when + an element is "changed". Changes to a <literal>Set</literal> always work via + <literal>INSERT</literal> and <literal>DELETE</literal> (of individual rows). Once + again, this consideration does not apply to one to many associations. + </para> + + <para> + After observing that arrays cannot be lazy, we would conclude that lists, maps and + idbags are the most performant (non-inverse) collection types, with sets not far + behind. Sets are expected to be the most common kind of collection in Hibernate + applications. This is because the "set" semantics are most natural in the relational + model. + </para> + + <para> + However, in well-designed Hibernate domain models, we usually see that most collections + are in fact one-to-many associations with <literal>inverse="true"</literal>. For these + associations, the update is handled by the many-to-one end of the association, and so + considerations of collection update performance simply do not apply. + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficentinverse"> + <title>Bags and lists are the most efficient inverse collections</title> + + <para> + Just before you ditch bags forever, there is a particular case in which bags (and also lists) + are much more performant than sets. For a collection with <literal>inverse="true"</literal> + (the standard bidirectional one-to-many relationship idiom, for example) we can add elements + to a bag or list without needing to initialize (fetch) the bag elements! This is because + <literal>Collection.add()</literal> or <literal>Collection.addAll()</literal> must always + return true for a bag or <literal>List</literal> (unlike a <literal>Set</literal>). This can + make the following common code much faster. + </para> + + <programlisting><![CDATA[Parent p = (Parent) sess.load(Parent.class, id); +Child c = new Child(); +c.setParent(p); +p.getChildren().add(c); //no need to fetch the collection! +sess.flush();]]></programlisting> + + </sect2> + + <sect2 id="performance-collections-oneshotdelete"> + <title>One shot delete</title> + + <para> + Occasionally, deleting collection elements one by one can be extremely inefficient. Hibernate + isn't completely stupid, so it knows not to do that in the case of an newly-empty collection + (if you called <literal>list.clear()</literal>, for example). In this case, Hibernate will + issue a single <literal>DELETE</literal> and we are done! + </para> + + <para> + Suppose we add a single element to a collection of size twenty and then remove two elements. + Hibernate will issue one <literal>INSERT</literal> statement and two <literal>DELETE</literal> + statements (unless the collection is a bag). This is certainly desirable. + </para> + + <para> + However, suppose that we remove eighteen elements, leaving two and then add thee new elements. + There are two possible ways to proceed + </para> + + <itemizedlist> + <listitem> + <para>delete eighteen rows one by one and then insert three rows</para> + </listitem> + <listitem> + <para>remove the whole collection (in one SQL <literal>DELETE</literal>) and insert + all five current elements (one by one)</para> + </listitem> + </itemizedlist> + + <para> + Hibernate isn't smart enough to know that the second option is probably quicker in this case. + (And it would probably be undesirable for Hibernate to be that smart; such behaviour might + confuse database triggers, etc.) + </para> + + <para> + Fortunately, you can force this behaviour (ie. the second strategy) at any time by discarding + (ie. dereferencing) the original collection and returning a newly instantiated collection with + all the current elements. This can be very useful and powerful from time to time. + </para> + + <para> + Of course, one-shot-delete does not apply to collections mapped <literal>inverse="true"</literal>. + </para> + + </sect2> + + </sect1> + + <sect1 id="performance-monitoring" revision="1"> + <title>Monitoring performance</title> + + <para> + Optimization is not much use without monitoring and access to performance numbers. + Hibernate provides a full range of figures about its internal operations. + Statistics in Hibernate are available per <literal>SessionFactory</literal>. + </para> + + <sect2 id="performance-monitoring-sf" revision="2"> + <title>Monitoring a SessionFactory</title> + + <para> + You can access <literal>SessionFactory</literal> metrics in two ways. + Your first option is to call <literal>sessionFactory.getStatistics()</literal> and + read or display the <literal>Statistics</literal> yourself. + </para> + + <para> + Hibernate can also use JMX to publish metrics if you enable the + <literal>StatisticsService</literal> MBean. You may enable a single MBean for all your + <literal>SessionFactory</literal> or one per factory. See the following code for + minimalistic configuration examples: + </para> + + <programlisting><![CDATA[// MBean service registration for a specific SessionFactory +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "myFinancialApp"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +stats.setSessionFactory(sessionFactory); // Bind the stats to a SessionFactory +server.registerMBean(stats, on); // Register the Mbean on the server]]></programlisting> + + +<programlisting><![CDATA[// MBean service registration for all SessionFactory's +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "all"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +server.registerMBean(stats, on); // Register the MBean on the server]]></programlisting> + + <para> + TODO: This doesn't make sense: In the first case, we retrieve and use the MBean directly. In the second one, we must give + the JNDI name in which the session factory is held before using it. Use + <literal>hibernateStatsBean.setSessionFactoryJNDIName("my/JNDI/Name")</literal> + </para> + <para> + You can (de)activate the monitoring for a <literal>SessionFactory</literal> + </para> + <itemizedlist> + <listitem> + <para> + at configuration time, set <literal>hibernate.generate_statistics</literal> to <literal>false</literal> + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + at runtime: <literal>sf.getStatistics().setStatisticsEnabled(true)</literal> + or <literal>hibernateStatsBean.setStatisticsEnabled(true)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + Statistics can be reset programatically using the <literal>clear()</literal> method. + A summary can be sent to a logger (info level) using the <literal>logSummary()</literal> + method. + </para> + + </sect2> + + <sect2 id="performance-monitoring-metrics" revision="1"> + <title>Metrics</title> + + <para> + Hibernate provides a number of metrics, from very basic to the specialized information + only relevant in certain scenarios. All available counters are described in the + <literal>Statistics</literal> interface API, in three categories: + </para> + <itemizedlist> + <listitem> + <para> + Metrics related to the general <literal>Session</literal> usage, such as + number of open sessions, retrieved JDBC connections, etc. + </para> + </listitem> + <listitem> + <para> + Metrics related to he entities, collections, queries, and caches as a + whole (aka global metrics), + </para> + </listitem> + <listitem> + <para> + Detailed metrics related to a particular entity, collection, query or + cache region. + </para> + </listitem> + </itemizedlist> + + <para> + For exampl,e you can check the cache hit, miss, and put ratio of entities, collections + and queries, and the average time a query needs. Beware that the number of milliseconds + is subject to approximation in Java. Hibernate is tied to the JVM precision, on some + platforms this might even only be accurate to 10 seconds. + </para> + + <para> + Simple getters are used to access the global metrics (i.e. not tied to a particular entity, + collection, cache region, etc.). You can access the metrics of a particular entity, collection + or cache region through its name, and through its HQL or SQL representation for queries. Please + refer to the <literal>Statistics</literal>, <literal>EntityStatistics</literal>, + <literal>CollectionStatistics</literal>, <literal>SecondLevelCacheStatistics</literal>, + and <literal>QueryStatistics</literal> API Javadoc for more information. The following + code shows a simple example: + </para> + + <programlisting><![CDATA[Statistics stats = HibernateUtil.sessionFactory.getStatistics(); + +double queryCacheHitCount = stats.getQueryCacheHitCount(); +double queryCacheMissCount = stats.getQueryCacheMissCount(); +double queryCacheHitRatio = + queryCacheHitCount / (queryCacheHitCount + queryCacheMissCount); + +log.info("Query Hit ratio:" + queryCacheHitRatio); + +EntityStatistics entityStats = + stats.getEntityStatistics( Cat.class.getName() ); +long changes = + entityStats.getInsertCount() + + entityStats.getUpdateCount() + + entityStats.getDeleteCount(); +log.info(Cat.class.getName() + " changed " + changes + "times" );]]></programlisting> + + <para> + To work on all entities, collections, queries and region caches, you can retrieve + the list of names of entities, collections, queries and region caches with the + following methods: <literal>getQueries()</literal>, <literal>getEntityNames()</literal>, + <literal>getCollectionRoleNames()</literal>, and + <literal>getSecondLevelCacheRegionNames()</literal>. + </para> + + </sect2> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/persistent_classes.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/persistent_classes.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/persistent_classes.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/persistent_classes.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,534 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="persistent-classes" revision="2"> + <title>Persistent Classes</title> + + <para> + Persistent classes are classes in an application that implement the entities + of the business problem (e.g. Customer and Order in an E-commerce application). + Not all instances of a persistent class are considered to be in the persistent + state - an instance may instead be transient or detached. + </para> + + <para> + Hibernate works best if these classes follow some simple rules, also known + as the Plain Old Java Object (POJO) programming model. However, none of these + rules are hard requirements. Indeed, Hibernate3 assumes very little about + the nature of your persistent objects. You may express a domain model in other + ways: using trees of <literal>Map</literal> instances, for example. + </para> + + <sect1 id="persistent-classes-pojo"> + <title>A simple POJO example</title> + + <para> + Most Java applications require a persistent class representing felines. + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +public class Cat { + private Long id; // identifier + + private Date birthdate; + private Color color; + private char sex; + private float weight; + private int litterId; + + private Cat mother; + private Set kittens = new HashSet(); + + private void setId(Long id) { + this.id=id; + } + public Long getId() { + return id; + } + + void setBirthdate(Date date) { + birthdate = date; + } + public Date getBirthdate() { + return birthdate; + } + + void setWeight(float weight) { + this.weight = weight; + } + public float getWeight() { + return weight; + } + + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + + void setSex(char sex) { + this.sex=sex; + } + public char getSex() { + return sex; + } + + void setLitterId(int id) { + this.litterId = id; + } + public int getLitterId() { + return litterId; + } + + void setMother(Cat mother) { + this.mother = mother; + } + public Cat getMother() { + return mother; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + public Set getKittens() { + return kittens; + } + + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kitten.setMother(this); + kitten.setLitterId( kittens.size() ); + kittens.add(kitten); + } +}]]></programlisting> + + <para> + There are four main rules to follow here: + </para> + + + <sect2 id="persistent-classes-pojo-constructor" revision="1"> + <title>Implement a no-argument constructor</title> + + <para> + <literal>Cat</literal> has a no-argument constructor. All persistent classes must + have a default constructor (which may be non-public) so that Hibernate can instantiate + them using <literal>Constructor.newInstance()</literal>. We strongly recommend having a + default constructor with at least <emphasis>package</emphasis> visibility for runtime proxy + generation in Hibernate. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-identifier" revision="2"> + <title>Provide an identifier property (optional)</title> + + <para> + <literal>Cat</literal> has a property called <literal>id</literal>. This property + maps to the primary key column of a database table. The property might have been called + anything, and its type might have been any primitive type, any primitive "wrapper" + type, <literal>java.lang.String</literal> or <literal>java.util.Date</literal>. (If + your legacy database table has composite keys, you can even use a user-defined class + with properties of these types - see the section on composite identifiers later.) + </para> + + <para> + The identifier property is strictly optional. You can leave them off and let Hibernate + keep track of object identifiers internally. We do not recommend this, however. + </para> + + <para> + In fact, some functionality is available only to classes which declare an + identifier property: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Transitive reattachment for detached objects (cascade update or cascade + merge) - see <xref linkend="objectstate-transitive"/> + </para> + </listitem> + <listitem> + <para> + <literal>Session.saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>Session.merge()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + We recommend you declare consistently-named identifier properties on persistent + classes. We further recommend that you use a nullable (ie. non-primitive) type. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-final"> + <title>Prefer non-final classes (optional)</title> + <para> + A central feature of Hibernate, <emphasis>proxies</emphasis>, depends upon the + persistent class being either non-final, or the implementation of an interface + that declares all public methods. + </para> + <para> + You can persist <literal>final</literal> classes that do not implement an interface + with Hibernate, but you won't be able to use proxies for lazy association fetching - + which will limit your options for performance tuning. + </para> + <para> + You should also avoid declaring <literal>public final</literal> methods on the + non-final classes. If you want to use a class with a <literal>public final</literal> + method, you must explicitly disable proxying by setting <literal>lazy="false"</literal>. + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-accessors" revision="2"> + <title>Declare accessors and mutators for persistent fields (optional)</title> + + <para> + <literal>Cat</literal> declares accessor methods for all its persistent fields. + Many other ORM tools directly persist instance variables. We believe it is + better to provide an indirection between the relational schema and internal + data structures of the class. By default, Hibernate persists JavaBeans style + properties, and recognizes method names of the form <literal>getFoo</literal>, + <literal>isFoo</literal> and <literal>setFoo</literal>. You may switch to direct + field access for particular properties, if needed. + </para> + + <para> + Properties need <emphasis>not</emphasis> be declared public - Hibernate can + persist a property with a default, <literal>protected</literal> or + <literal>private</literal> get / set pair. + </para> + + </sect2> + + </sect1> + + <sect1 id="persistent-classes-inheritance"> + <title>Implementing inheritance</title> + + <para> + A subclass must also observe the first and second rules. It inherits its + identifier property from the superclass, <literal>Cat</literal>. + </para> + + <programlisting><![CDATA[package eg; + +public class DomesticCat extends Cat { + private String name; + + public String getName() { + return name; + } + protected void setName(String name) { + this.name=name; + } +}]]></programlisting> + </sect1> + + <sect1 id="persistent-classes-equalshashcode" revision="1"> + <title>Implementing <literal>equals()</literal> and <literal>hashCode()</literal></title> + + <para> + You have to override the <literal>equals()</literal> and <literal>hashCode()</literal> + methods if you + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + intend to put instances of persistent classes in a <literal>Set</literal> + (the recommended way to represent many-valued associations) + <emphasis>and</emphasis> + </para> + </listitem> + <listitem> + <para> + intend to use reattachment of detached instances + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate guarantees equivalence of persistent identity (database row) and Java identity + only inside a particular session scope. So as soon as we mix instances retrieved in + different sessions, we must implement <literal>equals()</literal> and + <literal>hashCode()</literal> if we wish to have meaningful semantics for + <literal>Set</literal>s. + </para> + + <para> + The most obvious way is to implement <literal>equals()</literal>/<literal>hashCode()</literal> + by comparing the identifier value of both objects. If the value is the same, both must + be the same database row, they are therefore equal (if both are added to a <literal>Set</literal>, + we will only have one element in the <literal>Set</literal>). Unfortunately, we can't use that + approach with generated identifiers! Hibernate will only assign identifier values to objects + that are persistent, a newly created instance will not have any identifier value! Furthermore, + if an instance is unsaved and currently in a <literal>Set</literal>, saving it will assign + an identifier value to the object. If <literal>equals()</literal> and <literal>hashCode()</literal> + are based on the identifier value, the hash code would change, breaking the contract of the + <literal>Set</literal>. See the Hibernate website for a full discussion of this problem. Note + that this is not a Hibernate issue, but normal Java semantics of object identity and equality. + </para> + + <para> + We recommend implementing <literal>equals()</literal> and <literal>hashCode()</literal> + using <emphasis>Business key equality</emphasis>. Business key equality means that the + <literal>equals()</literal> method compares only the properties that form the business + key, a key that would identify our instance in the real world (a + <emphasis>natural</emphasis> candidate key): + </para> + + <programlisting><![CDATA[public class Cat { + + ... + public boolean equals(Object other) { + if (this == other) return true; + if ( !(other instanceof Cat) ) return false; + + final Cat cat = (Cat) other; + + if ( !cat.getLitterId().equals( getLitterId() ) ) return false; + if ( !cat.getMother().equals( getMother() ) ) return false; + + return true; + } + + public int hashCode() { + int result; + result = getMother().hashCode(); + result = 29 * result + getLitterId(); + return result; + } + +}]]></programlisting> + + <para> + Note that a business key does not have to be as solid as a database + primary key candidate (see <xref linkend="transactions-basics-identity"/>). + Immutable or unique properties are usually good + candidates for a business key. + </para> + + </sect1> + + <sect1 id="persistent-classes-dynamicmodels"> + <title>Dynamic models</title> + + <para> + <emphasis>Note that the following features are currently considered + experimental and may change in the near future.</emphasis> + </para> + + <para> + Persistent entities don't necessarily have to be represented as POJO classes + or as JavaBean objects at runtime. Hibernate also supports dynamic models + (using <literal>Map</literal>s of <literal>Map</literal>s at runtime) and the + representation of entities as DOM4J trees. With this approach, you don't + write persistent classes, only mapping files. + </para> + + <para> + By default, Hibernate works in normal POJO mode. You may set a default entity + representation mode for a particular <literal>SessionFactory</literal> using the + <literal>default_entity_mode</literal> configuration option (see + <xref linkend="configuration-optional-properties"/>. + </para> + + <para> + The following examples demonstrates the representation using <literal>Map</literal>s. + First, in the mapping file, an <literal>entity-name</literal> has to be declared + instead of (or in addition to) a class name: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class entity-name="Customer"> + + <id name="id" + type="long" + column="ID"> + <generator class="sequence"/> + </id> + + <property name="name" + column="NAME" + type="string"/> + + <property name="address" + column="ADDRESS" + type="string"/> + + <many-to-one name="organization" + column="ORGANIZATION_ID" + class="Organization"/> + + <bag name="orders" + inverse="true" + lazy="false" + cascade="all"> + <key column="CUSTOMER_ID"/> + <one-to-many class="Order"/> + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + + Note that even though associations are declared using target class names, + the target type of an associations may also be a dynamic entity instead + of a POJO. + </para> + + <para> + After setting the default entity mode to <literal>dynamic-map</literal> + for the <literal>SessionFactory</literal>, we can at runtime work with + <literal>Map</literal>s of <literal>Map</literal>s: + </para> + + <programlisting><![CDATA[Session s = openSession(); +Transaction tx = s.beginTransaction(); +Session s = openSession(); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); + +// Create an organization +Map foobar = new HashMap(); +foobar.put("name", "Foobar Inc."); + +// Link both +david.put("organization", foobar); + +// Save both +s.save("Customer", david); +s.save("Organization", foobar); + +tx.commit(); +s.close();]]></programlisting> + + <para> + The advantages of a dynamic mapping are quick turnaround time for prototyping + without the need for entity class implementation. However, you lose compile-time + type checking and will very likely deal with many exceptions at runtime. Thanks + to the Hibernate mapping, the database schema can easily be normalized and sound, + allowing to add a proper domain model implementation on top later on. + </para> + + <para> + Entity representation modes can also be set on a per <literal>Session</literal> + basis: + </para> + + <programlisting><![CDATA[Session dynamicSession = pojoSession.getSession(EntityMode.MAP); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); +dynamicSession.save("Customer", david); +... +dynamicSession.flush(); +dynamicSession.close() +... +// Continue on pojoSession +]]></programlisting> + + + <para> + Please note that the call to <literal>getSession()</literal> using an + <literal>EntityMode</literal> is on the <literal>Session</literal> API, not the + <literal>SessionFactory</literal>. That way, the new <literal>Session</literal> + shares the underlying JDBC connection, transaction, and other context + information. This means you don't have tocall <literal>flush()</literal> + and <literal>close()</literal> on the secondary <literal>Session</literal>, and + also leave the transaction and connection handling to the primary unit of work. + </para> + + <para> + More information about the XML representation capabilities can be found + in <xref linkend="xml"/>. + </para> + + </sect1> + + <sect1 id="persistent-classes-tuplizers" revision="1"> + <title>Tuplizers</title> + + <para> + <literal>org.hibernate.tuple.Tuplizer</literal>, and its sub-interfaces, are responsible + for managing a particular representation of a piece of data, given that representation's + <literal>org.hibernate.EntityMode</literal>. If a given piece of data is thought of as + a data structure, then a tuplizer is the thing which knows how to create such a data structure + and how to extract values from and inject values into such a data structure. For example, + for the POJO entity mode, the correpsonding tuplizer knows how create the POJO through its + constructor and how to access the POJO properties using the defined property accessors. + There are two high-level types of Tuplizers, represented by the + <literal>org.hibernate.tuple.entity.EntityTuplizer</literal> and <literal>org.hibernate.tuple.component.ComponentTuplizer</literal> + interfaces. <literal>EntityTuplizer</literal>s are responsible for managing the above mentioned + contracts in regards to entities, while <literal>ComponentTuplizer</literal>s do the same for + components. + </para> + + <para> + Users may also plug in their own tuplizers. Perhaps you require that a <literal>java.util.Map</literal> + implementation other than <literal>java.util.HashMap</literal> be used while in the + dynamic-map entity-mode; or perhaps you need to define a different proxy generation strategy + than the one used by default. Both would be achieved by defining a custom tuplizer + implementation. Tuplizers definitions are attached to the entity or component mapping they + are meant to manage. Going back to the example of our customer entity: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + <class entity-name="Customer"> +  + <tuplizer entity-mode="dynamic-map" + class="CustomMapTuplizerImpl"/> + + <id name="id" type="long" column="ID"> + <generator class="sequence"/> + </id> + +  + ... + </class> +</hibernate-mapping> + + +public class CustomMapTuplizerImpl + extends org.hibernate.tuple.entity.DynamicMapEntityTuplizer { + // override the buildInstantiator() method to plug in our custom map... + protected final Instantiator buildInstantiator( + org.hibernate.mapping.PersistentClass mappingInfo) { + return new CustomMapInstantiator( mappingInfo ); + } + + private static final class CustomMapInstantiator + extends org.hibernate.tuple.DynamicMapInstantitor { + // override the generateMap() method to return our custom map... + protected final Map generateMap() { + return new CustomMap(); + } + } +}]]></programlisting> + + + </sect1> + + <para> + TODO: Document user-extension framework in the property and proxy packages + </para> + +</chapter> + Added: core/trunk/documentation/manual/en-US/src/main/docbook/content/preface.xml =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/preface.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/preface.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,123 @@ +<?xml version='1.0'?> + +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<preface id="preface"> + <title>Preface</title> + + <para> + Working with object-oriented software and a relational database can be cumbersome + and time consuming in today's enterprise environments. Hibernate is an object/relational + mapping tool for Java environments. The term object/relational mapping (ORM) refers to + the technique of mapping a data representation from an object model to a relational + data model with a SQL-based schema. + </para> + + <para> + Hibernate not only takes care of the mapping from Java classes to + database tables (and from Java data types to SQL data types), but also provides data + query and retrieval facilities and can significantly reduce development time otherwise + spent with manual data handling in SQL and JDBC. + </para> + + <para> + Hibernates goal is to relieve the developer from 95 percent of common data persistence + related programming tasks. Hibernate may not be the best solution for data-centric + applications that only use stored-procedures to implement the business logic in the + database, it is most useful with object-oriented domain models and business logic in + the Java-based middle-tier. However, Hibernate can certainly help you to remove or + encapsulate vendor-specific SQL code and will help with the common task of result set + translation from a tabular representation to a graph of objects. + </para> + + <para> + If you are new to Hibernate and Object/Relational Mapping or even Java, + please follow these steps: + </para> + + <orderedlist> + <listitem> + <para> + Read <xref linkend="tutorial"/> for a tutorial with step-by-step + instructions. The source code for the tutorial is included in the + distribution in the <literal>doc/reference/tutorial/</literal> + directory. + </para> + </listitem> + <listitem> + <para> + Read <xref linkend="architecture"/> to understand the environments where + Hibernate can be used. + </para> + </listitem> + <listitem> + <para> + Have a look at the <literal>eg/</literal> directory in the Hibernate + distribution, it contains a simple standalone application. Copy your + JDBC driver to the <literal>lib/</literal> directory and edit + <literal>etc/hibernate.properties</literal>, specifying correct values for + your database. From a command prompt in the distribution directory, + type <literal>ant eg</literal> (using Ant), or under Windows, type + <literal>build eg</literal>. + </para> + </listitem> + <listitem> + <para> + Use this reference documentation as your primary source of information. + Consider reading <emphasis>Java Persistence with Hibernate</emphasis> + (http://www.manning.com/bauer2) if you need more help with application + design or if you prefer a step-by-step tutorial. Also visit + http://caveatemptor.hibernate.org and download the example application + for Java Persistence with Hibernate. + </para> + </listitem> + <listitem> + <para> + FAQs are answered on the Hibernate website. + </para> + </listitem> + <listitem> + <para> + Third party demos, examples, and tutorials are linked on the Hibernate + website. + </para> + </listitem> + <listitem> + <para> + The Community Area on the Hibernate website is a good resource for + design patterns and various integration solutions (Tomcat, JBoss AS, + Struts, EJB, etc.). + </para> + </listitem> + </orderedlist> + + <para> + If you have questions, use the user forum linked on the Hibernate website. We also + provide a JIRA issue trackings system for bug reports and feature requests. If you + are interested in the development of Hibernate, join the developer mailing list. If + you are interested in translating this documentation into your language, contact us + on the developer mailing list. + </para> + + <para> + Commercial development support, production support, and training for Hibernate is + available through JBoss Inc. (see http://www.hibernate.org/SupportTraining/). + Hibernate is a Professional Open Source project and a critical component of the + JBoss Enterprise Middleware System (JEMS) suite of products. + </para> + +</preface> \ No newline at end of file Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/query_criteria.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/query_criteria.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/query_criteria.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/query_criteria.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,439 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="querycriteria"> + <title>Criteria Queries</title> + + <para> + Hibernate features an intuitive, extensible criteria query API. + </para> + + <sect1 id="querycriteria-creating"> + <title>Creating a <literal>Criteria</literal> instance</title> + + <para> + The interface <literal>org.hibernate.Criteria</literal> represents a query against + a particular persistent class. The <literal>Session</literal> is a factory for + <literal>Criteria</literal> instances. + </para> + + <programlisting><![CDATA[Criteria crit = sess.createCriteria(Cat.class); +crit.setMaxResults(50); +List cats = crit.list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-narrowing"> + <title>Narrowing the result set</title> + + <para> + An individual query criterion is an instance of the interface + <literal>org.hibernate.criterion.Criterion</literal>. The class + <literal>org.hibernate.criterion.Restrictions</literal> defines + factory methods for obtaining certain built-in + <literal>Criterion</literal> types. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.between("weight", minWeight, maxWeight) ) + .list();]]></programlisting> + + <para> + Restrictions may be grouped logically. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.or( + Restrictions.eq( "age", new Integer(0) ), + Restrictions.isNull("age") + ) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) ) + .add( Restrictions.disjunction() + .add( Restrictions.isNull("age") ) + .add( Restrictions.eq("age", new Integer(0) ) ) + .add( Restrictions.eq("age", new Integer(1) ) ) + .add( Restrictions.eq("age", new Integer(2) ) ) + ) ) + .list();]]></programlisting> + + <para> + There are quite a range of built-in criterion types (<literal>Restrictions</literal> + subclasses), but one that is especially useful lets you specify SQL directly. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.sqlRestriction("lower({alias}.name) like lower(?)", "Fritz%", Hibernate.STRING) ) + .list();]]></programlisting> + + <para> + The <literal>{alias}</literal> placeholder with be replaced by the row alias + of the queried entity. + </para> + + <para> + An alternative approach to obtaining a criterion is to get it from a + <literal>Property</literal> instance. You can create a <literal>Property</literal> + by calling <literal>Property.forName()</literal>. + </para> + + <programlisting><![CDATA[ +Property age = Property.forName("age"); +List cats = sess.createCriteria(Cat.class) + .add( Restrictions.disjunction() + .add( age.isNull() ) + .add( age.eq( new Integer(0) ) ) + .add( age.eq( new Integer(1) ) ) + .add( age.eq( new Integer(2) ) ) + ) ) + .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-ordering"> + <title>Ordering the results</title> + + <para> + You may order the results using <literal>org.hibernate.criterion.Order</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") + .addOrder( Order.asc("name") ) + .addOrder( Order.desc("age") ) + .setMaxResults(50) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Property.forName("name").like("F%") ) + .addOrder( Property.forName("name").asc() ) + .addOrder( Property.forName("age").desc() ) + .setMaxResults(50) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-associations" revision="2"> + <title>Associations</title> + + <para> + You may easily specify constraints upon related entities by navigating + associations using <literal>createCriteria()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") ) + .createCriteria("kittens") + .add( Restrictions.like("name", "F%") ) + .list();]]></programlisting> + + <para> + note that the second <literal>createCriteria()</literal> returns a new + instance of <literal>Criteria</literal>, which refers to the elements of + the <literal>kittens</literal> collection. + </para> + + <para> + The following, alternate form is useful in certain circumstances. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createAlias("kittens", "kt") + .createAlias("mate", "mt") + .add( Restrictions.eqProperty("kt.name", "mt.name") ) + .list();]]></programlisting> + + <para> + (<literal>createAlias()</literal> does not create a new instance of + <literal>Criteria</literal>.) + </para> + + <para> + Note that the kittens collections held by the <literal>Cat</literal> instances + returned by the previous two queries are <emphasis>not</emphasis> pre-filtered + by the criteria! If you wish to retrieve just the kittens that match the + criteria, you must use a <literal>ResultTransformer</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createCriteria("kittens", "kt") + .add( Restrictions.eq("name", "F%") ) + .setResultTransformer(Criteria.ALIAS_TO_ENTITY_MAP) + .list(); +Iterator iter = cats.iterator(); +while ( iter.hasNext() ) { + Map map = (Map) iter.next(); + Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS); + Cat kitten = (Cat) map.get("kt"); +}]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-dynamicfetching" revision="1"> + <title>Dynamic association fetching</title> + + <para> + You may specify association fetching semantics at runtime using + <literal>setFetchMode()</literal>. + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .setFetchMode("mate", FetchMode.EAGER) + .setFetchMode("kittens", FetchMode.EAGER) + .list();]]></programlisting> + + <para> + This query will fetch both <literal>mate</literal> and <literal>kittens</literal> + by outer join. See <xref linkend="performance-fetching"/> for more information. + </para> + + </sect1> + + <sect1 id="querycriteria-examples"> + <title>Example queries</title> + + <para> + The class <literal>org.hibernate.criterion.Example</literal> allows + you to construct a query criterion from a given instance. + </para> + + <programlisting><![CDATA[Cat cat = new Cat(); +cat.setSex('F'); +cat.setColor(Color.BLACK); +List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .list();]]></programlisting> + + <para> + Version properties, identifiers and associations are ignored. By default, + null valued properties are excluded. + </para> + + <para> + You can adjust how the <literal>Example</literal> is applied. + </para> + + <programlisting><![CDATA[Example example = Example.create(cat) + .excludeZeroes() //exclude zero valued properties + .excludeProperty("color") //exclude the property named "color" + .ignoreCase() //perform case insensitive string comparisons + .enableLike(); //use like for string comparisons +List results = session.createCriteria(Cat.class) + .add(example) + .list();]]></programlisting> + + <para> + You can even use examples to place criteria upon associated objects. + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .createCriteria("mate") + .add( Example.create( cat.getMate() ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-projection"> + <title>Projections, aggregation and grouping</title> + <para> + The class <literal>org.hibernate.criterion.Projections</literal> is a + factory for <literal>Projection</literal> instances. We apply a + projection to a query by calling <literal>setProjection()</literal>. + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.rowCount() ) + .add( Restrictions.eq("color", Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount() ) + .add( Projections.avg("weight") ) + .add( Projections.max("weight") ) + .add( Projections.groupProperty("color") ) + ) + .list();]]></programlisting> + + <para> + There is no explicit "group by" necessary in a criteria query. Certain + projection types are defined to be <emphasis>grouping projections</emphasis>, + which also appear in the SQL <literal>group by</literal> clause. + </para> + + <para> + An alias may optionally be assigned to a projection, so that the projected value + may be referred to in restrictions or orderings. Here are two different ways to + do this: + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.alias( Projections.groupProperty("color"), "colr" ) ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.groupProperty("color").as("colr") ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <para> + The <literal>alias()</literal> and <literal>as()</literal> methods simply wrap a + projection instance in another, aliased, instance of <literal>Projection</literal>. + As a shortcut, you can assign an alias when you add the projection to a + projection list: + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount(), "catCountByColor" ) + .add( Projections.avg("weight"), "avgWeight" ) + .add( Projections.max("weight"), "maxWeight" ) + .add( Projections.groupProperty("color"), "color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Domestic.class, "cat") + .createAlias("kittens", "kit") + .setProjection( Projections.projectionList() + .add( Projections.property("cat.name"), "catName" ) + .add( Projections.property("kit.name"), "kitName" ) + ) + .addOrder( Order.asc("catName") ) + .addOrder( Order.asc("kitName") ) + .list();]]></programlisting> + + <para> + You can also use <literal>Property.forName()</literal> to express projections: + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Property.forName("name") ) + .add( Property.forName("color").eq(Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount().as("catCountByColor") ) + .add( Property.forName("weight").avg().as("avgWeight") ) + .add( Property.forName("weight").max().as("maxWeight") ) + .add( Property.forName("color").group().as("color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-detachedqueries"> + <title>Detached queries and subqueries</title> + <para> + The <literal>DetachedCriteria</literal> class lets you create a query outside the scope + of a session, and then later execute it using some arbitrary <literal>Session</literal>. + </para> + + <programlisting><![CDATA[DetachedCriteria query = DetachedCriteria.forClass(Cat.class) + .add( Property.forName("sex").eq('F') ); + +Session session = ....; +Transaction txn = session.beginTransaction(); +List results = query.getExecutableCriteria(session).setMaxResults(100).list(); +txn.commit(); +session.close();]]></programlisting> + + <para> + A <literal>DetachedCriteria</literal> may also be used to express a subquery. Criterion + instances involving subqueries may be obtained via <literal>Subqueries</literal> or + <literal>Property</literal>. + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeight = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight").avg() ); +session.createCriteria(Cat.class) + .add( Property.forName("weight").gt(avgWeight) ) + .list();]]></programlisting> + + <programlisting><![CDATA[DetachedCriteria weights = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight") ); +session.createCriteria(Cat.class) + .add( Subqueries.geAll("weight", weights) ) + .list();]]></programlisting> + + <para> + Even correlated subqueries are possible: + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeightForSex = DetachedCriteria.forClass(Cat.class, "cat2") + .setProjection( Property.forName("weight").avg() ) + .add( Property.forName("cat2.sex").eqProperty("cat.sex") ); +session.createCriteria(Cat.class, "cat") + .add( Property.forName("weight").gt(avgWeightForSex) ) + .list();]]></programlisting> + + </sect1> + +  + + <sect1 id="query-criteria-naturalid"> + <title>Queries by natural identifier</title> + + <para> + For most queries, including criteria queries, the query cache is not very efficient, + because query cache invalidation occurs too frequently. However, there is one special + kind of query where we can optimize the cache invalidation algorithm: lookups by a + constant natural key. In some applications, this kind of query occurs frequently. + The criteria API provides special provision for this use case. + </para> + + <para> + First, you should map the natural key of your entity using + <literal><natural-id></literal>, and enable use of the second-level cache. + </para> + + <programlisting><![CDATA[<class name="User"> + <cache usage="read-write"/> + <id name="id"> + <generator class="increment"/> + </id> + <natural-id> + <property name="name"/> + <property name="org"/> + </natural-id> + <property name="password"/> +</class>]]></programlisting> + + <para> + Note that this functionality is not intended for use with entities with + <emphasis>mutable</emphasis> natural keys. + </para> + + <para> + Next, enable the Hibernate query cache. + </para> + + <para> + Now, <literal>Restrictions.naturalId()</literal> allows us to make use of + the more efficient cache algorithm. + </para> + + <programlisting><![CDATA[session.createCriteria(User.class) + .add( Restrictions.naturalId() + .set("name", "gavin") + .set("org", "hb") + ).setCacheable(true) + .uniqueResult();]]></programlisting> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/query_hql.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/query_hql.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/query_hql.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/query_hql.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1237 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="queryhql" revision="1"> + <title>HQL: The Hibernate Query Language</title> + + <para> + Hibernate is equipped with an extremely powerful query language that (quite intentionally) + looks very much like SQL. But don't be fooled by the syntax; HQL is fully object-oriented, + understanding notions like inheritence, polymorphism and association. + </para> + + <sect1 id="queryhql-casesensitivity"> + <title>Case Sensitivity</title> + + <para> + Queries are case-insensitive, except for names of Java classes and properties. + So <literal>SeLeCT</literal> is the same as + <literal>sELEct</literal> is the same as + <literal>SELECT</literal> but + <literal>org.hibernate.eg.FOO</literal> is not + <literal>org.hibernate.eg.Foo</literal> and + <literal>foo.barSet</literal> is not + <literal>foo.BARSET</literal>. + </para> + + <para> + This manual uses lowercase HQL keywords. Some users find queries with uppercase keywords + more readable, but we find this convention ugly when embedded in Java code. + </para> + + </sect1> + + <sect1 id="queryhql-from"> + <title>The from clause</title> + + <para> + The simplest possible Hibernate query is of the form: + </para> + + <programlisting><![CDATA[from eg.Cat]]></programlisting> + + <para> + which simply returns all instances of the class <literal>eg.Cat</literal>. + We don't usually need to qualify the class name, since <literal>auto-import</literal> + is the default. So we almost always just write: + </para> + + <programlisting><![CDATA[from Cat]]></programlisting> + + <para> + Most of the time, you will need to assign an <emphasis>alias</emphasis>, since + you will want to refer to the <literal>Cat</literal> in other parts of the + query. + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + This query assigns the alias <literal>cat</literal> to <literal>Cat</literal> + instances, so we could use that alias later in the query. The <literal>as</literal> + keyword is optional; we could also write: + </para> + + <programlisting><![CDATA[from Cat cat]]></programlisting> + + <para> + Multiple classes may appear, resulting in a cartesian product or "cross" join. + </para> + + <programlisting><![CDATA[from Formula, Parameter]]></programlisting> + <programlisting><![CDATA[from Formula as form, Parameter as param]]></programlisting> + + <para> + It is considered good practice to name query aliases using an initial lowercase, + consistent with Java naming standards for local variables + (eg. <literal>domesticCat</literal>). + </para> + + </sect1> + + <sect1 id="queryhql-joins" revision="2"> + <title>Associations and joins</title> + + <para> + We may also assign aliases to associated entities, or even to elements of a + collection of values, using a <literal>join</literal>. + </para> + + <programlisting><![CDATA[from Cat as cat + inner join cat.mate as mate + left outer join cat.kittens as kitten]]></programlisting> + + <programlisting><![CDATA[from Cat as cat left join cat.mate.kittens as kittens]]></programlisting> + + <programlisting><![CDATA[from Formula form full join form.parameter param]]></programlisting> + + <para> + The supported join types are borrowed from ANSI SQL + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>inner join</literal> + </para> + </listitem> + <listitem> + <para> + <literal>left outer join</literal> + </para> + </listitem> + <listitem> + <para> + <literal>right outer join</literal> + </para> + </listitem> + <listitem> + <para> + <literal>full join</literal> (not usually useful) + </para> + </listitem> + </itemizedlist> + + <para> + The <literal>inner join</literal>, <literal>left outer join</literal> and + <literal>right outer join</literal> constructs may be abbreviated. + </para> + + <programlisting><![CDATA[from Cat as cat + join cat.mate as mate + left join cat.kittens as kitten]]></programlisting> + + <para> + You may supply extra join conditions using the HQL <literal>with</literal> + keyword. + </para> + + <programlisting><![CDATA[from Cat as cat + left join cat.kittens as kitten + with kitten.bodyWeight > 10.0]]></programlisting> + + <para> + In addition, a "fetch" join allows associations or collections of values to be + initialized along with their parent objects, using a single select. This is particularly + useful in the case of a collection. It effectively overrides the outer join and + lazy declarations of the mapping file for associations and collections. See + <xref linkend="performance-fetching"/> for more information. + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens]]></programlisting> + + <para> + A fetch join does not usually need to assign an alias, because the associated objects + should not be used in the <literal>where</literal> clause (or any other clause). Also, + the associated objects are not returned directly in the query results. Instead, they may + be accessed via the parent object. The only reason we might need an alias is if we are + recursively join fetching a further collection: + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens child + left join fetch child.kittens]]></programlisting> + + <para> + Note that the <literal>fetch</literal> construct may not be used in queries called using + <literal>iterate()</literal> (though <literal>scroll()</literal> can be used). Nor should + <literal>fetch</literal> be used together with <literal>setMaxResults()</literal> or + <literal>setFirstResult()</literal> as these operations are based on the result rows, which + usually contain duplicates for eager collection fetching, hence, the number of rows is not what + you'd expect. + Nor may <literal>fetch</literal> be used together with an ad hoc <literal>with</literal> condition. + It is possible to create a cartesian product by join fetching more than one collection in a + query, so take care in this case. Join fetching multiple collection roles also sometimes gives + unexpected results for bag mappings, so be careful about how you formulate your queries in this + case. Finally, note that <literal>full join fetch</literal> and <literal>right join fetch</literal> + are not meaningful. + </para> + + <para> + If you are using property-level lazy fetching (with bytecode instrumentation), it is + possible to force Hibernate to fetch the lazy properties immediately (in the first + query) using <literal>fetch all properties</literal>. + </para> + + <programlisting><![CDATA[from Document fetch all properties order by name]]></programlisting> + <programlisting><![CDATA[from Document doc fetch all properties where lower(doc.name) like '%cats%']]></programlisting> + + </sect1> + + <sect1 id="queryhql-joins-forms"> + <title>Forms of join syntax</title> + + <para> + HQL supports two forms of association joining: <literal>implicit</literal> and <literal>explicit</literal>. + </para> + + <para> + The queries shown in the previous section all use the <literal>explicit</literal> form where + the join keyword is explicitly used in the from clause. This is the recommended form. + </para> + + <para> + The <literal>implicit</literal> form does not use the join keyword. Instead, the + associations are "dereferenced" using dot-notation. <literal>implicit</literal> joins + can appear in any of the HQL clauses. <literal>implicit</literal> join result + in inner joins in the resulting SQL statement. + </para> + + <programlisting><![CDATA[from Cat as cat where cat.mate.name like '%s%']]></programlisting> + </sect1> + + <sect1 id="queryhql-identifier-property"> + <title>Refering to identifier property</title> + + <para> + There are, generally speaking, 2 ways to refer to an entity's identifier property: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + The special property (lowercase) <literal>id</literal> may be used to reference the identifier + property of an entity <emphasis>provided that entity does not define a non-identifier property + named id</emphasis>. + </para> + </listitem> + <listitem> + <para> + If the entity defines a named identifier property, you may use that property name. + </para> + </listitem> + </itemizedlist> + + <para> + References to composite identifier properties follow the same naming rules. If the + entity has a non-identifier property named id, the composite identifier property can only + be referenced by its defined named; otherwise, the special <literal>id</literal> property + can be used to rerference the identifier property. + </para> + + <para> + Note: this has changed significantly starting in version 3.2.2. In previous versions, + <literal>id</literal> <emphasis>always</emphasis> referred to the identifier property no + matter what its actual name. A ramification of that decision was that non-identifier + properties named <literal>id</literal> could never be referenced in Hibernate queries. + </para> + </sect1> + + <sect1 id="queryhql-select"> + <title>The select clause</title> + + <para> + The <literal>select</literal> clause picks which objects and properties to return in + the query result set. Consider: + </para> + + <programlisting><![CDATA[select mate +from Cat as cat + inner join cat.mate as mate]]></programlisting> + + <para> + The query will select <literal>mate</literal>s of other <literal>Cat</literal>s. + Actually, you may express this query more compactly as: + </para> + + <programlisting><![CDATA[select cat.mate from Cat cat]]></programlisting> + + <para> + Queries may return properties of any value type including properties of component type: + </para> + + <programlisting><![CDATA[select cat.name from DomesticCat cat +where cat.name like 'fri%']]></programlisting> + + <programlisting><![CDATA[select cust.name.firstName from Customer as cust]]></programlisting> + + <para> + Queries may return multiple objects and/or properties as an array of type + <literal>Object[]</literal>, + </para> + + <programlisting><![CDATA[select mother, offspr, mate.name +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + or as a <literal>List</literal>, + </para> + + <programlisting><![CDATA[select new list(mother, offspr, mate.name) +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + or as an actual typesafe Java object, + </para> + + <programlisting><![CDATA[select new Family(mother, mate, offspr) +from DomesticCat as mother + join mother.mate as mate + left join mother.kittens as offspr]]></programlisting> + + <para> + assuming that the class <literal>Family</literal> has an appropriate constructor. + </para> + + <para> + You may assign aliases to selected expressions using <literal>as</literal>: + </para> + + <programlisting><![CDATA[select max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n +from Cat cat]]></programlisting> + + <para> + This is most useful when used together with <literal>select new map</literal>: + </para> + + <programlisting><![CDATA[select new map( max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n ) +from Cat cat]]></programlisting> + + <para> + This query returns a <literal>Map</literal> from aliases to selected values. + </para> + + </sect1> + + <sect1 id="queryhql-aggregation"> + <title>Aggregate functions</title> + + <para> + HQL queries may even return the results of aggregate functions on properties: + </para> + + <programlisting><![CDATA[select avg(cat.weight), sum(cat.weight), max(cat.weight), count(cat) +from Cat cat]]></programlisting> + + + + <para> + The supported aggregate functions are + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>avg(...), sum(...), min(...), max(...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(*)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(...), count(distinct ...), count(all...)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + You may use arithmetic operators, concatenation, and recognized SQL functions + in the select clause: + </para> + + <programlisting><![CDATA[select cat.weight + sum(kitten.weight) +from Cat cat + join cat.kittens kitten +group by cat.id, cat.weight]]></programlisting> + + <programlisting><![CDATA[select firstName||' '||initial||' '||upper(lastName) from Person]]></programlisting> + + <para> + The <literal>distinct</literal> and <literal>all</literal> keywords may be used and + have the same semantics as in SQL. + </para> + + <programlisting><![CDATA[select distinct cat.name from Cat cat + +select count(distinct cat.name), count(cat) from Cat cat]]></programlisting> + + </sect1> + + <sect1 id="queryhql-polymorphism"> + <title>Polymorphic queries</title> + + <para> + A query like: + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + returns instances not only of <literal>Cat</literal>, but also of subclasses like + <literal>DomesticCat</literal>. Hibernate queries may name <emphasis>any</emphasis> Java + class or interface in the <literal>from</literal> clause. The query will return instances + of all persistent classes that extend that class or implement the interface. The following + query would return all persistent objects: + </para> + + <programlisting><![CDATA[from java.lang.Object o]]></programlisting> + + <para> + The interface <literal>Named</literal> might be implemented by various persistent + classes: + </para> + + <programlisting><![CDATA[from Named n, Named m where n.name = m.name]]></programlisting> + + <para> + Note that these last two queries will require more than one SQL <literal>SELECT</literal>. This + means that the <literal>order by</literal> clause does not correctly order the whole result set. + (It also means you can't call these queries using <literal>Query.scroll()</literal>.) + </para> + + </sect1> + + <sect1 id="queryhql-where" revision="1"> + <title>The where clause</title> + + <para> + The <literal>where</literal> clause allows you to narrow the list of instances returned. + If no alias exists, you may refer to properties by name: + </para> + + <programlisting><![CDATA[from Cat where name='Fritz']]></programlisting> + + <para> + If there is an alias, use a qualified property name: + </para> + + <programlisting><![CDATA[from Cat as cat where cat.name='Fritz']]></programlisting> + + <para> + returns instances of <literal>Cat</literal> named 'Fritz'. + </para> + + <programlisting><![CDATA[select foo +from Foo foo, Bar bar +where foo.startDate = bar.date]]></programlisting> + + <para> + will return all instances of <literal>Foo</literal> for which + there exists an instance of <literal>bar</literal> with a + <literal>date</literal> property equal to the + <literal>startDate</literal> property of the + <literal>Foo</literal>. Compound path expressions make the + <literal>where</literal> clause extremely powerful. Consider: + </para> + + <programlisting><![CDATA[from Cat cat where cat.mate.name is not null]]></programlisting> + + <para> + This query translates to an SQL query with a table (inner) join. If you were to write + something like + </para> + + <programlisting><![CDATA[from Foo foo +where foo.bar.baz.customer.address.city is not null]]></programlisting> + + <para> + you would end up with a query that would require four table joins in SQL. + </para> + + <para> + The <literal>=</literal> operator may be used to compare not only properties, but also + instances: + </para> + + <programlisting><![CDATA[from Cat cat, Cat rival where cat.mate = rival.mate]]></programlisting> + + <programlisting><![CDATA[select cat, mate +from Cat cat, Cat mate +where cat.mate = mate]]></programlisting> + + <para> + The special property (lowercase) <literal>id</literal> may be used to reference the + unique identifier of an object. See <xref linkend="queryhql-identifier-property"/> + for more information. + </para> + + <programlisting><![CDATA[from Cat as cat where cat.id = 123 + +from Cat as cat where cat.mate.id = 69]]></programlisting> + + <para> + The second query is efficient. No table join is required! + </para> + + <para> + Properties of composite identifiers may also be used. Suppose <literal>Person</literal> + has a composite identifier consisting of <literal>country</literal> and + <literal>medicareNumber</literal>. Again, see <xref linkend="queryhql-identifier-property"/> + for more information regarding referencing identifier properties. + </para> + + <programlisting><![CDATA[from bank.Person person +where person.id.country = 'AU' + and person.id.medicareNumber = 123456]]></programlisting> + + <programlisting><![CDATA[from bank.Account account +where account.owner.id.country = 'AU' + and account.owner.id.medicareNumber = 123456]]></programlisting> + + <para> + Once again, the second query requires no table join. + </para> + + <para> + Likewise, the special property <literal>class</literal> accesses the discriminator value + of an instance in the case of polymorphic persistence. A Java class name embedded in the + where clause will be translated to its discriminator value. + </para> + + <programlisting><![CDATA[from Cat cat where cat.class = DomesticCat]]></programlisting> + + <para> + You may also use components or composite user types, or properties of said + component types. See <xref linkend="queryhql-coomponents"/> for more details. + </para> + + <para> + An "any" type has the special properties <literal>id</literal> and <literal>class</literal>, + allowing us to express a join in the following way (where <literal>AuditLog.item</literal> + is a property mapped with <literal><any></literal>). + </para> + + <programlisting><![CDATA[from AuditLog log, Payment payment +where log.item.class = 'Payment' and log.item.id = payment.id]]></programlisting> + + <para> + Notice that <literal>log.item.class</literal> and <literal>payment.class</literal> + would refer to the values of completely different database columns in the above query. + </para> + + </sect1> + + <sect1 id="queryhql-expressions"> + <title>Expressions</title> + + <para> + Expressions allowed in the <literal>where</literal> clause include + most of the kind of things you could write in SQL: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + mathematical operators <literal>+, -, *, /</literal> + </para> + </listitem> + <listitem> + <para> + binary comparison operators <literal>=, >=, <=, <>, !=, like</literal> + </para> + </listitem> + <listitem> + <para> + logical operations <literal>and, or, not</literal> + </para> + </listitem> + <listitem> + <para> + Parentheses <literal>( )</literal>, indicating grouping + </para> + </listitem> + <listitem> + <para> + <literal>in</literal>, + <literal>not in</literal>, + <literal>between</literal>, + <literal>is null</literal>, + <literal>is not null</literal>, + <literal>is empty</literal>, + <literal>is not empty</literal>, + <literal>member of</literal> and + <literal>not member of</literal> + </para> + </listitem> + <listitem> + <para> + "Simple" case, <literal>case ... when ... then ... else ... end</literal>, and + "searched" case, <literal>case when ... then ... else ... end</literal> + </para> + </listitem> + <listitem> + <para> + string concatenation <literal>...||...</literal> or <literal>concat(...,...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>current_date()</literal>, <literal>current_time()</literal>, + <literal>current_timestamp()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>second(...)</literal>, <literal>minute(...)</literal>, + <literal>hour(...)</literal>, <literal>day(...)</literal>, + <literal>month(...)</literal>, <literal>year(...)</literal>, + </para> + </listitem> + <listitem> + <para> + Any function or operator defined by EJB-QL 3.0: <literal>substring(), trim(), + lower(), upper(), length(), locate(), abs(), sqrt(), bit_length(), mod()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>coalesce()</literal> and <literal>nullif()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>str()</literal> for converting numeric or temporal values to a + readable string + </para> + </listitem> + <listitem> + <para> + <literal>cast(... as ...)</literal>, where the second argument is the name of + a Hibernate type, and <literal>extract(... from ...)</literal> if ANSI + <literal>cast()</literal> and <literal>extract()</literal> is supported by + the underlying database + </para> + </listitem> + <listitem> + <para> + the HQL <literal>index()</literal> function, that applies to aliases of + a joined indexed collection + </para> + </listitem> + <listitem> + <para> + HQL functions that take collection-valued path expressions: <literal>size(), + minelement(), maxelement(), minindex(), maxindex()</literal>, along with the + special <literal>elements()</literal> and <literal>indices</literal> functions + which may be quantified using <literal>some, all, exists, any, in</literal>. + </para> + </listitem> + <listitem> + <para> + Any database-supported SQL scalar function like <literal>sign()</literal>, + <literal>trunc()</literal>, <literal>rtrim()</literal>, <literal>sin()</literal> + </para> + </listitem> + <listitem> + <para> + JDBC-style positional parameters <literal>?</literal> + </para> + </listitem> + <listitem> + <para> + named parameters <literal>:name</literal>, <literal>:start_date</literal>, <literal>:x1</literal> + </para> + </listitem> + <listitem> + <para> + SQL literals <literal>'foo'</literal>, <literal>69</literal>, <literal>6.66E+2</literal>, + <literal>'1970-01-01 10:00:01.0'</literal> + </para> + </listitem> + <listitem> + <para> + Java <literal>public static final</literal> constants <literal>eg.Color.TABBY</literal> + </para> + </listitem> + </itemizedlist> + + <para> + <literal>in</literal> and <literal>between</literal> may be used as follows: + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + and the negated forms may be written + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + Likewise, <literal>is null</literal> and <literal>is not null</literal> may be used to test + for null values. + </para> + + <para> + Booleans may be easily used in expressions by declaring HQL query substitutions in Hibernate + configuration: + </para> + + <programlisting><![CDATA[<property name="hibernate.query.substitutions">true 1, false 0</property>]]></programlisting> + + <para> + This will replace the keywords <literal>true</literal> and <literal>false</literal> with the + literals <literal>1</literal> and <literal>0</literal> in the translated SQL from this HQL: + </para> + + <programlisting><![CDATA[from Cat cat where cat.alive = true]]></programlisting> + + <para> + You may test the size of a collection with the special property <literal>size</literal>, or + the special <literal>size()</literal> function. + </para> + + <programlisting><![CDATA[from Cat cat where cat.kittens.size > 0]]></programlisting> + + <programlisting><![CDATA[from Cat cat where size(cat.kittens) > 0]]></programlisting> + + <para> + For indexed collections, you may refer to the minimum and maximum indices using + <literal>minindex</literal> and <literal>maxindex</literal> functions. Similarly, + you may refer to the minimum and maximum elements of a collection of basic type + using the <literal>minelement</literal> and <literal>maxelement</literal> + functions. + </para> + + <programlisting><![CDATA[from Calendar cal where maxelement(cal.holidays) > current_date]]></programlisting> + + <programlisting><![CDATA[from Order order where maxindex(order.items) > 100]]></programlisting> + + <programlisting><![CDATA[from Order order where minelement(order.items) > 10000]]></programlisting> + + <para> + The SQL functions <literal>any, some, all, exists, in</literal> are supported when passed the element + or index set of a collection (<literal>elements</literal> and <literal>indices</literal> functions) + or the result of a subquery (see below). + </para> + + <programlisting><![CDATA[select mother from Cat as mother, Cat as kit +where kit in elements(foo.kittens)]]></programlisting> + + <programlisting><![CDATA[select p from NameList list, Person p +where p.name = some elements(list.names)]]></programlisting> + + <programlisting><![CDATA[from Cat cat where exists elements(cat.kittens)]]></programlisting> + + <programlisting><![CDATA[from Player p where 3 > all elements(p.scores)]]></programlisting> + + <programlisting><![CDATA[from Show show where 'fizard' in indices(show.acts)]]></programlisting> + + <para> + Note that these constructs - <literal>size</literal>, <literal>elements</literal>, + <literal>indices</literal>, <literal>minindex</literal>, <literal>maxindex</literal>, + <literal>minelement</literal>, <literal>maxelement</literal> - may only be used in + the where clause in Hibernate3. + </para> + + <para> + Elements of indexed collections (arrays, lists, maps) may be referred to by + index (in a where clause only): + </para> + + <programlisting><![CDATA[from Order order where order.items[0].id = 1234]]></programlisting> + + <programlisting><![CDATA[select person from Person person, Calendar calendar +where calendar.holidays['national day'] = person.birthDay + and person.nationality.calendar = calendar]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ order.deliveredItemIndices[0] ] = item and order.id = 11]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ maxindex(order.items) ] = item and order.id = 11]]></programlisting> + + <para> + The expression inside <literal>[]</literal> may even be an arithmetic expression. + </para> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ size(order.items) - 1 ] = item]]></programlisting> + + <para> + HQL also provides the built-in <literal>index()</literal> function, for elements + of a one-to-many association or collection of values. + </para> + + <programlisting><![CDATA[select item, index(item) from Order order + join order.items item +where index(item) < 5]]></programlisting> + + <para> + Scalar SQL functions supported by the underlying database may be used + </para> + + <programlisting><![CDATA[from DomesticCat cat where upper(cat.name) like 'FRI%']]></programlisting> + + <para> + If you are not yet convinced by all this, think how much longer and less readable the + following query would be in SQL: + </para> + + <programlisting><![CDATA[select cust +from Product prod, + Store store + inner join store.customers cust +where prod.name = 'widget' + and store.location.name in ( 'Melbourne', 'Sydney' ) + and prod = all elements(cust.currentOrder.lineItems)]]></programlisting> + + <para> + <emphasis>Hint:</emphasis> something like + </para> + + <programlisting><![CDATA[SELECT cust.name, cust.address, cust.phone, cust.id, cust.current_order +FROM customers cust, + stores store, + locations loc, + store_customers sc, + product prod +WHERE prod.name = 'widget' + AND store.loc_id = loc.id + AND loc.name IN ( 'Melbourne', 'Sydney' ) + AND sc.store_id = store.id + AND sc.cust_id = cust.id + AND prod.id = ALL( + SELECT item.prod_id + FROM line_items item, orders o + WHERE item.order_id = o.id + AND cust.current_order = o.id + )]]></programlisting> + + </sect1> + + <sect1 id="queryhql-ordering"> + <title>The order by clause</title> + + <para> + The list returned by a query may be ordered by any property of a returned class or components: + </para> + + <programlisting><![CDATA[from DomesticCat cat +order by cat.name asc, cat.weight desc, cat.birthdate]]></programlisting> + + <para> + The optional <literal>asc</literal> or <literal>desc</literal> indicate ascending or descending order + respectively. + </para> + </sect1> + + <sect1 id="queryhql-grouping" revision="1"> + <title>The group by clause</title> + + <para> + A query that returns aggregate values may be grouped by any property of a returned class or components: + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color]]></programlisting> + + <programlisting><![CDATA[select foo.id, avg(name), max(name) +from Foo foo join foo.names name +group by foo.id]]></programlisting> + + <para> + A <literal>having</literal> clause is also allowed. + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color +having cat.color in (eg.Color.TABBY, eg.Color.BLACK)]]></programlisting> + + <para> + SQL functions and aggregate functions are allowed in the <literal>having</literal> + and <literal>order by</literal> clauses, if supported by the underlying database + (eg. not in MySQL). + </para> + + <programlisting><![CDATA[select cat +from Cat cat + join cat.kittens kitten +group by cat.id, cat.name, cat.other, cat.properties +having avg(kitten.weight) > 100 +order by count(kitten) asc, sum(kitten.weight) desc]]></programlisting> + + <para> + Note that neither the <literal>group by</literal> clause nor the + <literal>order by</literal> clause may contain arithmetic expressions. + Also note that Hibernate currently does not expand a grouped entity, + so you can't write <literal>group by cat</literal> if all properties + of <literal>cat</literal> are non-aggregated. You have to list all + non-aggregated properties explicitly. + </para> + + </sect1> + + <sect1 id="queryhql-subqueries" revision="3"> + <title>Subqueries</title> + + <para> + For databases that support subselects, Hibernate supports subqueries within queries. A subquery must + be surrounded by parentheses (often by an SQL aggregate function call). Even correlated subqueries + (subqueries that refer to an alias in the outer query) are allowed. + </para> + + <programlisting><![CDATA[from Cat as fatcat +where fatcat.weight > ( + select avg(cat.weight) from DomesticCat cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name = some ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[from Cat as cat +where not exists ( + from Cat as mate where mate.mate = cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name not in ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[select cat.id, (select max(kit.weight) from cat.kitten kit) +from Cat as cat]]></programlisting> + + <para> + Note that HQL subqueries may occur only in the select or where clauses. + </para> + + <para> + Note that subqueries can also utilize <literal>row value constructor</literal> syntax. See + <xref linkend="queryhql-tuple"/> for more details. + </para> + + </sect1> + + <sect1 id="queryhql-examples"> + <title>HQL examples</title> + + <para> + Hibernate queries can be quite powerful and complex. In fact, the power of the query language + is one of Hibernate's main selling points. Here are some example queries very similar to queries + that I used on a recent project. Note that most queries you will write are much simpler than these! + </para> + + <para> + The following query returns the order id, number of items and total value of the order for all + unpaid orders for a particular customer and given minimum total value, ordering the results by + total value. In determining the prices, it uses the current catalog. The resulting SQL query, + against the <literal>ORDER</literal>, <literal>ORDER_LINE</literal>, <literal>PRODUCT</literal>, + <literal>CATALOG</literal> and <literal>PRICE</literal> tables has four inner joins and an + (uncorrelated) subselect. + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog.effectiveDate < sysdate + and catalog.effectiveDate >= all ( + select cat.effectiveDate + from Catalog as cat + where cat.effectiveDate < sysdate + ) +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + What a monster! Actually, in real life, I'm not very keen on subqueries, so my query was + really more like this: + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog = :currentCatalog +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + The next query counts the number of payments in each status, excluding all payments in the + <literal>AWAITING_APPROVAL</literal> status where the most recent status change was made by the + current user. It translates to an SQL query with two inner joins and a correlated subselect + against the <literal>PAYMENT</literal>, <literal>PAYMENT_STATUS</literal> and + <literal>PAYMENT_STATUS_CHANGE</literal> tables. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status + join payment.statusChanges as statusChange +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or ( + statusChange.timeStamp = ( + select max(change.timeStamp) + from PaymentStatusChange change + where change.payment = payment + ) + and statusChange.user <> :currentUser + ) +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + If I would have mapped the <literal>statusChanges</literal> collection as a list, instead of a set, + the query would have been much simpler to write. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or payment.statusChanges[ maxIndex(payment.statusChanges) ].user <> :currentUser +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + The next query uses the MS SQL Server <literal>isNull()</literal> function to return all + the accounts and unpaid payments for the organization to which the current user belongs. + It translates to an SQL query with three inner joins, an outer join and a subselect against + the <literal>ACCOUNT</literal>, <literal>PAYMENT</literal>, <literal>PAYMENT_STATUS</literal>, + <literal>ACCOUNT_TYPE</literal>, <literal>ORGANIZATION</literal> and + <literal>ORG_USER</literal> tables. + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + left outer join account.payments as payment +where :currentUser in elements(account.holder.users) + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + <para> + For some databases, we would need to do away with the (correlated) subselect. + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + join account.holder.users as user + left outer join account.payments as payment +where :currentUser = user + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + </sect1> + + <sect1 id="queryhql-bulk" revision="2"> + <title>Bulk update and delete</title> + + <para> + HQL now supports <literal>update</literal>, <literal>delete</literal> and + <literal>insert ... select ...</literal> statements. + See <xref linkend="batch-direct"/> for details. + </para> + </sect1> + + <sect1 id="queryhql-tipstricks"> + <title>Tips & Tricks</title> + + <para> + You can count the number of query results without actually returning them: + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue()]]></programlisting> + + <para> + To order a result by the size of a collection, use the following query: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +order by count(msg)]]></programlisting> + + <para> + If your database supports subselects, you can place a condition upon selection + size in the where clause of your query: + </para> + + <programlisting><![CDATA[from User usr where size(usr.messages) >= 1]]></programlisting> + + <para> + If your database doesn't support subselects, use the following query: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User usr.name + join usr.messages msg +group by usr.id, usr.name +having count(msg) >= 1]]></programlisting> + + <para> + As this solution can't return a <literal>User</literal> with zero messages + because of the inner join, the following form is also useful: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +having count(msg) = 0]]></programlisting> + + <para> + Properties of a JavaBean can be bound to named query parameters: + </para> + + <programlisting><![CDATA[Query q = s.createQuery("from foo Foo as foo where foo.name=:name and foo.size=:size"); +q.setProperties(fooBean); // fooBean has getName() and getSize() +List foos = q.list();]]></programlisting> + + <para> + Collections are pageable by using the <literal>Query</literal> interface with a filter: + </para> + + <programlisting><![CDATA[Query q = s.createFilter( collection, "" ); // the trivial filter +q.setMaxResults(PAGE_SIZE); +q.setFirstResult(PAGE_SIZE * pageNumber); +List page = q.list();]]></programlisting> + + <para> + Collection elements may be ordered or grouped using a query filter: + </para> + + <programlisting><![CDATA[Collection orderedCollection = s.filter( collection, "order by this.amount" ); +Collection counts = s.filter( collection, "select this.type, count(this) group by this.type" );]]></programlisting> + + <para> + You can find the size of a collection without initializing it: + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue();]]></programlisting> + + </sect1> + + <sect1 id="queryhql-components"> + <title>Components</title> + + <para> + Components might be used in just about every way that simple value types can be used in HQL + queries. They can appear in the <literal>select</literal> clause: + </para> + + <programlisting><![CDATA[select p.name from from Person p]]></programlisting> + <programlisting><![CDATA[select p.name.first from from Person p]]></programlisting> + + <para> + where the Person's name property is a component. Components can also be used + in the <literal>where</literal> clause: + </para> + + <programlisting><![CDATA[from from Person p where p.name = :name]]></programlisting> + <programlisting><![CDATA[from from Person p where p.name.first = :firstName]]></programlisting> + + <para> + Components can also be used in the <literal>order by</literal> clause: + </para> + + <programlisting><![CDATA[from from Person p order by p.name]]></programlisting> + <programlisting><![CDATA[from from Person p order by p.name.first]]></programlisting> + + <para> + Another common use of components is in <xref linkend="queryhql-tuple">row value constructors</xref>. + </para> + </sect1> + + <sect1 id="queryhql-tuple"> + <title>Row value constructor syntax</title> + + <para> + HQL supports the use of ANSI SQL <literal>row value constructor</literal> syntax (sometimes + called <literal>tuple</literal> syntax), even though the underlying database may not support + that notion. Here we are generally referring to multi-valued comparisons, typically associated + with components. Consider an entity Person which defines a name component: + </para> + + <programlisting><![CDATA[from Person p where p.name.first='John' and p.name.last='Jingleheimer-Schmidt']]></programlisting> + + <para> + That's valid syntax, although a little verbose. It be nice to make this a bit more concise and use + <literal>row value constructor</literal> syntax: + </para> + + <programlisting><![CDATA[from Person p where p.name=('John', 'Jingleheimer-Schmidt')]]></programlisting> + + <para> + It can also be useful to specify this in the <literal>select</literal> clause: + </para> + + <programlisting><![CDATA[select p.name from from Person p]]></programlisting> + + <para> + Another time using <literal>row value constructor</literal> syntax can be beneficial + is when using subqueries needing to compare against multiple values: + </para> + + <programlisting><![CDATA[from Cat as cat +where not ( cat.name, cat.color ) in ( + select cat.name, cat.color from DomesticCat cat +)]]></programlisting> + + <para> + One thing to consider when deciding if you want to use this syntax is that the query will + be dependent upon the ordering of the component sub-properties in the metadata. + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/query_sql.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/query_sql.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/query_sql.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/query_sql.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,760 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="querysql" revision="2"> + <title>Native SQL</title> + + <para>You may also express queries in the native SQL dialect of your + database. This is useful if you want to utilize database specific features + such as query hints or the <literal>CONNECT</literal> keyword in Oracle. It + also provides a clean migration path from a direct SQL/JDBC based + application to Hibernate.</para> + + <para>Hibernate3 allows you to specify handwritten SQL (including stored + procedures) for all create, update, delete, and load operations.</para> + + <sect1 id="querysql-creating" revision="4"> + <title>Using a <literal>SQLQuery</literal></title> + + <para>Execution of native SQL queries is controlled via the + <literal>SQLQuery</literal> interface, which is obtained by calling + <literal>Session.createSQLQuery()</literal>. The following describes how + to use this API for querying.</para> + + <sect2> + <title>Scalar queries</title> + + <para>The most basic SQL query is to get a list of scalars + (values).</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS").list(); +sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").list(); +]]></programlisting> + + <para>These will both return a List of Object arrays (Object[]) with + scalar values for each column in the CATS table. Hibernate will use + ResultSetMetadata to deduce the actual order and types of the returned + scalar values.</para> + + <para>To avoid the overhead of using + <literal>ResultSetMetadata</literal> or simply to be more explicit in + what is returned one can use <literal>addScalar()</literal>.</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS") + .addScalar("ID", Hibernate.LONG) + .addScalar("NAME", Hibernate.STRING) + .addScalar("BIRTHDATE", Hibernate.DATE) +]]></programlisting> + + <para>This query specified:</para> + + <itemizedlist> + <listitem> + <para>the SQL query string</para> + </listitem> + + <listitem> + <para>the columns and types to return</para> + </listitem> + </itemizedlist> + + <para>This will still return Object arrays, but now it will not use + <literal>ResultSetMetdata</literal> but will instead explicitly get the + ID, NAME and BIRTHDATE column as respectively a Long, String and a Short + from the underlying resultset. This also means that only these three + columns will be returned, even though the query is using + <literal>*</literal> and could return more than the three listed + columns.</para> + + <para>It is possible to leave out the type information for all or some + of the scalars.</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS") + .addScalar("ID", Hibernate.LONG) + .addScalar("NAME") + .addScalar("BIRTHDATE") +]]></programlisting> + + <para>This is essentially the same query as before, but now + <literal>ResultSetMetaData</literal> is used to decide the type of NAME + and BIRTHDATE where as the type of ID is explicitly specified.</para> + + <para>How the java.sql.Types returned from ResultSetMetaData is mapped + to Hibernate types is controlled by the Dialect. If a specific type is + not mapped or does not result in the expected type it is possible to + customize it via calls to <literal>registerHibernateType</literal> in + the Dialect.</para> + </sect2> + + <sect2> + <title>Entity queries</title> + + <para>The above queries were all about returning scalar values, + basically returning the "raw" values from the resultset. The following + shows how to get entity objects from a native sql query via + <literal>addEntity()</literal>.</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS").addEntity(Cat.class); +sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").addEntity(Cat.class); +]]></programlisting> + + <para>This query specified:</para> + + <itemizedlist> + <listitem> + <para>the SQL query string</para> + </listitem> + + <listitem> + <para>the entity returned by the query</para> + </listitem> + </itemizedlist> + + <para>Assuming that Cat is mapped as a class with the columns ID, NAME + and BIRTHDATE the above queries will both return a List where each + element is a Cat entity.</para> + + <para>If the entity is mapped with a <literal>many-to-one</literal> to + another entity it is required to also return this when performing the + native query, otherwise a database specific "column not found" error + will occur. The additional columns will automatically be returned when + using the * notation, but we prefer to be explicit as in the following + example for a <literal>many-to-one</literal> to a + <literal>Dog</literal>:</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, DOG_ID FROM CATS").addEntity(Cat.class); +]]></programlisting> + + <para>This will allow cat.getDog() to function properly.</para> + </sect2> + + <sect2> + <title>Handling associations and collections</title> + + <para>It is possible to eagerly join in the <literal>Dog</literal> to + avoid the possible extra roundtrip for initializing the proxy. This is + done via the <literal>addJoin()</literal> method, which allows you to + join in an association or collection.</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT c.ID, NAME, BIRTHDATE, DOG_ID, D_ID, D_NAME FROM CATS c, DOGS d WHERE c.DOG_ID = d.D_ID") + .addEntity("cat", Cat.class) + .addJoin("cat.dog"); +]]></programlisting> + + <para>In this example the returned <literal>Cat</literal>'s will have + their <literal>dog</literal> property fully initialized without any + extra roundtrip to the database. Notice that we added a alias name + ("cat") to be able to specify the target property path of the join. It + is possible to do the same eager joining for collections, e.g. if the + <literal>Cat</literal> had a one-to-many to <literal>Dog</literal> + instead.</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, D_ID, D_NAME, CAT_ID FROM CATS c, DOGS d WHERE c.ID = d.CAT_ID") + .addEntity("cat", Cat.class) + .addJoin("cat.dogs"); +]]></programlisting> + + <p>At this stage we are reaching the limits of what is possible with + native queries without starting to enhance the sql queries to make them + usable in Hibernate; the problems starts to arise when returning + multiple entities of the same type or when the default alias/column + names are not enough.</p> + </sect2> + + <sect2> + <title>Returning multiple entities</title> + + <para>Until now the result set column names are assumed to be the same + as the column names specified in the mapping document. This can be + problematic for SQL queries which join multiple tables, since the same + column names may appear in more than one table.</para> + + <para>Column alias injection is needed in the following query (which + most likely will fail):</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT c.*, m.* FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID") + .addEntity("cat", Cat.class) + .addEntity("mother", Cat.class) +]]></programlisting> + + <para>The intention for this query is to return two Cat instances per + row, a cat and its mother. This will fail since there is a conflict of + names since they are mapped to the same column names and on some + databases the returned column aliases will most likely be on the form + "c.ID", "c.NAME", etc. which are not equal to the columns specificed in + the mappings ("ID" and "NAME").</para> + + <para>The following form is not vulnerable to column name + duplication:</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT {cat.*}, {mother.*} FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID") + .addEntity("cat", Cat.class) + .addEntity("mother", Cat.class) +]]></programlisting> + + <para>This query specified:</para> + + <itemizedlist> + <listitem> + <para>the SQL query string, with placeholders for Hibernate to + inject column aliases</para> + </listitem> + + <listitem> + <para>the entities returned by the query</para> + </listitem> + </itemizedlist> + + <para>The {cat.*} and {mother.*} notation used above is a shorthand for + "all properties". Alternatively, you may list the columns explicity, but + even in this case we let Hibernate inject the SQL column aliases for + each property. The placeholder for a column alias is just the property + name qualified by the table alias. In the following example, we retrieve + Cats and their mothers from a different table (cat_log) to the one + declared in the mapping metadata. Notice that we may even use the + property aliases in the where clause if we like.</para> + + <programlisting><![CDATA[String sql = "SELECT ID as {c.id}, NAME as {c.name}, " + + "BIRTHDATE as {c.birthDate}, MOTHER_ID as {c.mother}, {mother.*} " + + "FROM CAT_LOG c, CAT_LOG m WHERE {c.mother} = c.ID"; + +List loggedCats = sess.createSQLQuery(sql) + .addEntity("cat", Cat.class) + .addEntity("mother", Cat.class).list() +]]></programlisting> + + <sect3 id="querysql-aliasreferences" revision="2"> + <title>Alias and property references</title> + + <para>For most cases the above alias injection is needed, but for + queries relating to more complex mappings like composite properties, + inheritance discriminators, collections etc. there are some specific + aliases to use to allow Hibernate to inject the proper aliases.</para> + + <para>The following table shows the different possibilities of using + the alias injection. Note: the alias names in the result are examples, + each alias will have a unique and probably different name when + used.</para> + + <table frame="topbot" id="aliasinjection-summary"> + <title>Alias injection names</title> + + <tgroup cols="3"> + <colspec colwidth="1*" /> + + <colspec colwidth="1*" /> + + <colspec colwidth="2.5*" /> + + <thead> + <row> + <entry>Description</entry> + + <entry>Syntax</entry> + + <entry>Example</entry> + </row> + </thead> + + <tbody> + <row> + <entry>A simple property</entry> + + <entry><literal>{[aliasname].[propertyname]</literal></entry> + + <entry><literal>A_NAME as {item.name}</literal></entry> + </row> + + <row> + <entry>A composite property</entry> + + <entry><literal>{[aliasname].[componentname].[propertyname]}</literal></entry> + + <entry><literal>CURRENCY as {item.amount.currency}, VALUE as + {item.amount.value}</literal></entry> + </row> + + <row> + <entry>Discriminator of an entity</entry> + + <entry><literal>{[aliasname].class}</literal></entry> + + <entry><literal>DISC as {item.class}</literal></entry> + </row> + + <row> + <entry>All properties of an entity</entry> + + <entry><literal>{[aliasname].*}</literal></entry> + + <entry><literal>{item.*}</literal></entry> + </row> + + <row> + <entry>A collection key</entry> + + <entry><literal>{[aliasname].key}</literal></entry> + + <entry><literal>ORGID as {coll.key}</literal></entry> + </row> + + <row> + <entry>The id of an collection</entry> + + <entry><literal>{[aliasname].id}</literal></entry> + + <entry><literal>EMPID as {coll.id}</literal></entry> + </row> + + <row> + <entry>The element of an collection</entry> + + <entry><literal>{[aliasname].element}</literal></entry> + + <entry><literal>XID as {coll.element}</literal></entry> + </row> + + <row> + <entry>roperty of the element in the collection</entry> + + <entry><literal>{[aliasname].element.[propertyname]}</literal></entry> + + <entry><literal>NAME as {coll.element.name}</literal></entry> + </row> + + <row> + <entry>All properties of the element in the collection</entry> + + <entry><literal>{[aliasname].element.*}</literal></entry> + + <entry><literal>{coll.element.*}</literal></entry> + </row> + + <row> + <entry>All properties of the the collection</entry> + + <entry><literal>{[aliasname].*}</literal></entry> + + <entry><literal>{coll.*}</literal></entry> + </row> + </tbody> + </tgroup> + </table> + </sect3> + </sect2> + + <sect2> + <title>Returning non-managed entities</title> + + <para>It is possible to apply a ResultTransformer to native sql queries. Allowing it to e.g. return non-managed entities.</para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT NAME, BIRTHDATE FROM CATS") + .setResultTransformer(Transformers.aliasToBean(CatDTO.class))]]></programlisting> + + <para>This query specified:</para> + + <itemizedlist> + <listitem> + <para>the SQL query string</para> + </listitem> + + <listitem> + <para>a result transformer</para> + </listitem> + </itemizedlist> + + <para> + The above query will return a list of <literal>CatDTO</literal> which has been instantiated and injected the values of NAME and BIRTHNAME into its corresponding + properties or fields. + </para> + </sect2> + + <sect2> + <title>Handling inheritance</title> + + <para>Native sql queries which query for entities that is mapped as part + of an inheritance must include all properties for the baseclass and all + it subclasses.</para> + </sect2> + + <sect2> + <title>Parameters</title> + + <para>Native sql queries support positional as well as named + parameters:</para> + + <programlisting><![CDATA[Query query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like ?").addEntity(Cat.class); +List pusList = query.setString(0, "Pus%").list(); + +query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like :name").addEntity(Cat.class); +List pusList = query.setString("name", "Pus%").list(); ]]></programlisting> + </sect2> + + + + </sect1> + + <sect1 id="querysql-namedqueries" revision="3"> + <title>Named SQL queries</title> + + <para>Named SQL queries may be defined in the mapping document and called + in exactly the same way as a named HQL query. In this case, we do + <emphasis>not</emphasis> need to call + <literal>addEntity()</literal>.</para> + + <programlisting><![CDATA[<sql-query name="persons"> + <return alias="person" class="eg.Person"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex} + FROM PERSON person + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <programlisting><![CDATA[List people = sess.getNamedQuery("persons") + .setString("namePattern", namePattern) + .setMaxResults(50) + .list();]]></programlisting> + + <para>The <literal><return-join></literal> and + <literal><load-collection></literal> elements are used to join + associations and define queries which initialize collections, + respectively.</para> + + <programlisting><![CDATA[<sql-query name="personsWith"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <para>A named SQL query may return a scalar value. You must declare the + column alias and Hibernate type using the + <literal><return-scalar></literal> element:</para> + + <programlisting><![CDATA[<sql-query name="mySqlQuery"> + <return-scalar column="name" type="string"/> + <return-scalar column="age" type="long"/> + SELECT p.NAME AS name, + p.AGE AS age, + FROM PERSON p WHERE p.NAME LIKE 'Hiber%' +</sql-query>]]></programlisting> + + <para>You can externalize the resultset mapping informations in a + <literal><resultset></literal> element to either reuse them accross + several named queries or through the + <literal>setResultSetMapping()</literal> API.</para> + + <programlisting><![CDATA[<resultset name="personAddress"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> +</resultset> + +<sql-query name="personsWith" resultset-ref="personAddress"> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <para>You can alternatively use the resultset mapping information in your + hbm files directly in java code.</para> + + <programlisting><![CDATA[List cats = sess.createSQLQuery( + "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id" + ) + .setResultSetMapping("catAndKitten") + .list();]]></programlisting> + + <sect2 id="propertyresults"> + <title>Using return-property to explicitly specify column/alias + names</title> + + <para>With <literal><return-property></literal> you can explicitly + tell Hibernate what column aliases to use, instead of using the + <literal>{}</literal>-syntax to let Hibernate inject its own + aliases.</para> + + <programlisting><![CDATA[<sql-query name="mySqlQuery"> + <return alias="person" class="eg.Person"> + <return-property name="name" column="myName"/> + <return-property name="age" column="myAge"/> + <return-property name="sex" column="mySex"/> + </return> + SELECT person.NAME AS myName, + person.AGE AS myAge, + person.SEX AS mySex, + FROM PERSON person WHERE person.NAME LIKE :name +</sql-query> +]]></programlisting> + + <para><literal><return-property></literal> also works with + multiple columns. This solves a limitation with the + <literal>{}</literal>-syntax which can not allow fine grained control of + multi-column properties.</para> + + <programlisting><![CDATA[<sql-query name="organizationCurrentEmployments"> + <return alias="emp" class="Employment"> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + <return-property name="endDate" column="myEndDate"/> + </return> + SELECT EMPLOYEE AS {emp.employee}, EMPLOYER AS {emp.employer}, + STARTDATE AS {emp.startDate}, ENDDATE AS {emp.endDate}, + REGIONCODE as {emp.regionCode}, EID AS {emp.id}, VALUE, CURRENCY + FROM EMPLOYMENT + WHERE EMPLOYER = :id AND ENDDATE IS NULL + ORDER BY STARTDATE ASC +</sql-query>]]></programlisting> + + <para>Notice that in this example we used + <literal><return-property></literal> in combination with the + <literal>{}</literal>-syntax for injection. Allowing users to choose how + they want to refer column and properties.</para> + + <para>If your mapping has a discriminator you must use + <literal><return-discriminator></literal> to specify the + discriminator column.</para> + </sect2> + + <sect2 id="sp_query" revision="1"> + <title>Using stored procedures for querying</title> + + <para>Hibernate 3 introduces support for queries via stored procedures + and functions. Most of the following documentation is equivalent for + both. The stored procedure/function must return a resultset as the first + out-parameter to be able to work with Hibernate. An example of such a + stored function in Oracle 9 and higher is as follows:</para> + + <programlisting><![CDATA[CREATE OR REPLACE FUNCTION selectAllEmployments + RETURN SYS_REFCURSOR +AS + st_cursor SYS_REFCURSOR; +BEGIN + OPEN st_cursor FOR + SELECT EMPLOYEE, EMPLOYER, + STARTDATE, ENDDATE, + REGIONCODE, EID, VALUE, CURRENCY + FROM EMPLOYMENT; + RETURN st_cursor; + END;]]></programlisting> + + <para>To use this query in Hibernate you need to map it via a named + query.</para> + + <programlisting><![CDATA[<sql-query name="selectAllEmployees_SP" callable="true"> + <return alias="emp" class="Employment"> + <return-property name="employee" column="EMPLOYEE"/> + <return-property name="employer" column="EMPLOYER"/> + <return-property name="startDate" column="STARTDATE"/> + <return-property name="endDate" column="ENDDATE"/> + <return-property name="regionCode" column="REGIONCODE"/> + <return-property name="id" column="EID"/> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + </return> + { ? = call selectAllEmployments() } +</sql-query>]]></programlisting> + + <para>Notice stored procedures currently only return scalars and + entities. <literal><return-join></literal> and + <literal><load-collection></literal> are not supported.</para> + + <sect3 id="querysql-limits-storedprocedures" revision="1"> + <title>Rules/limitations for using stored procedures</title> + + <para>To use stored procedures with Hibernate the procedures/functions + have to follow some rules. If they do not follow those rules they are + not usable with Hibernate. If you still want to use these procedures + you have to execute them via <literal>session.connection()</literal>. + The rules are different for each database, since database vendors have + different stored procedure semantics/syntax.</para> + + <para>Stored procedure queries can't be paged with + <literal>setFirstResult()/setMaxResults()</literal>.</para> + + <para>Recommended call form is standard SQL92: <literal>{ ? = call + functionName(<parameters>) }</literal> or <literal>{ ? = call + procedureName(<parameters>}</literal>. Native call syntax is not + supported.</para> + + <para>For Oracle the following rules apply:</para> + + <itemizedlist spacing="compact"> + <listitem> + <para>A function must return a result set. The first parameter of + a procedure must be an <literal>OUT</literal> that returns a + result set. This is done by using a + <literal>SYS_REFCURSOR</literal> type in Oracle 9 or 10. In Oracle + you need to define a <literal>REF CURSOR</literal> type, see + Oracle literature.</para> + </listitem> + </itemizedlist> + + <para>For Sybase or MS SQL server the following rules apply:</para> + + <itemizedlist spacing="compact"> + <listitem> + <para>The procedure must return a result set. Note that since + these servers can/will return multiple result sets and update + counts, Hibernate will iterate the results and take the first + result that is a result set as its return value. Everything else + will be discarded.</para> + </listitem> + + <listitem> + <para>If you can enable <literal>SET NOCOUNT ON</literal> in your + procedure it will probably be more efficient, but this is not a + requirement.</para> + </listitem> + </itemizedlist> + </sect3> + </sect2> + </sect1> + + <sect1 id="querysql-cud"> + <title>Custom SQL for create, update and delete</title> + + <para>Hibernate3 can use custom SQL statements for create, update, and + delete operations. The class and collection persisters in Hibernate + already contain a set of configuration time generated strings (insertsql, + deletesql, updatesql etc.). The mapping tags + <literal><sql-insert></literal>, + <literal><sql-delete></literal>, and + <literal><sql-update></literal> override these strings:</para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert>INSERT INTO PERSON (NAME, ID) VALUES ( UPPER(?), ? )</sql-insert> + <sql-update>UPDATE PERSON SET NAME=UPPER(?) WHERE ID=?</sql-update> + <sql-delete>DELETE FROM PERSON WHERE ID=?</sql-delete> +</class>]]></programlisting> + + <para>The SQL is directly executed in your database, so you are free to + use any dialect you like. This will of course reduce the portability of + your mapping if you use database specific SQL.</para> + + <para>Stored procedures are supported if the <literal>callable</literal> + attribute is set:</para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert callable="true">{call createPerson (?, ?)}</sql-insert> + <sql-delete callable="true">{? = call deletePerson (?)}</sql-delete> + <sql-update callable="true">{? = call updatePerson (?, ?)}</sql-update> +</class>]]></programlisting> + + <para>The order of the positional parameters are currently vital, as they + must be in the same sequence as Hibernate expects them.</para> + + <para>You can see the expected order by enabling debug logging for the + <literal>org.hibernate.persister.entity</literal> level. With this level + enabled Hibernate will print out the static SQL that is used to create, + update, delete etc. entities. (To see the expected sequence, remember to + not include your custom SQL in the mapping files as that will override the + Hibernate generated static sql.)</para> + + <para>The stored procedures are in most cases (read: better do it than + not) required to return the number of rows inserted/updated/deleted, as + Hibernate has some runtime checks for the success of the statement. + Hibernate always registers the first statement parameter as a numeric + output parameter for the CUD operations:</para> + + <programlisting><![CDATA[CREATE OR REPLACE FUNCTION updatePerson (uid IN NUMBER, uname IN VARCHAR2) + RETURN NUMBER IS +BEGIN + + update PERSON + set + NAME = uname, + where + ID = uid; + + return SQL%ROWCOUNT; + +END updatePerson;]]></programlisting> + </sect1> + + <sect1 id="querysql-load"> + <title>Custom SQL for loading</title> + + <para>You may also declare your own SQL (or HQL) queries for entity + loading:</para> + + <programlisting><![CDATA[<sql-query name="person"> + <return alias="pers" class="Person" lock-mode="upgrade"/> + SELECT NAME AS {pers.name}, ID AS {pers.id} + FROM PERSON + WHERE ID=? + FOR UPDATE +</sql-query>]]></programlisting> + + <para>This is just a named query declaration, as discussed earlier. You + may reference this named query in a class mapping:</para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <loader query-ref="person"/> +</class>]]></programlisting> + + <para>This even works with stored procedures.</para> + + <para>You may even define a query for collection loading:</para> + + <programlisting><![CDATA[<set name="employments" inverse="true"> + <key/> + <one-to-many class="Employment"/> + <loader query-ref="employments"/> +</set>]]></programlisting> + + <programlisting><![CDATA[<sql-query name="employments"> + <load-collection alias="emp" role="Person.employments"/> + SELECT {emp.*} + FROM EMPLOYMENT emp + WHERE EMPLOYER = :id + ORDER BY STARTDATE ASC, EMPLOYEE ASC +</sql-query>]]></programlisting> + + <para>You could even define an entity loader that loads a collection by + join fetching:</para> + + <programlisting><![CDATA[<sql-query name="person"> + <return alias="pers" class="Person"/> + <return-join alias="emp" property="pers.employments"/> + SELECT NAME AS {pers.*}, {emp.*} + FROM PERSON pers + LEFT OUTER JOIN EMPLOYMENT emp + ON pers.ID = emp.PERSON_ID + WHERE ID=? +</sql-query>]]></programlisting> + </sect1> +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/session_api.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/session_api.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/session_api.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/session_api.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1263 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="objectstate"> + <title>Working with objects</title> + + <para> + Hibernate is a full object/relational mapping solution that not only shields + the developer from the details of the underlying database management + system, but also offers <emphasis>state management</emphasis> of objects. This is, + contrary to the management of SQL <literal>statements</literal> in common JDBC/SQL + persistence layers, a very natural object-oriented view of persistence in Java + applications. + </para> + + <para> + In other words, Hibernate application developers should always think about the + <emphasis>state</emphasis> of their objects, and not necessarily about the + execution of SQL statements. This part is taken care of by Hibernate and is only + relevant for the application developer when tuning the performance of the system. + </para> + + <sect1 id="objectstate-overview"> + <title>Hibernate object states</title> + + <para> + Hibernate defines and supports the following object states: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Transient</emphasis> - an object is transient if it has just + been instantiated using the <literal>new</literal> operator, and it + is not associated with a Hibernate <literal>Session</literal>. It has no + persistent representation in the database and no identifier value has been + assigned. Transient instances will be destroyed by the garbage collector if + the application doesn't hold a reference anymore. Use the Hibernate + <literal>Session</literal> to make an object persistent (and let Hibernate + take care of the SQL statements that need to be executed for this transition). + </para> + </listitem> + <listitem> + <para> + <emphasis>Persistent</emphasis> - a persistent instance has a representation + in the database and an identifier value. It might just have been saved or loaded, + however, it is by definition in the scope of a <literal>Session</literal>. + Hibernate will detect any changes made to an object in persistent state and + synchronize the state with the database when the unit of work completes. + Developers don't execute manual <literal>UPDATE</literal> statements, or + <literal>DELETE</literal> statements when an object should be made transient. + </para> + </listitem> + <listitem> + <para> + <emphasis>Detached</emphasis> - a detached instance is an object that has been + persistent, but its <literal>Session</literal> has been closed. The reference + to the object is still valid, of course, and the detached instance might even + be modified in this state. A detached instance can be reattached to a new + <literal>Session</literal> at a later point in time, making it (and all the + modifications) persistent again. This feature enables a programming model for + long running units of work that require user think-time. We call them + <emphasis>application transactions</emphasis>, i.e. a unit of work from the + point of view of the user. + </para> + </listitem> + </itemizedlist> + + <para> + We'll now discuss the states and state transitions (and the Hibernate methods that + trigger a transition) in more detail. + </para> + + </sect1> + + <sect1 id="objectstate-makingpersistent" revision="1"> + <title>Making objects persistent</title> + + <para> + Newly instantiated instances of a a persistent class are considered + <emphasis>transient</emphasis> by Hibernate. We can make a transient + instance <emphasis>persistent</emphasis> by associating it with a + session: + </para> + + <programlisting><![CDATA[DomesticCat fritz = new DomesticCat(); +fritz.setColor(Color.GINGER); +fritz.setSex('M'); +fritz.setName("Fritz"); +Long generatedId = (Long) sess.save(fritz);]]></programlisting> + + <para> + If <literal>Cat</literal> has a generated identifier, the identifier is + generated and assigned to the <literal>cat</literal> when <literal>save()</literal> + is called. If <literal>Cat</literal> has an <literal>assigned</literal> + identifier, or a composite key, the identifier should be assigned to + the <literal>cat</literal> instance before calling <literal>save()</literal>. + You may also use <literal>persist()</literal> instead of <literal>save()</literal>, + with the semantics defined in the EJB3 early draft. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>persist()</literal> makes a transient instance persistent. + However, it doesn't guarantee that the identifier value will be assigned to + the persistent instance immediately, the assignment might happen at flush time. + <literal>persist()</literal> also guarantees that it will not execute an + <literal>INSERT</literal> statement if it is called outside of transaction + boundaries. This is useful in long-running conversations with an extended + Session/persistence context. + </para> + </listitem> + <listitem> + <para> + <literal>save()</literal> does guarantee to return an identifier. If an INSERT + has to be executed to get the identifier ( e.g. "identity" generator, not + "sequence"), this INSERT happens immediately, no matter if you are inside or + outside of a transaction. This is problematic in a long-running conversation + with an extended Session/persistence context. + </para> + </listitem> + </itemizedlist> + + <para> + Alternatively, you may assign the identifier using an overloaded version + of <literal>save()</literal>. + </para> + +<programlisting><![CDATA[DomesticCat pk = new DomesticCat(); +pk.setColor(Color.TABBY); +pk.setSex('F'); +pk.setName("PK"); +pk.setKittens( new HashSet() ); +pk.addKitten(fritz); +sess.save( pk, new Long(1234) );]]></programlisting> + + <para> + If the object you make persistent has associated objects (e.g. the + <literal>kittens</literal> collection in the previous example), + these objects may be made persistent in any order you like unless you + have a <literal>NOT NULL</literal> constraint upon a foreign key column. + There is never a risk of violating foreign key constraints. However, you + might violate a <literal>NOT NULL</literal> constraint if you + <literal>save()</literal> the objects in the wrong order. + </para> + + <para> + Usually you don't bother with this detail, as you'll very likely use Hibernate's + <emphasis>transitive persistence</emphasis> feature to save the associated + objects automatically. Then, even <literal>NOT NULL</literal> + constraint violations don't occur - Hibernate will take care of everything. + Transitive persistence is discussed later in this chapter. + </para> + + </sect1> + + <sect1 id="objectstate-loading"> + <title>Loading an object</title> + + <para> + The <literal>load()</literal> methods of <literal>Session</literal> gives you + a way to retrieve a persistent instance if you already know its identifier. + <literal>load()</literal> takes a class object and will load the state into + a newly instantiated instance of that class, in persistent state. + </para> + + <programlisting><![CDATA[Cat fritz = (Cat) sess.load(Cat.class, generatedId);]]></programlisting> + +<programlisting><![CDATA[// you need to wrap primitive identifiers +long id = 1234; +DomesticCat pk = (DomesticCat) sess.load( DomesticCat.class, new Long(id) );]]></programlisting> + + <para> + Alternatively, you can load state into a given instance: + </para> + +<programlisting><![CDATA[Cat cat = new DomesticCat(); +// load pk's state into cat +sess.load( cat, new Long(pkId) ); +Set kittens = cat.getKittens();]]></programlisting> + + <para> + Note that <literal>load()</literal> will throw an unrecoverable exception if + there is no matching database row. If the class is mapped with a proxy, + <literal>load()</literal> just returns an uninitialized proxy and does not + actually hit the database until you invoke a method of the proxy. This + behaviour is very useful if you wish to create an association to an object + without actually loading it from the database. It also allows multiple + instances to be loaded as a batch if <literal>batch-size</literal> is + defined for the class mapping. + </para> + + <para> + If you are not certain that a matching row exists, you should use the + <literal>get()</literal> method, which hits the database immediately and + returns null if there is no matching row. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id); +if (cat==null) { + cat = new Cat(); + sess.save(cat, id); +} +return cat;]]></programlisting> + + <para> + You may even load an object using an SQL <literal>SELECT ... FOR UPDATE</literal>, + using a <literal>LockMode</literal>. See the API documentation for more information. + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id, LockMode.UPGRADE);]]></programlisting> + + <para> + Note that any associated instances or contained collections are + <emphasis>not</emphasis> selected <literal>FOR UPDATE</literal>, unless you decide + to specify <literal>lock</literal> or <literal>all</literal> as a + cascade style for the association. + </para> + + <para> + It is possible to re-load an object and all its collections at any time, using the + <literal>refresh()</literal> method. This is useful when database triggers are used to + initialize some of the properties of the object. + </para> + + <programlisting><![CDATA[sess.save(cat); +sess.flush(); //force the SQL INSERT +sess.refresh(cat); //re-read the state (after the trigger executes)]]></programlisting> + + <para> + An important question usually appears at this point: How much does Hibernate load + from the database and how many SQL <literal>SELECT</literal>s will it use? This + depends on the <emphasis>fetching strategy</emphasis> and is explained in + <xref linkend="performance-fetching"/>. + </para> + + </sect1> + + <sect1 id="objectstate-querying" revision="1"> + <title>Querying</title> + + <para> + If you don't know the identifiers of the objects you are looking for, + you need a query. Hibernate supports an easy-to-use but powerful object + oriented query language (HQL). For programmatic query creation, Hibernate + supports a sophisticated Criteria and Example query feature (QBC and QBE). + You may also express your query in the native SQL of your database, with + optional support from Hibernate for result set conversion into objects. + </para> + + <sect2 id="objectstate-querying-executing" revision="1"> + <title>Executing queries</title> + + <para> + HQL and native SQL queries are represented with an instance of <literal>org.hibernate.Query</literal>. + This interface offers methods for parameter binding, result set handling, and for the execution + of the actual query. You always obtain a <literal>Query</literal> using the current + <literal>Session</literal>: + </para> + + <programlisting><![CDATA[List cats = session.createQuery( + "from Cat as cat where cat.birthdate < ?") + .setDate(0, date) + .list(); + +List mothers = session.createQuery( + "select mother from Cat as cat join cat.mother as mother where cat.name = ?") + .setString(0, name) + .list(); + +List kittens = session.createQuery( + "from Cat as cat where cat.mother = ?") + .setEntity(0, pk) + .list(); + +Cat mother = (Cat) session.createQuery( + "select cat.mother from Cat as cat where cat = ?") + .setEntity(0, izi) + .uniqueResult();]] + +Query mothersWithKittens = (Cat) session.createQuery( + "select mother from Cat as mother left join fetch mother.kittens"); +Set uniqueMothers = new HashSet(mothersWithKittens.list());]]></programlisting> + + <para> + A query is usually executed by invoking <literal>list()</literal>, the + result of the query will be loaded completely into a collection in memory. + Entity instances retrieved by a query are in persistent state. The + <literal>uniqueResult()</literal> method offers a shortcut if you + know your query will only return a single object. Note that queries that + make use of eager fetching of collections usually return duplicates of + the root objects (but with their collections initialized). You can filter + these duplicates simply through a <literal>Set</literal>. + </para> + + <sect3 id="objectstate-querying-executing-iterate"> + <title>Iterating results</title> + + <para> + Occasionally, you might be able to achieve better performance by + executing the query using the <literal>iterate()</literal> method. + This will only usually be the case if you expect that the actual + entity instances returned by the query will already be in the session + or second-level cache. If they are not already cached, + <literal>iterate()</literal> will be slower than <literal>list()</literal> + and might require many database hits for a simple query, usually + <emphasis>1</emphasis> for the initial select which only returns identifiers, + and <emphasis>n</emphasis> additional selects to initialize the actual instances. + </para> + + <programlisting><![CDATA[// fetch ids +Iterator iter = sess.createQuery("from eg.Qux q order by q.likeliness").iterate(); +while ( iter.hasNext() ) { + Qux qux = (Qux) iter.next(); // fetch the object + // something we couldnt express in the query + if ( qux.calculateComplicatedAlgorithm() ) { + // delete the current instance + iter.remove(); + // dont need to process the rest + break; + } +}]]></programlisting> + </sect3> + + <sect3 id="objectstate-querying-executing-tuples"> + <title>Queries that return tuples</title> + + <para> + Hibernate queries sometimes return tuples of objects, in which case each tuple + is returned as an array: + </para> + + <programlisting><![CDATA[Iterator kittensAndMothers = sess.createQuery( + "select kitten, mother from Cat kitten join kitten.mother mother") + .list() + .iterator(); + +while ( kittensAndMothers.hasNext() ) { + Object[] tuple = (Object[]) kittensAndMothers.next(); + Cat kitten = (Cat) tuple[0]; + Cat mother = (Cat) tuple[1]; + .... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-scalar" revision="1"> + <title>Scalar results</title> + + <para> + Queries may specify a property of a class in the <literal>select</literal> clause. + They may even call SQL aggregate functions. Properties or aggregates are considered + "scalar" results (and not entities in persistent state). + </para> + + <programlisting><![CDATA[Iterator results = sess.createQuery( + "select cat.color, min(cat.birthdate), count(cat) from Cat cat " + + "group by cat.color") + .list() + .iterator(); + +while ( results.hasNext() ) { + Object[] row = (Object[]) results.next(); + Color type = (Color) row[0]; + Date oldest = (Date) row[1]; + Integer count = (Integer) row[2]; + ..... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-parameters"> + <title>Bind parameters</title> + + <para> + Methods on <literal>Query</literal> are provided for binding values to + named parameters or JDBC-style <literal>?</literal> parameters. + <emphasis>Contrary to JDBC, Hibernate numbers parameters from zero.</emphasis> + Named parameters are identifiers of the form <literal>:name</literal> in + the query string. The advantages of named parameters are: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + named parameters are insensitive to the order they occur in the + query string + </para> + </listitem> + <listitem> + <para> + they may occur multiple times in the same query + </para> + </listitem> + <listitem> + <para> + they are self-documenting + </para> + </listitem> + </itemizedlist> + + <programlisting><![CDATA[//named parameter (preferred) +Query q = sess.createQuery("from DomesticCat cat where cat.name = :name"); +q.setString("name", "Fritz"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//positional parameter +Query q = sess.createQuery("from DomesticCat cat where cat.name = ?"); +q.setString(0, "Izi"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//named parameter list +List names = new ArrayList(); +names.add("Izi"); +names.add("Fritz"); +Query q = sess.createQuery("from DomesticCat cat where cat.name in (:namesList)"); +q.setParameterList("namesList", names); +List cats = q.list();]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-pagination"> + <title>Pagination</title> + + <para> + If you need to specify bounds upon your result set (the maximum number of rows + you want to retrieve and / or the first row you want to retrieve) you should + use methods of the <literal>Query</literal> interface: + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("from DomesticCat cat"); +q.setFirstResult(20); +q.setMaxResults(10); +List cats = q.list();]]></programlisting> + + <para> + Hibernate knows how to translate this limit query into the native + SQL of your DBMS. + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-scrolling"> + <title>Scrollable iteration</title> + + <para> + If your JDBC driver supports scrollable <literal>ResultSet</literal>s, the + <literal>Query</literal> interface may be used to obtain a + <literal>ScrollableResults</literal> object, which allows flexible + navigation of the query results. + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("select cat.name, cat from DomesticCat cat " + + "order by cat.name"); +ScrollableResults cats = q.scroll(); +if ( cats.first() ) { + + // find the first name on each page of an alphabetical list of cats by name + firstNamesOfPages = new ArrayList(); + do { + String name = cats.getString(0); + firstNamesOfPages.add(name); + } + while ( cats.scroll(PAGE_SIZE) ); + + // Now get the first page of cats + pageOfCats = new ArrayList(); + cats.beforeFirst(); + int i=0; + while( ( PAGE_SIZE > i++ ) && cats.next() ) pageOfCats.add( cats.get(1) ); + +} +cats.close()]]></programlisting> + + <para> + Note that an open database connection (and cursor) is required for this + functionality, use <literal>setMaxResult()</literal>/<literal>setFirstResult()</literal> + if you need offline pagination functionality. + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-named" revision="1"> + <title>Externalizing named queries</title> + + <para> + You may also define named queries in the mapping document. (Remember to use a + <literal>CDATA</literal> section if your query contains characters that could + be interpreted as markup.) + </para> + + <programlisting><![CDATA[<query name="ByNameAndMaximumWeight"><![CDATA[ + from eg.DomesticCat as cat + where cat.name = ? + and cat.weight > ? +] ]></query>]]></programlisting> + + <para> + Parameter binding and executing is done programatically: + </para> + + <programlisting><![CDATA[Query q = sess.getNamedQuery("ByNameAndMaximumWeight"); +q.setString(0, name); +q.setInt(1, minWeight); +List cats = q.list();]]></programlisting> + + <para> + Note that the actual program code is independent of the query language that + is used, you may also define native SQL queries in metadata, or migrate + existing queries to Hibernate by placing them in mapping files. + </para> + + <para> + Also note that a query declaration inside a <literal><hibernate-mapping></literal> + element requires a global unique name for the query, while a query declaration inside a + <literal><class></literal> element is made unique automatically by prepending the + fully qualified name of the class, for example + <literal>eg.Cat.ByNameAndMaximumWeight</literal>. + </para> + + </sect3> + + </sect2> + + <sect2 id="objectstate-filtering" revision="1"> + <title>Filtering collections</title> + <para> + A collection <emphasis>filter</emphasis> is a special type of query that may be applied to + a persistent collection or array. The query string may refer to <literal>this</literal>, + meaning the current collection element. + </para> + + <programlisting><![CDATA[Collection blackKittens = session.createFilter( + pk.getKittens(), + "where this.color = ?") + .setParameter( Color.BLACK, Hibernate.custom(ColorUserType.class) ) + .list() +);]]></programlisting> + + <para> + The returned collection is considered a bag, and it's a copy of the given + collection. The original collection is not modified (this is contrary to + the implication of the name "filter", but consistent with expected behavior). + </para> + + <para> + Observe that filters do not require a <literal>from</literal> clause (though they may have + one if required). Filters are not limited to returning the collection elements themselves. + </para> + + <programlisting><![CDATA[Collection blackKittenMates = session.createFilter( + pk.getKittens(), + "select this.mate where this.color = eg.Color.BLACK.intValue") + .list();]]></programlisting> + + <para> + Even an empty filter query is useful, e.g. to load a subset of elements in a + huge collection: + </para> + + <programlisting><![CDATA[Collection tenKittens = session.createFilter( + mother.getKittens(), "") + .setFirstResult(0).setMaxResults(10) + .list();]]></programlisting> + + </sect2> + + <sect2 id="objecstate-querying-criteria" revision="1"> + <title>Criteria queries</title> + + <para> + HQL is extremely powerful but some developers prefer to build queries dynamically, + using an object-oriented API, rather than building query strings. Hibernate provides + an intuitive <literal>Criteria</literal> query API for these cases: + </para> + + <programlisting><![CDATA[Criteria crit = session.createCriteria(Cat.class); +crit.add( Restrictions.eq( "color", eg.Color.BLACK ) ); +crit.setMaxResults(10); +List cats = crit.list();]]></programlisting> + + <para> + The <literal>Criteria</literal> and the associated <literal>Example</literal> + API are discussed in more detail in <xref linkend="querycriteria"/>. + </para> + + </sect2> + + <sect2 id="objectstate-querying-nativesql" revision="2"> + <title>Queries in native SQL</title> + + <para> + You may express a query in SQL, using <literal>createSQLQuery()</literal> and + let Hibernate take care of the mapping from result sets to objects. Note + that you may at any time call <literal>session.connection()</literal> and + use the JDBC <literal>Connection</literal> directly. If you chose to use the + Hibernate API, you must enclose SQL aliases in braces: + </para> + + <programlisting><![CDATA[List cats = session.createSQLQuery("SELECT {cat.*} FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list();]]></programlisting> + + <programlisting><![CDATA[List cats = session.createSQLQuery( + "SELECT {cat}.ID AS {cat.id}, {cat}.SEX AS {cat.sex}, " + + "{cat}.MATE AS {cat.mate}, {cat}.SUBCLASS AS {cat.class}, ... " + + "FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list()]]></programlisting> + + <para> + SQL queries may contain named and positional parameters, just like Hibernate queries. + More information about native SQL queries in Hibernate can be found in + <xref linkend="querysql"/>. + </para> + + </sect2> + + </sect1> + + <sect1 id="objectstate-modifying" revision="1"> + <title>Modifying persistent objects</title> + + <para> + <emphasis>Transactional persistent instances</emphasis> (ie. objects loaded, saved, created or + queried by the <literal>Session</literal>) may be manipulated by the application + and any changes to persistent state will be persisted when the <literal>Session</literal> + is <emphasis>flushed</emphasis> (discussed later in this chapter). There is no need + to call a particular method (like <literal>update()</literal>, which has a different + purpose) to make your modifications persistent. So the most straightforward way to update + the state of an object is to <literal>load()</literal> it, + and then manipulate it directly, while the <literal>Session</literal> is open: + </para> + + <programlisting><![CDATA[DomesticCat cat = (DomesticCat) sess.load( Cat.class, new Long(69) ); +cat.setName("PK"); +sess.flush(); // changes to cat are automatically detected and persisted]]></programlisting> + + <para> + Sometimes this programming model is inefficient since it would require both an SQL + <literal>SELECT</literal> (to load an object) and an SQL <literal>UPDATE</literal> + (to persist its updated state) in the same session. Therefore Hibernate offers an + alternate approach, using detached instances. + </para> + + <para> + <emphasis>Note that Hibernate does not offer its own API for direct execution of + <literal>UPDATE</literal> or <literal>DELETE</literal> statements. Hibernate is a + <emphasis>state management</emphasis> service, you don't have to think in + <emphasis>statements</emphasis> to use it. JDBC is a perfect API for executing + SQL statements, you can get a JDBC <literal>Connection</literal> at any time + by calling <literal>session.connection()</literal>. Furthermore, the notion + of mass operations conflicts with object/relational mapping for online + transaction processing-oriented applications. Future versions of Hibernate + may however provide special mass operation functions. See <xref linkend="batch"/> + for some possible batch operation tricks.</emphasis> + </para> + + </sect1> + + <sect1 id="objectstate-detached" revision="2"> + <title>Modifying detached objects</title> + + <para> + Many applications need to retrieve an object in one transaction, send it to the + UI layer for manipulation, then save the changes in a new transaction. + Applications that use this kind of approach in a high-concurrency environment + usually use versioned data to ensure isolation for the "long" unit of work. + </para> + + <para> + Hibernate supports this model by providing for reattachment of detached instances + using the <literal>Session.update()</literal> or <literal>Session.merge()</literal> + methods: + </para> + + <programlisting><![CDATA[// in the first session +Cat cat = (Cat) firstSession.load(Cat.class, catId); +Cat potentialMate = new Cat(); +firstSession.save(potentialMate); + +// in a higher layer of the application +cat.setMate(potentialMate); + +// later, in a new session +secondSession.update(cat); // update cat +secondSession.update(mate); // update mate]]></programlisting> + + <para> + If the <literal>Cat</literal> with identifier <literal>catId</literal> had already + been loaded by <literal>secondSession</literal> when the application tried to + reattach it, an exception would have been thrown. + </para> + + <para> + Use <literal>update()</literal> if you are sure that the session does + not contain an already persistent instance with the same identifier, and + <literal>merge()</literal> if you want to merge your modifications at any time + without consideration of the state of the session. In other words, <literal>update()</literal> + is usually the first method you would call in a fresh session, ensuring that + reattachment of your detached instances is the first operation that is executed. + </para> + + <para> + The application should individually <literal>update()</literal> detached instances + reachable from the given detached instance if and <emphasis>only</emphasis> if it wants + their state also updated. This can be automated of course, using <emphasis>transitive + persistence</emphasis>, see <xref linkend="objectstate-transitive"/>. + </para> + + <para> + The <literal>lock()</literal> method also allows an application to reassociate + an object with a new session. However, the detached instance has to be unmodified! + </para> + + <programlisting><![CDATA[//just reassociate: +sess.lock(fritz, LockMode.NONE); +//do a version check, then reassociate: +sess.lock(izi, LockMode.READ); +//do a version check, using SELECT ... FOR UPDATE, then reassociate: +sess.lock(pk, LockMode.UPGRADE);]]></programlisting> + + <para> + Note that <literal>lock()</literal> can be used with various + <literal>LockMode</literal>s, see the API documentation and the + chapter on transaction handling for more information. Reattachment is not + the only usecase for <literal>lock()</literal>. + </para> + + <para> + Other models for long units of work are discussed in <xref linkend="transactions-optimistic"/>. + </para> + + </sect1> + + <sect1 id="objectstate-saveorupdate"> + <title>Automatic state detection</title> + + <para> + Hibernate users have requested a general purpose method that either saves a + transient instance by generating a new identifier or updates/reattaches + the detached instances associated with its current identifier. + The <literal>saveOrUpdate()</literal> method implements this functionality. + </para> + + <programlisting><![CDATA[// in the first session +Cat cat = (Cat) firstSession.load(Cat.class, catID); + +// in a higher tier of the application +Cat mate = new Cat(); +cat.setMate(mate); + +// later, in a new session +secondSession.saveOrUpdate(cat); // update existing state (cat has a non-null id) +secondSession.saveOrUpdate(mate); // save the new instance (mate has a null id)]]></programlisting> + + <para> + The usage and semantics of <literal>saveOrUpdate()</literal> seems to be confusing + for new users. Firstly, so long as you are not trying to use instances from one session + in another new session, you should not need to use <literal>update()</literal>, + <literal>saveOrUpdate()</literal>, or <literal>merge()</literal>. Some whole + applications will never use either of these methods. + </para> + + <para> + Usually <literal>update()</literal> or <literal>saveOrUpdate()</literal> are used in + the following scenario: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + the application loads an object in the first session + </para> + </listitem> + <listitem> + <para> + the object is passed up to the UI tier + </para> + </listitem> + <listitem> + <para> + some modifications are made to the object + </para> + </listitem> + <listitem> + <para> + the object is passed back down to the business logic tier + </para> + </listitem> + <listitem> + <para> + the application persists these modifications by calling + <literal>update()</literal> in a second session + </para> + </listitem> + </itemizedlist> + + <para> + <literal>saveOrUpdate()</literal> does the following: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + if the object is already persistent in this session, do nothing + </para> + </listitem> + <listitem> + <para> + if another object associated with the session has the same identifier, + throw an exception + </para> + </listitem> + <listitem> + <para> + if the object has no identifier property, <literal>save()</literal> it + </para> + </listitem> + <listitem> + <para> + if the object's identifier has the value assigned to a newly instantiated + object, <literal>save()</literal> it + </para> + </listitem> + <listitem> + <para> + if the object is versioned (by a <literal><version></literal> or + <literal><timestamp></literal>), and the version property value + is the same value assigned to a newly instantiated object, + <literal>save()</literal> it + </para> + </listitem> + <listitem> + <para> + otherwise <literal>update()</literal> the object + </para> + </listitem> + </itemizedlist> + + <para> + and <literal>merge()</literal> is very different: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + if there is a persistent instance with the same identifier currently + associated with the session, copy the state of the given object onto + the persistent instance + </para> + </listitem> + <listitem> + <para> + if there is no persistent instance currently associated with the session, + try to load it from the database, or create a new persistent instance + </para> + </listitem> + <listitem> + <para> + the persistent instance is returned + </para> + </listitem> + <listitem> + <para> + the given instance does not become associated with the session, it + remains detached + </para> + </listitem> + </itemizedlist> + + </sect1> + + <sect1 id="objectstate-deleting" revision="1"> + <title>Deleting persistent objects</title> + + <para> + <literal>Session.delete()</literal> will remove an object's state from the database. + Of course, your application might still hold a reference to a deleted object. + It's best to think of <literal>delete()</literal> as making a persistent instance + transient. + </para> + + <programlisting><![CDATA[sess.delete(cat);]]></programlisting> + + <para> + You may delete objects in any order you like, without risk of foreign key + constraint violations. It is still possible to violate a <literal>NOT + NULL</literal> constraint on a foreign key column by deleting objects in + the wrong order, e.g. if you delete the parent, but forget to delete the + children. + </para> + + </sect1> + + <sect1 id="objectstate-replicating" revision="1"> + <title>Replicating object between two different datastores</title> + + <para> + It is occasionally useful to be able to take a graph of persistent instances + and make them persistent in a different datastore, without regenerating identifier + values. + </para> + + <programlisting><![CDATA[//retrieve a cat from one database +Session session1 = factory1.openSession(); +Transaction tx1 = session1.beginTransaction(); +Cat cat = session1.get(Cat.class, catId); +tx1.commit(); +session1.close(); + +//reconcile with a second database +Session session2 = factory2.openSession(); +Transaction tx2 = session2.beginTransaction(); +session2.replicate(cat, ReplicationMode.LATEST_VERSION); +tx2.commit(); +session2.close();]]></programlisting> + + <para> + The <literal>ReplicationMode</literal> determines how <literal>replicate()</literal> + will deal with conflicts with existing rows in the database. + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ReplicationMode.IGNORE</literal> - ignore the object when there is + an existing database row with the same identifier + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.OVERWRITE</literal> - overwrite any existing database + row with the same identifier + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.EXCEPTION</literal> - throw an exception if there is + an existing database row with the same identifier + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.LATEST_VERSION</literal> - overwrite the row if its + version number is earlier than the version number of the object, or ignore + the object otherwise + </para> + </listitem> + </itemizedlist> + + <para> + Usecases for this feature include reconciling data entered into different database + instances, upgrading system configuration information during product upgrades, + rolling back changes made during non-ACID transactions and more. + </para> + + </sect1> + + <sect1 id="objectstate-flushing"> + <title>Flushing the Session</title> + + <para> + From time to time the <literal>Session</literal> will execute the SQL statements + needed to synchronize the JDBC connection's state with the state of objects held in + memory. This process, <emphasis>flush</emphasis>, occurs by default at the following + points + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + before some query executions + </para> + </listitem> + <listitem> + <para> + from <literal>org.hibernate.Transaction.commit()</literal> + </para> + </listitem> + <listitem> + <para> + from <literal>Session.flush()</literal> + </para> + </listitem> + </itemizedlist> + + <para> + The SQL statements are issued in the following order + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + all entity insertions, in the same order the corresponding objects + were saved using <literal>Session.save()</literal> + </para> + </listitem> + <listitem> + <para> + all entity updates + </para> + </listitem> + <listitem> + <para> + all collection deletions + </para> + </listitem> + <listitem> + <para> + all collection element deletions, updates and insertions + </para> + </listitem> + <listitem> + <para> + all collection insertions + </para> + </listitem> + <listitem> + <para> + all entity deletions, in the same order the corresponding objects + were deleted using <literal>Session.delete()</literal> + </para> + </listitem> + </orderedlist> + + <para> + (An exception is that objects using <literal>native</literal> ID generation are + inserted when they are saved.) + </para> + + <para> + Except when you explicity <literal>flush()</literal>, there are absolutely no + guarantees about <emphasis>when</emphasis> the <literal>Session</literal> executes + the JDBC calls, only the <emphasis>order</emphasis> in which they are executed. + However, Hibernate does guarantee that the <literal>Query.list(..)</literal> + will never return stale data; nor will they return the wrong data. + </para> + + <para> + It is possible to change the default behavior so that flush occurs less frequently. + The <literal>FlushMode</literal> class defines three different modes: only flush + at commit time (and only when the Hibernate <literal>Transaction</literal> API + is used), flush automatically using the explained routine, or never flush unless + <literal>flush()</literal> is called explicitly. The last mode is useful for long running + units of work, where a <literal>Session</literal> is kept open and disconnected for + a long time (see <xref linkend="transactions-optimistic-longsession"/>). + </para> + + <programlisting><![CDATA[sess = sf.openSession(); +Transaction tx = sess.beginTransaction(); +sess.setFlushMode(FlushMode.COMMIT); // allow queries to return stale state + +Cat izi = (Cat) sess.load(Cat.class, id); +izi.setName(iznizi); + +// might return stale data +sess.find("from Cat as cat left outer join cat.kittens kitten"); + +// change to izi is not flushed! +... +tx.commit(); // flush occurs +sess.close();]]></programlisting> + + <para> + During flush, an exception might occur (e.g. if a DML operation violates a constraint). + Since handling exceptions involves some understanding of Hibernate's transactional + behavior, we discuss it in <xref linkend="transactions"/>. + </para> + + </sect1> + + <sect1 id="objectstate-transitive" revision="1"> + <title>Transitive persistence</title> + + <para> + It is quite cumbersome to save, delete, or reattach individual objects, + especially if you deal with a graph of associated objects. A common case is + a parent/child relationship. Consider the following example: + </para> + + <para> + If the children in a parent/child relationship would be value typed (e.g. a collection + of addresses or strings), their life cycle would depend on the parent and no + further action would be required for convenient "cascading" of state changes. + When the parent is saved, the value-typed child objects are saved as + well, when the parent is deleted, the children will be deleted, etc. This + even works for operations such as the removal of a child from the collection; + Hibernate will detect this and, since value-typed objects can't have shared + references, delete the child from the database. + </para> + + <para> + Now consider the same scenario with parent and child objects being entities, + not value-types (e.g. categories and items, or parent and child cats). Entities + have their own life cycle, support shared references (so removing an entity from + the collection does not mean it can be deleted), and there is by default no + cascading of state from one entity to any other associated entities. Hibernate + does not implement <emphasis>persistence by reachability</emphasis> by default. + </para> + + <para> + For each basic operation of the Hibernate session - including <literal>persist(), merge(), + saveOrUpdate(), delete(), lock(), refresh(), evict(), replicate()</literal> - there is a + corresponding cascade style. Respectively, the cascade styles are named <literal>create, + merge, save-update, delete, lock, refresh, evict, replicate</literal>. If you want an + operation to be cascaded along an association, you must indicate that in the mapping + document. For example: + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist"/>]]></programlisting> + + <para> + Cascade styles my be combined: + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist,delete,lock"/>]]></programlisting> + + <para> + You may even use <literal>cascade="all"</literal> to specify that <emphasis>all</emphasis> + operations should be cascaded along the association. The default <literal>cascade="none"</literal> + specifies that no operations are to be cascaded. + </para> + + <para> + A special cascade style, <literal>delete-orphan</literal>, applies only to one-to-many + associations, and indicates that the <literal>delete()</literal> operation should + be applied to any child object that is removed from the association. + </para> + + + <para> + Recommendations: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + It doesn't usually make sense to enable cascade on a <literal><many-to-one></literal> + or <literal><many-to-many></literal> association. Cascade is often useful for + <literal><one-to-one></literal> and <literal><one-to-many></literal> + associations. + </para> + </listitem> + <listitem> + <para> + If the child object's lifespan is bounded by the lifespan of the parent + object, make it a <emphasis>life cycle object</emphasis> by specifying + <literal>cascade="all,delete-orphan"</literal>. + </para> + </listitem> + <listitem> + <para> + Otherwise, you might not need cascade at all. But if you think that you will often be + working with the parent and children together in the same transaction, and you want to save + yourself some typing, consider using <literal>cascade="persist,merge,save-update"</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + Mapping an association (either a single valued association, or a collection) with + <literal>cascade="all"</literal> marks the association as a + <emphasis>parent/child</emphasis> style relationship where save/update/delete of the + parent results in save/update/delete of the child or children. + </para> + <para> + Futhermore, a mere reference to a child from a persistent parent will result in + save/update of the child. This metaphor is incomplete, however. A child which becomes + unreferenced by its parent is <emphasis>not</emphasis> automatically deleted, except + in the case of a <literal><one-to-many></literal> association mapped with + <literal>cascade="delete-orphan"</literal>. The precise semantics of cascading + operations for a parent/child relationship are as follows: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + If a parent is passed to <literal>persist()</literal>, all children are passed to + <literal>persist()</literal> + </para> + </listitem> + <listitem> + <para> + If a parent is passed to <literal>merge()</literal>, all children are passed to + <literal>merge()</literal> + </para> + </listitem> + <listitem> + <para> + If a parent is passed to <literal>save()</literal>, <literal>update()</literal> or + <literal>saveOrUpdate()</literal>, all children are passed to <literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + If a transient or detached child becomes referenced by a persistent parent, + it is passed to <literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + If a parent is deleted, all children are passed to <literal>delete()</literal> + </para> + </listitem> + <listitem> + <para> + If a child is dereferenced by a persistent parent, <emphasis>nothing + special happens</emphasis> - the application should explicitly delete + the child if necessary - unless <literal>cascade="delete-orphan"</literal>, + in which case the "orphaned" child is deleted. + </para> + </listitem> + </itemizedlist> + + <para> + Finally, note that cascading of operations can be applied to an object graph at + <emphasis>call time</emphasis> or at <emphasis>flush time</emphasis>. All operations, + if enabled, are cascaded to associated entities reachable when the operation is + executed. However, <literal>save-upate</literal> and <literal>delete-orphan</literal> + are transitive for all associated entities reachable during flush of the + <literal>Session</literal>. + </para> + + </sect1> + + <sect1 id="objectstate-metadata"> + <title>Using metadata</title> + + <para> + Hibernate requires a very rich meta-level model of all entity and value types. From time + to time, this model is very useful to the application itself. For example, the application + might use Hibernate's metadata to implement a "smart" deep-copy algorithm that understands + which objects should be copied (eg. mutable value types) and which should not (eg. + immutable value types and, possibly, associated entities). + </para> + <para> + Hibernate exposes metadata via the <literal>ClassMetadata</literal> and + <literal>CollectionMetadata</literal> interfaces and the <literal>Type</literal> + hierarchy. Instances of the metadata interfaces may be obtained from the + <literal>SessionFactory</literal>. + </para> + + <programlisting><![CDATA[Cat fritz = ......; +ClassMetadata catMeta = sessionfactory.getClassMetadata(Cat.class); + +Object[] propertyValues = catMeta.getPropertyValues(fritz); +String[] propertyNames = catMeta.getPropertyNames(); +Type[] propertyTypes = catMeta.getPropertyTypes(); + +// get a Map of all properties which are not collections or associations +Map namedValues = new HashMap(); +for ( int i=0; i<propertyNames.length; i++ ) { + if ( !propertyTypes[i].isEntityType() && !propertyTypes[i].isCollectionType() ) { + namedValues.put( propertyNames[i], propertyValues[i] ); + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/toolset_guide.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/toolset_guide.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/toolset_guide.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/toolset_guide.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,607 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="toolsetguide" revision="2"> + <title>Toolset Guide</title> + + <para> + Roundtrip engineering with Hibernate is possible using a set of Eclipse plugins, + commandline tools, as well as Ant tasks. + </para> + + <para> + The <emphasis>Hibernate Tools</emphasis> currently include plugins for the Eclipse + IDE as well as Ant tasks for reverse engineering of existing databases: + </para> + + <itemizedlist> + <listitem><para> + <emphasis>Mapping Editor:</emphasis> An editor for Hibernate XML mapping files, + supporting auto-completion and syntax highlighting. It also supports semantic + auto-completion for class names and property/field names, making it much more versatile than a normal XML editor. + </para></listitem> + <listitem><para> + <emphasis>Console:</emphasis> The console is a new view in Eclipse. In addition to + a tree overview of your console configurations, you also get an interactive view + of your persistent classes and their relationships. The console allows you to + execute HQL queries against your database and browse the result directly in + Eclipse. + </para></listitem> + <listitem><para> + <emphasis>Development Wizards:</emphasis> Several wizards are provided with the + Hibernate Eclipse tools; you can use a wizard to quickly generate Hibernate configuration + (cfg.xml) files, or you may even completely reverse engineer an existing database schema + into POJO source files and Hibernate mapping files. The reverse engineering wizard + supports customizable templates. + </para></listitem> + <listitem><para> + <emphasis>Ant Tasks:</emphasis> + </para></listitem> + + </itemizedlist> + + <para> + Please refer to the <emphasis>Hibernate Tools</emphasis> package and it's documentation + for more information. + </para> + + <para> + However, the Hibernate main package comes bundled with an integrated tool (it can even + be used from "inside" Hibernate on-the-fly): <emphasis>SchemaExport</emphasis> aka + <literal>hbm2ddl</literal>. + </para> + + <sect1 id="toolsetguide-s1" revision="2"> + <title>Automatic schema generation</title> + + <para> + DDL may be generated from your mapping files by a Hibernate utility. The generated + schema includes referential integrity constraints (primary and foreign keys) for + entity and collection tables. Tables and sequences are also created for mapped + identifier generators. + </para> + + <para> + You <emphasis>must</emphasis> specify a SQL <literal>Dialect</literal> via the + <literal>hibernate.dialect</literal> property when using this tool, as DDL + is highly vendor specific. + </para> + + <para> + First, customize your mapping files to improve the generated schema. + </para> + + <sect2 id="toolsetguide-s1-2" revision="3"> + <title>Customizing the schema</title> + + <para> + Many Hibernate mapping elements define optional attributes named <literal>length</literal>, + <literal>precision</literal> and <literal>scale</literal>. You may set the length, precision + and scale of a column with this attribute. + + </para> + + <programlisting><![CDATA[<property name="zip" length="5"/>]]></programlisting> + <programlisting><![CDATA[<property name="balance" precision="12" scale="2"/>]]></programlisting> + + <para> + Some tags also accept a <literal>not-null</literal> attribute (for generating a + <literal>NOT NULL</literal> constraint on table columns) and a <literal>unique</literal> + attribute (for generating <literal>UNIQUE</literal> constraint on table columns). + </para> + + <programlisting><![CDATA[<many-to-one name="bar" column="barId" not-null="true"/>]]></programlisting> + + <programlisting><![CDATA[<element column="serialNumber" type="long" not-null="true" unique="true"/>]]></programlisting> + + <para> + A <literal>unique-key</literal> attribute may be used to group columns in + a single unique key constraint. Currently, the specified value of the + <literal>unique-key</literal> attribute is <emphasis>not</emphasis> used + to name the constraint in the generated DDL, only to group the columns in + the mapping file. + </para> + + <programlisting><![CDATA[<many-to-one name="org" column="orgId" unique-key="OrgEmployeeId"/> +<property name="employeeId" unique-key="OrgEmployee"/>]]></programlisting> + + <para> + An <literal>index</literal> attribute specifies the name of an index that + will be created using the mapped column or columns. Multiple columns may be + grouped into the same index, simply by specifying the same index name. + </para> + + <programlisting><![CDATA[<property name="lastName" index="CustName"/> +<property name="firstName" index="CustName"/>]]></programlisting> + + <para> + A <literal>foreign-key</literal> attribute may be used to override the name + of any generated foreign key constraint. + </para> + + <programlisting><![CDATA[<many-to-one name="bar" column="barId" foreign-key="FKFooBar"/>]]></programlisting> + + <para> + Many mapping elements also accept a child <literal><column></literal> element. + This is particularly useful for mapping multi-column types: + </para> + + <programlisting><![CDATA[<property name="name" type="my.customtypes.Name"/> + <column name="last" not-null="true" index="bar_idx" length="30"/> + <column name="first" not-null="true" index="bar_idx" length="20"/> + <column name="initial"/> +</property>]]></programlisting> + + <para> + The <literal>default</literal> attribute lets you specify a default value for + a column (you should assign the same value to the mapped property before + saving a new instance of the mapped class). + </para> + + <programlisting><![CDATA[<property name="credits" type="integer" insert="false"> + <column name="credits" default="10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<version name="version" type="integer" insert="false"> + <column name="version" default="0"/> +</property>]]></programlisting> + + <para> + The <literal>sql-type</literal> attribute allows the user to override the default + mapping of a Hibernate type to SQL datatype. + </para> + + <programlisting><![CDATA[<property name="balance" type="float"> + <column name="balance" sql-type="decimal(13,3)"/> +</property>]]></programlisting> + + <para> + The <literal>check</literal> attribute allows you to specify a check constraint. + </para> + + <programlisting><![CDATA[<property name="foo" type="integer"> + <column name="foo" check="foo > 10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<class name="Foo" table="foos" check="bar < 100.0"> + ... + <property name="bar" type="float"/> +</class>]]></programlisting> + + + <table frame="topbot" id="schemattributes-summary" revision="2"> + <title>Summary</title> + <tgroup cols="3"> + <colspec colwidth="1*"/> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>Attribute</entry> + <entry>Values</entry> + <entry>Interpretation</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>length</literal></entry> + <entry>number</entry> + <entry>column length</entry> + </row> + <row> + <entry><literal>precision</literal></entry> + <entry>number</entry> + <entry>column decimal precision</entry> + </row> + <row> + <entry><literal>scale</literal></entry> + <entry>number</entry> + <entry>column decimal scale</entry> + </row> + <row> + <entry><literal>not-null</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>specfies that the column should be non-nullable</entry> + </row> + <row> + <entry><literal>unique</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>specifies that the column should have a unique constraint</entry> + </row> + <row> + <entry><literal>index</literal></entry> + <entry><literal>index_name</literal></entry> + <entry>specifies the name of a (multi-column) index</entry> + </row> + <row> + <entry><literal>unique-key</literal></entry> + <entry><literal>unique_key_name</literal></entry> + <entry>specifies the name of a multi-column unique constraint</entry> + </row> + <row> + <entry><literal>foreign-key</literal></entry> + <entry><literal>foreign_key_name</literal></entry> + <entry> + specifies the name of the foreign key constraint generated + for an association, for a <literal><one-to-one></literal>, + <literal><many-to-one></literal>, <literal><key></literal>, + or <literal><many-to-many></literal> mapping element. Note that + <literal>inverse="true"</literal> sides will not be considered + by <literal>SchemaExport</literal>. + </entry> + </row> + <row> + <entry><literal>sql-type</literal></entry> + <entry><literal>SQL column type</literal></entry> + <entry> + overrides the default column type (attribute of + <literal><column></literal> element only) + </entry> + </row> + <row> + <entry><literal>default</literal></entry> + <entry>SQL expression</entry> + <entry> + specify a default value for the column + </entry> + </row> + <row> + <entry><literal>check</literal></entry> + <entry>SQL expression</entry> + <entry> + create an SQL check constraint on either column or table + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + The <literal><comment></literal> element allows you to specify comments + for the generated schema. + </para> + + <programlisting><![CDATA[<class name="Customer" table="CurCust"> + <comment>Current customers only</comment> + ... +</class>]]></programlisting> + + <programlisting><![CDATA[<property name="balance"> + <column name="bal"> + <comment>Balance in USD</comment> + </column> +</property>]]></programlisting> + + <para> + This results in a <literal>comment on table</literal> or + <literal>comment on column</literal> statement in the generated + DDL (where supported). + </para> + + </sect2> + + <sect2 id="toolsetguide-s1-3" revision="2"> + <title>Running the tool</title> + + <para> + The <literal>SchemaExport</literal> tool writes a DDL script to standard out and/or + executes the DDL statements. + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaExport</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaExport</literal> Command Line Options</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>don't output the script to stdout</entry> + </row> + <row> + <entry><literal>--drop</literal></entry> + <entry>only drop the tables</entry> + </row> + <row> + <entry><literal>--create</literal></entry> + <entry>only create the tables</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>don't export to the database</entry> + </row> + <row> + <entry><literal>--output=my_schema.ddl</literal></entry> + <entry>output the ddl script to a file</entry> + </row> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>select a <literal>NamingStrategy</literal></entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>read Hibernate configuration from an XML file</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>read database properties from a file</entry> + </row> + <row> + <entry><literal>--format</literal></entry> + <entry>format the generated SQL nicely in the script</entry> + </row> + <row> + <entry><literal>--delimiter=;</literal></entry> + <entry>set an end of line delimiter for the script</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + You may even embed <literal>SchemaExport</literal> in your application: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaExport(cfg).create(false, true);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-4"> + <title>Properties</title> + + <para> + Database properties may be specified + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para>as system properties with <literal>-D</literal><emphasis><property></emphasis></para> + </listitem> + <listitem> + <para>in <literal>hibernate.properties</literal></para> + </listitem> + <listitem> + <para>in a named properties file with <literal>--properties</literal></para> + </listitem> + </itemizedlist> + + <para> + The needed properties are: + </para> + + <table frame="topbot"> + <title>SchemaExport Connection Properties</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Property Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>hibernate.connection.driver_class</literal></entry> + <entry>jdbc driver class</entry> + </row> + <row> + <entry><literal>hibernate.connection.url</literal></entry> + <entry>jdbc url</entry> + </row> + <row> + <entry><literal>hibernate.connection.username</literal></entry> + <entry>database user</entry> + </row> + <row> + <entry><literal>hibernate.connection.password</literal></entry> + <entry>user password</entry> + </row> + <row> + <entry><literal>hibernate.dialect</literal></entry> + <entry>dialect</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="toolsetguide-s1-5"> + <title>Using Ant</title> + + <para> + You can call <literal>SchemaExport</literal> from your Ant build script: + </para> + + <programlisting><![CDATA[<target name="schemaexport"> + <taskdef name="schemaexport" + classname="org.hibernate.tool.hbm2ddl.SchemaExportTask" + classpathref="class.path"/> + + <schemaexport + properties="hibernate.properties" + quiet="no" + text="no" + drop="no" + delimiter=";" + output="schema-export.sql"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaexport> +</target>]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-6" revision="2"> + <title>Incremental schema updates</title> + + <para> + The <literal>SchemaUpdate</literal> tool will update an existing schema with "incremental" changes. + Note that <literal>SchemaUpdate</literal> depends heavily upon the JDBC metadata API, so it will + not work with all JDBC drivers. + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaUpdate</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaUpdate</literal> Command Line Options</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>don't output the script to stdout</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>don't export the script to the database</entry> + </row> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>select a <literal>NamingStrategy</literal></entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>read database properties from a file</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>specify a <literal>.cfg.xml</literal> file</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + You may embed <literal>SchemaUpdate</literal> in your application: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaUpdate(cfg).execute(false);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-7"> + <title>Using Ant for incremental schema updates</title> + + <para> + You can call <literal>SchemaUpdate</literal> from the Ant script: + </para> + + <programlisting><![CDATA[<target name="schemaupdate"> + <taskdef name="schemaupdate" + classname="org.hibernate.tool.hbm2ddl.SchemaUpdateTask" + classpathref="class.path"/> + + <schemaupdate + properties="hibernate.properties" + quiet="no"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaupdate> +</target>]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-8" revision="1"> + <title>Schema validation</title> + + <para> + The <literal>SchemaValidator</literal> tool will validate that the existing database schema "matches" + your mapping documents. Note that <literal>SchemaValidator</literal> depends heavily upon the JDBC + metadata API, so it will not work with all JDBC drivers. This tool is extremely useful for testing. + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaValidator</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaValidator</literal> Command Line Options</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>select a <literal>NamingStrategy</literal></entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>read database properties from a file</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>specify a <literal>.cfg.xml</literal> file</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + You may embed <literal>SchemaValidator</literal> in your application: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaValidator(cfg).validate();]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-9"> + <title>Using Ant for schema validation</title> + + <para> + You can call <literal>SchemaValidator</literal> from the Ant script: + </para> + + <programlisting><![CDATA[<target name="schemavalidate"> + <taskdef name="schemavalidator" + classname="org.hibernate.tool.hbm2ddl.SchemaValidatorTask" + classpathref="class.path"/> + + <schemavalidator + properties="hibernate.properties"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemavalidator> +</target>]]></programlisting> + + </sect2> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/transactions.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/transactions.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/transactions.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/transactions.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1112 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="transactions" revision="2"> + <title>Transactions And Concurrency</title> + + <para> + The most important point about Hibernate and concurrency control is that it is very + easy to understand. Hibernate directly uses JDBC connections and JTA resources without + adding any additional locking behavior. We highly recommend you spend some time with the + JDBC, ANSI, and transaction isolation specification of your database management system. + </para> + + <para> + Hibernate does not lock objects in memory. Your application can expect the behavior as + defined by the isolation level of your database transactions. Note that thanks to the + <literal>Session</literal>, which is also a transaction-scoped cache, Hibernate + provides repeatable reads for lookup by identifier and entity queries (not + reporting queries that return scalar values). + </para> + + <para> + In addition to versioning for automatic optimistic concurrency control, Hibernate also + offers a (minor) API for pessimistic locking of rows, using the + <literal>SELECT FOR UPDATE</literal> syntax. Optimistic concurrency control and + this API are discussed later in this chapter. + </para> + + <para> + We start the discussion of concurrency control in Hibernate with the granularity of + <literal>Configuration</literal>, <literal>SessionFactory</literal>, and + <literal>Session</literal>, as well as database transactions and long conversations. + </para> + + <sect1 id="transactions-basics" revision="1"> + <title>Session and transaction scopes</title> + + <para> + A <literal>SessionFactory</literal> is an expensive-to-create, threadsafe object + intended to be shared by all application threads. It is created once, usually on + application startup, from a <literal>Configuration</literal> instance. + </para> + + <para> + A <literal>Session</literal> is an inexpensive, non-threadsafe object that should be + used once, for a single request, a conversation, single unit of work, and then discarded. + A <literal>Session</literal> will not obtain a JDBC <literal>Connection</literal> + (or a <literal>Datasource</literal>) unless it is needed, hence consume no + resources until used. + </para> + + <para> + To complete this picture you also have to think about database transactions. A + database transaction has to be as short as possible, to reduce lock contention in + the database. Long database transactions will prevent your application from scaling + to highly concurrent load. Hence, it is almost never good design to hold a + database transaction open during user think time, until the unit of work is + complete. + </para> + + <para> + What is the scope of a unit of work? Can a single Hibernate <literal>Session</literal> + span several database transactions or is this a one-to-one relationship of scopes? When + should you open and close a <literal>Session</literal> and how do you demarcate the + database transaction boundaries? + </para> + + <sect2 id="transactions-basics-uow" revision="1"> + <title>Unit of work</title> + + <para> + First, don't use the <emphasis>session-per-operation</emphasis> antipattern, that is, + don't open and close a <literal>Session</literal> for every simple database call in + a single thread! Of course, the same is true for database transactions. Database calls + in an application are made using a planned sequence, they are grouped into atomic + units of work. (Note that this also means that auto-commit after every single + SQL statement is useless in an application, this mode is intended for ad-hoc SQL + console work. Hibernate disables, or expects the application server to do so, + auto-commit mode immediately.) Database transactions are never optional, all + communication with a database has to occur inside a transaction, no matter if + you read or write data. As explained, auto-commit behavior for reading data + should be avoided, as many small transactions are unlikely to perform better than + one clearly defined unit of work. The latter is also much more maintainable + and extensible. + </para> + + <para> + The most common pattern in a multi-user client/server application is + <emphasis>session-per-request</emphasis>. In this model, a request from the client + is send to the server (where the Hibernate persistence layer runs), a new Hibernate + <literal>Session</literal> is opened, and all database operations are executed in this unit + of work. Once the work has been completed (and the response for the client has been prepared), + the session is flushed and closed. You would also use a single database transaction to + serve the clients request, starting and committing it when you open and close the + <literal>Session</literal>. The relationship between the two is one-to-one and this + model is a perfect fit for many applications. + </para> + + <para> + The challenge lies in the implementation. Hibernate provides built-in management of + the "current session" to simplify this pattern. All you have to do is start a + transaction when a server request has to be processed, and end the transaction + before the response is send to the client. You can do this in any way you + like, common solutions are <literal>ServletFilter</literal>, AOP interceptor with a + pointcut on the service methods, or a proxy/interception container. An EJB container + is a standardized way to implement cross-cutting aspects such as transaction + demarcation on EJB session beans, declaratively with CMT. If you decide to + use programmatic transaction demarcation, prefer the Hibernate <literal>Transaction</literal> + API shown later in this chapter, for ease of use and code portability. + </para> + + <para> + Your application code can access a "current session" to process the request + by simply calling <literal>sessionFactory.getCurrentSession()</literal> anywhere + and as often as needed. You will always get a <literal>Session</literal> scoped + to the current database transaction. This has to be configured for either + resource-local or JTA environments, see <xref linkend="architecture-current-session"/>. + </para> + + <para> + Sometimes it is convenient to extend the scope of a <literal>Session</literal> and + database transaction until the "view has been rendered". This is especially useful + in servlet applications that utilize a separate rendering phase after the request + has been processed. Extending the database transaction until view rendering is + complete is easy to do if you implement your own interceptor. However, it is not + easily doable if you rely on EJBs with container-managed transactions, as a + transaction will be completed when an EJB method returns, before rendering of any + view can start. See the Hibernate website and forum for tips and examples around + this <emphasis>Open Session in View</emphasis> pattern. + </para> + + </sect2> + + <sect2 id="transactions-basics-apptx" revision="1"> + <title>Long conversations</title> + + <para> + The session-per-request pattern is not the only useful concept you can use to design + units of work. Many business processes require a whole series of interactions with the user + interleaved with database accesses. In web and enterprise applications it is + not acceptable for a database transaction to span a user interaction. Consider the following + example: + </para> + + <itemizedlist> + <listitem> + <para> + The first screen of a dialog opens, the data seen by the user has been loaded in + a particular <literal>Session</literal> and database transaction. The user is free to + modify the objects. + </para> + </listitem> + <listitem> + <para> + The user clicks "Save" after 5 minutes and expects his modifications to be made + persistent; he also expects that he was the only person editing this information and + that no conflicting modification can occur. + </para> + </listitem> + </itemizedlist> + + <para> + We call this unit of work, from the point of view of the user, a long running + <emphasis>conversation</emphasis> (or <emphasis>application transaction</emphasis>). + There are many ways how you can implement this in your application. + </para> + + <para> + A first naive implementation might keep the <literal>Session</literal> and database + transaction open during user think time, with locks held in the database to prevent + concurrent modification, and to guarantee isolation and atomicity. This is of course + an anti-pattern, since lock contention would not allow the application to scale with + the number of concurrent users. + </para> + + <para> + Clearly, we have to use several database transactions to implement the converastion. + In this case, maintaining isolation of business processes becomes the + partial responsibility of the application tier. A single conversation + usually spans several database transactions. It will be atomic if only one of + these database transactions (the last one) stores the updated data, all others + simply read data (e.g. in a wizard-style dialog spanning several request/response + cycles). This is easier to implement than it might sound, especially if + you use Hibernate's features: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Automatic Versioning</emphasis> - Hibernate can do automatic + optimistic concurrency control for you, it can automatically detect + if a concurrent modification occured during user think time. Usually + we only check at the end of the conversation. + </para> + </listitem> + <listitem> + <para> + <emphasis>Detached Objects</emphasis> - If you decide to use the already + discussed <emphasis>session-per-request</emphasis> pattern, all loaded instances + will be in detached state during user think time. Hibernate allows you to + reattach the objects and persist the modifications, the pattern is called + <emphasis>session-per-request-with-detached-objects</emphasis>. Automatic + versioning is used to isolate concurrent modifications. + </para> + </listitem> + <listitem> + <para> + <emphasis>Extended (or Long) Session</emphasis> - The Hibernate + <literal>Session</literal> may be disconnected from the underlying JDBC + connection after the database transaction has been committed, and reconnected + when a new client request occurs. This pattern is known as + <emphasis>session-per-conversation</emphasis> and makes + even reattachment unnecessary. Automatic versioning is used to isolate + concurrent modifications and the <literal>Session</literal> is usually + not allowed to be flushed automatically, but explicitely. + </para> + </listitem> + </itemizedlist> + + <para> + Both <emphasis>session-per-request-with-detached-objects</emphasis> and + <emphasis>session-per-conversation</emphasis> have advantages and disadvantages, + we discuss them later in this chapter in the context of optimistic concurrency control. + </para> + + </sect2> + + <sect2 id="transactions-basics-identity"> + <title>Considering object identity</title> + + <para> + An application may concurrently access the same persistent state in two + different <literal>Session</literal>s. However, an instance of a persistent class + is never shared between two <literal>Session</literal> instances. Hence there are + two different notions of identity: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>Database Identity</term> + <listitem> + <para> + <literal>foo.getId().equals( bar.getId() )</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>JVM Identity</term> + <listitem> + <para> + <literal>foo==bar</literal> + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Then for objects attached to a <emphasis>particular</emphasis> <literal>Session</literal> + (i.e. in the scope of a <literal>Session</literal>) the two notions are equivalent, and + JVM identity for database identity is guaranteed by Hibernate. However, while the application + might concurrently access the "same" (persistent identity) business object in two different + sessions, the two instances will actually be "different" (JVM identity). Conflicts are + resolved using (automatic versioning) at flush/commit time, using an optimistic approach. + </para> + + <para> + This approach leaves Hibernate and the database to worry about concurrency; it also provides + the best scalability, since guaranteeing identity in single-threaded units of work only doesn't + need expensive locking or other means of synchronization. The application never needs to + synchronize on any business object, as long as it sticks to a single thread per + <literal>Session</literal>. Within a <literal>Session</literal> the application may safely use + <literal>==</literal> to compare objects. + </para> + + <para> + However, an application that uses <literal>==</literal> outside of a <literal>Session</literal>, + might see unexpected results. This might occur even in some unexpected places, for example, + if you put two detached instances into the same <literal>Set</literal>. Both might have the same + database identity (i.e. they represent the same row), but JVM identity is by definition not + guaranteed for instances in detached state. The developer has to override the <literal>equals()</literal> + and <literal>hashCode()</literal> methods in persistent classes and implement + his own notion of object equality. There is one caveat: Never use the database + identifier to implement equality, use a business key, a combination of unique, usually + immutable, attributes. The database identifier will change if a transient object is made + persistent. If the transient instance (usually together with detached instances) is held in a + <literal>Set</literal>, changing the hashcode breaks the contract of the <literal>Set</literal>. + Attributes for business keys don't have to be as stable as database primary keys, you only + have to guarantee stability as long as the objects are in the same <literal>Set</literal>. See + the Hibernate website for a more thorough discussion of this issue. Also note that this is not + a Hibernate issue, but simply how Java object identity and equality has to be implemented. + </para> + + </sect2> + + <sect2 id="transactions-basics-issues"> + <title>Common issues</title> + + <para> + Never use the anti-patterns <emphasis>session-per-user-session</emphasis> or + <emphasis>session-per-application</emphasis> (of course, there are rare exceptions to + this rule). Note that some of the following issues might also appear with the recommended + patterns, make sure you understand the implications before making a design decision: + </para> + + <itemizedlist> + <listitem> + <para> + A <literal>Session</literal> is not thread-safe. Things which are supposed to work + concurrently, like HTTP requests, session beans, or Swing workers, will cause race + conditions if a <literal>Session</literal> instance would be shared. If you keep your + Hibernate <literal>Session</literal> in your <literal>HttpSession</literal> (discussed + later), you should consider synchronizing access to your Http session. Otherwise, + a user that clicks reload fast enough may use the same <literal>Session</literal> in + two concurrently running threads. + </para> + </listitem> + <listitem> + <para> + An exception thrown by Hibernate means you have to rollback your database transaction + and close the <literal>Session</literal> immediately (discussed later in more detail). + If your <literal>Session</literal> is bound to the application, you have to stop + the application. Rolling back the database transaction doesn't put your business + objects back into the state they were at the start of the transaction. This means the + database state and the business objects do get out of sync. Usually this is not a + problem, because exceptions are not recoverable and you have to start over after + rollback anyway. + </para> + </listitem> + <listitem> + <para> + The <literal>Session</literal> caches every object that is in persistent state (watched + and checked for dirty state by Hibernate). This means it grows endlessly until you + get an OutOfMemoryException, if you keep it open for a long time or simply load too + much data. One solution for this is to call <literal>clear()</literal> and <literal>evict()</literal> + to manage the <literal>Session</literal> cache, but you most likely should consider a + Stored Procedure if you need mass data operations. Some solutions are shown in + <xref linkend="batch"/>. Keeping a <literal>Session</literal> open for the duration + of a user session also means a high probability of stale data. + </para> + </listitem> + </itemizedlist> + + </sect2> + + </sect1> + + <sect1 id="transactions-demarcation"> + <title>Database transaction demarcation</title> + + <para> + Datatabase (or system) transaction boundaries are always necessary. No communication with + the database can occur outside of a database transaction (this seems to confuse many developers + who are used to the auto-commit mode). Always use clear transaction boundaries, even for + read-only operations. Depending on your isolation level and database capabilities this might not + be required but there is no downside if you always demarcate transactions explicitly. Certainly, + a single database transaction is going to perform better than many small transactions, even + for reading data. + </para> + + <para> + A Hibernate application can run in non-managed (i.e. standalone, simple Web- or Swing applications) + and managed J2EE environments. In a non-managed environment, Hibernate is usually responsible for + its own database connection pool. The application developer has to manually set transaction + boundaries, in other words, begin, commit, or rollback database transactions himself. A managed environment + usually provides container-managed transactions (CMT), with the transaction assembly defined declaratively + in deployment descriptors of EJB session beans, for example. Programmatic transaction demarcation is + then no longer necessary. + </para> + + <para> + However, it is often desirable to keep your persistence layer portable between non-managed + resource-local environments, and systems that can rely on JTA but use BMT instead of CMT. + In both cases you'd use programmatic transaction demaracation. Hibernate offers a wrapper + API called <literal>Transaction</literal> that translates into the native transaction system of + your deployment environment. This API is actually optional, but we strongly encourage its use + unless you are in a CMT session bean. + </para> + + <para> + Usually, ending a <literal>Session</literal> involves four distinct phases: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + flush the session + </para> + </listitem> + <listitem> + <para> + commit the transaction + </para> + </listitem> + <listitem> + <para> + close the session + </para> + </listitem> + <listitem> + <para> + handle exceptions + </para> + </listitem> + </itemizedlist> + + <para> + Flushing the session has been discussed earlier, we'll now have a closer look at transaction + demarcation and exception handling in both managed- and non-managed environments. + </para> + + + <sect2 id="transactions-demarcation-nonmanaged" revision="2"> + <title>Non-managed environment</title> + + <para> + If a Hibernate persistence layer runs in a non-managed environment, database connections + are usually handled by simple (i.e. non-DataSource) connection pools from which + Hibernate obtains connections as needed. The session/transaction handling idiom looks + like this: + </para> + + <programlisting><![CDATA[// Non-managed environment idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + You don't have to <literal>flush()</literal> the <literal>Session</literal> explicitly - + the call to <literal>commit()</literal> automatically triggers the synchronization (depending + upon the <xref linkend="objectstate-flushing">FlushMode</xref> for the session. + A call to <literal>close()</literal> marks the end of a session. The main implication + of <literal>close()</literal> is that the JDBC connection will be relinquished by the + session. This Java code is portable and runs in both non-managed and JTA environments. + </para> + + <para> + A much more flexible solution is Hibernate's built-in "current session" context + management, as described earlier: + </para> + + <programlisting><![CDATA[// Non-managed environment idiom with getCurrentSession() +try { + factory.getCurrentSession().beginTransaction(); + + // do some work + ... + + factory.getCurrentSession().getTransaction().commit(); +} +catch (RuntimeException e) { + factory.getCurrentSession().getTransaction().rollback(); + throw e; // or display error message +}]]></programlisting> + + <para> + You will very likely never see these code snippets in a regular application; + fatal (system) exceptions should always be caught at the "top". In other words, the + code that executes Hibernate calls (in the persistence layer) and the code that handles + <literal>RuntimeException</literal> (and usually can only clean up and exit) are in + different layers. The current context management by Hibernate can significantly + simplify this design, as all you need is access to a <literal>SessionFactory</literal>. + Exception handling is discussed later in this chapter. + </para> + + <para> + Note that you should select <literal>org.hibernate.transaction.JDBCTransactionFactory</literal> + (which is the default), and for the second example <literal>"thread"</literal> as your + <literal>hibernate.current_session_context_class</literal>. + </para> + + </sect2> + + <sect2 id="transactions-demarcation-jta" revision="3"> + <title>Using JTA</title> + + <para> + If your persistence layer runs in an application server (e.g. behind EJB session beans), + every datasource connection obtained by Hibernate will automatically be part of the global + JTA transaction. You can also install a standalone JTA implementation and use it without + EJB. Hibernate offers two strategies for JTA integration. + </para> + + <para> + If you use bean-managed transactions (BMT) Hibernate will tell the application server to start + and end a BMT transaction if you use the <literal>Transaction</literal> API. So, the + transaction management code is identical to the non-managed environment. + </para> + + <programlisting><![CDATA[// BMT idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + If you want to use a transaction-bound <literal>Session</literal>, that is, the + <literal>getCurrentSession()</literal> functionality for easy context propagation, + you will have to use the JTA <literal>UserTransaction</literal> API directly: + </para> + + <programlisting><![CDATA[// BMT idiom with getCurrentSession() +try { + UserTransaction tx = (UserTransaction)new InitialContext() + .lookup("java:comp/UserTransaction"); + + tx.begin(); + + // Do some work on Session bound to transaction + factory.getCurrentSession().load(...); + factory.getCurrentSession().persist(...); + + tx.commit(); +} +catch (RuntimeException e) { + tx.rollback(); + throw e; // or display error message +}]]></programlisting> + + <para> + With CMT, transaction demarcation is done in session bean deployment descriptors, not programatically, + hence, the code is reduced to: + </para> + + <programlisting><![CDATA[// CMT idiom + Session sess = factory.getCurrentSession(); + + // do some work + ... +]]></programlisting> + + <para> + In a CMT/EJB even rollback happens automatically, since an unhandled <literal>RuntimeException</literal> + thrown by a session bean method tells the container to set the global transaction to rollback. + <emphasis>This means you do not need to use the Hibernate <literal>Transaction</literal> API at + all with BMT or CMT, and you get automatic propagation of the "current" Session bound to the + transaction.</emphasis> + </para> + + <para> + Note that you should choose <literal>org.hibernate.transaction.JTATransactionFactory</literal> + if you use JTA directly (BMT), and <literal>org.hibernate.transaction.CMTTransactionFactory</literal> + in a CMT session bean, when you configure Hibernate's transaction factory. Remember to also set + <literal>hibernate.transaction.manager_lookup_class</literal>. Furthermore, make sure + that your <literal>hibernate.current_session_context_class</literal> is either unset (backwards + compatiblity), or set to <literal>"jta"</literal>. + </para> + + <para> + The <literal>getCurrentSession()</literal> operation has one downside in a JTA environment. + There is one caveat to the use of <literal>after_statement</literal> connection release + mode, which is then used by default. Due to a silly limitation of the JTA spec, it is not + possible for Hibernate to automatically clean up any unclosed <literal>ScrollableResults</literal> or + <literal>Iterator</literal> instances returned by <literal>scroll()</literal> or + <literal>iterate()</literal>. You <emphasis>must</emphasis> release the underlying database + cursor by calling <literal>ScrollableResults.close()</literal> or + <literal>Hibernate.close(Iterator)</literal> explicity from a <literal>finally</literal> + block. (Of course, most applications can easily avoid using <literal>scroll()</literal> or + <literal>iterate()</literal> at all from the JTA or CMT code.) + </para> + + </sect2> + + <sect2 id="transactions-demarcation-exceptions"> + <title>Exception handling</title> + + <para> + If the <literal>Session</literal> throws an exception (including any + <literal>SQLException</literal>), you should immediately rollback the database + transaction, call <literal>Session.close()</literal> and discard the + <literal>Session</literal> instance. Certain methods of <literal>Session</literal> + will <emphasis>not</emphasis> leave the session in a consistent state. No + exception thrown by Hibernate can be treated as recoverable. Ensure that the + <literal>Session</literal> will be closed by calling <literal>close()</literal> + in a <literal>finally</literal> block. + </para> + + <para> + The <literal>HibernateException</literal>, which wraps most of the errors that + can occur in a Hibernate persistence layer, is an unchecked exception (it wasn't + in older versions of Hibernate). In our opinion, we shouldn't force the application + developer to catch an unrecoverable exception at a low layer. In most systems, unchecked + and fatal exceptions are handled in one of the first frames of the method call + stack (i.e. in higher layers) and an error message is presented to the application + user (or some other appropriate action is taken). Note that Hibernate might also throw + other unchecked exceptions which are not a <literal>HibernateException</literal>. These + are, again, not recoverable and appropriate action should be taken. + </para> + + <para> + Hibernate wraps <literal>SQLException</literal>s thrown while interacting with the database + in a <literal>JDBCException</literal>. In fact, Hibernate will attempt to convert the eexception + into a more meningful subclass of <literal>JDBCException</literal>. The underlying + <literal>SQLException</literal> is always available via <literal>JDBCException.getCause()</literal>. + Hibernate converts the <literal>SQLException</literal> into an appropriate + <literal>JDBCException</literal> subclass using the <literal>SQLExceptionConverter</literal> + attached to the <literal>SessionFactory</literal>. By default, the + <literal>SQLExceptionConverter</literal> is defined by the configured dialect; however, it is + also possible to plug in a custom implementation (see the javadocs for the + <literal>SQLExceptionConverterFactory</literal> class for details). The standard + <literal>JDBCException</literal> subtypes are: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>JDBCConnectionException</literal> - indicates an error + with the underlying JDBC communication. + </para> + </listitem> + <listitem> + <para> + <literal>SQLGrammarException</literal> - indicates a grammar + or syntax problem with the issued SQL. + </para> + </listitem> + <listitem> + <para> + <literal>ConstraintViolationException</literal> - indicates some + form of integrity constraint violation. + </para> + </listitem> + <listitem> + <para> + <literal>LockAcquisitionException</literal> - indicates an error + acquiring a lock level necessary to perform the requested operation. + </para> + </listitem> + <listitem> + <para> + <literal>GenericJDBCException</literal> - a generic exception + which did not fall into any of the other categories. + </para> + </listitem> + </itemizedlist> + + </sect2> + + <sect2 id="transactions-demarcation-timeout"> + <title>Transaction timeout</title> + + <para> + One extremely important feature provided by a managed environment like EJB + that is never provided for non-managed code is transaction timeout. Transaction + timeouts ensure that no misbehaving transaction can indefinitely tie up + resources while returning no response to the user. Outside a managed (JTA) + environment, Hibernate cannot fully provide this functionality. However, + Hibernate can at least control data access operations, ensuring that database + level deadlocks and queries with huge result sets are limited by a defined + timeout. In a managed environment, Hibernate can delegate transaction timeout + to JTA. This functioanlity is abstracted by the Hibernate + <literal>Transaction</literal> object. + </para> + + <programlisting><![CDATA[ +Session sess = factory.openSession(); +try { + //set transaction timeout to 3 seconds + sess.getTransaction().setTimeout(3); + sess.getTransaction().begin(); + + // do some work + ... + + sess.getTransaction().commit() +} +catch (RuntimeException e) { + sess.getTransaction().rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + Note that <literal>setTimeout()</literal> may not be called in a CMT bean, + where transaction timeouts must be defined declaratively. + </para> + + </sect2> + + </sect1> + + <sect1 id="transactions-optimistic"> + <title>Optimistic concurrency control</title> + + <para> + The only approach that is consistent with high concurrency and high + scalability is optimistic concurrency control with versioning. Version + checking uses version numbers, or timestamps, to detect conflicting updates + (and to prevent lost updates). Hibernate provides for three possible approaches + to writing application code that uses optimistic concurrency. The use cases + we show are in the context of long conversations, but version checking + also has the benefit of preventing lost updates in single database transactions. + </para> + + <sect2 id="transactions-optimistic-manual"> + <title>Application version checking</title> + + <para> + In an implementation without much help from Hibernate, each interaction with the + database occurs in a new <literal>Session</literal> and the developer is responsible + for reloading all persistent instances from the database before manipulating them. + This approach forces the application to carry out its own version checking to ensure + conversation transaction isolation. This approach is the least efficient in terms of + database access. It is the approach most similar to entity EJBs. + </para> + + <programlisting><![CDATA[// foo is an instance loaded by a previous Session +session = factory.openSession(); +Transaction t = session.beginTransaction(); + +int oldVersion = foo.getVersion(); +session.load( foo, foo.getKey() ); // load the current state +if ( oldVersion != foo.getVersion() ) throw new StaleObjectStateException(); +foo.setProperty("bar"); + +t.commit(); +session.close();]]></programlisting> + + <para> + The <literal>version</literal> property is mapped using <literal><version></literal>, + and Hibernate will automatically increment it during flush if the entity is + dirty. + </para> + + <para> + Of course, if you are operating in a low-data-concurrency environment and don't + require version checking, you may use this approach and just skip the version + check. In that case, <emphasis>last commit wins</emphasis> will be the default + strategy for your long conversations. Keep in mind that this might + confuse the users of the application, as they might experience lost updates without + error messages or a chance to merge conflicting changes. + </para> + + <para> + Clearly, manual version checking is only feasible in very trivial circumstances + and not practical for most applications. Often not only single instances, but + complete graphs of modified ojects have to be checked. Hibernate offers automatic + version checking with either an extended <literal>Session</literal> or detached instances + as the design paradigm. + </para> + + </sect2> + + <sect2 id="transactions-optimistic-longsession"> + <title>Extended session and automatic versioning</title> + + <para> + A single <literal>Session</literal> instance and its persistent instances are + used for the whole conversation, known as <emphasis>session-per-conversation</emphasis>. + Hibernate checks instance versions at flush time, throwing an exception if concurrent + modification is detected. It's up to the developer to catch and handle this exception + (common options are the opportunity for the user to merge changes or to restart the + business conversation with non-stale data). + </para> + + <para> + The <literal>Session</literal> is disconnected from any underlying JDBC connection + when waiting for user interaction. This approach is the most efficient in terms + of database access. The application need not concern itself with version checking or + with reattaching detached instances, nor does it have to reload instances in every + database transaction. + </para> + + <programlisting><![CDATA[// foo is an instance loaded earlier by the old session +Transaction t = session.beginTransaction(); // Obtain a new JDBC connection, start transaction + +foo.setProperty("bar"); + +session.flush(); // Only for last transaction in conversation +t.commit(); // Also return JDBC connection +session.close(); // Only for last transaction in conversation]]></programlisting> + <para> + The <literal>foo</literal> object still knows which <literal>Session</literal> it was + loaded in. Beginning a new database transaction on an old session obtains a new connection + and resumes the session. Committing a database transaction disconnects a session + from the JDBC connection and returns the connection to the pool. After reconnection, to + force a version check on data you aren't updating, you may call <literal>Session.lock()</literal> + with <literal>LockMode.READ</literal> on any objects that might have been updated by another + transaction. You don't need to lock any data that you <emphasis>are</emphasis> updating. + Usually you would set <literal>FlushMode.MANUAL</literal> on an extended <literal>Session</literal>, + so that only the last database transaction cycle is allowed to actually persist all + modifications made in this conversation. Hence, only this last database transaction + would include the <literal>flush()</literal> operation, and then also + <literal>close()</literal> the session to end the conversation. + </para> + + <para> + This pattern is problematic if the <literal>Session</literal> is too big to + be stored during user think time, e.g. an <literal>HttpSession</literal> should + be kept as small as possible. As the <literal>Session</literal> is also the + (mandatory) first-level cache and contains all loaded objects, we can probably + use this strategy only for a few request/response cycles. You should use a + <literal>Session</literal> only for a single conversation, as it will soon also + have stale data. + </para> + + <para> + (Note that earlier Hibernate versions required explicit disconnection and reconnection + of a <literal>Session</literal>. These methods are deprecated, as beginning and + ending a transaction has the same effect.) + </para> + + <para> + Also note that you should keep the disconnected <literal>Session</literal> close + to the persistence layer. In other words, use an EJB stateful session bean to + hold the <literal>Session</literal> in a three-tier environment, and don't transfer + it to the web layer (or even serialize it to a separate tier) to store it in the + <literal>HttpSession</literal>. + </para> + + <para> + The extended session pattern, or <emphasis>session-per-conversation</emphasis>, is + more difficult to implement with automatic current session context management. + You need to supply your own implementation of the <literal>CurrentSessionContext</literal> + for this, see the Hibernate Wiki for examples. + </para> + + </sect2> + + <sect2 id="transactions-optimistic-detached"> + <title>Detached objects and automatic versioning</title> + + <para> + Each interaction with the persistent store occurs in a new <literal>Session</literal>. + However, the same persistent instances are reused for each interaction with the database. + The application manipulates the state of detached instances originally loaded in another + <literal>Session</literal> and then reattaches them using <literal>Session.update()</literal>, + <literal>Session.saveOrUpdate()</literal>, or <literal>Session.merge()</literal>. + </para> + + <programlisting><![CDATA[// foo is an instance loaded by a previous Session +foo.setProperty("bar"); +session = factory.openSession(); +Transaction t = session.beginTransaction(); +session.saveOrUpdate(foo); // Use merge() if "foo" might have been loaded already +t.commit(); +session.close();]]></programlisting> + + <para> + Again, Hibernate will check instance versions during flush, throwing an + exception if conflicting updates occured. + </para> + + <para> + You may also call <literal>lock()</literal> instead of <literal>update()</literal> + and use <literal>LockMode.READ</literal> (performing a version check, bypassing all + caches) if you are sure that the object has not been modified. + </para> + + </sect2> + + <sect2 id="transactions-optimistic-customizing"> + <title>Customizing automatic versioning</title> + + <para> + You may disable Hibernate's automatic version increment for particular properties and + collections by setting the <literal>optimistic-lock</literal> mapping attribute to + <literal>false</literal>. Hibernate will then no longer increment versions if the + property is dirty. + </para> + + <para> + Legacy database schemas are often static and can't be modified. Or, other applications + might also access the same database and don't know how to handle version numbers or + even timestamps. In both cases, versioning can't rely on a particular column in a table. + To force a version check without a version or timestamp property mapping, with a + comparison of the state of all fields in a row, turn on <literal>optimistic-lock="all"</literal> + in the <literal><class></literal> mapping. Note that this concepetually only works + if Hibernate can compare the old and new state, i.e. if you use a single long + <literal>Session</literal> and not session-per-request-with-detached-objects. + </para> + + <para> + Sometimes concurrent modification can be permitted as long as the changes that have been + made don't overlap. If you set <literal>optimistic-lock="dirty"</literal> when mapping the + <literal><class></literal>, Hibernate will only compare dirty fields during flush. + </para> + + <para> + In both cases, with dedicated version/timestamp columns or with full/dirty field + comparison, Hibernate uses a single <literal>UPDATE</literal> statement (with an + appropriate <literal>WHERE</literal> clause) per entity to execute the version check + and update the information. If you use transitive persistence to cascade reattachment + to associated entities, Hibernate might execute uneccessary updates. This is usually + not a problem, but <emphasis>on update</emphasis> triggers in the database might be + executed even when no changes have been made to detached instances. You can customize + this behavior by setting <literal>select-before-update="true"</literal> in the + <literal><class></literal> mapping, forcing Hibernate to <literal>SELECT</literal> + the instance to ensure that changes did actually occur, before updating the row. + </para> + + </sect2> + + </sect1> + + <sect1 id="transactions-locking"> + <title>Pessimistic Locking</title> + + <para> + It is not intended that users spend much time worring about locking strategies. Its usually + enough to specify an isolation level for the JDBC connections and then simply let the + database do all the work. However, advanced users may sometimes wish to obtain + exclusive pessimistic locks, or re-obtain locks at the start of a new transaction. + </para> + + <para> + Hibernate will always use the locking mechanism of the database, never lock objects + in memory! + </para> + + <para> + The <literal>LockMode</literal> class defines the different lock levels that may be acquired + by Hibernate. A lock is obtained by the following mechanisms: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>LockMode.WRITE</literal> is acquired automatically when Hibernate updates or inserts + a row. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.UPGRADE</literal> may be acquired upon explicit user request using + <literal>SELECT ... FOR UPDATE</literal> on databases which support that syntax. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.UPGRADE_NOWAIT</literal> may be acquired upon explicit user request using a + <literal>SELECT ... FOR UPDATE NOWAIT</literal> under Oracle. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.READ</literal> is acquired automatically when Hibernate reads data + under Repeatable Read or Serializable isolation level. May be re-acquired by explicit user + request. + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.NONE</literal> represents the absence of a lock. All objects switch to this + lock mode at the end of a <literal>Transaction</literal>. Objects associated with the session + via a call to <literal>update()</literal> or <literal>saveOrUpdate()</literal> also start out + in this lock mode. + </para> + </listitem> + </itemizedlist> + + <para> + The "explicit user request" is expressed in one of the following ways: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + A call to <literal>Session.load()</literal>, specifying a <literal>LockMode</literal>. + </para> + </listitem> + <listitem> + <para> + A call to <literal>Session.lock()</literal>. + </para> + </listitem> + <listitem> + <para> + A call to <literal>Query.setLockMode()</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + If <literal>Session.load()</literal> is called with <literal>UPGRADE</literal> or + <literal>UPGRADE_NOWAIT</literal>, and the requested object was not yet loaded by + the session, the object is loaded using <literal>SELECT ... FOR UPDATE</literal>. + If <literal>load()</literal> is called for an object that is already loaded with + a less restrictive lock than the one requested, Hibernate calls + <literal>lock()</literal> for that object. + </para> + + <para> + <literal>Session.lock()</literal> performs a version number check if the specified lock + mode is <literal>READ</literal>, <literal>UPGRADE</literal> or + <literal>UPGRADE_NOWAIT</literal>. (In the case of <literal>UPGRADE</literal> or + <literal>UPGRADE_NOWAIT</literal>, <literal>SELECT ... FOR UPDATE</literal> is used.) + </para> + + <para> + If the database does not support the requested lock mode, Hibernate will use an appropriate + alternate mode (instead of throwing an exception). This ensures that applications will + be portable. + </para> + + </sect1> + + <sect1 id="transactions-connection-release"> + <title>Connection Release Modes</title> + + <para> + The legacy (2.x) behavior of Hibernate in regards to JDBC connection management + was that a <literal>Session</literal> would obtain a connection when it was first + needed and then hold unto that connection until the session was closed. + Hibernate 3.x introduced the notion of connection release modes to tell a session + how to handle its JDBC connections. Note that the following discussion is pertinent + only to connections provided through a configured <literal>ConnectionProvider</literal>; + user-supplied connections are outside the breadth of this discussion. The different + release modes are identified by the enumerated values of + <literal>org.hibernate.ConnectionReleaseMode</literal>: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ON_CLOSE</literal> - is essentially the legacy behavior described above. The + Hibernate session obatins a connection when it first needs to perform some JDBC access + and holds unto that connection until the session is closed. + </para> + </listitem> + <listitem> + <para> + <literal>AFTER_TRANSACTION</literal> - says to release connections after a + <literal>org.hibernate.Transaction</literal> has completed. + </para> + </listitem> + <listitem> + <para> + <literal>AFTER_STATEMENT</literal> (also referred to as aggressive release) - says to + release connections after each and every statement execution. This aggressive releasing + is skipped if that statement leaves open resources associated with the given session; + currently the only situation where this occurs is through the use of + <literal>org.hibernate.ScrollableResults</literal>. + </para> + </listitem> + </itemizedlist> + + <para> + The configuration parameter <literal>hibernate.connection.release_mode</literal> is used + to specify which release mode to use. The possible values: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>auto</literal> (the default) - this choice delegates to the release mode + returned by the <literal>org.hibernate.transaction.TransactionFactory.getDefaultReleaseMode()</literal> + method. For JTATransactionFactory, this returns ConnectionReleaseMode.AFTER_STATEMENT; for + JDBCTransactionFactory, this returns ConnectionReleaseMode.AFTER_TRANSACTION. It is rarely + a good idea to change this default behavior as failures due to the value of this setting + tend to indicate bugs and/or invalid assumptions in user code. + </para> + </listitem> + <listitem> + <para> + <literal>on_close</literal> - says to use ConnectionReleaseMode.ON_CLOSE. This setting + is left for backwards compatibility, but its use is highly discouraged. + </para> + </listitem> + <listitem> + <para> + <literal>after_transaction</literal> - says to use ConnectionReleaseMode.AFTER_TRANSACTION. + This setting should not be used in JTA environments. Also note that with + ConnectionReleaseMode.AFTER_TRANSACTION, if a session is considered to be in auto-commit + mode connections will be released as if the release mode were AFTER_STATEMENT. + </para> + </listitem> + <listitem> + <para> + <literal>after_statement</literal> - says to use ConnectionReleaseMode.AFTER_STATEMENT. Additionally, + the configured <literal>ConnectionProvider</literal> is consulted to see if it supports this + setting (<literal>supportsAggressiveRelease()</literal>). If not, the release mode is reset + to ConnectionReleaseMode.AFTER_TRANSACTION. This setting is only safe in environments where + we can either re-acquire the same underlying JDBC connection each time we make a call into + <literal>ConnectionProvider.getConnection()</literal> or in auto-commit environments where + it does not matter whether we get back the same connection. + </para> + </listitem> + </itemizedlist> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/tutorial.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/tutorial.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/tutorial.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/tutorial.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,1559 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY mdash "-"> +]> + +<chapter id="tutorial"> + <title>Introduction to Hibernate</title> + + <sect1 id="tutorial-intro" revision="1"> + <title>Preface</title> + + <para> + This chapter is an introductory tutorial for new users of Hibernate. We start + with a simple command line application using an in-memory database and develop + it in easy to understand steps. + </para> + + <para> + This tutorial is intended for new users of Hibernate but requires Java and + SQL knowledge. It is based on a tutorial by Michael Gloegl, the third-party + libraries we name are for JDK 1.4 and 5.0. You might need others for JDK 1.3. + </para> + + <para> + The source code for the tutorial is included in the distribution in the + <literal>doc/reference/tutorial/</literal> directory. + </para> + + </sect1> + + <sect1 id="tutorial-firstapp" revision="2"> + <title>Part 1 - The first Hibernate Application</title> + + <para> + First, we'll create a simple console-based Hibernate application. We use an + Java database (HSQL DB), so we do not have to install any database server. + </para> + + <para> + Let's assume we need a small database application that can store events we want to + attend, and information about the hosts of these events. + </para> + + <para> + The first thing we do, is set up our development directory and put all the + Java libraries we need into it. Download the Hibernate distribution from the + Hibernate website. Extract the package and place all required libraries + found in <literal>/lib</literal> into into the <literal>/lib</literal> directory + of your new development working directory. It should look like this: + </para> + + <programlisting><![CDATA[. ++lib + antlr.jar + cglib.jar + asm.jar + asm-attrs.jars + commons-collections.jar + commons-logging.jar + hibernate3.jar + jta.jar + dom4j.jar + log4j.jar ]]></programlisting> + + <para> + This is the minimum set of required libraries (note that we also copied + hibernate3.jar, the main archive) for Hibernate <emphasis>at the time of writing</emphasis>. + The Hibernate release you are using might require more or less libraries. See the + <literal>README.txt</literal> file in the <literal>lib/</literal> directory of the + Hibernate distribution for more information about required and optional third-party + libraries. (Actually, Log4j is not required but preferred by many developers.) + </para> + + <para> + Next we create a class that represents the event we want to store in database. + </para> + + <sect2 id="tutorial-firstapp-firstclass" revision="1"> + <title>The first class</title> + + <para> + Our first persistent class is a simple JavaBean class with some properties: + </para> + + <programlisting><![CDATA[package events; + +import java.util.Date; + +public class Event { + private Long id; + + private String title; + private Date date; + + public Event() {} + + public Long getId() { + return id; + } + + private void setId(Long id) { + this.id = id; + } + + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public String getTitle() { + return title; + } + + public void setTitle(String title) { + this.title = title; + } +}]]></programlisting> + + <para> + You can see that this class uses standard JavaBean naming conventions for property + getter and setter methods, as well as private visibility for the fields. This is + a recommended design - but not required. Hibernate can also access fields directly, + the benefit of accessor methods is robustness for refactoring. The no-argument + constructor is required to instantiate an object of this class through reflection. + </para> + + <para> + The <literal>id</literal> property holds a unique identifier value for a particular event. + All persistent entity classes (there are less important dependent classes as well) will need + such an identifier property if we want to use the full feature set of Hibernate. In fact, + most applications (esp. web applications) need to distinguish objects by identifier, so you + should consider this a feature rather than a limitation. However, we usually don't manipulate + the identity of an object, hence the setter method should be private. Only Hibernate will assign + identifiers when an object is saved. You can see that Hibernate can access public, private, + and protected accessor methods, as well as (public, private, protected) fields directly. The + choice is up to you and you can match it to fit your application design. + </para> + + <para> + The no-argument constructor is a requirement for all persistent classes; Hibernate + has to create objects for you, using Java Reflection. The constructor can be + private, however, package visibility is required for runtime proxy generation and + efficient data retrieval without bytecode instrumentation. + </para> + + <para> + Place this Java source file in a directory called <literal>src</literal> in the + development folder, and in its correct package. The directory should now look like this: + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java]]></programlisting> + + <para> + In the next step, we tell Hibernate about this persistent class. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-mapping" revision="1"> + <title>The mapping file</title> + + <para> + Hibernate needs to know how to load and store objects of the persistent class. + This is where the Hibernate mapping file comes into play. The mapping file + tells Hibernate what table in the database it has to access, and what columns + in that table it should use. + </para> + + <para> + The basic structure of a mapping file looks like this: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping> +[...] +</hibernate-mapping>]]></programlisting> + + <para> + Note that the Hibernate DTD is very sophisticated. You can use it for + auto-completion of XML mapping elements and attributes in your editor or + IDE. You also should open up the DTD file in your text editor - it's the + easiest way to get an overview of all elements and attributes and to see + the defaults, as well as some comments. Note that Hibernate will not + load the DTD file from the web, but first look it up from the classpath + of the application. The DTD file is included in <literal>hibernate3.jar</literal> + as well as in the <literal>src/</literal> directory of the Hibernate distribution. + </para> + + <para> + We will omit the DTD declaration in future examples to shorten the code. It is + of course not optional. + </para> + + <para> + Between the two <literal>hibernate-mapping</literal> tags, include a + <literal>class</literal> element. All persistent entity classes (again, there + might be dependent classes later on, which are not first-class entities) need + such a mapping, to a table in the SQL database: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Event" table="EVENTS"> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + So far we told Hibernate how to persist and load object of class <literal>Event</literal> + to the table <literal>EVENTS</literal>, each instance represented by a row in that table. + Now we continue with a mapping of the unique identifier property to the tables primary key. + In addition, as we don't want to care about handling this identifier, we configure Hibernate's + identifier generation strategy for a surrogate primary key column: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="native"/> + </id> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + The <literal>id</literal> element is the declaration of the identifer property, + <literal>name="id"</literal> declares the name of the Java property - + Hibernate will use the getter and setter methods to access the property. + The column attribute tells Hibernate which column of the + <literal>EVENTS</literal> table we use for this primary key. The nested + <literal>generator</literal> element specifies the identifier generation strategy, + in this case we used <literal>native</literal>, which picks the best strategy depending + on the configured database (dialect). Hibernate supports database generated, globally + unique, as well as application assigned identifiers (or any strategy you have written + an extension for). + </para> + + <para> + Finally we include declarations for the persistent properties of the class in + the mapping file. By default, no properties of the class are considered + persistent: + </para> + + <programlisting><![CDATA[ +<hibernate-mapping> + + <class name="events.Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="native"/> + </id> + <property name="date" type="timestamp" column="EVENT_DATE"/> + <property name="title"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Just as with the <literal>id</literal> element, the <literal>name</literal> + attribute of the <literal>property</literal> element tells Hibernate which getter + and setter methods to use. So, in this case, Hibernate will look for + <literal>getDate()/setDate()</literal>, as well as <literal>getTitle()/setTitle()</literal>. + </para> + + <para> + Why does the <literal>date</literal> property mapping include the + <literal>column</literal> attribute, but the <literal>title</literal> + doesn't? Without the <literal>column</literal> attribute Hibernate + by default uses the property name as the column name. This works fine for + <literal>title</literal>. However, <literal>date</literal> is a reserved + keyword in most database, so we better map it to a different name. + </para> + + <para> + The next interesting thing is that the <literal>title</literal> mapping also lacks + a <literal>type</literal> attribute. The types we declare and use in the mapping + files are not, as you might expect, Java data types. They are also not SQL + database types. These types are so called <emphasis>Hibernate mapping types</emphasis>, + converters which can translate from Java to SQL data types and vice versa. Again, + Hibernate will try to determine the correct conversion and mapping type itself if + the <literal>type</literal> attribute is not present in the mapping. In some cases this + automatic detection (using Reflection on the Java class) might not have the default you + expect or need. This is the case with the <literal>date</literal> property. Hibernate can't + know if the property (which is of <literal>java.util.Date</literal>) should map to a + SQL <literal>date</literal>, <literal>timestamp</literal>, or <literal>time</literal> column. + We preserve full date and time information by mapping the property with a + <literal>timestamp</literal> converter. + </para> + + <para> + This mapping file should be saved as <literal>Event.hbm.xml</literal>, right in + the directory next to the <literal>Event</literal> Java class source file. + The naming of mapping files can be arbitrary, however the <literal>hbm.xml</literal> + suffix is a convention in the Hibernate developer community. The directory structure + should now look like this: + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java + Event.hbm.xml]]></programlisting> + + <para> + We continue with the main configuration of Hibernate. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-configuration" revision="2"> + <title>Hibernate configuration</title> + + <para> + We now have a persistent class and its mapping file in place. It is time to configure + Hibernate. Before we do this, we will need a database. HSQL DB, a java-based SQL DBMS, + can be downloaded from the HSQL DB website(http://hsqldb.org/). Actually, you only need the <literal>hsqldb.jar</literal> + from this download. Place this file in the <literal>lib/</literal> directory of the + development folder. + </para> + + <para> + Create a directory called <literal>data</literal> in the root of the development directory - + this is where HSQL DB will store its data files. Now start the database by running + <literal>java -classpath ../lib/hsqldb.jar org.hsqldb.Server</literal> in this data directory. + You can see it start up and bind to a TCP/IP socket, this is where our application + will connect later. If you want to start with a fresh database during this tutorial, + shutdown HSQL DB (press <literal>CTRL + C</literal> in the window), delete all files in the + <literal>data/</literal> directory, and start HSQL DB again. + </para> + + <para> + Hibernate is the layer in your application which connects to this database, so it needs + connection information. The connections are made through a JDBC connection pool, which we + also have to configure. The Hibernate distribution contains several open source JDBC connection + pooling tools, but will use the Hibernate built-in connection pool for this tutorial. Note that + you have to copy the required library into your classpath and use different + connection pooling settings if you want to use a production-quality third party + JDBC pooling software. + </para> + + <para> + For Hibernate's configuration, we can use a simple <literal>hibernate.properties</literal> file, a + slightly more sophisticated <literal>hibernate.cfg.xml</literal> file, or even complete + programmatic setup. Most users prefer the XML configuration file: + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <session-factory> + +  + <property name="connection.driver_class">org.hsqldb.jdbcDriver</property> + <property name="connection.url">jdbc:hsqldb:hsql://localhost</property> + <property name="connection.username">sa</property> + <property name="connection.password"></property> + +  + <property name="connection.pool_size">1</property> + +  + <property name="dialect">org.hibernate.dialect.HSQLDialect</property> + +  + <property name="current_session_context_class">thread</property> + +  + <property name="cache.provider_class">org.hibernate.cache.NoCacheProvider</property> + +  + <property name="show_sql">true</property> + +  + <property name="hbm2ddl.auto">create</property> + + <mapping resource="events/Event.hbm.xml"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + Note that this XML configuration uses a different DTD. We configure + Hibernate's <literal>SessionFactory</literal> - a global factory responsible + for a particular database. If you have several databases, use several + <literal><session-factory></literal> configurations, usually in + several configuration files (for easier startup). + </para> + + <para> + The first four <literal>property</literal> elements contain the necessary + configuration for the JDBC connection. The dialect <literal>property</literal> + element specifies the particular SQL variant Hibernate generates. + Hibernate's automatic session management for persistence contexts will + come in handy as you will soon see. + The <literal>hbm2ddl.auto</literal> option turns on automatic generation of + database schemas - directly into the database. This can of course also be turned + off (by removing the config option) or redirected to a file with the help of + the <literal>SchemaExport</literal> Ant task. Finally, we add the mapping file(s) + for persistent classes to the configuration. + </para> + + <para> + Copy this file into the source directory, so it will end up in the + root of the classpath. Hibernate automatically looks for a file called + <literal>hibernate.cfg.xml</literal> in the root of the classpath, on startup. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-ant" revision="1"> + <title>Building with Ant</title> + + <para> + We'll now build the tutorial with Ant. You will need to have Ant installed - get + it from the <ulink url="http://ant.apache.org/bindownload.cgi">Ant download page</ulink>. + How to install Ant will not be covered here. Please refer to the + <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink>. After you + have installed Ant, we can start to create the buildfile. It will be called + <literal>build.xml</literal> and placed directly in the development directory. + </para> + + <para> + A basic build file looks like this: + </para> + + <programlisting><![CDATA[<project name="hibernate-tutorial" default="compile"> + + <property name="sourcedir" value="${basedir}/src"/> + <property name="targetdir" value="${basedir}/bin"/> + <property name="librarydir" value="${basedir}/lib"/> + + <path id="libraries"> + <fileset dir="${librarydir}"> + <include name="*.jar"/> + </fileset> + </path> + + <target name="clean"> + <delete dir="${targetdir}"/> + <mkdir dir="${targetdir}"/> + </target> + + <target name="compile" depends="clean, copy-resources"> + <javac srcdir="${sourcedir}" + destdir="${targetdir}" + classpathref="libraries"/> + </target> + + <target name="copy-resources"> + <copy todir="${targetdir}"> + <fileset dir="${sourcedir}"> + <exclude name="**/*.java"/> + </fileset> + </copy> + </target> + +</project>]]></programlisting> + + <para> + This will tell Ant to add all files in the lib directory ending with <literal>.jar</literal> + to the classpath used for compilation. It will also copy all non-Java source files to the + target directory, e.g. configuration and Hibernate mapping files. If you now run Ant, you + should get this output: + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant +Buildfile: build.xml + +copy-resources: + [copy] Copying 2 files to C:\hibernateTutorial\bin + +compile: + [javac] Compiling 1 source file to C:\hibernateTutorial\bin + +BUILD SUCCESSFUL +Total time: 1 second ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-firstapp-helpers" revision="3"> + <title>Startup and helpers</title> + + <para> + It's time to load and store some <literal>Event</literal> objects, but first + we have to complete the setup with some infrastructure code. We have to startup + Hibernate. This startup includes building a global <literal>SessionFactory</literal> + object and to store it somewhere for easy access in application code. + A <literal>SessionFactory</literal> can open up new <literal>Session</literal>'s. + A <literal>Session</literal> represents a single-threaded unit of work, the + <literal>SessionFactory</literal> is a thread-safe global object, instantiated once. + </para> + + <para> + We'll create a <literal>HibernateUtil</literal> helper class which takes care + of startup and makes accessing a <literal>SessionFactory</literal> convenient. + Let's have a look at the implementation: + </para> + + <programlisting><![CDATA[package util; + +import org.hibernate.*; +import org.hibernate.cfg.*; + +public class HibernateUtil { + + private static final SessionFactory sessionFactory; + + static { + try { + // Create the SessionFactory from hibernate.cfg.xml + sessionFactory = new Configuration().configure().buildSessionFactory(); + } catch (Throwable ex) { + // Make sure you log the exception, as it might be swallowed + System.err.println("Initial SessionFactory creation failed." + ex); + throw new ExceptionInInitializerError(ex); + } + } + + public static SessionFactory getSessionFactory() { + return sessionFactory; + } + +}]]></programlisting> + + <para> + This class does not only produce the global <literal>SessionFactory</literal> in + its static initializer (called once by the JVM when the class is loaded), but also + hides the fact that it uses a static singleton. It might as well lookup the + <literal>SessionFactory</literal> from JNDI in an application server. + </para> + + <para> + If you give the <literal>SessionFactory</literal> a name in your configuration + file, Hibernate will in fact try to bind it to JNDI after it has been built. + To avoid this code completely you could also use JMX deployment and let the + JMX-capable container instantiate and bind a <literal>HibernateService</literal> + to JNDI. These advanced options are discussed in the Hibernate reference + documentation. + </para> + + <para> + Place <literal>HibernateUtil.java</literal> in the development source directory, in + a package next to <literal>events</literal>: + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java + Event.hbm.xml + +util + HibernateUtil.java + hibernate.cfg.xml ++data +build.xml]]></programlisting> + + <para> + This should again compile without problems. We finally need to configure a logging + system - Hibernate uses commons logging and leaves you the choice between Log4j and + JDK 1.4 logging. Most developers prefer Log4j: copy <literal>log4j.properties</literal> + from the Hibernate distribution (it's in the <literal>etc/</literal> directory) to + your <literal>src</literal> directory, next to <literal>hibernate.cfg.xml</literal>. + Have a look at the example configuration and change the settings if you like to have + more verbose output. By default, only Hibernate startup message are shown on stdout. + </para> + + <para> + The tutorial infrastructure is complete - and we are ready to do some real work with + Hibernate. + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-workingpersistence" revision="5"> + <title>Loading and storing objects</title> + + <para> + Finally, we can use Hibernate to load and store objects. We write an + <literal>EventManager</literal> class with a <literal>main()</literal> method: + </para> + + <programlisting><![CDATA[package events; +import org.hibernate.Session; + +import java.util.Date; + +import util.HibernateUtil; + +public class EventManager { + + public static void main(String[] args) { + EventManager mgr = new EventManager(); + + if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); + } + + HibernateUtil.getSessionFactory().close(); + } + + private void createAndStoreEvent(String title, Date theDate) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + + session.beginTransaction(); + + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + session.save(theEvent); + + session.getTransaction().commit(); + } + +}]]></programlisting> + + <para> + We create a new <literal>Event</literal> object, and hand it over to Hibernate. + Hibernate now takes care of the SQL and executes <literal>INSERT</literal>s + on the database. Let's have a look at the <literal>Session</literal> and + <literal>Transaction</literal>-handling code before we run this. + </para> + + <para> + A <literal>Session</literal> is a single unit of work. For now we'll keep things + simple and assume a one-to-one granularity between a Hibernate <literal>Session</literal> + and a database transaction. To shield our code from the actual underlying transaction + system (in this case plain JDBC, but it could also run with JTA) we use the + <literal>Transaction</literal> API that is available on the Hibernate <literal>Session</literal>. + </para> + + <para> + What does <literal>sessionFactory.getCurrentSession()</literal> do? First, you can call it + as many times and anywhere you like, once you get hold of your <literal>SessionFactory</literal> + (easy thanks to <literal>HibernateUtil</literal>). The <literal>getCurrentSession()</literal> + method always returns the "current" unit of work. Remember that we switched the configuration + option for this mechanism to "thread" in <literal>hibernate.cfg.xml</literal>? Hence, + the current unit of work is bound to the current Java thread that executes our application. + However, this is not the full picture, you also have to consider scope, when a unit of work + begins and when it ends. + </para> + + <para> + A <literal>Session</literal> begins when it is first needed, when the first call to + <literal>getCurrentSession()</literal> is made. It is then bound by Hibernate to the current + thread. When the transaction ends, either through commit or rollback, Hibernate automatically + unbinds the <literal>Session</literal> from the thread and closes it for you. If you call + <literal>getCurrentSession()</literal> again, you get a new <literal>Session</literal> and can + start a new unit of work. This <emphasis>thread-bound</emphasis> programming model is the most + popular way of using Hibernate, as it allows flexible layering of your code (transaction + demarcation code can be separated from data access code, we'll do this later in this tutorial). + </para> + + <para> + Related to the unit of work scope, should the Hibernate <literal>Session</literal> be used to + execute one or several database operations? The above example uses one <literal>Session</literal> + for one operation. This is pure coincidence, the example is just not complex enough to show any + other approach. The scope of a Hibernate <literal>Session</literal> is flexible but you should + never design your application to use a new Hibernate <literal>Session</literal> for + <emphasis>every</emphasis> database operation. So even if you see it a few more times in + the following (very trivial) examples, consider <emphasis>session-per-operation</emphasis> + an anti-pattern. A real (web) application is shown later in this tutorial. + </para> + + <para> + Have a look at <xref linkend="transactions"/> for more information + about transaction handling and demarcation. We also skipped any error handling and + rollback in the previous example. + </para> + + <para> + To run this first routine we have to add a callable target to the Ant build file: + </para> + + <programlisting><![CDATA[<target name="run" depends="compile"> + <java fork="true" classname="events.EventManager" classpathref="libraries"> + <classpath path="${targetdir}"/> + <arg value="${action}"/> + </java> +</target>]]></programlisting> + + <para> + The value of the <literal>action</literal> argument is set on the command line when + calling the target: + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant run -Daction=store]]></programlisting> + + <para> + You should see, after compilation, Hibernate starting up and, depending on your + configuration, lots of log output. At the end you will find the following line: + </para> + + <programlisting><![CDATA[[java] Hibernate: insert into EVENTS (EVENT_DATE, title, EVENT_ID) values (?, ?, ?)]]></programlisting> + + <para> + This is the <literal>INSERT</literal> executed by Hibernate, the question marks + represent JDBC bind parameters. To see the values bound as arguments, or to reduce + the verbosity of the log, check your <literal>log4j.properties</literal>. + </para> + + <para> + Now we'd like to list stored events as well, so we add an option to the main method: + </para> + + <programlisting><![CDATA[if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); +} +else if (args[0].equals("list")) { + List events = mgr.listEvents(); + for (int i = 0; i < events.size(); i++) { + Event theEvent = (Event) events.get(i); + System.out.println("Event: " + theEvent.getTitle() + + " Time: " + theEvent.getDate()); + } +}]]></programlisting> + + <para> + We also add a new <literal>listEvents() method</literal>: + </para> + + <programlisting><![CDATA[private List listEvents() { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + + session.beginTransaction(); + + List result = session.createQuery("from Event").list(); + + session.getTransaction().commit(); + + return result; +}]]></programlisting> + + <para> + What we do here is use an HQL (Hibernate Query Language) query to load all existing + <literal>Event</literal> objects from the database. Hibernate will generate the + appropriate SQL, send it to the database and populate <literal>Event</literal> objects + with the data. You can create more complex queries with HQL, of course. + </para> + + <para> + Now, to execute and test all of this, follow these steps: + </para> + + <itemizedlist> + <listitem> + <para> + Run <literal>ant run -Daction=store</literal> to store something into the database + and, of course, to generate the database schema before through hbm2ddl. + </para> + </listitem> + <listitem> + <para> + Now disable hbm2ddl by commenting out the property in your <literal>hibernate.cfg.xml</literal> + file. Usually you only leave it turned on in continous unit testing, but another + run of hbm2ddl would <emphasis>drop</emphasis> everything you have stored - the + <literal>create</literal> configuration setting actually translates into "drop all + tables from the schema, then re-create all tables, when the SessionFactory is build". + </para> + </listitem> + </itemizedlist> + + <para> + If you now call Ant with <literal>-Daction=list</literal>, you should see the events + you have stored so far. You can of course also call the <literal>store</literal> action a few + times more. + </para> + + <para> + Note: Most new Hibernate users fail at this point and we see questions about + <emphasis>Table not found</emphasis> error messages regularly. However, if you follow the + steps outlined above you will not have this problem, as hbm2ddl creates the database + schema on the first run, and subsequent application restarts will use this schema. If + you change the mapping and/or database schema, you have to re-enable hbm2ddl once again. + </para> + + </sect2> + + </sect1> + + <sect1 id="tutorial-associations"> + <title>Part 2 - Mapping associations</title> + + <para> + We mapped a persistent entity class to a table. Let's build on this and add some class associations. + First we'll add people to our application, and store a list of events they participate in. + </para> + + <sect2 id="tutorial-associations-mappinguser" revision="1"> + <title>Mapping the Person class</title> + + <para> + The first cut of the <literal>Person</literal> class is simple: + </para> + + <programlisting><![CDATA[package events; + +public class Person { + + private Long id; + private int age; + private String firstname; + private String lastname; + + public Person() {} + + // Accessor methods for all properties, private setter for 'id' + +}]]></programlisting> + + <para> + Create a new mapping file called <literal>Person.hbm.xml</literal> (don't forget the + DTD reference at the top): + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="native"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + Finally, add the new mapping to Hibernate's configuration: + </para> + + <programlisting><![CDATA[<mapping resource="events/Event.hbm.xml"/> +<mapping resource="events/Person.hbm.xml"/>]]></programlisting> + + <para> + We'll now create an association between these two entities. Obviously, persons + can participate in events, and events have participants. The design questions + we have to deal with are: directionality, multiplicity, and collection + behavior. + </para> + + </sect2> + + <sect2 id="tutorial-associations-unidirset" revision="3"> + <title>A unidirectional Set-based association</title> + + <para> + We'll add a collection of events to the <literal>Person</literal> class. That way we can + easily navigate to the events for a particular person, without executing an explicit query - + by calling <literal>aPerson.getEvents()</literal>. We use a Java collection, a <literal>Set</literal>, + because the collection will not contain duplicate elements and the ordering is not relevant for us. + </para> + + <para> + We need a unidirectional, many-valued associations, implemented with a <literal>Set</literal>. + Let's write the code for this in the Java classes and then map it: + </para> + + <programlisting><![CDATA[public class Person { + + private Set events = new HashSet(); + + public Set getEvents() { + return events; + } + + public void setEvents(Set events) { + this.events = events; + } +}]]></programlisting> + + <para> + Before we map this association, think about the other side. Clearly, we could just keep this + unidirectional. Or, we could create another collection on the <literal>Event</literal>, if we + want to be able to navigate it bi-directional, i.e. <literal>anEvent.getParticipants()</literal>. + This is not necessary, from a functional perspective. You could always execute an explicit query + to retrieve the participants for a particular event. This is a design choice left to you, but what + is clear from this discussion is the multiplicity of the association: "many" valued on both sides, + we call this a <emphasis>many-to-many</emphasis> association. Hence, we use Hibernate's + many-to-many mapping: + </para> + + <programlisting><![CDATA[<class name="events.Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="native"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + + <set name="events" table="PERSON_EVENT"> + <key column="PERSON_ID"/> + <many-to-many column="EVENT_ID" class="events.Event"/> + </set> + +</class>]]></programlisting> + + <para> + Hibernate supports all kinds of collection mappings, a <literal><set></literal> being most + common. For a many-to-many association (or <emphasis>n:m</emphasis> entity relationship), an + association table is needed. Each row in this table represents a link between a person and an event. + The table name is configured with the <literal>table</literal> attribute of the <literal>set</literal> + element. The identifier column name in the association, for the person's side, is defined with the + <literal><key></literal> element, the column name for the event's side with the + <literal>column</literal> attribute of the <literal><many-to-many></literal>. You also + have to tell Hibernate the class of the objects in your collection (correct: the class on the + other side of the collection of references). + </para> + + <para> + The database schema for this mapping is therefore: + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | + |_____________| |__________________| | PERSON | + | | | | |_____________| + | *EVENT_ID | <--> | *EVENT_ID | | | + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | + |_____________| | FIRSTNAME | + | LASTNAME | + |_____________| + ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-associations-working" revision="2"> + <title>Working the association</title> + + <para> + Let's bring some people and events together in a new method in <literal>EventManager</literal>: + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + Event anEvent = (Event) session.load(Event.class, eventId); + + aPerson.getEvents().add(anEvent); + + session.getTransaction().commit(); +}]]></programlisting> + + <para> + After loading a <literal>Person</literal> and an <literal>Event</literal>, simply + modify the collection using the normal collection methods. As you can see, there is no explicit call + to <literal>update()</literal> or <literal>save()</literal>, Hibernate automatically + detects that the collection has been modified and needs to be updated. This is called <emphasis>automatic + dirty checking</emphasis>, and you can also try it by modifying the name or the date property of + any of your objects. As long as they are in <emphasis>persistent</emphasis> state, that is, bound + to a particular Hibernate <literal>Session</literal> (i.e. they have been just loaded or saved in + a unit of work), Hibernate monitors any changes and executes SQL in a write-behind fashion. The + process of synchronizing the memory state with the database, usually only at the end of a unit of + work, is called <emphasis>flushing</emphasis>. In our code, the unit of work ends with a commit + (or rollback) of the database transaction - as defined by the <literal>thread</literal> configuration + option for the <literal>CurrentSessionContext</literal> class. + </para> + + <para> + You might of course load person and event in different units of work. Or you modify an object + outside of a <literal>Session</literal>, when it is not in persistent state (if it was persistent + before, we call this state <emphasis>detached</emphasis>). You can even modify a collection when + it is detached: + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session + .createQuery("select p from Person p left join fetch p.events where p.id = :pid") + .setParameter("pid", personId) + .uniqueResult(); // Eager fetch the collection so we can use it detached + + Event anEvent = (Event) session.load(Event.class, eventId); + + session.getTransaction().commit(); + + // End of first unit of work + + aPerson.getEvents().add(anEvent); // aPerson (and its collection) is detached + + // Begin second unit of work + + Session session2 = HibernateUtil.getSessionFactory().getCurrentSession(); + session2.beginTransaction(); + + session2.update(aPerson); // Reattachment of aPerson + + session2.getTransaction().commit(); +}]]></programlisting> + + <para> + The call to <literal>update</literal> makes a detached object persistent again, you could + say it binds it to a new unit of work, so any modifications you made to it while detached + can be saved to the database. This includes any modifications (additions/deletions) you + made to a collection of that entity object. + </para> + + <para> + Well, this is not much use in our current situation, but it's an important concept you can + design into your own application. For now, complete this exercise by adding a new action + to the <literal>EventManager</literal>'s main method and call it from the command line. If + you need the identifiers of a person and an event - the <literal>save()</literal> method + returns it (you might have to modify some of the previous methods to return that identifier): + </para> + + <programlisting><![CDATA[else if (args[0].equals("addpersontoevent")) { + Long eventId = mgr.createAndStoreEvent("My Event", new Date()); + Long personId = mgr.createAndStorePerson("Foo", "Bar"); + mgr.addPersonToEvent(personId, eventId); + System.out.println("Added person " + personId + " to event " + eventId); +}]]></programlisting> + + <para> + This was an example of an association between two equally important classes, two entities. + As mentioned earlier, there are other classes and types in a typical model, usually "less + important". Some you have already seen, like an <literal>int</literal> or a <literal>String</literal>. + We call these classes <emphasis>value types</emphasis>, and their instances <emphasis>depend</emphasis> + on a particular entity. Instances of these types don't have their own identity, nor are they + shared between entities (two persons don't reference the same <literal>firstname</literal> + object, even if they have the same first name). Of course, value types can not only be found in + the JDK (in fact, in a Hibernate application all JDK classes are considered value types), but + you can also write dependent classes yourself, <literal>Address</literal> or <literal>MonetaryAmount</literal>, + for example. + </para> + + <para> + You can also design a collection of value types. This is conceptually very different from a + collection of references to other entities, but looks almost the same in Java. + </para> + + </sect2> + + <sect2 id="tutorial-associations-valuecollections"> + <title>Collection of values</title> + + <para> + We add a collection of value typed objects to the <literal>Person</literal> entity. We want to + store email addresses, so the type we use is <literal>String</literal>, and the collection is + again a <literal>Set</literal>: + </para> + <programlisting><![CDATA[private Set emailAddresses = new HashSet(); + +public Set getEmailAddresses() { + return emailAddresses; +} + +public void setEmailAddresses(Set emailAddresses) { + this.emailAddresses = emailAddresses; +}]]></programlisting> + + <para> + The mapping of this <literal>Set</literal>: + </para> + + <programlisting><![CDATA[<set name="emailAddresses" table="PERSON_EMAIL_ADDR"> + <key column="PERSON_ID"/> + <element type="string" column="EMAIL_ADDR"/> +</set>]]></programlisting> + + <para> + The difference compared with the earlier mapping is the <literal>element</literal> part, which tells Hibernate that the collection + does not contain references to another entity, but a collection of elements of type + <literal>String</literal> (the lowercase name tells you it's a Hibernate mapping type/converter). + Once again, the <literal>table</literal> attribute of the <literal>set</literal> element determines + the table name for the collection. The <literal>key</literal> element defines the foreign-key column + name in the collection table. The <literal>column</literal> attribute in the <literal>element</literal> + element defines the column name where the <literal>String</literal> values will actually be stored. + </para> + + <para> + Have a look at the updated schema: + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | ___________________ + |_____________| |__________________| | PERSON | | | + | | | | |_____________| | PERSON_EMAIL_ADDR | + | *EVENT_ID | <--> | *EVENT_ID | | | |___________________| + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | | *EMAIL_ADDR | + |_____________| | FIRSTNAME | |___________________| + | LASTNAME | + |_____________| + ]]></programlisting> + + <para> + You can see that the primary key of the collection table is in fact a composite key, + using both columns. This also implies that there can't be duplicate email addresses + per person, which is exactly the semantics we need for a set in Java. + </para> + + <para> + You can now try and add elements to this collection, just like we did before by + linking persons and events. It's the same code in Java: + </para> + + <programlisting><![CDATA[private void addEmailToPerson(Long personId, String emailAddress) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + + // The getEmailAddresses() might trigger a lazy load of the collection + aPerson.getEmailAddresses().add(emailAddress); + + session.getTransaction().commit(); +}]]></programlisting> + + <para> + This time we didnt' use a <emphasis>fetch</emphasis> query to initialize the collection. + Hence, the call to its getter method will trigger an additional select to initialize + it, so we can add an element to it. Monitor the SQL log and try to optimize this with + an eager fetch. + </para> + + </sect2> + + <sect2 id="tutorial-associations-bidirectional" revision="1"> + <title>Bi-directional associations</title> + + <para> + Next we are going to map a bi-directional association - making the association between + person and event work from both sides in Java. Of course, the database schema doesn't + change, we still have many-to-many multiplicity. A relational database is more flexible + than a network programming language, so it doesn't need anything like a navigation + direction - data can be viewed and retrieved in any possible way. + </para> + + <para> + First, add a collection of participants to the <literal>Event</literal> Event class: + </para> + + <programlisting><![CDATA[private Set participants = new HashSet(); + +public Set getParticipants() { + return participants; +} + +public void setParticipants(Set participants) { + this.participants = participants; +}]]></programlisting> + + <para> + Now map this side of the association too, in <literal>Event.hbm.xml</literal>. + </para> + + <programlisting><![CDATA[<set name="participants" table="PERSON_EVENT" inverse="true"> + <key column="EVENT_ID"/> + <many-to-many column="PERSON_ID" class="events.Person"/> +</set>]]></programlisting> + + <para> + As you see, these are normal <literal>set</literal> mappings in both mapping documents. + Notice that the column names in <literal>key</literal> and <literal>many-to-many</literal> are + swapped in both mapping documents. The most important addition here is the + <literal>inverse="true"</literal> attribute in the <literal>set</literal> element of the + <literal>Event</literal>'s collection mapping. + </para> + + <para> + What this means is that Hibernate should take the other side - the <literal>Person</literal> class - + when it needs to find out information about the link between the two. This will be a lot easier to + understand once you see how the bi-directional link between our two entities is created . + </para> + + </sect2> + + <sect2 id="tutorial-associations-usingbidir"> + <title>Working bi-directional links</title> + + <para> + First, keep in mind that Hibernate does not affect normal Java semantics. How did we create a + link between a <literal>Person</literal> and an <literal>Event</literal> in the unidirectional + example? We added an instance of <literal>Event</literal> to the collection of event references, + of an instance of <literal>Person</literal>. So, obviously, if we want to make this link working + bi-directional, we have to do the same on the other side - adding a <literal>Person</literal> + reference to the collection in an <literal>Event</literal>. This "setting the link on both sides" + is absolutely necessary and you should never forget doing it. + </para> + + <para> + Many developers program defensive and create link management methods to + correctly set both sides, e.g. in <literal>Person</literal>: + </para> + + <programlisting><![CDATA[protected Set getEvents() { + return events; +} + +protected void setEvents(Set events) { + this.events = events; +} + +public void addToEvent(Event event) { + this.getEvents().add(event); + event.getParticipants().add(this); +} + +public void removeFromEvent(Event event) { + this.getEvents().remove(event); + event.getParticipants().remove(this); +}]]></programlisting> + + <para> + Notice that the get and set methods for the collection are now protected - this allows classes in the + same package and subclasses to still access the methods, but prevents everybody else from messing + with the collections directly (well, almost). You should probably do the same with the collection + on the other side. + </para> + + <para> + What about the <literal>inverse</literal> mapping attribute? For you, and for Java, a bi-directional + link is simply a matter of setting the references on both sides correctly. Hibernate however doesn't + have enough information to correctly arrange SQL <literal>INSERT</literal> and <literal>UPDATE</literal> + statements (to avoid constraint violations), and needs some help to handle bi-directional associations + properly. Making one side of the association <literal>inverse</literal> tells Hibernate to basically + ignore it, to consider it a <emphasis>mirror</emphasis> of the other side. That's all that is necessary + for Hibernate to work out all of the issues when transformation a directional navigation model to + a SQL database schema. The rules you have to remember are straightforward: All bi-directional associations + need one side as <literal>inverse</literal>. In a one-to-many association it has to be the many-side, + in many-to-many association you can pick either side, there is no difference. + </para> + + </sect2> + + <para> + Let's turn this into a small web application. + </para> + + </sect1> + + <sect1 id="tutorial-webapp"> + <title>Part 3 - The EventManager web application</title> + + <para> + A Hibernate web application uses <literal>Session</literal> and <literal>Transaction</literal> + almost like a standalone application. However, some common patterns are useful. We now write + an <literal>EventManagerServlet</literal>. This servlet can list all events stored in the + database, and it provides an HTML form to enter new events. + </para> + + <sect2 id="tutorial-webapp-servlet" revision="2"> + <title>Writing the basic servlet</title> + + <para> + Create a new class in your source directory, in the <literal>events</literal> + package: + </para> + + <programlisting><![CDATA[package events; + +// Imports + +public class EventManagerServlet extends HttpServlet { + + // Servlet code +}]]></programlisting> + + <para> + The servlet handles HTTP <literal>GET</literal> requests only, hence, the method + we implement is <literal>doGet()</literal>: + </para> + + <programlisting><![CDATA[protected void doGet(HttpServletRequest request, + HttpServletResponse response) + throws ServletException, IOException { + + SimpleDateFormat dateFormatter = new SimpleDateFormat("dd.MM.yyyy"); + + try { + // Begin unit of work + HibernateUtil.getSessionFactory() + .getCurrentSession().beginTransaction(); + + // Process request and render page... + + // End unit of work + HibernateUtil.getSessionFactory() + .getCurrentSession().getTransaction().commit(); + + } catch (Exception ex) { + HibernateUtil.getSessionFactory() + .getCurrentSession().getTransaction().rollback(); + throw new ServletException(ex); + } + +}]]></programlisting> + + <para> + The pattern we are applying here is called <emphasis>session-per-request</emphasis>. + When a request hits the servlet, a new Hibernate <literal>Session</literal> is + opened through the first call to <literal>getCurrentSession()</literal> on the + <literal>SessionFactory</literal>. Then a database transaction is started—all + data access as to occur inside a transaction, no matter if data is read or written + (we don't use the auto-commit mode in applications). + </para> + + <para> + Do <emphasis>not</emphasis> use a new Hibernate <literal>Session</literal> for + every database operation. Use one Hibernate <literal>Session</literal> that is + scoped to the whole request. Use <literal>getCurrentSession()</literal>, so that + it is automatically bound to the current Java thread. + </para> + + <para> + Next, the possible actions of the request are processed and the response HTML + is rendered. We'll get to that part soon. + </para> + + <para> + Finally, the unit of work ends when processing and rendering is complete. If any + problem occured during processing or rendering, an exception will be thrown + and the database transaction rolled back. This completes the + <literal>session-per-request</literal> pattern. Instead of the transaction + demarcation code in every servlet you could also write a servlet filter. + See the Hibernate website and Wiki for more information about this pattern, + called <emphasis>Open Session in View</emphasis>—you'll need it as soon + as you consider rendering your view in JSP, not in a servlet. + </para> + + </sect2> + + <sect2 id="tutorial-webapp-processing" revision="1"> + <title>Processing and rendering</title> + + <para> + Let's implement the processing of the request and rendering of the page. + </para> + +<programlisting><![CDATA[// Write HTML header +PrintWriter out = response.getWriter(); +out.println("<html><head><title>Event Manager</title></head><body>"); + +// Handle actions +if ( "store".equals(request.getParameter("action")) ) { + + String eventTitle = request.getParameter("eventTitle"); + String eventDate = request.getParameter("eventDate"); + + if ( "".equals(eventTitle) || "".equals(eventDate) ) { + out.println("<b><i>Please enter event title and date.</i></b>"); + } else { + createAndStoreEvent(eventTitle, dateFormatter.parse(eventDate)); + out.println("<b><i>Added event.</i></b>"); + } +} + +// Print page +printEventForm(out); +listEvents(out, dateFormatter); + +// Write HTML footer +out.println("</body></html>"); +out.flush(); +out.close();]]></programlisting> + + <para> + Granted, this coding style with a mix of Java and HTML would not scale + in a more complex application—keep in mind that we are only illustrating + basic Hibernate concepts in this tutorial. The code prints an HTML + header and a footer. Inside this page, an HTML form for event entry and + a list of all events in the database are printed. The first method is + trivial and only outputs HTML: + </para> + + <programlisting><![CDATA[private void printEventForm(PrintWriter out) { + out.println("<h2>Add new event:</h2>"); + out.println("<form>"); + out.println("Title: <input name='eventTitle' length='50'/><br/>"); + out.println("Date (e.g. 24.12.2009): <input name='eventDate' length='10'/><br/>"); + out.println("<input type='submit' name='action' value='store'/>"); + out.println("</form>"); +}]]></programlisting> + + <para> + The <literal>listEvents()</literal> method uses the Hibernate + <literal>Session</literal> bound to the current thread to execute + a query: + </para> + + <programlisting><![CDATA[private void listEvents(PrintWriter out, SimpleDateFormat dateFormatter) { + + List result = HibernateUtil.getSessionFactory() + .getCurrentSession().createCriteria(Event.class).list(); + if (result.size() > 0) { + out.println("<h2>Events in database:</h2>"); + out.println("<table border='1'>"); + out.println("<tr>"); + out.println("<th>Event title</th>"); + out.println("<th>Event date</th>"); + out.println("</tr>"); + for (Iterator it = result.iterator(); it.hasNext();) { + Event event = (Event) it.next(); + out.println("<tr>"); + out.println("<td>" + event.getTitle() + "</td>"); + out.println("<td>" + dateFormatter.format(event.getDate()) + "</td>"); + out.println("</tr>"); + } + out.println("</table>"); + } +}]]></programlisting> + + <para> + Finally, the <literal>store</literal> action is dispatched to the + <literal>createAndStoreEvent()</literal> method, which also uses + the <literal>Session</literal> of the current thread: + </para> + + <programlisting><![CDATA[protected void createAndStoreEvent(String title, Date theDate) { + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + HibernateUtil.getSessionFactory() + .getCurrentSession().save(theEvent); +}]]></programlisting> + + <para> + That's it, the servlet is complete. A request to the servlet will be processed + in a single <literal>Session</literal> and <literal>Transaction</literal>. As + earlier in the standalone application, Hibernate can automatically bind these + ojects to the current thread of execution. This gives you the freedom to layer + your code and access the <literal>SessionFactory</literal> in any way you like. + Usually you'd use a more sophisticated design and move the data access code + into data access objects (the DAO pattern). See the Hibernate Wiki for more + examples. + </para> + + </sect2> + + <sect2 id="tutorial-webapp-deploy"> + <title>Deploying and testing</title> + + <para> + To deploy this application you have to create a web archive, a WAR. Add the + following Ant target to your <literal>build.xml</literal>: + </para> + +<programlisting><![CDATA[<target name="war" depends="compile"> + <war destfile="hibernate-tutorial.war" webxml="web.xml"> + <lib dir="${librarydir}"> + <exclude name="jsdk*.jar"/> + </lib> + + <classes dir="${targetdir}"/> + </war> +</target>]]></programlisting> + + <para> + This target creates a file called <literal>hibernate-tutorial.war</literal> + in your project directory. It packages all libraries and the <literal>web.xml</literal> + descriptor, which is expected in the base directory of your project: + </para> + + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<web-app version="2.4" + xmlns="http://java.sun.com/xml/ns/j2ee" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> + + <servlet> + <servlet-name>Event Manager</servlet-name> + <servlet-class>events.EventManagerServlet</servlet-class> + </servlet> + + <servlet-mapping> + <servlet-name>Event Manager</servlet-name> + <url-pattern>/eventmanager</url-pattern> + </servlet-mapping> +</web-app>]]></programlisting> + + <para> + Before you compile and deploy the web application, note that an additional library + is required: <literal>jsdk.jar</literal>. This is the Java servlet development kit, + if you don't have this library already, get it from the Sun website and copy it to + your library directory. However, it will be only used for compliation and excluded + from the WAR package. + </para> + + <para> + To build and deploy call <literal>ant war</literal> in your project directory + and copy the <literal>hibernate-tutorial.war</literal> file into your Tomcat + <literal>webapp</literal> directory. If you don't have Tomcat installed, download + it and follow the installation instructions. You don't have to change any Tomcat + configuration to deploy this application though. + </para> + + <para> + Once deployed and Tomcat is running, access the application at + <literal>http://localhost:8080/hibernate-tutorial/eventmanager</literal>. Make + sure you watch the Tomcat log to see Hibernate initialize when the first + request hits your servlet (the static initializer in <literal>HibernateUtil</literal> + is called) and to get the detailed output if any exceptions occurs. + </para> + + </sect2> + + </sect1> + + <sect1 id="tutorial-summary" revision="1"> + <title>Summary</title> + + <para> + This tutorial covered the basics of writing a simple standalone Hibernate application + and a small web application. + </para> + + <para> + If you already feel confident with Hibernate, continue browsing through the reference + documentation table of contents for topics you find interesting - most asked are + transactional processing (<xref linkend="transactions"/>), fetch + performance (<xref linkend="performance"/>), or the usage of the API (<xref linkend="objectstate"/>) + and the query features (<xref linkend="objectstate-querying"/>). + </para> + + <para> + Don't forget to check the Hibernate website for more (specialized) tutorials. + </para> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/en-US/src/main/docbook/content/xml.xml (from rev 12794, core/trunk/documentation/manual/en-US/src/main/docbook/modules/xml.xml) =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/content/xml.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/content/xml.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,289 @@ +<?xml version='1.0' encoding="iso-8859-1"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<chapter id="xml"> + <title>XML Mapping</title> + + <para><emphasis> + Note that this is an experimental feature in Hibernate 3.0 and is under + extremely active development. + </emphasis></para> + + <sect1 id="xml-intro" revision="1"> + <title>Working with XML data</title> + + <para> + Hibernate lets you work with persistent XML data in much the same way + you work with persistent POJOs. A parsed XML tree can be thought of + as just another way to represent the relational data at the object level, + instead of POJOs. + </para> + + <para> + Hibernate supports dom4j as API for manipulating XML trees. You can write + queries that retrieve dom4j trees from the database and have any + modification you make to the tree automatically synchronized to the + database. You can even take an XML document, parse it using dom4j, and + write it to the database with any of Hibernate's basic operations: + <literal>persist(), saveOrUpdate(), merge(), delete(), replicate()</literal> + (merging is not yet supported). + </para> + + <para> + This feature has many applications including data import/export, + externalization of entity data via JMS or SOAP and XSLT-based reporting. + </para> + + <para> + A single mapping may be used to simultaneously map properties of a class + and nodes of an XML document to the database, or, if there is no class to map, + it may be used to map just the XML. + </para> + + <sect2 id="xml-intro-mapping"> + <title>Specifying XML and class mapping together</title> + + <para> + Here is an example of mapping a POJO and XML simultaneously: + </para> + + <programlisting><![CDATA[<class name="Account" + table="ACCOUNTS" + node="account"> + + <id name="accountId" + column="ACCOUNT_ID" + node="@id"/> + + <many-to-one name="customer" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false"/> + + <property name="balance" + column="BALANCE" + node="balance"/> + + ... + +</class>]]></programlisting> + </sect2> + + <sect2 id="xml-onlyxml"> + <title>Specifying only an XML mapping</title> + + <para> + Here is an example where there is no POJO class: + </para> + + <programlisting><![CDATA[<class entity-name="Account" + table="ACCOUNTS" + node="account"> + + <id name="id" + column="ACCOUNT_ID" + node="@id" + type="string"/> + + <many-to-one name="customerId" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false" + entity-name="Customer"/> + + <property name="balance" + column="BALANCE" + node="balance" + type="big_decimal"/> + + ... + +</class>]]></programlisting> + + <para> + This mapping allows you to access the data as a dom4j tree, or as a graph of + property name/value pairs (java <literal>Map</literal>s). The property names + are purely logical constructs that may be referred to in HQL queries. + </para> + + </sect2> + + </sect1> + + <sect1 id="xml-mapping" revision="1"> + <title>XML mapping metadata</title> + + <para> + Many Hibernate mapping elements accept the <literal>node</literal> attribute. + This let's you specify the name of an XML attribute or element that holds the + property or entity data. The format of the <literal>node</literal> attribute + must be one of the following: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para><literal>"element-name"</literal> - map to the named XML element</para> + </listitem> + <listitem> + <para><literal>"@attribute-name"</literal> - map to the named XML attribute</para> + </listitem> + <listitem> + <para><literal>"."</literal> - map to the parent element</para> + </listitem> + <listitem> + <para> + <literal>"element-name/@attribute-name"</literal> - + map to the named attribute of the named element + </para> + </listitem> + </itemizedlist> + + <para> + For collections and single valued associations, there is an additional + <literal>embed-xml</literal> attribute. If <literal>embed-xml="true"</literal>, + the default, the XML tree for the associated entity (or collection of value type) + will be embedded directly in the XML tree for the entity that owns the association. + Otherwise, if <literal>embed-xml="false"</literal>, then only the referenced + identifier value will appear in the XML for single point associations and + collections will simply not appear at all. + </para> + + <para> + You should be careful not to leave <literal>embed-xml="true"</literal> for + too many associations, since XML does not deal well with circularity! + </para> + + <programlisting><![CDATA[<class name="Customer" + table="CUSTOMER" + node="customer"> + + <id name="id" + column="CUST_ID" + node="@id"/> + + <map name="accounts" + node="." + embed-xml="true"> + <key column="CUSTOMER_ID" + not-null="true"/> + <map-key column="SHORT_DESC" + node="@short-desc" + type="string"/> + <one-to-many entity-name="Account" + embed-xml="false" + node="account"/> + </map> + + <component name="name" + node="name"> + <property name="firstName" + node="first-name"/> + <property name="initial" + node="initial"/> + <property name="lastName" + node="last-name"/> + </component> + + ... + +</class>]]></programlisting> + + <para> + in this case, we have decided to embed the collection of account ids, but not + the actual account data. The following HQL query: + </para> + + <programlisting><![CDATA[from Customer c left join fetch c.accounts where c.lastName like :lastName]]></programlisting> + + <para> + Would return datasets such as this: + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account short-desc="Savings">987632567</account> + <account short-desc="Credit Card">985612323</account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + <para> + If you set <literal>embed-xml="true"</literal> on the <literal><one-to-many></literal> + mapping, the data might look more like this: + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account id="987632567" short-desc="Savings"> + <customer id="123456789"/> + <balance>100.29</balance> + </account> + <account id="985612323" short-desc="Credit Card"> + <customer id="123456789"/> + <balance>-2370.34</balance> + </account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + </sect1> + + + <sect1 id="xml-manipulation" revision="1"> + <title>Manipulating XML data</title> + + <para> + Let's rearead and update XML documents in the application. We do this by + obtaining a dom4j session: + </para> + + <programlisting><![CDATA[Document doc = ....; + +Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +List results = dom4jSession + .createQuery("from Customer c left join fetch c.accounts where c.lastName like :lastName") + .list(); +for ( int i=0; i<results.size(); i++ ) { + //add the customer data to the XML document + Element customer = (Element) results.get(i); + doc.add(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <programlisting><![CDATA[Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +Element cust = (Element) dom4jSession.get("Customer", customerId); +for ( int i=0; i<results.size(); i++ ) { + Element customer = (Element) results.get(i); + //change the customer name in the XML and database + Element name = customer.element("name"); + name.element("first-name").setText(firstName); + name.element("initial").setText(initial); + name.element("last-name").setText(lastName); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + It is extremely useful to combine this feature with Hibernate's <literal>replicate()</literal> + operation to implement XML-based data import/export. + </para> + + </sect1> + +</chapter> + Added: core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml (rev 0) +++ core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -0,0 +1,52 @@ +<?xml version='1.0'?> + +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<legalnotice id="Legal_Notice"> + <title>Legal Notice</title> + <para> + <address> + <street>1801 Varsity Drive</street> + <city>Raleigh</city>, <state>NC</state><postcode>27606-2072</postcode><country>USA</country> + <phone>Phone: +1 919 754 3700</phone> + <phone>Phone: 888 733 4281</phone> + <fax>Fax: +1 919 754 3701</fax> + <pob>PO Box 13588</pob><city>Research Triangle Park</city>, <state>NC</state><postcode>27709</postcode><country>USA</country> + </address> + </para> + <para> + Copyright <trademark class="copyright"></trademark> 2007 by Red Hat, Inc. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</ulink>). + </para> + <para> + Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. + </para> + <para> + Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder. + </para> + <para> + Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat, Inc. in the United States and other countries. + </para> + <para> + All other trademarks referenced herein are the property of their respective owners. + </para> + <para> + The GPG fingerprint of the security(a)redhat.com key is: + </para> + <para> + CA 20 86 86 2B D6 9D FC 65 F6 EC C4 21 91 80 CD DB 42 A6 0E + </para> +</legalnotice> \ No newline at end of file Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/master.xml =================================================================== --- core/trunk/documentation/manual/en-US/src/main/docbook/master.xml 2007-10-09 17:58:42 UTC (rev 14072) +++ core/trunk/documentation/manual/en-US/src/main/docbook/master.xml 2007-10-09 18:14:35 UTC (rev 14073) @@ -1,183 +0,0 @@ -<?xml version='1.0' encoding="iso-8859-1"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" - "../support/docbook-dtd/docbookx.dtd" -[ -<!ENTITY tutorial SYSTEM "modules/tutorial.xml"> -<!ENTITY architecture SYSTEM "modules/architecture.xml"> -<!ENTITY configuration SYSTEM "modules/configuration.xml"> -<!ENTITY persistent-classes SYSTEM "modules/persistent_classes.xml"> -<!ENTITY basic-mapping SYSTEM "modules/basic_mapping.xml"> -<!ENTITY collection-mapping SYSTEM "modules/collection_mapping.xml"> -<!ENTITY association-mapping SYSTEM "modules/association_mapping.xml"> -<!ENTITY component-mapping SYSTEM "modules/component_mapping.xml"> -<!ENTITY inheritance-mapping SYSTEM "modules/inheritance_mapping.xml"> -<!ENTITY session-api SYSTEM "modules/session_api.xml"> -<!ENTITY transactions SYSTEM "modules/transactions.xml"> -<!ENTITY events SYSTEM "modules/events.xml"> -<!ENTITY batch SYSTEM "modules/batch.xml"> -<!ENTITY query-hql SYSTEM "modules/query_hql.xml"> -<!ENTITY query-criteria SYSTEM "modules/query_criteria.xml"> -<!ENTITY query-sql SYSTEM "modules/query_sql.xml"> -<!ENTITY filters SYSTEM "modules/filters.xml"> -<!ENTITY xml SYSTEM "modules/xml.xml"> -<!ENTITY performance SYSTEM "modules/performance.xml"> -<!ENTITY toolset-guide SYSTEM "modules/toolset_guide.xml"> -<!ENTITY example-parentchild SYSTEM "modules/example_parentchild.xml"> -<!ENTITY example-weblog SYSTEM "modules/example_weblog.xml"> -<!ENTITY example-mappings SYSTEM "modules/example_mappings.xml"> -<!ENTITY best-practices SYSTEM "modules/best_practices.xml"> -]> - -<book lang="en"> - - <bookinfo> - <title>HIBERNATE - Relational Persistence for Idiomatic Java</title> - <subtitle>Hibernate Reference Documentation</subtitle> - <releaseinfo>3.2 cr3</releaseinfo> - </bookinfo> - - <toc/> - - <preface id="preface" revision="2"> - <title>Preface</title> - - <para> - Working with object-oriented software and a relational database can be cumbersome - and time consuming in today's enterprise environments. Hibernate is an object/relational - mapping tool for Java environments. The term object/relational mapping (ORM) refers to - the technique of mapping a data representation from an object model to a relational - data model with a SQL-based schema. - </para> - - <para> - Hibernate not only takes care of the mapping from Java classes to - database tables (and from Java data types to SQL data types), but also provides data - query and retrieval facilities and can significantly reduce development time otherwise - spent with manual data handling in SQL and JDBC. - </para> - - <para> - Hibernates goal is to relieve the developer from 95 percent of common data persistence - related programming tasks. Hibernate may not be the best solution for data-centric - applications that only use stored-procedures to implement the business logic in the - database, it is most useful with object-oriented domain models and business logic in - the Java-based middle-tier. However, Hibernate can certainly help you to remove or - encapsulate vendor-specific SQL code and will help with the common task of result set - translation from a tabular representation to a graph of objects. - </para> - - <para> - If you are new to Hibernate and Object/Relational Mapping or even Java, - please follow these steps: - </para> - - <orderedlist> - <listitem> - <para> - Read <xref linkend="tutorial"/> for a tutorial with step-by-step - instructions. The source code for the tutorial is included in the - distribution in the <literal>doc/reference/tutorial/</literal> - directory. - </para> - </listitem> - <listitem> - <para> - Read <xref linkend="architecture"/> to understand the environments where - Hibernate can be used. - </para> - </listitem> - <listitem> - <para> - Have a look at the <literal>eg/</literal> directory in the Hibernate - distribution, it contains a simple standalone application. Copy your - JDBC driver to the <literal>lib/</literal> directory and edit - <literal>etc/hibernate.properties</literal>, specifying correct values for - your database. From a command prompt in the distribution directory, - type <literal>ant eg</literal> (using Ant), or under Windows, type - <literal>build eg</literal>. - </para> - </listitem> - <listitem> - <para> - Use this reference documentation as your primary source of information. - Consider reading <emphasis>Java Persistence with Hibernate</emphasis> - (http://www.manning.com/bauer2) if you need more help with application - design or if you prefer a step-by-step tutorial. Also visit - http://caveatemptor.hibernate.org and download the example application - for Java Persistence with Hibernate. - </para> - </listitem> - <listitem> - <para> - FAQs are answered on the Hibernate website. - </para> - </listitem> - <listitem> - <para> - Third party demos, examples, and tutorials are linked on the Hibernate - website. - </para> - </listitem> - <listitem> - <para> - The Community Area on the Hibernate website is a good resource for - design patterns and various integration solutions (Tomcat, JBoss AS, - Struts, EJB, etc.). - </para> - </listitem> - </orderedlist> - - <para> - If you have questions, use the user forum linked on the Hibernate website. We also - provide a JIRA issue trackings system for bug reports and feature requests. If you - are interested in the development of Hibernate, join the developer mailing list. If - you are interested in translating this documentation into your language, contact us - on the developer mailing list. - </para> - - <para> - Commercial development support, production support, and training for Hibernate is - available through JBoss Inc. (see http://www.hibernate.org/SupportTraining/). - Hibernate is a Professional Open Source project and a critical component of the - JBoss Enterprise Middleware System (JEMS) suite of products. - </para> - - </preface> - - &tutorial; - - &architecture; - - &configuration; - - &persistent-classes; - - &basic-mapping; - &collection-mapping; - &association-mapping; - &component-mapping; - &inheritance-mapping; - - &session-api; - &transactions; - &events; - &batch; - - &query-hql; - &query-criteria; - &query-sql; - &filters; - &xml; - - &performance; - - &toolset-guide; - - &example-parentchild; - &example-weblog; - &example-mappings; - - &best-practices; - -</book> -

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14072 - branches/Branch_3_2/HibernateExt/tools/src/java/org/hibernate/cfg/reveng/dialect.

by hibernate-commits＠lists.jboss.org

Author: dan.j.allen Date: 2007-10-09 13:58:42 -0400 (Tue, 09 Oct 2007) New Revision: 14072 Modified: branches/Branch_3_2/HibernateExt/tools/src/java/org/hibernate/cfg/reveng/dialect/H2MetaDataDialect.java Log: HBX-965 - conditionally exclude catalog name in H2 if using builds < 55 HBX-961 - fix invalid column name in suggested primary key query Modified: branches/Branch_3_2/HibernateExt/tools/src/java/org/hibernate/cfg/reveng/dialect/H2MetaDataDialect.java =================================================================== --- branches/Branch_3_2/HibernateExt/tools/src/java/org/hibernate/cfg/reveng/dialect/H2MetaDataDialect.java 2007-10-09 15:38:29 UTC (rev 14071) +++ branches/Branch_3_2/HibernateExt/tools/src/java/org/hibernate/cfg/reveng/dialect/H2MetaDataDialect.java 2007-10-09 17:58:42 UTC (rev 14072) @@ -8,6 +8,7 @@ import java.util.Map; import org.hibernate.util.StringHelper; +import org.hibernate.util.ReflectHelper; /** @@ -18,16 +19,35 @@ */ public class H2MetaDataDialect extends JDBCMetaDataDialect { - /*protected void putTablePart(Map element, ResultSet tableRs) throws SQLException { + private static boolean understandsCatalogName = true; + + public H2MetaDataDialect() { + super(); + try { + Class constants = ReflectHelper.classForName( "org.h2.engine.Constants" ); + Integer build = (Integer)constants.getDeclaredField( "BUILD_ID" ).get( null ); + if ( build.intValue() < 55 ) { + understandsCatalogName = false; + } + } + catch( Throwable e ) { + // ignore (probably H2 not in the classpath) + } + } + + protected void putTablePart(Map element, ResultSet tableRs) throws SQLException { super.putTablePart( element, tableRs ); - element.put("TABLE_CAT", null); + if ( !understandsCatalogName ) { + element.put( "TABLE_CAT", null ); + } } protected void putExportedKeysPart(Map element, ResultSet rs) throws SQLException { super.putExportedKeysPart( element, rs ); - element.put( "PKTABLE_CAT", null); - element.put( "FKTABLE_CAT", null); - }*/ + if ( !understandsCatalogName ) { + element.put( "PKTABLE_CAT", null ); + } + } public Iterator getSuggestedPrimaryKeyStrategyName(String catalog, String schema, String table) { try { @@ -46,7 +66,7 @@ "AND idx.PRIMARY_KEY = TRUE " + "AND COLUMN_DEFAULT like '%NEXT VALUE FOR%' "; if(catalog!=null) { - sql += "AND idx.TABLE_CATNAME like '" + catalog + "' "; + sql += "AND idx.TABLE_CATALOG like '" + catalog + "' "; } if(schema!=null) { sql += "AND idx.TABLE_SCHEMA like '" + schema + "' ";

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14071 - core/trunk/documentation/manual/en-US/src/main.

by hibernate-commits＠lists.jboss.org

Author: steve.ebersole(a)jboss.com Date: 2007-10-09 11:38:29 -0400 (Tue, 09 Oct 2007) New Revision: 14071 Removed: core/trunk/documentation/manual/en-US/src/main/resources/ Log: moved html css to documentation style stuff

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14070 - core/trunk/documentation/manual/en-US/src/main/docbook/images.

by hibernate-commits＠lists.jboss.org

Author: steve.ebersole(a)jboss.com Date: 2007-10-09 11:35:40 -0400 (Tue, 09 Oct 2007) New Revision: 14070 Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.png core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.png core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.png core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.png core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.png core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.png Removed: core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.gif core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.gif core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.gif core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.gif core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.gif core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.gif Log: documentation images : gif -> png Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.gif =================================================================== (Binary files differ) Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.gif =================================================================== (Binary files differ) Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.gif =================================================================== (Binary files differ) Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.gif =================================================================== (Binary files differ) Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.gif =================================================================== (Binary files differ) Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.gif =================================================================== (Binary files differ) Added: core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.png =================================================================== (Binary files differ) Property changes on: core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14069 - core/trunk/testsuite/src/test/java/org/hibernate/test/cascade.

by hibernate-commits＠lists.jboss.org

Author: gbadner Date: 2007-10-08 19:05:38 -0400 (Mon, 08 Oct 2007) New Revision: 14069 Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/CascadeSuite.java core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.hbm.xml core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.java core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.java core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.hbm.xml core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.java Log: iHHH-2269 : added tests for bidirectional one-to-many associations with both sides cascading; one test fails with TransientObjectException if the inverse collection is marked CascadeType.DELETE_ORPHAN Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,145 @@ +//$Id: $ + +package org.hibernate.test.cascade; + +import java.util.Collections; + +import junit.framework.Test; + +import org.hibernate.Session; +import org.hibernate.Transaction; +import org.hibernate.junit.functional.FunctionalTestCase; +import org.hibernate.junit.functional.FunctionalTestClassTestSuite; + +/** + * @author Gail Badner (based on annotations test case submitted by Edward Costello) + */ + +/** + * Test case to illustrate that when a delete-orphan cascade is used on a + * one-to-many collection and the many-to-one side is also cascaded a + * TransientObjectException is thrown. + */ +public class BidirectionalOneToManyCascadeTest extends FunctionalTestCase { + + public BidirectionalOneToManyCascadeTest(String name) { + super( name ); + } + + public String[] getMappings() { + return new String[] { + "cascade/Child.hbm.xml", + "cascade/DeleteOrphanChild.hbm.xml", + "cascade/Parent.hbm.xml" + }; + } + + public static Test suite() { + return new FunctionalTestClassTestSuite( BidirectionalOneToManyCascadeTest.class ); + } + + /** + * Saves the parent object with a child when both the one-to-many and + * many-to-one associations use cascade="all" + */ + public void testSaveParentWithChild() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + Child child = new Child(); + child.setParent( parent ); + parent.setChildren( Collections.singleton( child ) ); + session.save( parent ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 1, parent.getChildren().size() ); + assertEquals( 0, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + + /** + * Saves the child object with the parent when both the one-to-many and + * many-to-one associations use cascade="all" + */ + public void testSaveChildWithParent() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + Child child = new Child(); + child.setParent( parent ); + parent.setChildren( Collections.singleton( child ) ); + session.save( child ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 1, parent.getChildren().size() ); + assertEquals( 0, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + + /** + * Saves the parent object with a child when the one-to-many association + * uses cascade="all-delete-orphan" and the many-to-one association uses + * cascade="all" + */ + public void testSaveParentWithOrphanDeleteChild() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + DeleteOrphanChild child = new DeleteOrphanChild(); + child.setParent( parent ); + parent.setDeleteOrphanChildren( Collections.singleton( child ) ); + session.save( parent ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 0, parent.getChildren().size() ); + assertEquals( 1, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + + /** + * Saves the child object with the parent when the one-to-many association + * uses cascade="all-delete-orphan" and the many-to-one association uses + * cascade="all" + * <p/> + * This test is known to fail. See HHH-2269. + */ + public void testSaveOrphanDeleteChildWithParentFailureExpected() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + DeleteOrphanChild child = new DeleteOrphanChild(); + child.setParent( parent ); + parent.setDeleteOrphanChildren( Collections.singleton( child ) ); + session.save( child ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 0, parent.getChildren().size() ); + assertEquals( 1, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + +} Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/CascadeSuite.java =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/CascadeSuite.java (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/CascadeSuite.java 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,17 @@ +package org.hibernate.test.cascade; + +import junit.framework.Test; +import junit.framework.TestSuite; + +/** + * Implementation of CascadeSuite. + */ +public class CascadeSuite { + + public static Test suite() { + TestSuite suite = new TestSuite( "Cascade tests" ); + suite.addTest( BidirectionalOneToManyCascadeTest.suite() ); + suite.addTest( RefreshTest.suite() ); + return suite; + } +} Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.hbm.xml =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.hbm.xml (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.hbm.xml 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="org.hibernate.test.cascade"> + <class name="Child" table="Child"> + <id name="id" column="id" type="java.lang.Long"> + <generator class="native"/> + </id> + <many-to-one name="parent" class="Parent" not-null="false" cascade="all"/> + </class> +</hibernate-mapping> Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.java =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.java (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Child.java 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,29 @@ +package org.hibernate.test.cascade; + +/** + * Created by IntelliJ IDEA. + * User: Gail + * Date: Jan 2, 2007 + * Time: 4:51:29 PM + * To change this template use File | Settings | File Templates. + */ +public class Child { + private Long id; + private Parent parent; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public Parent getParent() { + return parent; + } + + public void setParent(Parent parent) { + this.parent = parent; + } +} Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="org.hibernate.test.cascade"> + <class name="DeleteOrphanChild" table="DeleteOrphanChild"> + <id name="id" column="id" type="java.lang.Long"> + <generator class="native"/> + </id> + <many-to-one name="parent" class="Parent" not-null="false" cascade="all"/> + </class> +</hibernate-mapping> Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.java =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.java (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/DeleteOrphanChild.java 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,29 @@ +package org.hibernate.test.cascade; + +/** + * Created by IntelliJ IDEA. + * User: Gail + * Date: Jan 2, 2007 + * Time: 4:52:10 PM + * To change this template use File | Settings | File Templates. + */ +public class DeleteOrphanChild { + private Long id; + private Parent parent; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public Parent getParent() { + return parent; + } + + public void setParent(Parent parent) { + this.parent = parent; + } +} Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.hbm.xml =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.hbm.xml (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.hbm.xml 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="org.hibernate.test.cascade"> + <class name="Parent" table="Parent"> + <id name="id" column="id" type="java.lang.Long"> + <generator class="native"/> + </id> + <set name="children" cascade="all" inverse="true"> + <key column="parent"/> + <one-to-many class="Child"/> + </set> + <set name="deleteOrphanChildren" cascade="all-delete-orphan" inverse="true"> + <key column="parent"/> + <one-to-many class="DeleteOrphanChild"/> + </set> + </class> +</hibernate-mapping> Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.java =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.java (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cascade/Parent.java 2007-10-08 23:05:38 UTC (rev 14069) @@ -0,0 +1,40 @@ +package org.hibernate.test.cascade; + +import java.util.Set; + +/** + * Created by IntelliJ IDEA. + * User: Gail + * Date: Jan 2, 2007 + * Time: 4:50:24 PM + * To change this template use File | Settings | File Templates. + */ +public class Parent { + private Long id; + private Set deleteOrphanChildren; + private Set children; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public Set getDeleteOrphanChildren() { + return deleteOrphanChildren; + } + + public void setDeleteOrphanChildren(Set deleteOrphanChildren) { + this.deleteOrphanChildren = deleteOrphanChildren; + } + + public Set getChildren() { + return children; + } + + public void setChildren(Set children) { + this.children = children; + } +}

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14068 - in core/branches/Branch_3_2/test/org/hibernate/test: cascade and 1 other directory.

by hibernate-commits＠lists.jboss.org

Author: gbadner Date: 2007-10-08 19:04:31 -0400 (Mon, 08 Oct 2007) New Revision: 14068 Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java core/branches/Branch_3_2/test/org/hibernate/test/cascade/CascadeSuite.java core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.hbm.xml core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.java core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.java core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.hbm.xml core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.java Modified: core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java Log: HHH-2269 : added tests for bidirectional one-to-many associations with both sides cascading; one test fails with TransientObjectException if the inverse collection is marked CascadeType.DELETE_ORPHAN Modified: core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java 2007-10-08 14:57:56 UTC (rev 14067) +++ core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java 2007-10-08 23:04:31 UTC (rev 14068) @@ -20,7 +20,7 @@ import org.hibernate.test.bidi.AuctionTest2; import org.hibernate.test.bytecode.BytecodeSuite; import org.hibernate.test.cache.CacheSuite; -import org.hibernate.test.cascade.RefreshTest; +import org.hibernate.test.cascade.CascadeSuite; import org.hibernate.test.cfg.ListenerTest; import org.hibernate.test.cid.CompositeIdTest; import org.hibernate.test.collection.CollectionSuite; @@ -259,7 +259,7 @@ suite.addTest( SortTest.suite() ); suite.addTest( WhereTest.suite() ); suite.addTest( IterateTest.suite() ); - suite.addTest( RefreshTest.suite() ); + suite.addTest( CascadeSuite.suite() ); suite.addTest( ListenerTest.suite() ); suite.addTest( ExtraLazyTest.suite() ); suite.addTest( StatsTest.suite() ); Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/BidirectionalOneToManyCascadeTest.java 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,145 @@ +//$Id: $ + +package org.hibernate.test.cascade; + +import java.util.Collections; + +import junit.framework.Test; + +import org.hibernate.Session; +import org.hibernate.Transaction; +import org.hibernate.junit.functional.FunctionalTestCase; +import org.hibernate.junit.functional.FunctionalTestClassTestSuite; + +/** + * @author Gail Badner (based on annotations test case submitted by Edward Costello) + */ + +/** + * Test case to illustrate that when a delete-orphan cascade is used on a + * one-to-many collection and the many-to-one side is also cascaded a + * TransientObjectException is thrown. + */ +public class BidirectionalOneToManyCascadeTest extends FunctionalTestCase { + + public BidirectionalOneToManyCascadeTest(String name) { + super( name ); + } + + public String[] getMappings() { + return new String[] { + "cascade/Child.hbm.xml", + "cascade/DeleteOrphanChild.hbm.xml", + "cascade/Parent.hbm.xml" + }; + } + + public static Test suite() { + return new FunctionalTestClassTestSuite( BidirectionalOneToManyCascadeTest.class ); + } + + /** + * Saves the parent object with a child when both the one-to-many and + * many-to-one associations use cascade="all" + */ + public void testSaveParentWithChild() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + Child child = new Child(); + child.setParent( parent ); + parent.setChildren( Collections.singleton( child ) ); + session.save( parent ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 1, parent.getChildren().size() ); + assertEquals( 0, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + + /** + * Saves the child object with the parent when both the one-to-many and + * many-to-one associations use cascade="all" + */ + public void testSaveChildWithParent() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + Child child = new Child(); + child.setParent( parent ); + parent.setChildren( Collections.singleton( child ) ); + session.save( child ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 1, parent.getChildren().size() ); + assertEquals( 0, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + + /** + * Saves the parent object with a child when the one-to-many association + * uses cascade="all-delete-orphan" and the many-to-one association uses + * cascade="all" + */ + public void testSaveParentWithOrphanDeleteChild() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + DeleteOrphanChild child = new DeleteOrphanChild(); + child.setParent( parent ); + parent.setDeleteOrphanChildren( Collections.singleton( child ) ); + session.save( parent ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 0, parent.getChildren().size() ); + assertEquals( 1, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + + /** + * Saves the child object with the parent when the one-to-many association + * uses cascade="all-delete-orphan" and the many-to-one association uses + * cascade="all" + * <p/> + * This test is known to fail. See HHH-2269. + */ + public void testSaveOrphanDeleteChildWithParentFailureExpected() { + Session session = openSession(); + Transaction txn = session.beginTransaction(); + Parent parent = new Parent(); + DeleteOrphanChild child = new DeleteOrphanChild(); + child.setParent( parent ); + parent.setDeleteOrphanChildren( Collections.singleton( child ) ); + session.save( child ); + txn.commit(); + session.close(); + + session = openSession(); + txn = session.beginTransaction(); + parent = ( Parent ) session.get( Parent.class, parent.getId() ); + assertEquals( 0, parent.getChildren().size() ); + assertEquals( 1, parent.getDeleteOrphanChildren().size() ); + session.delete( parent ); + txn.commit(); + session.close(); + } + +} Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/CascadeSuite.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/CascadeSuite.java (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/CascadeSuite.java 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,17 @@ +package org.hibernate.test.cascade; + +import junit.framework.Test; +import junit.framework.TestSuite; + +/** + * Implementation of CascadeSuite. + */ +public class CascadeSuite { + + public static Test suite() { + TestSuite suite = new TestSuite( "Cascade tests" ); + suite.addTest( BidirectionalOneToManyCascadeTest.suite() ); + suite.addTest( RefreshTest.suite() ); + return suite; + } +} Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.hbm.xml =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.hbm.xml (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.hbm.xml 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="org.hibernate.test.cascade"> + <class name="Child" table="Child"> + <id name="id" column="id" type="java.lang.Long"> + <generator class="native"/> + </id> + <many-to-one name="parent" class="Parent" not-null="false" cascade="all"/> + </class> +</hibernate-mapping> Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.java (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/Child.java 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,29 @@ +package org.hibernate.test.cascade; + +/** + * Created by IntelliJ IDEA. + * User: Gail + * Date: Jan 2, 2007 + * Time: 4:51:29 PM + * To change this template use File | Settings | File Templates. + */ +public class Child { + private Long id; + private Parent parent; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public Parent getParent() { + return parent; + } + + public void setParent(Parent parent) { + this.parent = parent; + } +} Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.hbm.xml 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="org.hibernate.test.cascade"> + <class name="DeleteOrphanChild" table="DeleteOrphanChild"> + <id name="id" column="id" type="java.lang.Long"> + <generator class="native"/> + </id> + <many-to-one name="parent" class="Parent" not-null="false" cascade="all"/> + </class> +</hibernate-mapping> Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.java (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/DeleteOrphanChild.java 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,29 @@ +package org.hibernate.test.cascade; + +/** + * Created by IntelliJ IDEA. + * User: Gail + * Date: Jan 2, 2007 + * Time: 4:52:10 PM + * To change this template use File | Settings | File Templates. + */ +public class DeleteOrphanChild { + private Long id; + private Parent parent; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public Parent getParent() { + return parent; + } + + public void setParent(Parent parent) { + this.parent = parent; + } +} Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.hbm.xml =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.hbm.xml (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.hbm.xml 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="org.hibernate.test.cascade"> + <class name="Parent" table="Parent"> + <id name="id" column="id" type="java.lang.Long"> + <generator class="native"/> + </id> + <set name="children" cascade="all" inverse="true"> + <key column="parent"/> + <one-to-many class="Child"/> + </set> + <set name="deleteOrphanChildren" cascade="all-delete-orphan" inverse="true"> + <key column="parent"/> + <one-to-many class="DeleteOrphanChild"/> + </set> + </class> +</hibernate-mapping> Added: core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.java (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cascade/Parent.java 2007-10-08 23:04:31 UTC (rev 14068) @@ -0,0 +1,40 @@ +package org.hibernate.test.cascade; + +import java.util.Set; + +/** + * Created by IntelliJ IDEA. + * User: Gail + * Date: Jan 2, 2007 + * Time: 4:50:24 PM + * To change this template use File | Settings | File Templates. + */ +public class Parent { + private Long id; + private Set deleteOrphanChildren; + private Set children; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public Set getDeleteOrphanChildren() { + return deleteOrphanChildren; + } + + public void setDeleteOrphanChildren(Set deleteOrphanChildren) { + this.deleteOrphanChildren = deleteOrphanChildren; + } + + public Set getChildren() { + return children; + } + + public void setChildren(Set children) { + this.children = children; + } +}

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14066 - in core/trunk: testsuite/src/test/java/org/hibernate/test/cfg and 1 other directory.

by hibernate-commits＠lists.jboss.org

Author: gbadner Date: 2007-10-05 21:52:54 -0400 (Fri, 05 Oct 2007) New Revision: 14066 Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cfg/ListenerTest.java Modified: core/trunk/core/src/main/java/org/hibernate/cfg/Configuration.java Log: HHH-1593 - StackOverflow when calling configuration.setListener(null) Modified: core/trunk/core/src/main/java/org/hibernate/cfg/Configuration.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/cfg/Configuration.java 2007-10-06 01:52:08 UTC (rev 14065) +++ core/trunk/core/src/main/java/org/hibernate/cfg/Configuration.java 2007-10-06 01:52:54 UTC (rev 14066) @@ -1653,31 +1653,41 @@ setListeners( type, new String[]{impl} ); } + public void setListener(String type, String listener) { + String[] listeners = null; + if ( listener != null ) { + listeners = (String[]) Array.newInstance( String.class, 1 ); + listeners[0] = listener; + } + setListeners( type, listeners ); + } + public void setListeners(String type, String[] listenerClasses) { - Object[] listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), listenerClasses.length ); - for ( int i = 0; i < listeners.length ; i++ ) { - try { - listeners[i] = ReflectHelper.classForName( listenerClasses[i] ).newInstance(); + Object[] listeners = null; + if ( listenerClasses != null ) { + listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), listenerClasses.length ); + for ( int i = 0; i < listeners.length ; i++ ) { + try { + listeners[i] = ReflectHelper.classForName( listenerClasses[i] ).newInstance(); + } + catch (Exception e) { + throw new MappingException( + "Unable to instantiate specified event (" + type + ") listener class: " + listenerClasses[i], + e + ); + } } - catch (Exception e) { - throw new MappingException( - "Unable to instantiate specified event (" + type + ") listener class: " + listenerClasses[i], - e - ); - } } setListeners( type, listeners ); } public void setListener(String type, Object listener) { - if ( listener == null ) { - setListener( type, null ); - } - else { - Object[] listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), 1 ); + Object[] listeners = null; + if ( listener != null ) { + listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), 1 ); listeners[0] = listener; - setListeners( type, listeners ); } + setListeners( type, listeners ); } public void setListeners(String type, Object[] listeners) { @@ -1916,7 +1926,7 @@ } } else { - log.warn( "Unrecognized listener type [" + type + "]" ); + throw new MappingException("Unrecognized listener type [" + type + "]"); } } Added: core/trunk/testsuite/src/test/java/org/hibernate/test/cfg/ListenerTest.java =================================================================== --- core/trunk/testsuite/src/test/java/org/hibernate/test/cfg/ListenerTest.java (rev 0) +++ core/trunk/testsuite/src/test/java/org/hibernate/test/cfg/ListenerTest.java 2007-10-06 01:52:54 UTC (rev 14066) @@ -0,0 +1,306 @@ +package org.hibernate.test.cfg; + +import java.util.Set; + +import org.hibernate.HibernateException; +import org.hibernate.MappingException; +import org.hibernate.cfg.Configuration; +import org.hibernate.event.DeleteEvent; +import org.hibernate.event.DeleteEventListener; +import org.hibernate.event.def.DefaultDeleteEventListener; +import org.hibernate.junit.UnitTestCase; + +/** + * {@inheritDoc} + * + * @author Gail Badner + */ +public class ListenerTest extends UnitTestCase { + + public static class InvalidListenerForTest { + } + + public static class DeleteListenerForTest implements DeleteEventListener { + public void onDelete(DeleteEvent event) throws HibernateException { + } + + public void onDelete(DeleteEvent event, Set transientEntities) throws HibernateException { + } + } + + public static class AnotherDeleteListenerForTest implements DeleteEventListener { + public void onDelete(DeleteEvent event) throws HibernateException { + } + + public void onDelete(DeleteEvent event, Set transientEntities) throws HibernateException { + } + } + + public ListenerTest(String string) { + super( string ); + } + + public void testSetListenerNullClass() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListener( "delete", null ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenersNullClass() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", null ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenerEmptyClassNameArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new String[] { } ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersEmptyClassNsmeArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", new String[] { } ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenerEmptyClassObjectArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new Object[] { } ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersEmptyClassObjectArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new Object[] { } ); + fail( "should have thrown ClassCastException" ); + } + catch ( ClassCastException ex ) { + // expected + } + } + + public void testSetListenerEmptyClassArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new DefaultDeleteEventListener[] { } ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersEmptyClassArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", new DefaultDeleteEventListener[] { } ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenerUnknownClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", "UnknownClassName" ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersUnknownClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new String[] { "UnknownClassName" } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenerInvalidClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", InvalidListenerForTest.class.getName() ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersInvalidClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new String[] { InvalidListenerForTest.class.getName() } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenerClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListener( "delete", DeleteListenerForTest.class.getName() ); + assertEquals( 1, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + } + + public void testSetListenersClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", new String[] { DeleteListenerForTest.class.getName() } ); + assertEquals( 1, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + } + + public void testSetListenerClassNames() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( + "delete", new String[] { + DeleteListenerForTest.class.getName(), + AnotherDeleteListenerForTest.class.getName() + } + ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersClassNames() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( + "delete", new String[] { + DeleteListenerForTest.class.getName(), + AnotherDeleteListenerForTest.class.getName() + } + ); + assertEquals( 2, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[1] instanceof AnotherDeleteListenerForTest ); + } + + public void testSetListenerClassInstance() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListener( "delete", new DeleteListenerForTest() ); + assertEquals( 1, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenersClassInstances() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( + "delete", new DeleteEventListener[] { + new DeleteListenerForTest(), + new AnotherDeleteListenerForTest() + } + ); + assertEquals( 2, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[1] instanceof AnotherDeleteListenerForTest ); + } + + public void testSetListenerInvalidClassInstance() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new InvalidListenerForTest() ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersInvalidClassInstances() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new InvalidListenerForTest[] { new InvalidListenerForTest() } ); + fail( "should have thrown java.lang.ClassCastException" ); + } + catch ( ClassCastException ex ) { + // expected + } + } + + public void testSetListenerNullType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( null, new DeleteListenerForTest() ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersNullType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( null, new DeleteEventListener[] { new DeleteListenerForTest() } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenerUnknownType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "unknown-type", new DeleteListenerForTest() ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersUnknownType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "unknown-type", new DeleteEventListener[] { new DeleteListenerForTest() } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } +}

18 years, 2 months

1
0
0 / 0

Hibernate SVN: r14065 - in core/branches/Branch_3_2: test/org/hibernate/test and 1 other directories.

by hibernate-commits＠lists.jboss.org

Author: gbadner Date: 2007-10-05 21:52:08 -0400 (Fri, 05 Oct 2007) New Revision: 14065 Added: core/branches/Branch_3_2/test/org/hibernate/test/cfg/ListenerTest.java Modified: core/branches/Branch_3_2/src/org/hibernate/cfg/Configuration.java core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java Log: HHH-1593 - StackOverflow when calling configuration.setListener(null) Modified: core/branches/Branch_3_2/src/org/hibernate/cfg/Configuration.java =================================================================== --- core/branches/Branch_3_2/src/org/hibernate/cfg/Configuration.java 2007-10-05 13:54:14 UTC (rev 14064) +++ core/branches/Branch_3_2/src/org/hibernate/cfg/Configuration.java 2007-10-06 01:52:08 UTC (rev 14065) @@ -1653,31 +1653,41 @@ setListeners( type, new String[]{impl} ); } + public void setListener(String type, String listener) { + String[] listeners = null; + if ( listener != null ) { + listeners = (String[]) Array.newInstance( String.class, 1 ); + listeners[0] = listener; + } + setListeners( type, listeners ); + } + public void setListeners(String type, String[] listenerClasses) { - Object[] listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), listenerClasses.length ); - for ( int i = 0; i < listeners.length ; i++ ) { - try { - listeners[i] = ReflectHelper.classForName( listenerClasses[i] ).newInstance(); + Object[] listeners = null; + if ( listenerClasses != null ) { + listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), listenerClasses.length ); + for ( int i = 0; i < listeners.length ; i++ ) { + try { + listeners[i] = ReflectHelper.classForName( listenerClasses[i] ).newInstance(); + } + catch (Exception e) { + throw new MappingException( + "Unable to instantiate specified event (" + type + ") listener class: " + listenerClasses[i], + e + ); + } } - catch (Exception e) { - throw new MappingException( - "Unable to instantiate specified event (" + type + ") listener class: " + listenerClasses[i], - e - ); - } } setListeners( type, listeners ); } public void setListener(String type, Object listener) { - if ( listener == null ) { - setListener( type, null ); - } - else { - Object[] listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), 1 ); + Object[] listeners = null; + if ( listener != null ) { + listeners = (Object[]) Array.newInstance( eventListeners.getListenerClassFor(type), 1 ); listeners[0] = listener; - setListeners( type, listeners ); } + setListeners( type, listeners ); } public void setListeners(String type, Object[] listeners) { @@ -1916,7 +1926,7 @@ } } else { - log.warn( "Unrecognized listener type [" + type + "]" ); + throw new MappingException("Unrecognized listener type [" + type + "]"); } } Modified: core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java 2007-10-05 13:54:14 UTC (rev 14064) +++ core/branches/Branch_3_2/test/org/hibernate/test/AllTests.java 2007-10-06 01:52:08 UTC (rev 14065) @@ -21,6 +21,7 @@ import org.hibernate.test.bytecode.BytecodeSuite; import org.hibernate.test.cache.CacheSuite; import org.hibernate.test.cascade.RefreshTest; +import org.hibernate.test.cfg.ListenerTest; import org.hibernate.test.cid.CompositeIdTest; import org.hibernate.test.collection.CollectionSuite; import org.hibernate.test.component.ComponentSuite; @@ -259,6 +260,7 @@ suite.addTest( WhereTest.suite() ); suite.addTest( IterateTest.suite() ); suite.addTest( RefreshTest.suite() ); + suite.addTest( ListenerTest.suite() ); suite.addTest( ExtraLazyTest.suite() ); suite.addTest( StatsTest.suite() ); suite.addTest( SessionStatsTest.suite() ); Added: core/branches/Branch_3_2/test/org/hibernate/test/cfg/ListenerTest.java =================================================================== --- core/branches/Branch_3_2/test/org/hibernate/test/cfg/ListenerTest.java (rev 0) +++ core/branches/Branch_3_2/test/org/hibernate/test/cfg/ListenerTest.java 2007-10-06 01:52:08 UTC (rev 14065) @@ -0,0 +1,313 @@ +package org.hibernate.test.cfg; + +import java.util.Set; + +import junit.framework.Test; + +import org.hibernate.HibernateException; +import org.hibernate.MappingException; +import org.hibernate.cfg.Configuration; +import org.hibernate.event.DeleteEvent; +import org.hibernate.event.DeleteEventListener; +import org.hibernate.event.def.DefaultDeleteEventListener; +import org.hibernate.junit.UnitTestCase; +import org.hibernate.junit.functional.FunctionalTestClassTestSuite; + +/** + * {@inheritDoc} + * + * @author Gail Badner + */ +public class ListenerTest extends UnitTestCase { + + public static class InvalidListenerForTest { + } + + public static class DeleteListenerForTest implements DeleteEventListener { + public void onDelete(DeleteEvent event) throws HibernateException { + } + + public void onDelete(DeleteEvent event, Set transientEntities) throws HibernateException { + } + } + + public static class AnotherDeleteListenerForTest implements DeleteEventListener { + public void onDelete(DeleteEvent event) throws HibernateException { + } + + public void onDelete(DeleteEvent event, Set transientEntities) throws HibernateException { + } + } + + public ListenerTest(String string) { + super( string ); + } + + public static Test suite() { + return new FunctionalTestClassTestSuite( ListenerTest.class ); + } + + public void testSetListenerNullClass() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListener( "delete", null ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenersNullClass() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", null ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenerEmptyClassNameArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new String[] { } ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersEmptyClassNsmeArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", new String[] { } ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenerEmptyClassObjectArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new Object[] { } ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersEmptyClassObjectArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new Object[] { } ); + fail( "should have thrown ClassCastException" ); + } + catch ( ClassCastException ex ) { + // expected + } + } + + public void testSetListenerEmptyClassArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new DefaultDeleteEventListener[] { } ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersEmptyClassArray() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", new DefaultDeleteEventListener[] { } ); + assertEquals( 0, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenerUnknownClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", "UnknownClassName" ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersUnknownClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new String[] { "UnknownClassName" } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenerInvalidClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", InvalidListenerForTest.class.getName() ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersInvalidClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new String[] { InvalidListenerForTest.class.getName() } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenerClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListener( "delete", DeleteListenerForTest.class.getName() ); + assertEquals( 1, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + } + + public void testSetListenersClassName() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( "delete", new String[] { DeleteListenerForTest.class.getName() } ); + assertEquals( 1, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + } + + public void testSetListenerClassNames() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( + "delete", new String[] { + DeleteListenerForTest.class.getName(), + AnotherDeleteListenerForTest.class.getName() + } + ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersClassNames() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( + "delete", new String[] { + DeleteListenerForTest.class.getName(), + AnotherDeleteListenerForTest.class.getName() + } + ); + assertEquals( 2, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[1] instanceof AnotherDeleteListenerForTest ); + } + + public void testSetListenerClassInstance() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListener( "delete", new DeleteListenerForTest() ); + assertEquals( 1, cfg.getEventListeners().getDeleteEventListeners().length ); + } + + public void testSetListenersClassInstances() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + cfg.setListeners( + "delete", new DeleteEventListener[] { + new DeleteListenerForTest(), + new AnotherDeleteListenerForTest() + } + ); + assertEquals( 2, cfg.getEventListeners().getDeleteEventListeners().length ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[0] instanceof DeleteListenerForTest ); + assertTrue( cfg.getEventListeners().getDeleteEventListeners()[1] instanceof AnotherDeleteListenerForTest ); + } + + public void testSetListenerInvalidClassInstance() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "delete", new InvalidListenerForTest() ); + fail( "should have thrown java.lang.ArrayStoreException" ); + } + catch ( ArrayStoreException ex ) { + // expected + } + } + + public void testSetListenersInvalidClassInstances() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "delete", new InvalidListenerForTest[] { new InvalidListenerForTest() } ); + fail( "should have thrown java.lang.ClassCastException" ); + } + catch ( ClassCastException ex ) { + // expected + } + } + + public void testSetListenerNullType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( null, new DeleteListenerForTest() ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersNullType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( null, new DeleteEventListener[] { new DeleteListenerForTest() } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenerUnknownType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListener( "unknown-type", new DeleteListenerForTest() ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } + + public void testSetListenersUnknownType() { + Configuration cfg = new Configuration(); + assertNotNull( cfg.getEventListeners().getDeleteEventListeners() ); + try { + cfg.setListeners( "unknown-type", new DeleteEventListener[] { new DeleteListenerForTest() } ); + fail( "should have thrown MappingException" ); + } + catch ( MappingException ex ) { + // expected + } + } +}

18 years, 2 months

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

hibernate-commits October 2007