Una entidad va a ser una simple clase Java que deseamos persistir en la base de datos.

Este tutorial está dividido en 3 partes:

• La clase Java
• Fichero de mapeo ''.hbm.xml''
• Anotaciones

La clases Java deberán tener las siguientes características:

• Deben tener un constructor público sin ningún tipo de argumentos ¹⁾.
• Para cada propiedad que queramos persistir debe haber un método get/set asociado.
• Implementar el interfaz Serializable ²⁾

1|Profesor.java

public class Profesor implements Serializable  {
    private int id;
    private String nombre;
    private String ape1;
    private String ape2;   
 
    public Profesor(){ 
    }
 
    public Profesor(int id, String nombre, String ape1, String ape2) {
        this.id = id;
        this.nombre = nombre;
        this.ape1 = ape1;
        this.ape2 = ape2;
    }
 
    public int getId() {
        return id;
    }
 
    public void setId(int id) {
        this.id = id;
    }
 
    public String getNombre() {
        return nombre;
    }
 
    public void setNombre(String nombre) {
        this.nombre = nombre;
    }
 
    public String getApe1() {
        return ape1;
    }
 
    public void setApe1(String ape1) {
        this.ape1 = ape1;
    }
 
    public String getApe2() {
        return ape2;
    }
 
    public void setApe2(String ape2) {
        this.ape2 = ape2;
    }
}

Vemos en el código fuente cómo la clase Profesor tiene un constructor sin ningún tipo de argumentos (Linea 7). Además para las propiedades id,nombre,ape1 y ape2 están el par de métodos get y set y por último implementa el interfaz Serializable (Línea 1).

¿Ya podemos persistir la clase Profesor usando hibernate? Pues NO, debemos indicarle a hibernate toda la metainformación relativa a esta clase. Hay que explicarle como se mapeará el objeto en una base de datos relacional ³⁾ , indicando para ello en que tabla de base de datos se debe guardar cuál es la clave primaria de la tabla, las columnas que tiene, etc.

Para cada clase que queremos persistir se creará un fichero xml con la información que permitirá mapear la clase a una base de datos relacional. Este fichero estará en el mismo paquete que la clase a persistir.

En nuestro caso, si queremos persistir la clase Profesor deberemos crear el fichero Profesor.hbm.xml en el mismo paquete que la clase Java.

1|Profesor.hbm.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
  <class name="ejemplo01.Profesor" table="Profesor" >
    <id column="Id" name="id" type="integer"/>
    <property name="nombre" />
    <property name="ape1" />
    <property name="ape2" />
  </class>
</hibernate-mapping>

Podemos ver cómo el fichero Profesor.hbm.xml es un típico fichero xml.

• En la linea 1 vemos la declaración de que es un fichero XML.
• En la linea 2 se aprecia la declaración del DOCTYPE junto con la referencia al documento http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd DTD que permite validarlo. Es decir que si nos descargamos el fichero hibernate-mapping-3.0.dtd podremos saber todos los elementos que hay en un fichero de mapeo.
• El nodo raiz del documento xml se llama <hibernate-mapping> y se encuentra en la línea 3.
• La parte interesante de este fichero empieza en la línea 4. Vemos el tag <class> que nos indica que vamos a mapear una clase.
  • En el atributo name deberemos poner el FQCN ⁴⁾ de la clase que queremos mapear.Es decir el nombre de la clase incluyendo el paquete en el que se encuentra.
  • El atributo table nos indica el nombre de la tabla en la que vamos a mapear la clase. Este atributo es opcional si el nombre de la clase Java y el de la tabla coinciden.
• El tag <id> de la línea 5 se usa para indicar la propiedad de la clase que es la clave primaria.
  • El atributo name es el nombre de la propiedad Java que contiene la clave primaria.
  • El atributo column contiene el nombre de la columna de la base de datos asociado a la propiedad. Este atributo es opcional si el nombre de la propiedad Java y el nombre de la columna coinciden.
  • El atributo type indica el tipo de la propiedad Java. Este atributo no es necesario puesto que Hibernate por defecto ya usa el tipo de la propiedad Java. Mas información en Tipos básicos.
• El tag <property> de las líneas 6 a la 8 se usa para declarar más propiedades Java para ser mapeadas en la base de datos. Si no declaramos las propiedades Java mediante este tag no se leerán o guardarán en la base de datos.
  • El atributo name es el nombre de la propiedad Java que queremos mapear a la base de datos.
  • El atributo column contiene el nombre de la columna de la base de datos asociado a la propiedad. Este atributo es opcional si el nombre de la propiedad Java y el nombre de la columna coinciden.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
  <class name="ejemplo01.Profesor" table="Profesor" >
    <id column="Id" name="id" type="integer"/>
    <property name="nombre"  />
    <property name="ape1" column="primer_apellido" />
    <property name="ape2" column="segundo_apellido" />
  </class>
</hibernate-mapping>

<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">

<property name="nombre" access="field" />

En el apartado anterior hemos visto cómo mediante un fichero .hbm.xml podemos especificar cómo mapear la clases Java en tablas de base de datos.

Desde hace algunos años en Java se ha creado el concepto llamado El infierno XML.Este infierno ha consistido en que en demasiados frameworks ⁶⁾ se hacía un uso intensivo de XML , siendo el XML un formato de ficheros demasiado largo de escribir , muy repetitivo , verboso, etc. Ésto ha llevado a crear una solución para evitar los ficheros XML de persistencia en hibernate ⁷⁾: El uso de Anotaciones Java en el propio código. Estas anotaciones permiten especificar de una forma más compacta y sencilla la información de mapeo de las clases Java.

Inicialmente Hibernate creó sus propia anotaciones en el paquete org.hibernate.annotations pero a partir de la versión 4 de Hibernate la mayoría de dichas anotaciones han sido java.lang.Deprecated y ya no deben usarse. Las anotaciones que deben usarse actualmente son las del estándar de JPA que se encuentran en el paquete javax.persistence. Sin embargo hay características específicas de Hibernate que no posee JPA lo que hace que aun sea necesario usar alguna anotación del paquete org.hibernate.annotations pero en ese caso Hibernate 4 no las ha marcado como java.lang.Deprecated

Veamos ahora el ejemplo de la clase Profesor pero mapeada con anotaciones.

1|Profesor.java anotado

@Entity
@Table(name="Profesor")
public class Profesor implements Serializable  {
 
    @Id
    @Column(name="Id")
    private int id;
 
    @Column(name="nombre")
    private String nombre;
 
    @Column(name="ape1")
    private String ape1;
 
    @Column(name="ape2")    
    private String ape2;
 
 
    public Profesor(){ 
    }
 
    public Profesor(int id, String nombre, String ape1, String ape2) {
        this.id = id;
        this.nombre = nombre;
        this.ape1 = ape1;
        this.ape2 = ape2;
    }
 
    public int getId() {
        return id;
    }
 
    public void setId(int id) {
        this.id = id;
    }
 
    public String getNombre() {
        return nombre;
    }
 
    public void setNombre(String nombre) {
        this.nombre = nombre;
    }
 
    public String getApe1() {
        return ape1;
    }
 
    public void setApe1(String ape1) {
        this.ape1 = ape1;
    }
 
    public String getApe2() {
        return ape2;
    }
 
    public void setApe2(String ape2) {
        this.ape2 = ape2;
    }
}

Las anotaciones que se han usado son las siguientes:

• @Entity: Se aplica a la clase e indica que esta clase Java es una entidad a persistir. Es una anotación estándar de JPA. En nuestro ejemplo estamos indicando que la clase Profesor es una entidad que se puede persistir.
• @Table(name=“Profesor”): Se aplica a la clase e indica el nombre de la tabla de la base de datos donde se persistirá la clase. Es opcional si el nombre de la clase coincide con el de la tabla. Es una anotación estándar de JPA. En nuestro ejemplo estamos indicando que la clase Profesor se persistirá en la tabla Profesor de la base de datos.
• @Id: Se aplica a una propiedad Java e indica que este atributo es la clave primaria. Es una anotación estándar de JPA. En nuestro ejemplo estamos indicando que la propiedad Java id es la clave primaria.
• @Column(name=“Id”): Se aplica a una propiedad Java e indica el nombre de la columna de la base de datos en la que se persistirá la propiedad. Es opcional si el nombre de la propiedad Java coincide con el de la columna de la base de datos. Es una anotación estándar de JPA. En nuestro ejemplo estamos indicando que la propiedad Java id se persistirá en una columna llamada Id.
• @Column(name=“nombre”): Se aplica a una propiedad Java e indica el nombre de la columna de la base de datos en la que se persistirá la propiedad. Es opcional si el nombre de la propiedad Java coincide con el de la columna de la base de datos. Es una anotación estándar de JPA. En nuestro ejemplo estamos indicando que la propiedad Java nombre se persistirá en una columna llamada nombre.
• @Column(name=“ape1”): Es igual al caso anterior pero para la propiedad ape1.
• @Column(name=“ape2”): Es igual al caso anterior pero para la propiedad ape2.