Capítulo 5. Mapeamento O/R Básico

O mapeamento de objeto/relacional é geralmente definido em um documento XML. O documento de mapeamento é criado para ser de leitura e editável manualmente. A linguagem do mapeamento é Java-centric, ou seja, os mapeamentos são construídos em torno de declarações de classe persistente e não de declarações de tabelas.

Note que, embora muitos usuários do Hibernate escolham gravar o XML manualmente, existem diversas ferramentas para gerar o documento de mapeamento, incluindo o XDoclet Middlegen e AndroMDA.

Vamos iniciar com um exemplo de mapeamento:


<?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">

                <!-- mapping for Dog could go here -->

        </class>



</hibernate-mapping

>

Discutiremos agora o conteúdo deste documento de mapeamento. Iremos apenas descrever os elementos do documento e funções que são utilizadas pelo Hibernate em tempo de execução. O documento de mapeamento também contém algumas funções adicionais e opcionais além de elementos que afetam os esquemas de banco de dados exportados pela ferramenta de exportação de esquemas. (Por exemplo, o atributo not-null).

5.1.1. Doctype

Todos os mapeamentos de XML devem declarar o doctype exibido. O DTD atual pode ser encontrado na URL abaixo, no diretório hibernate-x.x.x/src/org/ hibernate ou no hibernate3.jar. O Hibernate sempre irá procurar pelo DTD inicialmente no seu classpath. Se você tentar localizar o DTD usando uma conexão de internet, compare a declaração do seu DTD com o conteúdo do seu classpath.

5.1.1.1. Solucionador de Entidade

O Hibernate irá primeiro tentar solucionar os DTDs em seus classpath. Isto é feito, registrando uma implementação org.xml.sax.EntityResolver personalizada com o SAXReader que ele utiliza para ler os arquivos xml. Este EntityResolver personalizado, reconhece dois nomes de espaço de sistemas Id diferentes:

Um hibernate namespace é reconhecido quando um solucionador encontra um systema Id iniciando com http://hibernate.sourceforge.net/. O solucionador tenta solucionar estas entidades através do carregador de classe que carregou as classes do Hibernate.
Um user namespace é reconhecido quando um solucionador encontra um sistema Id, utilizando um protocolo URL de classpath://. O solucionador tentará solucionar estas entidades através do carregador de classe do contexto de thread atual (1) e o carregador de classe (2) que carregou as classes do Hibernate.

Um exemplo de utilização do espaço de nome do usuário:


<?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 version "3.5.6-Final">

<!ENTITY today "September 15, 2010">



    <!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>

Onde types.xml é um recurso no pacote your.domain e contém um typedef personalizado.

5.1.2. Mapeamento do Hibernate

Este elemento possui diversos atributos opcionais. Os atributos schema e catalog especificam que tabelas referenciadas neste mapeamento pertencem ao esquema e/ou ao catálogo nomeado. Se especificados, os nomes das tabelas serão qualificados no esquema ou catálogo dado. Se não, os nomes das tabelas não serão qualificados. O atributo default-cascade especifica qual estilo de cascata será considerado pelas propriedades e coleções que não especificarem uma função cascade. A função auto-import nos deixa utilizar nomes de classes não qualificados na linguagem de consulta, por padrão.

<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"
 />

	`schema` (opcional): O nome do esquema do banco de dados.
	`catalog` (opcional): O nome do catálogo do banco de dados.
	`default-cascade` (opcional – o padrão é `none`): Um estilo cascata padrão.
	`default-access` (opcional – o padrão é `property`): A estratégia que o Hibernate deve utilizar para acessar todas as propridades. Pode ser uma implementação personalizada de `PropertyAccessor`.
	`default-lazy` (opcional - o padrão é `true`): O valor padrão para atributos `lazy` não especificados da classe e dos mapeamentos de coleções.
	`auto-import` (opcional - o padrão é `true`): Especifica se podemos usar nomes de classes não qualificados, das classes deste mapeamento, na linguagem de consulta.
	`package` (opcional): Especifica um prefixo do pacote a ser considerado para nomes de classes não qualificadas no documento de mapeamento.

Se você tem duas classes persistentes com o mesmo nome (não qualificadas), você deve ajustar auto-import="false". Caso você tentar ajustar duas classes para o mesmo nome "importado", isto resultará numa exceção.

Observe que o elemento hibernate-mapping permite que você aninhe diversos mapeamentos de <class> persistentes, como mostrado abaixo. Entretanto, é uma boa prática (e esperado por algumas ferramentas) o mapeamento de apenas uma classe persistente simples (ou uma hierarquia de classes simples) em um arquivo de mapeamento e nomeá-la após a superclasse persistente, por exemplo: Cat.hbm.xml, Dog.hbm.xml, ou se estiver usando herança, Animal.hbm.xml.

5.1.3. Classe

Você pode declarar uma classe persistente utilizando o elemento class. Por exemplo:

<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="(16)true|false"
        entity(17)-name="EntityName"
        check=(18)"arbitrary sql check condition"
        rowid=(19)"rowid"
        subsel(20)ect="SQL expression"
        abstra(21)ct="true|false"
        node="element-name"
/>

	`name` (opcional): O nome da classe Java inteiramente qualificado da classe persistente (ou interface). Se a função é ausente, assume-se que o mapeamento é para entidades não-POJO.
	`table` (opcional – padrão para nomes de classes não qualificadas): O nome da sua tabela do banco de dados.
	`discriminator-value` (opcional – padrão para o nome da classe): Um valor que distingue subclasses individuais, usadas para o comportamento polimórfico. Valores aceitos incluem `null` e `not null`.
	`mutable` (opcional - valor padrão `true`): Especifica quais instâncias da classe são (ou não) mutáveis.
	`schema` (opcional): Sobrepõe o nome do esquema especificado pelo elemento raíz `<hibernate-mapping>`.
	`catalog` (opcional): Sobrepõe o nome do catálogo especificado pelo elemento raíz `<hibernate-mapping>`.
	`proxy` (opcional): Especifica uma interface para ser utilizada pelos proxies de inicialização lazy. Você pode especificar o nome da própria classe.
	`dynamic-update` (opcional, valor padrão `false`): Especifica que o SQL de `UPDATE` deve ser gerado em tempo de execução e conter apenas aquelas colunas cujos valores foram alterados.
	`dynamic-insert` (opcional, valor padrão `falso`): Especifica que o SQL de `INSERT` deve ser gerado em tempo de execução e conter apenas aquelas colunas cujos valores não estão nulos.
	`select-before-update` (opcional, valor padrão `false`): Especifica que o Hibernate nunca deve executar um SQL de `UPDATE` a não ser que seja certo que um objeto está atualmente modificado. Em certos casos (na verdade, apenas quando um objeto transiente foi associado a uma nova sessão utilizando `update()`), isto significa que o Hibernate irá executar uma instrução SQL de `SELECT` adicional para determinar se um `UPDATE` é necessário nesse momento.
	`polymorphism` (opcional, padrão para `implicit`): Determina se deve ser utilizado a consulta polimórfica implícita ou explicitamente.
	`where` (opicional): Especifica um comando SQL `WHERE` arbitrário para ser usado quando da recuperação de objetos desta classe.
	`persister` (opcional): Especifica uma `ClassPersister` customizada.
	`batch-size` (opcional, valor padrão `1`) Especifica um "tamanho de lote" para a recuperação de instâncias desta classe pela identificação.
	`optimistic-lock` (opcional, valor padrão `version`): Determina a estratégia de bloqueio.
(16)	`lazy` (opcional): A recuperação lazy pode ser completamente desabilitada, ajustando `lazy="false"`.
(17)	`entity-name` (optional - defaults to the class name): Hibernate3 allows a class to be mapped multiple times, potentially to different tables. It also 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 Seção 4.4, “Modelos dinâmicos” and Capítulo 19, Mapeamento XML for more information.
(18)	`check` (opcional): Uma expressão SQL utilizada para gerar uma restrição de verificação de múltiplas linhas para a geração automática do esquema.
(19)	`rowid` (opcional): O Hibernate poder usar as então chamadas ROWIDs em bancos de dados que a suportam. Por exemplo, no Oracle, o Hibernate pode utilizar a coluna extra rowid para atualizações mais rápidas se você configurar esta opção para `rowid`. Um ROWID é uma implementação que representa de maneira detalhada a localização física de uma determinada tuple armazenada.
(20)	`subselect` (opcional): Mapeia uma entidade imutável e somente de leitura para um subconjunto do banco de dados. Útil se você quiser ter uma visão, ao invés de uma tabela. Veja abaixo para mais informações.
(21)	`abstract` (opcional): Utilizada para marcar superclasses abstratas em hierarquias `<union-subclass>`.

É perfeitamente aceitável uma classe persitente nomeada ser uma interface. Você deverá então declarar as classes implementadas desta interface utilizando o elemento <subclass>. Você pode persistir qualquer classe interna estática. Você deverá especificar o nome da classe usando a forma padrão, por exemplo: eg.Foo$Bar.

Classes imutáveis, mutable="false", não podem ser modificadas ou excluídas pela aplicação. Isso permite que o Hibernate aperfeiçoe o desempenho.

A função opcional proxy habilita a inicialização lazy das instâncias persistentes da classe. O Hibernate irá retornar CGLIB proxies como implementado na interface nomeada. O objeto persistente atual será carregado quando um método do proxy for invocado. Veja "Inicialização de Coleções e Proxies" abaixo.

Polimorfismo implícito significa que instâncias de uma classe serão retornadas por uma consulta que dá nome a qualquer superclasse ou interface e classe implementada, além das instâncias de qualquer subclasse da classe serão retornadas por uma consulta que nomeia a classe por si. Polimorfismo explícito significa que instâncias da classe serão retornadas apenas por consultas que explicitamente nomeiam a classe e que as consultas que nomeiam as classes irão retornar apenas instâncias de subclasses mapeadas dentro da declaração <class> como uma <subclass> ou <joined-subclass>. Para a maioria dos casos, o valor padrão polymorphism="implicit", é apropriado. Polimorfismo explicito é útil quando duas classes distintas estão mapeadas para a mesma tabela. Isso aceita uma classe "peso leve" que contém um subconjunto de colunas da tabela.

O atributo persister deixa você customizar a estratégia de persistência utilizada para a classe. Você pode, por exemplo, especificar sua própria subclasse do org.hibernate.persister.EntityPersister ou você pode criar uma implementação completamente nova da interface org.hibernate.persister.ClassPersister que implementa a persistência através de, por exemplo, chamadas a procedimentos armazenados, serialização de arquivos planos ou LDAP. Veja org.hibernate.test.CustomPersister para um exemplo simples de "persistência" para uma Hashtable.

Observe que as configurações dynamic-update e dynamic-insert não são herdadas pelas subclasses e assim podem também ser especificadas em elementos <subclass> ou <joined-subclass>. Estas configurações podem incrementar o desempenho em alguns casos, mas podem realmente diminuir o desempenho em outras.

O uso de select-before-update geralmente irá diminuir o desempenho. Ela é muito útil para prevenir que um trigger de atualização no banco de dados seja ativado desnecessariamente, se você reconectar um nó de uma instância desconectada em uma Session.

Se você ativar dynamic-update, você terá de escolher a estratégia de bloqueio otimista:

version: verifica as colunas de versão/timestamp
all: verifica todas as colunas
dirty: verifica as colunas modificadas, permitindo algumas atualizações concorrentes
none: não utiliza o bloqueio otimista

Nós realmente recomendamos que você utilize as colunas de versão/timestamp para o bloqueio otimista com o Hibernate. Esta é a melhor estratégia em relação ao desempenho e é a única estratégia que trata corretamente as modificações efetuadas em instâncias desconectadas (por exemplo, quando Session.merge() é utilizado).

Não há diferença entre uma visão e uma tabela para o mapeamento do Hibernate, e como esperado isto é transparente no nível do banco de dados, mesmo que alguns bancos de dados não suportam visões apropriadamente, especialmente com atualizações. Algumas vezes, você quer utilizar uma visão, mas não pode criá-la no banco de dados (por exemplo, com um esquema legado). Neste caso, você pode mapear uma entidade imutável e de somente leitura, para uma dada expressão de subseleção SQL:


<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

>

Declare as tabelas para sincronizar com esta entidade, garantindo que a auto-liberação ocorra corretamente, e que as consultas para esta entidade derivada não retornem dados desatualizados. O <subselect> está disponível tanto como um atributo como um elemento mapeado aninhado.

5.1.4. id

Classes mapeadas devem declarar a coluna de chave primária da tabela do banco de dados. Muitas classes irão também ter uma propriedade ao estilo Java-Beans declarando o identificador único de uma instância. O elemento <id> define o mapeamento desta propriedade para a chave primária.

<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
>

	`name` (opcional): O nome da propriedade do identificador.
	`type` (opcional): um nome que indica o tipo de Hibernate.
	`column` (opcional – padrão para o nome da propridade): O nome coluna chave primária.
	`unsaved-value` (opcional - padrão para um valor "sensível"): O valor da propriedade de identificação que indica que a instância foi novamente instanciada (unsaved), diferenciando de instâncias desconectadas que foram salvas ou carregadas em uma sessão anterior.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.

Se a função name não for declarada, considera-se que a classe não tem a propriedade de identificação.

A função unsaved-value não é mais necessária no Hibernate 3.

Há uma declaração alternativa <composite-id> que permite o acesso à dados legados com chaves compostas. Nós realmente desencorajamos o uso deste para qualquer outra função.

5.1.4.1. Gerador

O elemento filho opcional <generator> nomeia uma classe Java usada para gerar identificadores únicos para instâncias de uma classe persistente. Se algum parâmetro é requerido para configurar ou inicializar a instância geradora, eles são passados utilizando o elemento <param>.


<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

>

Todos os geradores implementam a interface org.hibernate.id.IdentifierGenerator. Esta é uma interface bem simples. Algumas aplicações podem prover suas próprias implementações especializadas, entretanto, o Hibernate disponibiliza um conjunto de implementações internamente. Há nomes de atalhos para estes geradores internos, conforme segue abaixo:

increment: gera identificadores dos tipos long, short ou int que são únicos apenas quando nenhum outro processo está inserindo dados na mesma tabela. Não utilize em ambientes de cluster.
identity: suporta colunas de identidade em DB2, MySQL, Servidor MS SQL, Sybase e HypersonicSQL. O identificador retornado é do tipo long, short ou int.
sequence: utiliza uma seqüência em DB2, PostgreSQL, Oracle, SAP DB, McKoi ou um gerador no Interbase. O identificador de retorno é do tipo long, short ou int.
hilo: utiliza um algoritmo hi/lo para gerar de forma eficiente identificadores do tipo long, short ou int, a partir de uma tabela e coluna fornecida (por padrão hibernate_unique_key e next_hi) como fonte para os valores hi. O algoritmo hi/lo gera identificadores que são únicos apenas para um banco de dados específico.
seqhilo: utiliza um algoritmo hi/lo para gerar de forma eficiente identificadores do tipo long, short ou int, a partir de uma seqüência de banco de dados fornecida.
uuid: utiliza um algorítimo UUID de 128-bits para gerar identificadores do tipo string, únicos em uma rede (o endereço IP é utilizado). O UUID é codificado como um string de dígitos hexadecimais de tamanho 32.
guid: utiliza um string GUID gerado pelo banco de dados no Servidor MS SQL e MySQL.
native: seleciona entre identity, sequenceou hilo dependendo das capacidades do banco de dados utilizado.
assigned: deixa a aplicação definir um identificador para o objeto antes que o save() seja chamado. Esta é a estratégia padrão caso nenhum elemento <generator> seja especificado.
select: retorna a chave primária recuperada por um trigger do banco de dados, selecionando uma linha pela chave única e recuperando o valor da chave primária.
foreign: utiliza o identificador de um outro objeto associado. Normalmente utilizado em conjunto com uma associação de chave primária do tipo <one-to-one>.
sequence-identity: uma estratégia de geração de seqüência especializada que use uma seqüência de banco de dados para a geração de valor atual, mas combina isto com JDBC3 getGeneratedKeys para de fato retornar o valor do identificador gerado como parte da execução de instrução de inserção. Esta estratégia é somente conhecida para suportar drivers da Oracle 10g, focados em JDK 1.4. Note que os comentários sobre estas instruções de inserção estão desabilitados devido a um bug nos drivers da Oracle.

5.1.4.2. Algoritmo Hi/lo

Os geradores hilo e seqhilo fornecem duas implementações alternativas do algoritmo hi/lo, uma solução preferencial para a geração de identificadores. A primeira implementação requer uma tabela "especial" do banco de dados para manter o próximo valor "hi" disponível. A segunda utiliza uma seqüência do estilo Oracle (quando suportado).


<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

>


<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

>

Infelizmente, você não pode utilizar hilo quando estiver fornecendo sua própria Connection para o Hibernate. Quando o Hibernate estiver usando uma fonte de dados do servidor de aplicações para obter conexões suportadas com JTA, você precisará configurar adequadamente o hibernate.transaction.manager_lookup_class.

5.1.4.3. Algoritmo UUID

O UUID contém: o endereço IP, hora de início da JVM que é com precisão de um quarto de segundo, a hora do sistema e um valor contador que é único dentro da JVM. Não é possível obter o endereço MAC ou um endereço de memória do código Java, portanto este é o melhor que pode ser feito sem utilizar JNI.

5.1.4.4. Colunas de identidade e seqüências

Para bancos de dados que suportam colunas de identidade (DB2, MySQL, Sybase, MS SQL), você pode utilizar uma geração de chave identity. Para bancos de dados que suportam sequencias (DB2, Oracle, PostgreSQL, Interbase, McKoi, SAP DB) você pode utilizar a geração de chaves no estilo sequence. As duas estratégias requerem duas consultas SQL para inserir um novo objeto.


<id name="id" type="long" column="person_id">

        <generator class="sequence">

                <param name="sequence"

>person_id_sequence</param>

        </generator>

</id

>


<id name="id" type="long" column="person_id" unsaved-value="0">

        <generator class="identity"/>

</id

>

Para desenvolvimento multi-plataforma, a estratégia native irá escolher entre as estratégias identity, sequence e hilo, dependendo das capacidades do banco de dados utilizado.

5.1.4.5. Identificadores atribuídos

Se você quiser que a aplicação especifique os identificadores, em vez do Hibernate gerá-los, você deve utilizar o gerador assigned. Este gerador especial irá utilizar o valor do identificador especificado para a propriedade de identificação do objeto. Este gerador é usado quando a chave primária é a chave natural em vez de uma chave substituta. Este é o comportamento padrão se você não especificar um elemento <generator>.

A escolha do gerador assigned faz com que o Hibernate utilize unsaved-value="undefined". Isto força o Hibernate ir até o banco de dados para determinar se uma instância está transiente ou desacoplada, a não ser que haja uma versão ou uma propriedade de timestamp, ou que você definia Interceptor.isUnsaved().

5.1.4.6. Chaves primárias geradas por triggers

O Hibernate não gera DDL com triggers, apenas para sistemas legados.


<id name="id" type="long" column="person_id">

        <generator class="select">

                <param name="key"

>socialSecurityNumber</param>

        </generator>

</id

>

No exemplo acima, há uma única propriedade com valor nomeada socialSecurityNumber definida pela classe, uma chave natural, e uma chave substituta nomeada person_id cujo valor é gerado por um trigger.

5.1.5. Aprimoração dos geradores de identificador

Iniciando com a liberação 3.2.3, existem dois novos geradores que representam uma reavaliação de dois diferentes aspectos da geração identificadora. O primeiro aspecto é a portabilidade do banco de dados, o segundo é a otimização. A otimização significa que você não precisa questionar o banco de dados a cada solicitação para um novo valor de identificador. Estes dois geradores possuem por intenção substituir alguns dos geradores nomeados acima, começando em 3.3.x. No entanto, eles estão incluídos nas liberações atuais e podem ser referenciados pelo FQN.

A primeira destas novas gerações é a org.hibernate.id.enhanced.SequenceStyleGenerator que primeiramente é uma substituição para o gerador sequence e, segundo, um melhor gerador de portabilidade que o native. Isto é devido ao native normalmente escolher entre identity e sequence, que são semânticas extremamente diferentes das quais podem causar problemas súbitos em portabilidade de observação de aplicativos. No entanto, o org.hibernate.id.enhanced.SequenceStyleGenerator atinge a portabilidade numa maneira diferente. Ele escolhe entre uma tabela ou uma seqüência no banco de dados para armazenar seus valores de incrementação, dependendo nas capacidades do dialeto sendo usado. A diferença entre isto e o native é que o armazenamento baseado na tabela e seqüência possuem exatamente a mesma semântica. Na realidade, as seqüências são exatamente o que o Hibernate tenta imitar com os próprios geradores baseados na tabela. Este gerador possui um número de parâmetros de configuração:

sequence_name (opcional - valor padrão hibernate_sequence) o nome da seqüência ou tabela a ser usada.
initial_value (opcional - padrão para 1) O valor inicial a ser restaurado a partir da seqüência/tabela. Em termos da criação de seqüência, isto é análogo à cláusula tipicamente nomeada "STARTS WITH".
increment_size (opcional - padrão para 1): o valor pelo qual as chamadas para a seqüência/tabela devem diferenciar-se. Nos termos da criação da seqüência, isto é análogo à cláusula tipicamente nomeada "INCREMENT BY".
force_table_use (opcional - padrão para false): devemos forçar o uso de uma tabela como uma estrutura de reforço, mesmo que o dialeto possa suportar a seqüência?
value_column (opcional - padrão para next_val): apenas relevante para estruturas de tabela, este é o nome da coluna onde na tabela que é usado para manter o valor.
optimizer (optional - defaults to none): See Seção 5.1.6, “Otimização do Gerador de Identificação”

O segundo destes novos geradores é o org.hibernate.id.enhanced.TableGenerator, que primeiramente é uma substituição para o gerador table, mesmo que isto funcione muito mais como um org.hibernate.id.MultipleHiLoPerTableGenerator, e segundo, como uma reimplementação do org.hibernate.id.MultipleHiLoPerTableGenerator que utiliza a noção dos otimizadores pugláveis. Basicamente, este gerador define uma tabela capacitada de manter um número de valores de incremento simultâneo pelo uso múltiplo de filas de chaves distintas. Este gerador possui um número de parâmetros de configuração.

table_name (opcional - padrão para hibernate_sequences): O nome da tabela a ser usado.
value_column_name (opcional - padrão para next_val): o nome da coluna na tabela que é usado para manter o valor.
segment_column_name (opcional - padrão para sequence_name) O nome da coluna da tabela que é usado para manter a "chave de segmento". Este é o valor que identifica qual valor de incremento a ser usado.
base (opcional - padrão para default) O valor da "chave de segmento" para o segmento pelo qual nós queremos obter os valores de incremento para este gerador.
segment_value_length (opcional - padrão para 255): Usado para a geração do esquema. O tamanho da coluna para criar esta coluna de chave de segmento.
initial_value (opcional - valor padrão para 1): O valor inicial a ser restaurado a partir da tabela.
increment_size (opcional - padrão para 1): O valor pelo qual as chamadas subseqüentes para a tabela devem diferir-se.
optimizer (optional - defaults to ): See Seção 5.1.6, “Otimização do Gerador de Identificação”

`5.1.6. Otimização do Gerador de Identificação`

For identifier generators that 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 can 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 (Seção 5.1.5, “Aprimoração dos geradores de identificador” support this operation.

none (geralmente este é o padrão, caso nenhum otimizador for especificado): isto não executará quaisquer otimizações e alcançará o banco de dados para cada e toda solicitação.
hilo: aplica-se ao algoritmo em volta dos valores restaurados do banco de dados. Espera-se que os valores a partir do banco de dados para este otimizador sejam seqüenciais. Os valores restaurados a partir da estrutura do banco de dados para este otimizador indica um "número de grupo". O increment_size é multiplicado pelo valor em memória para definir um grupo "hi value".
pooled: assim como o caso do hilo, este otimizador tenta minimizar o número de tentativas no banco de dados. No entanto, nós simplesmente implementamos o valor de inicialização para o "próximo grupo" na estrutura do banco de dados ao invés do valor seqüencial na combinação com um algoritmo de agrupamento em memória. Neste caso, o increment_size refere-se aos valores de entrada a partir do banco de dados.

`5.1.7. Composição-id`


<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

>

Uma tabela com uma chave composta, pode ser mapeada com múltiplas propriedades da classe como propriedades de identificação. O elemento <composite-id> aceita o mapeamento da propriedade <key-property> e mapeamentos <key-many-to-one>como elementos filhos.


<composite-id>

        <key-property name="medicareNumber"/>

        <key-property name="dependent"/>

</composite-id

>

A classe persistente precisa substituir equals() e hashCode() para implementar identificadores compostos igualmente. E precisa também implementar Serializable.

Infelizmente, esta solução para um identificador composto significa que um objeto persistente é seu próprio identificador. Não há outro "handle" conveniente a não ser o próprio objeto. Você mesmo precisa instanciar uma instância de outra classe persistente e preencher suas propriedades de identificação antes que você possa dar um load() para o estado persistente associado com uma chave composta. Nós chamamos esta solução de identificador composto incorporado e não aconselhamos para aplicações sérias.

Uma segunda solução seria chamar de identificador composto mapped quando a propriedades de identificação nomeadas dentro do elemento <composite-id> estão duplicadas tanto na classe persistente como em uma classe de identificação separada.


<composite-id class="MedicareId" mapped="true">

        <key-property name="medicareNumber"/>

        <key-property name="dependent"/>

</composite-id

>

No exemplo, ambas as classes de identificadores compostas, MedicareId, e a própria classe entidade possuem propriedades nomeadas medicareNumber e dependent. A classe identificadora precisa sobrepor equals() e hashCode() e implementar Serializable. A desvantagem desta solução é óbvia: duplicação de código.

As seguintes funções são utilizadas para especificar o mapeamento de um identificador composto:

mapped (opcional, false por padrão): Indica que um identificar composto mapeado é usado, e que as propriedades de mapeamento contidas refere-se tanto à classe entidade quanto à classe de identificação composta.
class (opcional, mas requerida para um identificador composto mapeado): A classe usada como um identificador composto.

We will describe a third, even more convenient approach, where the composite identifier is implemented as a component class in Seção 8.4, “Componentes como identificadores compostos”. The attributes described below apply only to this alternative approach:

name (opcional, requerida para esta abordagem): Uma propriedade do tipo componente que armazena o identificador composto. Para maiores informações, por favor consulte o capítulo 9.
access (opcional - padrão para property): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
class (opcional - valor padrão para o tipo de propriedade determinando por reflexão): A classe componente utilizada como um identificador composto. Por favor consulte a próxima seção para maiores informações.

Esta terceira abordagem, um componente identificador, é a que nós recomendamos para a maioria das aplicações.

`5.1.8. Discriminador`

O elemento <discriminator> é necessário para persistência polimórfica utilizando a estratégia de mapeamento de tabela-por-classe-hierárquica e declara uma coluna discriminadora da tabela. A coluna discriminadora contém valores de marcação que informam à camada de persistência qual subclasse instanciar para uma linha em específico. Um restrito conjunto de tipos que podem ser utilizados: string, character, integer, byte, short, boolean, yes_no, true_false.

<discriminator
        column="discriminator_column"
        type="discriminator_type"
        force="true|false"
        insert="true|false"
        formula="arbitrary sql expression"
/>

	`column` (opcional - padrão para `class`): O nome da coluna discriminadora.
	`type` (opcional - padrão para `string`): O nome que indica o tipo Hibernate.
	`force` (opcional - valor padrão `false`): "Força" o Hibernate a especificar valores discriminadores permitidos mesmo quando recuperando todas as instâncias da classe raíz.
	`insert` (opcional - valor padrão para `true`) Ajuste para `false` se sua coluna discriminadora também fizer parte do identificador composto mapeado. (Isto informa ao Hibernate para não incluir a coluna em comandos SQL `INSERT`s).
	`formula` (opcional): Uma expressão SQL arbitrária que é executada quando um tipo tem que ser avaliado. Permite discriminação baseada em conteúdo.

Valores atuais de uma coluna discriminada são especificados pela função discriminator-value da <class> e elementos da <subclass>.

O atributo force é útil (apenas) em tabelas contendo linhas com valores discriminadores "extras" que não estão mapeados para uma classe persistente. Este não é geralmente o caso.

Usando o atributo formula você pode declarar uma expressão SQL arbitrária que será utilizada para avaliar o tipo de uma linha. Por exemplo:


<discriminator

    formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end"

    type="integer"/>

`5.1.9. Versão (opcional)`

O elemento <version> é opcional e indica que a tabela possui dados versionados. Isto é particularmente útil se você planeja utilizar transações longas. Veja abaixo maiores informações:

<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|."
/>

	`column` (opcional - tem como padrão o nome da propriedade name): O nome da coluna mantendo o número da versão.
	`name`: O nome da propriedade da classe persistente.
	`type` (opcional - padrão para `integer`): O tipo do número da versão.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`unsaved-value` (opcional – valor padrão para `undefined` ): Um valor para a propriedade versão que indica que uma instância foi instanciada recentemente (unsaved), distinguindo de instâncias desconectadas que foram salvas ou carregadas em sessões anteriores. (`undefined` especifica que o valor da propriedade de identificação deve ser utilizado).
	`generated` (opcional - valor padrão `never`): Especifica que este valor de propriedade da versão é na verdade gerado pelo banco de dados. Veja o generated properties para maiores informações.
	`insert` (opcional - padrão para `true`): Especifica se a coluna de versão deve ser incluída na instrução de inserção do SQL. Pode ser configurado como `false` se a coluna do banco de dados estiver definida com um valor padrão de `0`.

Números de versão podem ser dos tipos Hibernate long, integer, short, timestamp ou calendar.

A versão ou timestamp de uma propriedade nunca deve ser nula para uma instância desconectada, assim o Hibernate irá identificar qualquer instância com uma versão nula ou timestamp como transiente, não importando qual outra estratégia unsaved-value tenha sido especificada. A declaração de uma versão nula ou a propriedade timestamp é um caminho fácil para tratar problemas com reconexões transitivas no Hibernate, especialmente úteis para pessoas utilizando identificadores atribuídos ou chaves compostas.

`5.1.10. Timestamp (opcional)`

O elemento opcional <timestamp> indica que uma tabela contém dados em timestamp. Isso tem por objetivo dar uma alternativa para versionamento. Timestamps são por natureza uma implementação menos segura do bloqueio otimista. Entretanto, algumas vezes a aplicação pode usar timestamps em outros caminhos.

<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|."
/>

	`column` (opcional - padrão para o nome da propriedade): O nome da coluna que mantém o timestamp.
	`name`: O nome da propriedade no estilo JavaBeans do tipo `Date` ou `Timestamp` da classe persistente.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`unsaved-value` (opcional - padrão para `null`): Um valor de propriedade da versão que indica que uma instância foi recentemente instanciada (unsaved), distinguindo-a de instâncias desconectadas que foram salvas ou carregadas em sessões prévias. `Undefined` especifica que um valor de propriedade de identificação deve ser utilizado.
	`source` (opcional - padrão para `vm`): De onde o Hibernate deve recuperar o valor timestamp? Do banco de dados ou da JVM atual? Timestamps baseados em banco de dados levam a um overhead porque o Hibernate precisa acessar o banco de dados para determinar o "próximo valor", mas é mais seguro para uso em ambientes de cluster. Observe também, que nem todos os `Dialects` suportam a recuperação do carimbo de data e hora atual do banco de dados, enquanto outros podem não ser seguros para utilização em bloqueios, pela falta de precisão (Oracle 8, por exemplo).
	`generated` (opcional - padrão para `never`): Especifica que o valor da propriedade timestamp é gerado pelo banco de dados. Veja a discussão do generated properties para maiores informações.

`Nota`

Observe que o <timestamp> é equivalente a <version type="timestamp">. E <timestamp source="db"> é equivalente a <version type="dbtimestamp">.

`5.1.11. Propriedade`

O elemento <property> declara uma propriedade de estilo JavaBean de uma classe.

<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"
/>

	`name`: o nome da propriedade, iniciando com letra minúscula.
	`column` (opcional - padrão para o nome da propriedade): O nome da coluna mapeada do banco de dados. Isto pode também ser especificado pelo(s) elemento(s) `<column>` aninhados.
	`type` (opcional): um nome que indica o tipo de Hibernate.
	`update, insert` (opcional - padrão para `true`): especifica que as colunas mapeadas devem ser incluídas nas instruções SQL de `UPDATE` e/ou `INSERT`. Ajustar ambas para `false` permite uma propridade "derivada" pura, cujo valor é inicializado de outra propriedade, que mapeie a mesma coluna(s) ou por uma disparo ou outra aplicação.
	`formula` (opcional): uma instrução SQL que definie o valor para uma propriedade calculada. Propriedades calculadas não possuem uma coluna de mapeamento para elas.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`lazy` (opcional - padrão para `false`): Especifica que esta propriedade deve ser atingida de forma lenta quando a instância da variável é acessada pela primeira vez. Isto requer instrumentação bytecode em tempo de criação.
	`unique` (opcional): Habilita a geração de DDL de uma única restrição para as colunas. Da mesma forma, permita que isto seja o alvo de uma `property-ref`.
	`not-null` (opcional): Habilita a geração de DDL de uma restrição de nulidade para as colunas.
	`optimistic-lock` (opcional - padrão para `true`): Especifica se mudanças para esta propriedade requerem ou não bloqueio otimista. Em outras palavras, determina se um incremento de versão deve ocorrer quando esta propriedade está suja.
	`generated` (opcional - padrão para `never`): Especifica que o valor da propriedade é na verdade gerado pelo banco de dados. Veja a discussão do generated properties para maiores informações.

typename pode ser:

O nome de um tipo básico de Hibernate: integer, string, character, date, timestamp, float, binary, serializable, object, blob, etc.
O nome da classe Java com um tipo básico padrão: int, float, char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob, etc.
O nome da classe Java serializável
O nome da classe de um tipo customizado: com.illflow.type.MyCustomType, etc.

Se você não especificar um tipo, o Hibernate irá utilizar reflexão sobre a propriedade nomeada para ter uma idéia do tipo de Hibernate correto. O Hibernate tentará interpretar o nome da classe retornada, usando as regras 2, 3 e 4 nesta ordem. Em certos casos, você ainda precisará do atributo type. Por exemplo, para distinguir entre Hibernate.DATE e Hibernate.TIMESTAMP, ou para especificar um tipo customizado.

A função access permite que você controle como o Hibernate irá acessar a propriedade em tempo de execução. Por padrão, o Hibernate irá chamar os métodos get/set da propriedades. Se você especificar access="field", o Hibernate irá bipassar os metodos get/set, acessando o campo diretamente, usando reflexão. Você pode especificar sua própria estratégia para acesso da propriedade criando uma classe que implemente a interface org.hibernate.property.PropertyAccessor.

Um recurso especialmente poderoso é o de propriedades derivadas. Estas propriedades são por definição somente leitura, e o valor da propriedade é calculado em tempo de execução. Você declara este cálculo como uma expressão SQL, que traduz para cláusula SELECT de uma subconsulta da consulta SQL que carrega a instância:




<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 )"/>

Observe que você pode referenciar as entidades da própria tabela, através da não declaração de um alias para uma coluna particular. Isto seria o customerId no exemplo dado. Observe também que você pode usar o mapeamento de elemento aninhado <formula>, se você não gostar de usar o atributo.

`5.1.12. Muitos-para-um`

Uma associação ordinária para outra classe persistente é declarada usando o elemento many-to-one. O modelo relacional é uma associação muitos para um: uma chave exterior de uma tabela referenciando as colunas da chave primária da tabela destino.

<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"
/>

	`name`: O nome da propriedade.
	`column` (opcional): O nome da coluna da chave exterior. Isto pode também ser especificado através de elementos aninhados `<column>`.
	`class` (opcional – padrão para o tipo de propriedade determinado pela reflexão): O nome da classe associada.
	`cascade` (opcional): Especifica qual operação deve ser cascateada do objeto pai para o objeto associado.
	`fetch` (opcional - padrão para `select`): Escolhe entre recuperação da união exterior ou recuperação seqüencial de seleção.
	`update, insert` (opcional - valor padrão `true`): especifica que as colunas mapeadas devem ser incluídas em instruções SQL de `UPDATE` e/ou `INSERT`. Com o ajuste de ambas para `false` você permite uma associação "derivada" pura cujos valores são inicializados de algumas outras propriedades que mapeiam a(s) mesma(s) coluna(s) ou por um trigger ou outra aplicação.
	`property-ref`: (opcional) O nome de uma propriedade da classe associada que esteja unida à esta chave exterior. Se não for especificada, a chave primária da classe associada será utilizada.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`unique` (opcional): Habilita a geração DDL de uma restrição única para a coluna da chave exterior. Além disso, permite ser o alvo de uma `property-ref`. Isso torna a multiplicidade da associação efetivamente um para um.
	`not-null` (opcional): Habilita a geração DDL de uma restrição de nulidade para as colunas de chaves exteriores.
	`optimistic-lock` (opcional - padrão para `true`): Especifica se mudanças para esta propriedade requerem ou não bloqueio otimista. Em outras palavras, determina se um incremento de versão deve ocorrer quando esta propriedade está suja.
	`lazy`(opcional – padrão para `proxy`): Por padrão, associações de ponto único são envoltas em um proxie. `lazy="no-proxy"` especifica que a propriedade deve ser trazida de forma tardia quando a instância da variável é acessada pela primeira vez. Isto requer instrumentação bytecode em tempo de criação. O `lazy="false"` especifica que a associação será sempre procurada.
	`not-found` (opcional - padrão para `exception`): Especifica como as chaves exteriores que informam que linhas que estejam faltando serão manuseadas. O `ignore` tratará a linha faltante como uma associação nula.
	`entity-name` (opcional): O nome da entidade da classe associada.
	`formula` (optional): Uma instrução SQL que define um valor para uma chave exterior computed.

Setting a value of the cascade attribute to any meaningful value other than none will propagate certain operations to the associated object. The meaningful values are divided into three categories. First, basic operations, which include: persist, merge, delete, save-update, evict, replicate, lock and refresh; second, special values: delete-orphan; and third, all comma-separated combinations of operation names: cascade="persist,merge,evict" or cascade="all,delete-orphan". See Seção 10.11, “Persistência Transitiva” for a full explanation. Note that single valued, many-to-one and one-to-one, associations do not support orphan delete.

Segue abaixo uma amostra de uma típica declaração many-to-one:


<many-to-one name="product" class="Product" column="PRODUCT_ID"/>

O atributo property-ref deve apenas ser usado para mapear dados legados onde uma chave exterior se refere à uma chave exclusiva da tabela associada que não seja a chave primária. Este é um modelo relacional desagradável. Por exemplo, suponha que a classe Product tenha um número seqüencial exclusivo, que não seja a chave primária. O atributo unique controla a geração de DDL do Hibernate com a ferramenta SchemaExport.


<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>

Então o mapeamento para OrderItem poderia usar:


<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>

No entanto, isto não é recomendável.

Se a chave exclusiva referenciada engloba múltiplas propriedades da entidade associada, você deve mapear as propriedades referenciadas dentro de um elemento chamado <properties>

Se a chave exclusiva referenciada é a propriedade de um componente, você pode especificar um caminho para a propriedade:


<many-to-one name="owner" property-ref="identity.ssn" column="OWNER_SSN"/>

`5.1.13. Um-para-um`

Uma associação um-pra-um para outra classe persistente é declarada usando um elemento one-to-one .

<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"
/>

	`name`: O nome da propriedade.
	`class` (opcional – padrão para o tipo de propriedade determinado pela reflexão): O nome da classe associada.
	`cascade` (opcional): Especifica qual operação deve ser cascateada do objeto pai para o objeto associado.
	`constrained` (opcional): Especifica que uma restrição de chave exterior na chave primária da tabela mapeada referencia a tabela da classe associada. Esta opção afeta a ordem em que `save()` e `delete()` são cascateadas, e determina se a associação pode sofrer o proxie. Isto também é usado pela ferramenta schema export.
	`fetch` (opcional - padrão para `select`): Escolhe entre recuperação da união exterior ou recuperação seqüencial de seleção.
	`property-ref`(opcional): O nome da propriedade da classe associada que é ligada à chave primária desta classe. Se não for especificada, a chave primária da classe associada é utilizada.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`formula` (opcional): Quase todas associações um-pra-um mapeiam para a chave primária da entidade dona. Caso este não seja o caso, você pode especificar uma outra coluna, colunas ou expressões para unir utilizando uma fórmula SQL. Veja `org.hibernate.test.onetooneformula` para exemplo.
	`lazy` (opcional – valor padrão `proxy`): Por padrão, as associações de ponto único estão em proxy. `lazy="no-proxy"` especifica que a propriedade deve ser recuperada de forma preguiçosa quando a variável da instância for acessada pela primeira vez. Isto requer instrumentação de bytecode de tempo de construção. `lazy="false"` especifica que a associação terá sempre uma busca antecipada (eager fetched). Note que se `constrained="false"`, será impossível efetuar o proxing e o Hibernate irá realizar uma busca antecipada na associação.
	`entity-name` (opcional): O nome da entidade da classe associada.

Existem duas variedades de associações um-pra-um:

Associações de chave primária
Associações de chave exterior exclusiva

Associações de chave primária não necessitam de uma coluna extra de tabela. Se duas linhas forem relacionadas pela associação, então as duas linhas da tabela dividem o mesmo valor da chave primária. Assim, se você quiser que dois objetos sejam relacionados por uma associação de chave primária, você deve ter certeza que foram atribuídos com o mesmo valor identificador.

Para uma associação de chave primária, adicione os seguintes mapeamentos em Employee e Person, respectivamente:


<one-to-one name="person" class="Person"/>


<one-to-one name="employee" class="Employee" constrained="true"/>

Agora devemos assegurar que as chaves primárias de linhas relacionadas nas tabelas PERSON e EMPLOYEE são iguais. Nós usamos uma estratégia especial de geração de identificador do Hibernate chamada foreign:


<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

>

Uma nova instância de Person é atribuída com o mesmo valor da chave primária da instância de Employee referenciada com a propriedade employee daquela Person.

Alternativamente, uma chave exterior com uma restrição única, de Employee para Person, pode ser expressada como:


<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>

Esta associação pode ser feita de forma bi-direcional adicionando o seguinte no mapeamento de Person:


<one-to-one name="employee" class="Employee" property-ref="person"/>

`5.1.14. Id Natural`


<natural-id mutable="true|false"/>

        <property ... />

        <many-to-one ... />

        ......

</natural-id

>

Embora recomendemos o uso das chaves substitutas como chaves primárias, você deve ainda identificar chaves naturais para todas as entidades. Uma chave natural é uma propriedade ou combinação de propriedades que é exclusiva e não nula. Mapeie as propriedades da chave natural dentro do elemento <natural-id>. O Hibernate irá gerar a chave exclusiva necessária e as restrições de anulabilidade, e seu mapeamento será apropriadamente auto documentado.

Nós recomendamos com ênfase que você implemente equals() e hashCode() para comparar as propriedades da chave natural da entidade.

Este mapeamento não pretende ser utilizado com entidades com chaves naturais primárias.

mutable (opcional, padrão false): Por padrão, propriedades naturais identificadoras são consideradas imutáveis (constante).

`5.1.15. Componente e componente dinâmico`

O elemento <component> mapeia propriedades de um objeto filho para colunas da tabela de uma classe pai. Os componentes podem, um após o outro, declarar suas próprias propriedades, componentes ou coleções. Veja "Components" abaixo:

<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
>

	`name`: O nome da propriedade.
	`class` (opcional – padrão para o tipo de propriedade determinada por reflection): O nome da classe (filha) do componente.
	`insert`: As colunas mapeadas aparecem nos SQL de `INSERTs`?
	`update`: As colunas mapeadas aparecem nos SQL de `UPDATEs`?
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`lazy` (opcional - padrão para `false`): Especifica que este componente deve ter uma busca lazy quando a função for acessada pela primeira vez. Isto requer instrumentação bytecode de tempo de construção.
	`optimistic-lock` (opcional – padrão para `true`): Especifica que atualizações para este componente requerem ou não aquisição de um bloqueio otimista. Em outras palavras, determina se uma versão de incremento deve ocorrer quando esta propriedade estiver suja.
	`unique` (opcional – valor padrão `false`): Especifica que existe uma unique restrição em todas as colunas mapeadas do componente.

A tag filha <property> acrescenta a propriedade de mapeamento da classe filha para colunas de uma tabela.

O elemento <component> permite um sub-elemento <parent> mapeie uma propriedade da classe do componente como uma referencia de volta para a entidade que o contém.

The <dynamic-component> element allows a Map to be mapped as a component, where the property names refer to keys of the map. See Seção 8.5, “Componentes Dinâmicos” for more information.

`5.1.16. Propriedades`

O elemento <properties> permite a definição de um grupo com nome, lógico de propriedades de uma classe. A função mais importante do construtor é que ele permite que a combinação de propriedades seja o objetivo de uma property-ref. É também um modo conveninente para definir uma restrição única de múltiplas colunas. Por exemplo:

<properties
        name="logicalName"
        insert="true|false"
        update="true|false"
        optimistic-lock="true|false"
        unique="true|false"
>

        <property ...../>
        <many-to-one .... />
        ........
</properties
>

	`name`: O nome lógico do agrupamento. Isto não é o nome atual de propriedade.
	`insert`: As colunas mapeadas aparecem nos SQL de `INSERTs`?
	`update`: As colunas mapeadas aparecem nos SQL de `UPDATEs`?
	`optimistic-lock` (opcional – padrão para `true`): Especifica que atualizações para estes componentes requerem ou não aquisição de um bloqueio otimista. Em outras palavras, determina se uma versão de incremento deve ocorrer quando estas propriedades estiverem sujas.
	`unique` (opcional – valor padrão `false`): Especifica que existe uma unique restrição em todas as colunas mapeadas do componente.

Por exemplo, se temos o seguinte mapeamento de <properties>:


<class name="Person">

    <id name="personNumber"/>



    ...

    <properties name="name"

            unique="true" update="false">

        <property name="firstName"/>

        <property name="initial"/>

        <property name="lastName"/>

    </properties>

</class

>

Então podemos ter uma associação de dados legados que referem a esta chave exclusiva da tabela Person, ao invés de se referirem a chave primária:


<many-to-one name="person"

         class="Person" property-ref="name">

    <column name="firstName"/>

    <column name="initial"/>

    <column name="lastName"/>

</many-to-one

>

Nós não recomendamos o uso deste tipo de coisa fora do contexto de mapeamento de dados legados.

`5.1.17. Subclass`

Finalmente, a persistência polimórfica requer a declaração de cada subclasse da classe raíz de persistência. Para a estratégia de mapeamento tabela-por-hierarquia-de-classe, deve-se utilizar a declaração <subclass>. Por exemplo:

<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
>

	`name`: O nome de classe completamente qualificada da subclasse.
	`discriminator-value` (opcional – padrão para o nome da classe): Um valor que distingue subclasses individuais.
	`proxy` (opcional): Especifica a classe ou interface que usará os proxies de inicialização lazy.
	`lazy` (opcional, padrão para `true`): Configurar `lazy="false"` desabilitará o uso de inicialização lazy.

Cada subclasse deve declarar suas próprias propriedades persistentes e subclasses. As propriedades <version> e <id> são configuradas para serem herdadas da classe raíz. Cada subclasse numa hierarquia deve definir um único discriminator-value. Se nenhum for especificado, será usado o nome da classe Java completamente qualificado.

For information about inheritance mappings see Capítulo 9, Mapeamento de Herança .

`5.1.18. Subclasses Unidas`

Alternativamente, cada subclasse pode ser mapeada para sua própria tabela. Isto é chamado estratégia de mapeamento de tabela-por-subclasse. O estado herdado é devolvido por associação com a tabela da superclasse. Nós usamos o elemento <joined-subclass>. Por exemplo:

<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
>

	`name`: O nome de classe completamente qualificada da subclasse.
	`table`: O nome da tabela da subclasse.
	`proxy` (opcional): Especifica a classe ou interface que usará os proxies de inicialização lazy.
	`lazy` (opcional, padrão para `true`): Configurar `lazy="false"` desabilitará o uso de inicialização lazy.

A coluna discriminadora não é requerida para esta estratégia de mapeamento. Cada subclasse deve declarar uma coluna de tabela com o identificador do objeto usando o elemento <key>. O mapeamento no início do capítulo poderia ser re-escrito assim:


<?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">

                <!-- mapping for Dog could go here -->

        </class>



</hibernate-mapping

>

For information about inheritance mappings see Capítulo 9, Mapeamento de Herança .

`5.1.19. Subclasse de União`

Uma terceira opção é mapear apenas as classes concretas de uma hierarquia de heranças para tabelas. Isto é chamado estratégia table-per-concrete-class. Cada tabela define todos os estados persistentes da classe, incluindo estados herdados. No Hibernate, não é absolutamente necessário mapear explicitamente como hierarquia de heranças. Você pode simplesmente mapear cada classe com uma declaração <class> separada. Porém, se você deseja usar associações polimórficas (por exemplo: uma associação para a superclasse de sua hierarquia), você precisa usar o mapeamento <union-subclass>. Por exemplo:

<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
>

	`name`: O nome de classe completamente qualificada da subclasse.
	`table`: O nome da tabela da subclasse.
	`proxy` (opcional): Especifica a classe ou interface que usará os proxies de inicialização lazy.
	`lazy` (opcional, padrão para `true`): Configurar `lazy="false"` desabilitará o uso de inicialização lazy.

A coluna discriminatória não é requerida para esta estratégia de mapeamento.

For information about inheritance mappings see Capítulo 9, Mapeamento de Herança .

`5.1.20. União`

Usando o elemento <join>>, é possível mapear propriedades de uma classe para várias tabelas que possuem uma relação um por um. Por exemplo:

<join
        table="tablename"
        schema="owner"
        catalog="catalog"
        fetch="join|select"
        inverse="true|false"
        optional="true|false">

        <key ... />

        <property ... />
        ...
</join
>

	`table`: O nome da tabela associada.
	`schema` (opcional): Sobrepõe o nome do esquema especificado pelo elemento raíz `<hibernate-mapping>`.
	`catalog` (opcional): Sobrepõe o nome do catálogo especificado pelo elemento raíz `<hibernate-mapping>`.
	`fetch`(opcional – valor padrão `join`): Se ajustado para `join`, o padrão, o Hibernate irá usar uma união interna para restaurar um `join` definido por uma classe ou suas subclasses e uma união externa para um `join` definido por uma subclasse. Se ajustado para `select`, então o Hibernate irá usar uma seleção seqüencial para um `<join>` definida numa subclasse, que será emitido apenas se uma linha representar uma instância da subclasse. Uniões internas ainda serão utilizadas para restaurar um `<join>` definido pela classe e suas superclasses.
	`inverse` (opcional – padrão para `false`): Se habilitado, o Hibernate não tentará inserir ou atualizar as propriedades definidas por esta união.
	`optional` (opcional – padrão para `false`): Se habilitado, o Hibernate irá inserir uma linha apenas se as propriedades, definidas por esta junção, não forem nulas. Isto irá sempre usar uma união externa para recuperar as propriedades.

Por exemplo, a informação de endereço para uma pessoa pode ser mapeada para uma tabela separada, enquanto preservando o valor da semântica de tipos para todas as propriedades:


<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>

    ...

Esta característica é útil apenas para modelos de dados legados. Nós recomendamos menos tabelas do que classes e um modelo de domínio fine-grained. Porém, é útil para ficar trocando entre estratégias de mapeamento de herança numa hierarquia simples, como explicaremos mais a frente.

`5.1.21. Key`

Vimos que o elemento <key> (chave) surgiu algumas vezes até agora. Ele aparece em qualquer lugar que o elemento pai define uma junção para a nova tabela, e define a chave exterior para a tabela associada. Ele também referencia a chave primária da tabela original:

<key
        column="columnname"
        on-delete="noaction|cascade"
        property-ref="propertyName"
        not-null="true|false"
        update="true|false"
        unique="true|false"
/>

	`column` (opcional): O nome da coluna da chave exterior. Isto pode também ser especificado através de elementos aninhados `<column>`.
	`on-delete` (opcional, padrão para `noaction`): Especifica se a restrição da chave exterior no banco de dados está habilitada para o deletar cascade.
	`property-ref` (opcional): Especifica que a chave exterior se refere a colunas que não são chave primária da tabela original. Útil para os dados legados.
	`not-null` (opcional): Especifica que a coluna da chave exterior não aceita valores nulos. Isto é implícito em qualquer momento que a chave exterior também fizer parte da chave primária.
	`update` (opcional): Especifica que a chave exterior nunca deve ser atualizada. Isto está implícito em qualquer momento que a chave exterior também fizer parte da chave primária.
	`unique` (opcional): Especifica que a chave exterior deve ter uma restrição única. Isto é, implícito em qualquer momento que a chave exterior também fizer parte da chave primária.

Nós recomendamos que para sistemas que o desempenho deletar seja importante, todas as chaves devem ser definidas on-delete="cascade". O Hibernate irá usar uma restrição a nível de banco de dados ON CASCADE DELETE, ao invés de muitas instruções DELETE. Esteja ciente que esta característica é um atalho da estratégia usual de bloqueio otimista do Hibernate para dados versionados.

As funções not-null e update são úteis quando estamos mapeando uma associação unidirecional um para muitos. Se você mapear uma associação unidirecional um para muitos para uma chave exterior não-nula, você deve declarar a coluna chave usando <key not-null="true">.

`5.1.22. Elementos coluna e fórmula`

Qualquer elemento de mapeamento que aceita uma função column irá aceitar alternativamente um sub-elemento <column>. Da mesma forma, <formula> é uma alternativa para a função formula.


<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"

        read="SQL expression"

        write="SQL expression"/>


<formula

>SQL expression</formula

>

A maioria das funções no column fornecem um significado de junção do DDL durante a geração automática do esquema. As funções read e write permitem que você especifique o SQL personalizado, do qual o Hibernate usará para acessar o valor da coluna. Consulte a discussão da column read and write expressions para maiores informações.

Os elementos column e formula podem até ser combinados dentro da mesma propriedade ou associação mapeando para expressar, por exemplo, condições de associações exóticas.


<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

>

`5.1.23. Importar`

Vamos supor que a sua aplicação tenha duas classes persistentes com o mesmo nome, e você não quer especificar o nome qualificado do pacote nas consultas do Hibernate. As Classes deverão ser "importadas" explicitamente, de preferência contando com auto-import="true". Você pode até importar classes e interfaces que não estão explicitamente mapeadas:


<import class="java.lang.Object" rename="Universe"/>

<import
        class="ClassName"
        rename="ShortName"
/>

	`class`: O nome qualificado do pacote de qualquer classe Java.
	`rename` (opcional – padrão para o nome da classe não qualificada): Um nome que pode ser usado numa linguagem de consulta.

`5.1.24. Any`

Existe mais um tipo de propriedade de mapeamento. O elemento de mapeamento <any> define uma associação polimórfica para classes de múltiplas tabelas. Este tipo de mapeamento sempre requer mais de uma coluna. A primeira coluna possui o tipo da entidade associada. A outra coluna restante possui o identificador. É impossível especificar uma restrição de chave exterior para este tipo de associação, portanto isto certamente não é visto como um caminho usual para associações (polimórficas) de mapeamento. Você deve usar este mapeamento apenas em casos muito especiais. Por exemplo: audit logs, dados de sessão do usuário, etc.

A função meta-type permite que a aplicação especifique um tipo adaptado que mapeia valores de colunas de banco de dados para classes persistentes que possuem propriedades identificadoras do tipo especificado através do id-type. Você deve especificar o mapeamento de valores do meta-type para nome de classes.


<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

>

<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
>

	`name`: o nome da propriedade.
	`id-type`: o tipo identificador.
	`meta-type` (opcional – padrão para `string`): Qualquer tipo que é permitido para um mapeamento discriminador.
	`cascade` (opcional – valor padrão `none`): o estilo cascata.
	`access` (opcional - padrão para `property`): A estratégia que o Hiberante deve utilizar para acessar o valor da propriedade.
	`optimistic-lock` (opcional - valor padrão`true`): Especifica que as atualizações para esta propriedade requerem ou não aquisição da bloqueio otimista. Em outras palavras, define se uma versão de incremento deve ocorrer se esta propriedade for suja.

`5.2. Tipos do Hibernate`


<property name="twoStrings" type="org.hibernate.test.DoubleStringType">

    <column name="first_string"/>

    <column name="second_string"/>

</property

>

Observe o uso da tag <column> para mapear uma propriedade para colunas múltiplas.

As interfaces CompositeUserType, EnhancedUserType, UserCollectionType, e UserVersionType fornecem suporte para usos mais especializados.

Você mesmo pode fornecer parâmetros a um UserType no arquivo de mapeamento. Para isto, seu UserType deve implementar a interface org.hibernate.usertype.ParameterizedType. Para fornecer parâmetros a seu tipo personalizado, você pode usar o elemento <type> em seus arquivos de mapeamento.


<property name="priority">

    <type name="com.mycompany.usertypes.DefaultValueIntegerType">

        <param name="default"

>0</param>

    </type>

</property

>

O UserType pode agora recuperar o valor para o parâmetro chamado padrão da Propriedade do passado a ele.

Se você usar freqüentemente um determinado UserType, pode ser útil definir um nome mais curto para ele. Você pode fazer isto usando o elemento <typedef>. Typedefs atribui um nome a um tipo personalizado, e pode também conter uma lista de valores de parâmetro padrão se o tipo for parametrizado.


<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero">

    <param name="default"

>0</param>

</typedef

>


<property name="priority" type="default_zero"/>

Também é possível substituir os parâmetros fornecidos em um tipo de definição em situações de caso a caso, utilizando tipos de parâmetros no mapeamento da propriedade.

Apesar da rica variedade, os tipos construídos do Hibernate e suporte para componentes raramente irão utilizar um tipo de padrão, no entanto, é considerado uma boa idéia, utilizar tipos customizados para classes não entidade que ocorrem com freqüência em seu aplicativo. Por exemplo, uma classe MonetaryAmount é um bom candidato para um CompositeUserType, apesar de poder ter sido mapeado facilmente como um componente. Uma motivação para isto é a abstração. Com um tipo padronizado, seus documentos de mapeamento seriam colocados à prova contra mudanças possíveis na forma de representação de valores monetários.

`5.3. Mapeando uma classe mais de uma vez`

É possível fornecer mais de um mapeamento para uma classe persistente em específico. Neste caso, você deve especificar um nome de entidade para as instâncias das duas entidades mapeadas não se tornarem ambíguas. Por padrão, o nome da entidade é o mesmo do nome da classe. O Hibernate o deixa especificar o nome de entidade quando estiver trabalhando com objetos persistentes, quando escrever consultas, ou ao mapear associações para a entidade nomeada.

<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
>

Note como as associações são agora especificadas utilizando o entity-name ao invés da class.

`5.4. Identificadores quotados do SQL`

Você poderá forçar o Hibernate a quotar um identificador no SQL gerado, anexando o nome da tabela ou coluna aos backticks no documento de mapeamento. O Hibernate usará o estilo de quotação correto para o SQL Dialect. Geralmente são quotas dúplas, mas parênteses para o Servidor SQL e backticks para MeuSQL.


<class name="LineItem" table="`Line Item`">

    <id name="id" column="`Item Id`"/><generator class="assigned"/></id>

    <property name="itemNumber" column="`Item #`"/>

    ...

</class

>

`5.5. Alternativas de Metadados`

O XML não é para todos, e portanto existem algumas formas alternativas de defiinir o metadado de mapeamento no Hibernate.

`5.5.1. Usando a marcação XDoclet.`

Muitos usuários do Hibernate preferem encubar a informação de mapeamento diretamente no código de fonte utilizando o XDoclet @hibernate.tags. Nós não falaremos sobre esta abordagem neste documento, uma vez que é estritamente considerado parte de um XDoclet. No entanto, incluímos os seguintes exemplos da classe Cat com os mapeamentos de XDoclet:

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;

    }

}

Veja o web site do Hibernate para maiores detalhes sobre um XDoclet e Hibernate.

`5.5.2. Usando as anotações JDK 5.0`

O JDK 5.0 introduziu as anotações estilo XDoclet em nível de linguagem, tipo seguro e checado em tempo de compilação. Este mecanismo é mais potente do que as anotações XDoclet e melhor suportado pelas ferramentas e IDEs. O IntelliJ IDEA por exemplo, suporta a auto complexão e destaque da sintaxe das anotações JDK 5.0. A nova revisão da especificação EJB (JSR-220) usa as anotações JDK 5.0 como mecanismos de metadados para beans de entidade. O Hibernate3 implementa o EntityManager do JSR-220 (o API de persistência). O suporte para mapear metadados está disponível através do pacote Anotações do Hibernate, como um download separado. Ambos os EJB3 (JSR-220) e o metadado Hibernate3 são suportados.

Este é um exemplo de uma classe POJO anotado como um bean de entidade EJB:

@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

}

`Nota`

Note que o suporte para Anotações JDK 5.0 (e JSR-220) ainda está em construção. Consulte o módulo de Anotações do Hibernate para maiores detalhes.

`5.6. Propriedades geradas`

Propriedades Geradas são propriedades que possuem seus valores gerados pelo banco de dados. Como sempre, os aplicativos do Hibernate precisavam renovar objetos que contenham qualquer propriedade para qual o banco de dados estivesse gerando valores. No entanto, vamos permitir que o aplicativo delegue esta responsabilidade ao Hibernate. Essencialmente, quando o Hibernate edita um SQL INSERT ou UPDATE para uma entidade que tem propriedades geradas definidas, ele edita imediatamente depois uma seleção para recuperar os valores gerados.

As propriedades marcadas como geradas devem ser não-inseríveis e não-atualizáveis. Somente versions, timestamps, e simple properties podem ser marcadas como geradas.

never (padrão) - significa que o valor de propriedade dado não é gerado dentro do banco de dados.

insert: informa que o valor de propriedade dado é gerado ao inserir, mas não é novamente gerado nas próximas atualizações. Propriedades do tipo data criada, se encaixam nesta categoria. Note que embora as propriedades version e timestamp podem ser marcadas como geradas, esta opção não está disponível.

always - informa que o valor da propriedade é gerado tanto ao inserir quanto ao atualizar.

`5.7. Coluna de expressöes de gravação e leitura`

Hibernate allows you to customize the SQL it uses to read and write the values of columns mapped to simple properties. For example, if your database provides a set of data encryption functions, you can invoke them for individual columns like this:

<!-- XML : generated by JHighlight v1.0 (http://jhighlight.dev.java.net) -->
<span class="xml_tag_symbols">&lt;</span><span class="xml_tag_name">property</span><span class="xml_plain">&nbsp;</span><span class="xml_attribute_name">name</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;creditCardNumber&quot;</span><span class="xml_tag_symbols">&gt;</span><span class="xml_plain"></span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_tag_symbols">&lt;</span><span class="xml_tag_name">column</span><span class="xml_plain">&nbsp;</span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_attribute_name">name</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;credit_card_num&quot;</span><span class="xml_plain"></span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_attribute_name">read</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;decrypt(credit_card_num)&quot;</span><span class="xml_plain"></span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_attribute_name">write</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;encrypt(?)&quot;</span><span class="xml_tag_symbols">/&gt;</span><span class="xml_plain"></span><br />
<span class="xml_tag_symbols">&lt;/</span><span class="xml_tag_name">property</span><span class="xml_plain"></span><br />
<span class="xml_tag_symbols">&gt;</span><span class="xml_plain"></span><br />

O Hibernate aplica automaticamente as expressöes personalizadas a todo instante que a propriedade é referenciada numa consulta. Esta funcionalidade é parecida a uma formula de propriedade-derivada com duas diferenças:

Esta propriedade é suportada por uma ou mais colunas que são exportadas como parte da geração do esquema automático.
Esta propriedade é de gravação-leitura, e não de leitura apenas.

Caso a expressão writeseja especificada, deverá conter um '?' para o valor.

`5.8. Objetos de Banco de Dados Auxiliares`

Permite o uso dos comandos CREATE e DROP para criar e remover os objetos de banco de dados arbitrários. Juntamente às ferramentas de evolução do esquema do Hibernate, eles possuem a habilidade de definir completamente um esquema de usuário dentro dos arquivos de mapeamento do Hibernate. Embora criado especificamente para criar e remover algo como trigger ou procedimento armazenado, qualquer comando SQL que pode rodar através de um método java.sql.Statement.execute() é válido. Existem dois módulos essenciais para definir objetos de banco de dados auxiliares:

O primeiro módulo é para listar explicitamente os comandos CREATE e DROP no arquivo de mapeamento:


<hibernate-mapping>

    ...

    <database-object>

        <create

>CREATE TRIGGER my_trigger ...</create>

        <drop

>DROP TRIGGER my_trigger</drop>

    </database-object>

</hibernate-mapping

>

O segundo módulo é para fornecer uma classe padrão que sabe como construir os comandos CREATE e DROP. Esta classe padrão deve implementar a interface org.hibernate.mapping.AuxiliaryDatabaseObject.


<hibernate-mapping>

    ...

    <database-object>

        <definition class="MyTriggerDefinition"/>

    </database-object>

</hibernate-mapping

>

Além disso, estes objetos de banco de dados podem ter um escopo opcional que só será aplicado quando certos dialetos forem utilizados.


<hibernate-mapping>

    ...

    <database-object>

        <definition class="MyTriggerDefinition"/>

        <dialect-scope name="org.hibernate.dialect.Oracle9iDialect"/>

        <dialect-scope name="org.hibernate.dialect.Oracle10gDialect"/>

    </database-object>

</hibernate-mapping

>