Capítulo 3: Modelo

La capa del modelo en una aplicación orientada a objetos es la que contiene la lógica de negocio, esto es la estructura de los datos con los que se trabaja y todos los cálculos, validaciones y procesos asociados a esos datos.
OpenXava es un marco orientado al modelo, en donde el modelo es lo más importante, y todo lo demás (p. ej. la interfaz gráfica) depende de él.
La forma de definir el modelo en OpenXava es mediante simples clases Java (aunque también existe una versión XML) y un poquito de Java. OpenXava provee una aplicación completamente funcional a partir de la definición del modelo.

Componente de negocio

La unidad básica para crear aplicaciones OpenXava es el componente de negocio. Un componente de negocio se define usando una clase Java llamada Entity. Esta clase es una entidad EJB3 convencional, o con otras palabras, un POJO con anotaciones que sigue el estándar Java Persistence API (JPA).
JPA es el estándar de Java para la persistencia, es decir, para objetos que guardan su estado en una base de datos. Si sabes desarrollar usando POJOs con JPA, ya sabes como desarrollar aplicaciones OpenXava.
Usando una simple clase Java podemos definir un Componente de Negocio con:
Using this classes you can define a Business Component with:

• Modelo: Estrutura de datos, validaciones, calculos, etc.
• Vista: Cómo se puede mostrar el modelo al usuario.
• Datos tabulares: Cómo se muestra los datos de este componentes en modo lista (en formato tabular).
• Mapeo objeto/relacional: Cómo grabar y leer el estado de los objetos desde la base de datos.

Este capítulo explica cómo definir la parte del modelo, es decir, todo sobre la estructura, las validaciones, los cálculos, etc.

Entidad

Para define la parte del modelo hemos de definir a clase Java con anotaciones. Además de sus propias anotaciones, OpenXava sporta anotaciones de JPA e Hibernate Validator. Esta clase Java es una entidad, es decir, una clase persistente que representa concepto de negocio.
En este capítulo JPA se usa para indicar que es una anotación estándar de Java Persistent API, HV para indicar que es una anotación de Hibernate Validator, y OX para indicar que es una anotación de OpenXava.
Ésta es la sintáxis para una entidad:

@Entity                       //  1
@EntityValidator              //  2
@RemoveValidator              //  3
public class NombreEntidad {  //  4
  // Propiedades              //  5
  // Referencias              //  6
  // Colecciones              //  7
  // Métodos                  //  8
  // Buscadores               //  9
  // Métodos de retrollamada  // 10
}

1. @Entity (JPA, uno, obligado): Indica que esta clase es una entidad JPA, con otras palabras, sus instancias serán objetos persistentes.
2. @EntityValidator (OX, varios, opcional): Ejecuta una validación a nivel de modelo. Este validador puede recibir el valor de varias propiedades del modelo. Para validar una sola propiedad es preferible poner el validador a nivel de propiedad.
3. @RemoveValidator (OX, varios, opcional): Se ejecuta antes de borrar, y tiene la posibilidad de vetar el borrado del objeto.
4. Declaración de la clase: Como en un clase de Java convencional. Podemos usar extends e implements.
5. Propiedades: Propiedades de Java convencionales. Representan el estado principal del objeto.
6. Referencias: Referencias a otras entidades.
7. Colecciones: Colecciones de referencias a otras entidades.
8. Métodos: Métodos Java con lógica de negocio.
9. Buscadores: Los buscadores son métodos estáticos que hacen búsquedas usando las prestaciones de consulta de JPA.
10. Métodos de retrollamada: Los métodos JPA de retrollamada (callbacks) para insertar lógica al crear, modificar, cargar, borrar, etc

Propiedades

Una propiedad representa parte del estado de un objeto que se puede consultar y en algunos casos cambiar. El objeto no tiene la obligación de guardar físicamente la información de la propiedad, solo de devolverla cuando se le pregunte.
La sintaxis para definir una propiedad es:

@Stereotype                                                  //  1
@Column(length=) @Max @Length(max=) @Digits(integerDigits=)  //  2
@Digits(fractionalDigits=)                                   //  3
@Required @Min @Range(min=) @Length(min=)                    //  4
@Id                                                          //  5
@Hidden                                                      //  6
@SearchKey                                                   //  7
@Version                                                     //  8
@DefaultValueCalculator                                      //  9
@PropertyValidator                                           // 10
private tipo nombrePropiedad;                                // 11
public tipo getNombrePropiedad() { ... }                     // 11
public void setNombrePropiedad(tipo nuevoValor) { ... }      // 11

1. @Stereotype (OX, opcional): Permite especificar un comportamiento especial para cierta propiedades.
2. @Column(length=) (JPA), @Max (HV), @Length(max=) (HV), @Digits(integerDigits=) (HV, opcional, normalmente solo se usa una): Longitud en caracteres de la propiedad, excepto para @Max que es el valor máximo. Especialmente útil a la hora de generar interfaces gráficas. Si no especificamos longitud asume un valor por defecto asociado al tipo o estereotipo que se obtiene de default-size.xml o longitud-defecto.xml.
3. @Digits(fractionalDigits=) (HV, opcional): Escala (tamaño de la parte decimal) de la propiedad. Solo aplica a propiedades numéricas. Si no especificamos escala asume un valor por defecto asociado al tipo o estereotipo que se obtiene de default-size.xml o longitud-defecto.xml.
4. @Required (OX), @Min (HV), @Range(min=) (HV), @Length(min=) (HV) (opcional, normalmente solo se usa una): Indica si esa propiedad es requerida. En el caso de @Min, @Range y @Length tenemos que poner un valor mayor que cero para min para que se asuma la propiedad como requerida. Por defecto es true para las propiedades clave ocultas (nuevo en v2.1.3) y false en todos los demás casos. Al grabar OpenXava comprobará si las propiedades requeridas están presentes, si no lo están no se producirá la grabación y se devolverá una lista de errores de validación. La lógica para determinar si una propiedad está presente o no se puede configurar creando un archivo validators.xml o validadores.xml en nuestro proyecto. Podemos ver la sintaxis en OpenXava/xava/validators.xml.
5. @Id (JPA, opcional): Para indicar si una propiedad forma parte de la clave. Al menos una propiedad (o referencia) ha de ser clave. La combinación de propiedades (y referencias) clave se debe mapear a un conjunto de campos en la base de datos que no tengan valores repetidos, típicamente con la clave primaria.
6. @Hidden (OX, opcional): Una propiedad oculta es aquella que tiene sentido para el desarrollador pero no para el usuario. Las propiedades ocultas se excluyen cuando se generan interfaces gráficas automáticas, sin embargo a nivel de código generado están presentes y son totalmente funcionales, incluso si se les hace alusión explicita podrían aparecer en una interfaz gráfica.
7. @SearchKey (OX, optional): Las propiedades clave de búsqueda se usan por los usuarios para buscar los objetos. Son editables en la interfaz de usuario de las referencias permitiendo al usuario teclear su valor para buscar. OpenXava usa las propiedades clave (@Id) para buscar por defecto, y si la propiedades clave (@Id) están ocultas usa la primera propiedad en la vista. Con @SearchKey podemos elegir las propiedades para buscar explicitamente.
8. @Version (JPA, opcional): Una propiedad versión se usa para el control de concurrencia optimista. Si queremos control de concurrencia solo necesitamos tener una propiedad marcada como @Version en nuestra entidad. Solo podemos especificar una propiedad de versión por entidad. Los siguientes tipos son soportados para propiedades versión: int, Integer, short, Short, long, Long, Timestamp. Las propiedades de versión también se consideran ocultas.
9. @DefaultValueCalculator (OX, uno, optional): Para implementar la lógica para calcular el valor inicial de la propiedad. Una propiedad con @DefaultValueCalculator sí tiene setter y es persistente.
10. @PropertyValidator (OX, varios, opcional): Indica la lógica de validación a ejecutar sobre el valor a asignar a esta propiedad antes de crear o modificar.
11. Declaración de la propiedad: Una declaración de propiedad Java normal y corriente con getters y setters. Podemos crear una propiedad calculada usando solo un getter sin campo ni setter. Cualquier tipo legal para JPA está permitido, solo hemos de proveer un Hibernate Type para grabar en la base de datos y un editor OpenXava para dibujar como HTML.

Estereotipo

Un estereotipo (@Stereotype) es la forma de determinar un comportamiento especifico dentro de un tipo. Por ejemplo, un nombre, un comentario, una descripción, etc. todos corresponden al tipo Java java.lang.String pero si queremos que los validadores, logitud por defecto, editores visuales, etc. sean diferente en cada caso y necesitamos afinar más; lo podemos hacer asignando un esterotipo a cada uno de estos casos. Es decir, podemos tener los estereotipos NOMBRE, TEXTO_GRANDE o DESCRIPCION y asignarlos a nuestras propiedades.
El OpenXava viene configurado con los siguientes estereotipos:

• DINERO, MONEY
• FOTO, PHOTO, IMAGEN, IMAGE
• TEXTO_GRANDE, MEMO, TEXT_AREA
• ETIQUETA, LABEL
• ETIQUETA_NEGRITA, BOLD_LABEL
• HORA, TIME
• FECHAHORA, DATETIME
• GALERIA_IMAGENES, IMAGES_GALLERY (instrucciones)
• RELLENADO_CON_CEROS, ZEROS_FILLED
• TEXTO_HTML, HTML_TEXT (texto con formato editable)
• ETIQUETA_IMAGEN, IMAGE_LABEL (imagen que depende del contenido de la propiedad)
• EMAIL
• TELEFONO, TELEPHONE
• WEBURL
• IP
• ISBN
• TARJETA_CREDITO, CREDIT_CARD
• LISTA_EMAIL, EMAIL_LIST

Vamos a ver como definiríamos un estereotipo propio. Crearemos uno llamado NOMBRE_PERSONA para representar nombres de persona.
Editamos (o creamos) el archivo editors.xml o editores.xml en nuestra carpeta xava. Y añadimos

<editor url="editorNombrePersona.jsp">
    <para-estereotipo estereotipo="NOMBRE_PERSONA"/>
</editor>

De esta forma indicamos que editor se ha de ejecutar para editar y visualizar propiedades con el estereotipo NOMBRE_PERSONA.
Además es útil indicar la longitud por defecto, eso se hace editando default-size.xml o longitud-defecto.xml:

<para-estereotipo nombre="NOMBRE_PERSONA" longitud="40"/>

Y así si no ponemos longitud asumirá 40 por defecto.
Menos común es querer cambiar el validador para requerido, pero si queremos cambiarlo lo podemos hacer añadiendo a validators.xml o validadores.xml de nuestro proyecto lo siguiente:

<validador-requerido>
    <clase-validador clase="org.openxava.validators.NotBlankCharacterValidator"/>
    <para-estereotipo estereotipo="NOMBRE_PERSONA"/>
</validador-requerido>

Ahora podemos definir propiedades con estereotipo NOMBRE_PERSONA:

@Stereotype("PERSON_NAME")
private String nombre;

En este caso asume 40 longitud y tipo String, así como ejecutar el validador NotBlankCharacterValidator
para comprobar que es requerido.

Estereotipo GALERIA_IMAGENES

Si queremos que una propiedad de nuestro componente almacene una galería de imágenes. Solo necesitamos declarar que nuestra propiedad sea del estereotipo GALERIA_IMAGENES. De esta manera:

@Stereotype("GALERIA_IMAGENES")
private String fotos;

Además, en el mapeo tenemos que mapear la propiedad contra una columna adecuada para almacenar una cadena (String) con 32 caracteres de longitud (VARCHAR(32)).
Y ya está todo.
Pero, para que nuestra aplicación soporte este estereotipo necesitamos configurar nuestro sistema.
Lo primero es crear a tabla en la base de datos para almacenar las imágenes:

CREATE TABLE IMAGENES (
    ID VARCHAR(32) NOT NULL PRIMARY KEY,
    GALLERY VARCHAR(32) NOT NULL,
    IMAGE BLOB);
CREATE INDEX IMAGENES01
    ON IMAGENES (GALLERY);
 

El tipo de la columna IMAGE puede ser un tipo más adecuado para almacenar byte [] en el caso de nuestra base de datos (por ejemplo LONGVARBINARY) .
Y finalmente necesitamos definir el mapeo en nuestro archivo persistence/hibernate.cfg.xml, así:

<hibernate-configuration>
    <session-factory>
    ...
        <mapping resource="GalleryImage.hbm.xml"/>
    ...
    </session-factory>
</hibernate-configuration>

Después de todo esto ya podemos usar el estereotipo GALERIA_IMAGENES en los componentes de nuestra aplicación.

Concurrencia y propiedad versión

Concurrencia es la habilidad de una aplicación para permitir que varios usuarios graben datos al mismo tiempo sin perder información. OpenXava usa un esquema de concurrencia optimista. Usando concurrencia optimista los registros no se bloquean permitiendo un alto nivel de concurrencia sin perder la integridad de la información.
Por ejemplo, si un usuario A lee un registro y entonces un usuario B lee el mismo registro, lo modifica y graba los cambios, cuando el usuario A intente grabar el registro recibirá un error y tendrá que refrescar los datos y reintentar su modificación.
Para activar el soporte de concurrencia para un componente OpenXava solo necesitamos declarar una propiedad usando @Version, de esta manera:

@Version
private int version;

Esta propiedad es para uso del mecanismo de persistencia (Hibernate o JPA), ni nuestra aplicación ni usuarios deberían acceder directamente a ella.

Enums

OpenXava suporta enums de Java 5. Un enum permite definir una propiedad que solo puede contener los valores indicados.
Es fácil de usar, veamos un ejemplo:

private Distancia distancia;
public enum Distancia { LOCAL, NACIONAL, INTERNACIONAL };

La propiedad distancia solo puede valer LOCAL, NACIONAL o INTERNACIONAL, y como no hemos puesto @Required también permite valor vacío (null).
A nivel de interfaz gráfico la implementación web actual usa un combo. La etiqueta para cada valor se obtienen de los archivos i18n.
A nivel de base datos por defecto guarda el entero (0 para LOCAL, 1 para NACIONAL, 2 para INTERNACIONAL y null para cuando no hay valor), pero esto se puede configurar fácilmente para poder usar sin problemas bases de datos legadas. Ver más de esto último en el capítulo sobre mapeo.

Propiedades calculadas

Las propiedades calculadas son de solo lectura (solo tienen getter) y no persistentes (no se almacenan en ninguna columna de la tabla de base de datos).
Una propiedad calculada se define de esta manera:

@Depends("precioUnitario")  // 1
@Max(9999999999L)           // 2
public BigDecimal getPrecioUnitarioEnPesetas() {
    if (precioUnitario == null) return null;
    return precioUnitario.multiply(new BigDecimal("166.386"))
    .setScale(0, BigDecimal.ROUND_HALF_UP);
}
 

De acuerdo con esta definición ahora podemos usar el código de esta manera:

Producto producto = ...
producto.setPrecioUnitario(2);
BigDecimal resultado = producto.getPrecioUnitarioEnPesetas();
 

Y resultado contendrá 332,772.
Cuando la propiedad precioUnitarioEnPesetas se visualiza al usuario no es editable, y su editor tiene una longitud de 10, indicado usando @Max(9999999999L) (2). También, dado que usamos @Depends("precioUnitario") (1) cuando el usuario cambie la propiedad precioUnitario en la interfaz de usuario la propiedad precioUnitarioEnPesetas será recalculada y su valor será refrescado de cara al usuario.
Desde una propiedad calculada tenemos acceso a conexiones JDBC. Un ejemplo:

@Max(999)
public int getCantidadLineas() {
    // Un ejemplo de uso de JDBC
    Connection con = null;
    try {
        con = DataSourceConnectionProvider.getByComponent("Factura").getConnection();  // 1
        String tabla = MetaModel.get("LineaFactura").getMapping().getTable();
        PreparedStatement ps = con.prepareStatement("select count(*) from " + tabla +
            " where FACTURA_AÑO = ? and FACTURA_NUMERO = ?");
        ps.setInt(1, getAño());
        ps.setInt(2, getNumero());
        ResultSet rs = ps.executeQuery();
        rs.next();
        Integer result = new Integer(rs.getInt(1));
        ps.close();
        return result;
    }
    catch (Exception ex) {
        log.error("Problemas al calcular cantidad de líneas de una Factura", ex);
        // Podemos lanzar cualquier RuntimeException aquí
        throw new SystemException(ex);
    }
    finally {
        try {
            con.close();
        }
        catch (Exception ex) {
        }
    }
}
 

Es verdad, el código JDBC es feo y complicado, pero a veces puede ayudar a resolver problemas de rendimiento. La clase DataSourceConnectionProvider nos permite obtener la conexión asociada a la misma fuente de datos que la entidad indicada (en este caso Factura). Esta clase es para nuestra conveniencia, también podemos acceder a una conexión JDBC usando JNDI o cualquier otro medio que queramos. De hecho, en una propiedad calculada podemos escribir cualquier código que Java nos permita.

Calculador valor por defecto

Con @DefaultValueCalculator podemos asociar lógica a una propiedad, en este caso la propiedad es lectura y escritura. Este calculador se usa para calcular el valor inicial. Por ejemplo:

@DefaultValueCalculator(CurrentYearCalculator.class)
private int año;
 

En este caso cuando el usuario intenta crear una nueva factura (por ejemplo) se encontrará con que el campo de año ya tiene valor, que él puede cambiar si quiere. La lógica para generar este valor está en la clase CurrentYearCalculator class, así:

package org.openxava.calculators;
 
import java.util.*;
 
/**
 * @author Javier Paniza
 */
public class CurrentYearCalculator implements ICalculator {
 
    public Object calculate() throws Exception {
        Calendar cal = Calendar.getInstance();
        cal.setTime(new java.util.Date());
        return new Integer(cal.get(Calendar.YEAR));
    }
 
}
 

Es posible personalizar el comportamiento de un calculador poniendo el valor de sus propiedades, como sigue:

@DefaultValueCalculator(
    value=org.openxava.calculators.StringCalculator.class,
    properties={ @PropertyValue(name="string", value="BUENA") }
)
private String relacionConComercial;

En este caso para calcular el valor por defecto OpenXava instancia StringCalculator y entonces inyecta el valor "BUENA" en la propiedad string de StringCalculator, y finalmente llama al método calculate() para obtener el valor por defecto para relacionConComercial. Como se ve, el uso de la anotación @PropertyValue permite crear calculadores reutilizable.
@PropertyValue permite inyectar valores desde otras propiedades visualizadas, de esta forma:

@DefaultValueCalculator(
    value=org.openxava.test.calculatodores.CalculadorObservacionesTransportista.class,
    properties={
        @PropertyValue(name="tipoPermisoConducir", from="permisoConducir.tipo")
    }
)
private String observaciones;

En este caso antes de ejecutar el calculador OpenXava llena la propiedad permisoConducir de CalculadorObservacionesTransportista con el valor de la propiedad visualizada tipo de la referencia permisoConducir. Como se ve el atributo from soporta propiedades calificadas (referencia.propiedad).
Además podemos usar @PropertyValue sin from ni value:

@DefaultValueCalculator(value=CalculadorPrecioDefectoProducto.class, properties=
    @PropertyValue(name="codigoFamilia")
)

En este caso OpenXava coge el valor de la propiedad visualizada codigoFamilia y lo inyecta en la propiedad codigoFamilia del calculador, es decir @PropertyValue(name="codigoFamilia") equivale a @PropertyValue(name="codigoFamilia", from="codigoFamilia").
Desde un calculador tenemos acceso a conexiones JDBC, he aquí un ejemplo:

@DefaultValueCalculator(value=CalculadorCantidadLineas.class,
    properties= {
        @PropertyValue(name="año"),
        @PropertyValue(name="numero"),
    }
)
private int cantidadLineas;
 

Y la clase del calculador:

package org.openxava.test.calculadores;
 
import java.sql.*;
 
import org.openxava.calculators.*;
import org.openxava.util.*;
 
/**
 * @author Javier Paniza
 */
public class CalculadorCantidadLineas implements IJDBCCalculator {    // 1
 
    private IConnectionProvider provider;
    private int año;
    private int numero;
 
    public void setConnectionProvider(IConnectionProvider provider) { // 2
        this.provider = provider;
    }
 
    public Object calculate() throws Exception {
        Connection con = provider.getConnection();
        try {
            PreparedStatement ps = con.prepareStatement(
                "select count(*) from XAVATEST.LINEAFACTURA “ +
                “where FACTURA_AÑO = ? and FACTURA_NUMERO = ?");
            ps.setInt(1, getAño());
            ps.setInt(2, getNumero());
            ResultSet rs = ps.executeQuery();
            rs.next();
            Integer result = new Integer(rs.getInt(1));
            ps.close();
            return result;
        }
        finally {
            con.close();
        }
    }
 
    public int getAño() {
        return año;
    }
 
    public int getNumero() {
        return numero;
    }
 
    public void setAño(int año) {
        this.año = año;
    }
 
    public void setNumero(int numero) {
        this.numero = numero;
    }
 
}

Para usar JDBC nuestro calculador tiene que implementar IJDBCCalculator (1) y entonces recibirá un IConnectionProvider (2) que podemos usar dentro de calculate().
OpenXava dispone de un conjunto de calculadores incluidos de uso genérico, que se pueden encontrar en org.openxava.calculators.

Valores por defecto al crear

Podemos indicar que el valor sea calculado justo antes de crear (insertar en la base de datos) un objeto por primera vez.
Usualmente para las claves usamos el estándar JPA. Por ejemplo, si queremos usar una columna identity (auto incremento) como clave:

@Id @Hidden
@GeneratedValue(strategy=GenerationType.IDENTITY)
private Integer id;
 

Podemos usar otras técnicas de generación, por ejemplo, una sequence de base de datos puede ser definida usando el estándar JPA de esta manera:

@SequenceGenerator(name="SIZE_SEQ", sequenceName="SIZE_ID_SEQ", allocationSize=1 )
@Hidden @Id @GeneratedValue(strategy=GenerationType.SEQUENCE, generator="SIZE_SEQ")
private Integer id;
 

Si queremos generar un identificador único de tipo String y 32 caracteres, podemos usar una extensión de Hibernate de JPA:

@Id @GeneratedValue(generator="system-uuid") @Hidden
@GenericGenerator(name="system-uuid", strategy = "uuid")
private String oid;
 

Ver la sección 9.1.9 de la especificación JPA 1.0 (parte de JSR-220) para aprender más sobre @GeneratedValues.
Si queremos usar nuestra propia lógica para generar el valor al crear, o bien queremos generar un nuevo valor para propiedades que no son clave entonces no podemos usar el @GeneratedValue de JPA, aunque es fácil resolver estos casos con JPA. Solo necesitamos añadir este código a nuestra clase:

@PrePersist
private void calcularContador() {
    contador = new Long(System.currentTimeMillis()).intValue();
}
 

La anotación JPA @PrePersist hace que este método se ejecute antes de insertar datos por primera vez en la base de datos, en este método podemos calcular el valor para nuestra clave o incluso para propiedades no clave con nuestra propia lógica.

Validador de propiedad

Un validador de propiedad (@PropertyValidator) ejecuta la lógica de validación sobre el valor que se vaya a asignar a esa propiedad antes de grabar. Una propiedad puede tener varios validadores:

@PropertyValidators ({
    @PropertyValidator(value=ValidadorExcluirCadena.class, properties=
        @PropertyValue(name="cadena", value="MOTO")
    ),
    @PropertyValidator(value=ValidadorExcluirCadena.class, properties=
        @PropertyValue(name="cadena", value="COCHE"),
        onlyOnCreate=true
    )
})
private String descripcion;

La forma de configurar el validador (con los @PropertyValue) es exactamente igual como en los calculadores. Con el atributo onlyOnCreate=”true” se puede definir que esa validación solo se ejecute cuando se crea el objeto, y no cuando se modifica.
El código del validador es:

package org.openxava.test.validadores;
 
import org.openxava.util.*;
import org.openxava.validators.*;
 
/**
 * @author Javier Paniza
 */
 
public class ValidadorExcluirCadena implements IPropertyValidator { // (1)
 
    private String cadena;
 
    public void validate(
        Messages errores,                                   // (2)
        Object valor,                                       // (3)
        String nombreObjecto,                               // (4)
        String nombrePropiedad)                             // (5)
        throws Exception {
        if (valor==null) return;
        if (valor.toString().indexOf(getCadena()) >= 0) {
            errores.add("excluir_cadena",
                nombrePropiedad, nombreObjeto, getCadena());
        }
    }
 
    public String getCadena() {
        return cadena==null?"":cadena;
    }
 
    public void setCadena(String cadena) {
        this.cadena = cadena;
    }
 
}

Un validador ha de implementar IPropertyValidator (1), esto le obliga a tener un método validate() en donde se ejecuta la validación de la propiedad. Los argumentos del método validate() son:

1. Messages errores: Un objeto de tipo Messages que representa un conjunto de mensajes (una especie de colección inteligente) y es donde podemos añadir los problemas de validación que encontremos.
2. Object valor: El valor a validar.
3. String nombreObjeto: Nombre del objeto al que pertenece la propiedad a validar. Útil para usarlo en los mensajes de error.
4. String nombrePropiedad: Nombre de la propiedad a validar. Útil para usarlo en los mensajes de error.

Como se ve cuando encontramos un error de validación solo tenemos que añadirlo (con errores.add()) enviando un identificador de mensaje y los argumentos. Para que este validador produzca un mensaje significativo tenemos que tener en nuestro archivo de mensajes i18n la siguiente entrada:

excluir_cadena={0} no puede contener {2} en {1}

Si el identificador que se envía no está en el archivo de mensajes, sale tal cual al usuario; pero lo recomendado es siempre usar identificadores del archivo de mensajes.
La validación es satisfactoria si no se añaden mensajes y se supone fallida si se añaden. El sistema recolecta todos los mensajes de todos los validadores antes de grabar y si encuentra los visualiza al usuario y no graba.
El paquete org.openxava.validators contiene algunos validadores de uso común.

Validador por defecto (nuevo en v2.0.3)

Podemos definir validadores por defecto para las propiedades de cierto tipo o estereotipo. Para esto se usa el archivo xava/validadores.xml de nuestro proyecto para definir en él los validadores por defecto.
Por ejemplo, podemos definir en nuestro xava/validadores.xml lo siguiente:

<validadores>
    <validador-defecto>
        <clase-validador
            clase="org.openxava.test.validadores.ValidadorNombrePersona"/>
        <para-estereotipo stereotipo="NOMBRE_PERSONA"/>
    </validador-defecto>
</validadores>

En este caso estamos asociando el validador ValidadorNombrePersona al estereotipo NOMBRE_PERSONA. Ahora si definimos una propiedad como la siguiente:

@Required @Stereotype("NOMBRE_PERSONA")
private String nombre;

Esta propiedad será validada usando ValidadorNombrePersona aunque la propiedad misma no defina ningun validador. ValidadorNombrePersona se aplica a todas las propiedades con el estereotipo NOMBRE_PERSONA.
Podemos también asignar validadores por defecto a un tipo.
En el archivo validadores.xml podemos definir también los validadores para determinar si un valor requerido está presente (ejecutado cuando usamos @Required). Además podemos asignar nombre (alias) a las clases de los validadores.
Podemos aprender más sobre los validadores examinando OpenXava/xava/validators.xml y OpenXavaTest/xava/validators.xml.

Referencias

Una referencia hace que desde una entidad o agregado se pueda acceder otra entidad o agregado. Una referencia se traduce a código Java como una propiedad (con su getter y su setter) cuyo tipo es el del modelo al que se referencia. Por ejemplo un Cliente puede tener una referencia a su Comercial, y así podemos escribir código Java como éste:

Cliente cliente = ...
cliente.getComercial().getNombre();
 

para acceder al nombre del comercial de ese cliente.
La sintaxis para definir referencias es:

@Required                                                 // 1
@Id                                                       // 2
@DefaultValueCalculator                                   // 3
@ManyToOne(                                               // 4
    optional=false                                        // 1
)
private tipo nombreReferencia;                            // 4
public tipo getNombreReferencia() { ... }                 // 4
public void setNombreReferencia(tipo nuevoValor) { ... }  // 4

1. @ManyToOne(optional=false) (JPA), @Required (OX) (opcional, el JPA es el preferido): Indica si la referencia es requerida. Al grabar OpenXava comprobará si las referencias requeridas están presentes, si no lo están no se producirá la grabación y se devolverá una lista de errores de validación.
2. @Id (JPA, opcional): Para indicar si la referencia forma parte de la clave. La combinación de propiedades y referencias clave se debe mapear a un conjunto de campos en la base de datos que no tengan valores repetidos, típicamente con la clave primaria.
3. @DefaultValueCalculator (OX, one, opcional): Para implementar la lógica para calcular el valor inicial de la referencia. Este calculador ha de devolver el valor de la clave, que puede ser un dato simple (solo si la clave del objeto referenciado es simple) o un objeto clave (un objeto especial que envuelve la clave primaria).
4. Declaración de la referencia: Una declaración de referencia convencional de Java con sus getters y setters. La referencia se marca con @ManyToOne (JPA) y el tipo ha de ser otra entidad.

Un pequeño ejemplo de referencias:

@ManyToOne
private Comercial comercial;                    // 1
public Comercial getComercial() {
    return comercial;
}
public void setComercial(Comercial comercial) {
    this.comercial = comercial;
}
 
@ManyToOne(fetch=FetchType.LAZY)
private Comercial comercialAlternativo;         // 2
public Comercial getComercialAlternativo() {
    return comercialAlternativo;
}
public void setComercialAlternativo(Comercial comercialAlternativa) {
    this.comercialAlternativo = comercialAlternativo;
}
 

1. Una referencia llamada comercial a la entidad Comercial.
2. Una referencia llamada comercialAlternativo a la entidad Comercial. En este caso usamos fetch=FetchType.LAZY, de esta manera los datos son leidos de la base de datos bajo demanda. Este es el enfoque más eficiente, pero no es el valor por defecto en JPA, por tanto es aconsejable usar siempre fetch=FetchType.LAZY al declarar las referencias.

Si asumimos que esto está en una entidad llamada Cliente, podemos escribir:

Cliente cliente = ...
Comercial comercial = cliente.getComercial();
Comercial comercialAlternativo = cliente.getComercialAlternativo();
 

Calculador valor por defecto en referencias

En una referencia @DefaultValueCalculator funciona como en una propiedad, solo que hay que devolver el valor de la clave de la referencia.
Por ejemplo, en el caso de una referencia con clave simple podemos poner:

@ManyToOne(optional=false, fetch=FetchType.LAZY) @JoinColumn(name="FAMILY")
@DefaultValueCalculator(value=IntegerCalculator.class, properties=
    @PropertyValue(name="value", value="2")
)
private Familia familia;

El método calculate() de este calculador es:

public Object calculate() throws Exception {
    return new Integer(value);
}
 

Como se puede ver se devuelve un entero, es decir, el valor para familia por defecto es la familia cuyo código es el 2.
En el caso de clave compuesta sería así:

@ManyToOne(fetch=FetchType.LAZY)
@JoinColumns({
    @JoinColumn(name="ZONA", referencedColumnName="ZONA"),
    @JoinColumn(name="ALMACEN", referencedColumnName="CODIGO")
})
@DefaultValueCalculator(CalculadorDefectoAlmacen.class)
private Almacen almacen;

Y el código del calculador:

package org.openxava.test.calculadores;
 
import org.openxava.calculators.*;
 
/**
 * @author Javier Paniza
 */
public class CalculadorDefectoAlmacen implements ICalculator {
 
    public Object calculate() throws Exception {
        AlmacenKey clave = new AlmacenKey();
        clave.setNumber(4);
        clave.setZoneNumber(4);
        return clave;
    }
 
}

Devuelve un objeto de tipo AlmacenKey.

Usar referencias como clave

Podemos usar referencias como clave, o como parte de la clave. Hemos de declarar la referencia como
@Id, y usar una clase clave, como sigue:

@Entity
@IdClass(DetalleAdicionalKey.class)
public class DetalleAdicional {
 
    // JoinColumn se especifica también en DetalleAdicionalKey por un
    // bug de Hibernate, ver http://opensource.atlassian.com/projects/hibernate/browse/ANN-361
    @Id @ManyToOne(fetch=FetchType.LAZY)
    @JoinColumn(name="SERVICIO")
    private Servicio servicio;
 
    @Id @Hidden
    private int contador;
 
    ...
 
}

Además, necesitamos escribir la clase clave:

public class DetalleAdicionalKey implements java.io.Serializable {
 
    @ManyToOne(fetch=FetchType.LAZY)
    @JoinColumn(name="SERVICIO")
    private Servicio servicio;
 
    @Hidden
    private int contador;
 
    // equals, hashCode, toString, getters y setters
    ...
 
 }

Necesitamos escribir la clase clave aunque la clave sea solo una referencia con una sola columna clave.
Es mejor usar esta característica sólo cuando estemos trabajando contra bases de datos legadas, si tenemos control sobre el esquema es mejor usar un id autogenerado.

Colecciones

Podemos definir colecciones de referencias a entidades. Una colección es una propiedad Java que devuelve java.util.Collection.
Aquí la sintaxis para definir una colección:

@Size                                                                // 1
@Condition                                                           // 2
@OrderBy                                                             // 3
@XOrderBy                                                            // 4
@OneToMany/@ManyToMany                                               // 5
private Collection<tipo> nombreColeccion;                            // 5
public Collection<tipo> getNombreColeccion() { ... }                 // 5
public void setNombreColeccion(Collection<tipo> nuevoValor) { ... }  // 5
 

1. @Size (HV, opcional): Cantidad mínima (min) y/o máxima (max) de elementos esperados. Esto se valida antes de grabar.
2. @Condition (OX, opcional): Para restringir los elementos que aparecen en la colección.
3. @OrderBy (JPA, opcional): Para que los elementos de la colección aparezcan en un determinado orden.
4. @XOrderBy (OX, opcional): @OrderBy de JPA no permite usar propiedades calificadas (propiedades de referencias). @XOrderBy sí lo permite.
5. Declaracion de la colección: Una declaración de colección convencional de Java con sus getters y setters. La colección se marca con @OneToMany (JPA) o @ManyToMany (JPA) y el tipo ha de ser otra entidad.

Vamos a ver algunos ejemplos. Empecemos por uno simple:

@OneToMany (mappedBy="factura")
private Collection<Albaran> albaranes;
public Collection<Albaran> getAlbaranes() {
    return albaranes;
}
public void setAlbaranes(Collection<Albaran> albaranes) {
    this.albaranes = albaranes;
}
 

Si ponemos esto dentro de una Factura, estamos definiendo una colección de los albaranes asociados a esa Factura. La forma de relacionarlo se hace en la parte del mapeo objeto-relacional. Usamos mappedBy="factura" para indicar que la referencia factura de Albaran se usa para mapear esta colección.
Ahora podemos escribir código como este:

Factura factura = ...
for (Albaran albaran: factura.getAlbaranes()) {
    albaran.hacerAlgo();
}

Para hacer algo con todos los albaranes asociados a una factura.
Vamos a ver otro ejemplo más complejo, también dentro de Factura:

@OneToMany (mappedBy="factura", cascade=CascadeType.REMOVE)  // 1
@OrderBy("tipoServicio desc")                                // 2
@org.hibernate.validator.Size(min=1)                         // 3
private Collection<LineaFactural> facturas;

1. Usar REMOVE como tipo de cascadaas cascade type hace que cuando el usuario borra una factura sus líneas también se borran.
2. Con @OrderBy obligamos a que las lineas se devuelvan ordenadas por tipoServicio.
3. La restricción de @Size(min=1) hace que sea obligado que haya al menos una línea para que la factura sea válida.

Tenemos libertad completa para definir como se obtienen los datos de una colección, con @Condition podemos sobreescribir la condición por defecto:

@Condition(
    "${almacen.codigoZona} = ${this.almacen.codigoZona} AND " +
    "${almacen.codigo} = ${this.almacen.codigo} AND " +
    "NOT (${codigo} = ${this.codigo})"
)
public Collection<Transportista> getCompañeros() {
    return null;
}

Si ponemos esta colección dentro de Transportista, podemos obtener todos los transportista del mismo almacén menos él mismo, es decir, la lista de sus compañeros. Es de notar como podemos usar this en la condición para referenciar al valor de una propiedad del objeto actual. @Condition solo aplica a la interfaz de usuario generada por OpenXava, si llamamos directamente a getFellowCarriers() it will be returns null.
Si con esto no tenemos suficiente, podemos escribir completamente la lógica que devuelve la colección. La colección anterior también se podría haber definido así:

public Collection<Transportista> getCompañeros() {
    Query query = XPersistence.getManager().createQuery("from Transportista t where " +
        "t.almacen.codigoZona = :zona AND " +
        "t.almacen.codigo = :codigoAlmacen AND " +
        "NOT (t.codigo = :codigo) ");
    query.setParameter("zona", getAlmacen().getCodigoZona());
    query.setParameter("codigoAlmacen", getAlmacen().getCodigo());
    query.setParameter("codigo",  getCodigo());
    return query.getResultList();
}

Como se ve es un método getter. Obviamente ha de devolver una java.util.Collection cuyos elementos sean de tipo Transportista.
Las referencias de las colecciones se asumen bidireccionales, esto quiere decir que si en un Comercial tengo una colección clientes, en Cliente tengo que tener una referencia a Comercial. Pero puede ocurrir que en Cliente tenga más de una referencia a Comercial (por ejemplo, comercial y comercialAlternativo) y entonce JPA no sabe cual escoger, por eso tenemos el atributo mappedBy de @OneToMany. En este caso pondríamos:

@OneToMany(mappedBy="comercial")
private Collection<Cliente> clientes;

Para indicar que es la referencia comercial y no comercialAlternativo la que vamos a usar para esta colección.
La anotación @ManyToMany (JPA) permite definir una colección con una multiciplidad de muchos-a-muchos. Como sigue:

@Entity
public class Cliente {
    ...
    @ManyToMany
    private Collection<Provincia> provincias;
    ...
}
 

En este caso un cliente tiene una colección de provincias, pero una misma provincia puede estar presente en varios clientes.

Métodos

Los métodos se definen en una entidad OpenXava (mejor dicho, en una entidad JPA) como una clase de Java convencional. Por ejemplo:

public void incrementarPrecio() {
    setPrecioUnitario(getPrecioUnitario().multiply(new BigDecimal("1.02")).setScale(2));
}

Los métodos son la salsa de los objetos, sin ellos solo serían caparazones tontos alrededor de los datos. Cuando sea posible es mejor poner la lógica de negocio en los métodos (capa del modelo) que en las acciones (capa del controlador).

Buscadores

Un buscador es método estático especial que nos permite buscar un objeto o una colección de objetos que sigue algún criterio.
Algunos ejemplos:

public static Cliente findByCodigo(int codigo) throws NoResultException {
    Query query = XPersistence.getManager().createQuery(
    "from Cliente as o where o.codigo = :codigo");
    query.setParameter("codigo", codigo);
    return (Cliente) query.getSingleResult();
}
 
public static Collection findTodos()  {
    Query query = XPersistence.getManager().createQuery("from Cliente as o");
    return query.getResultList();
}
 
public static Collection findByNombreLike(String nombre)  {
    Query query = XPersistence.getManager().createQuery(
    "from Cliente as o where o.nombre like :nombre order by o.nombre desc");
    query.setParameter("nombre", nombre);
    return query.getResultList();
}

Estos métodos se pueden usar de esta manera:

Cliente cliente = Cliente.findByCodigo(8);
Collection javieres = Cliente.findByNombreLike(“%JAVI%”);

Como se ve, usar método buscadores produce un código más legible que usando la verbosa API de JPA. Pero esto es solo una recomendación de estilo, podemos escoger no escribir métodos buscadores y usar directamente consultas de JPA.

Validador de entidad

Este validador (@EntityValidator) permite poner una validación a nivel de modelo. Cuando necesitamos hacer una validación sobre varias propiedades del modelo, y esta validación no corresponde lógicamente a ninguna de ellas se puede usar este tipo de validación.
Su sintaxis es:

@EntityValidator(
    value=clase,                        // 1
    onlyOnCreate=(true|false),          // 2
    properties={ @PropertyValue ... }   // 3
)

1. value (opcional, obligada si no se especifica nombre): Clase que implementa la validación. Ha de ser del tipo IValidator.
2. onlyOnCreate (opcional): Si true el validador es ejecutado solo cuando estamos creando un objeto nuevo, no cuando modificamos uno existente. El valor por defecto es false.
3. properties (varios @PropertyValue, opcional): Para establecer valor a las propiedades del validador antes de ejecutarse.

Un ejemplo:

@EntityValidator(value=org.openxava.test.validadores.ValidadorProductoBarato.class, properties= {
    @PropertyValue(name="limite", value="100"),
    @PropertyValue(name="descripcion"),
    @PropertyValue(name="precioUnitario")
})
public class Producto {

Y el código del validador:

package org.openxava.test.validadores;
 
import java.math.*;
 
/**
 * @author Javier Paniza
 */
 
public class ValidadorProductoBarato implements IValidator {         // 1
 
    private int limite;
    private BigDecimal precioUnitario;
    private String descripcion;
 
    public void validate(Messages errores) {                         // 2
        if (getDescripcion().indexOf("CHEAP") >= 0 ||
            getDescripcion().indexOf("BARATO") >= 0 ||
            getDescripcion().indexOf("BARATA") >= 0) {
            if (getLimiteBd().compareTo(getPrecioUnitario()) < 0) {
                errors.add("producto_barato", getLimiteBd());        // 3
            }
        }
    }
 
    public BigDecimal getPrecioUnitario() {
        return precioUnitario;
    }
 
    public void setPrecioUnitario(BigDecimal decimal) {
        precioUnitario = decimal;
    }
 
    public String getDescripcion() {
        return descripcion==null?"":descripcion;
    }
 
    public void setDescripcion(String string) {
        descripcion = string;
    }
 
    public int getLimite() {
        return limite;
    }
 
    public void setLimite(int i) {
        limite = i;
    }
 
    private BigDecimal getLimiteBd() {
        return new BigDecimal(Integer.toString(limite));
    }
 
}
 

Este validador ha de implementar IValidator (1), lo que le obliga a tener un método validate(Messages messages) (2). En este método solo hay que añadir identificadores de mensajes de error (3) (cuyos textos estarán en los archivos i18n), si en el proceso de validación (es decir en la ejecución de todos los validadores) hubiese al menos un mensaje de error, OpenXava no graba la información y visualiza los mensajes al usuario.
En este caso vemos como se accede a descripcion y precioUnitario, por eso la validación se pone a nivel de módelo y no a nivel de propiedad individual, porque abarca más de una propiedad.
Podemos definir más de un validador por entidad usando @EntityValidators, como sigue:

@EntityValidators({
    @EntityValidator(value=org.openxava.test.validadores.ValidadorProductoBarato.class, properties= {
        @PropertyValue(name="limite", value="100"),
        @PropertyValue(name="descripcion"),
        @PropertyValue(name="precioUnitario")
    }),
    @EntityValidator(value=org.openxava.test.validadores.ValidadorProductoCaro.class, properties= {
        @PropertyValue(name="limite", value="1000"),
        @PropertyValue(name="descripcion"),
        @PropertyValue(name="precioUnitario")
    }),
    @EntityValidator(value=org.openxava.test.validadores.ValidadorPrecioProhibido.class,
        properties= {
            @PropertyValue(name="precioProhibido", value="555"),
            @PropertyValue(name="precioUnitario")
        },
        onlyOnCreate=true
    )
})
public class Product {

Validador al borrar

El @RemoveValidator también es un validador a nivel de modelo, la diferencia es que se ejecuta antes de borrar el objeto, y tiene la posibilidad de vetar el borrado.
Su sintaxis es:

@RemoveValidator(
    value=clase,                        // 1
    properties={ @PropertyValue ... }   // 2
)
 

1. clase (obligada): Clase que implementa la validación. Ha de ser del tipo IRemoveValidator.
2. properties (varios @PropertyValue, opcional): Para establecer valor a las propiedades del calculador antes de ejecutarse.

Un ejemplo puede ser:

@RemoveValidator(value=ValidadorBorrarTipoAlbaran.class,
    properties=@PropertyValue(name="codigo")
)
public class TipoAlbaran {

Y el validador:

package org.openxava.test.validadores;
 
import org.openxava.test.model.*;
import org.openxava.util.*;
import org.openxava.validators.*;
 
/**
 * @author Javier Paniza
 */
public class ValidadorBorrarTipoAlbaran implements IRemoveValidator {                      // 1
 
    private TipoAlbaran tipoAlbaran;
    private int codigo; // Usamos esto (en vez de obtenerlo de tipoAlbaran)
                // para probar @PropertyValue con propiedades simples
 
    public void setEntity(Object entidad) throws Exception {                               // 2
        this.tipoAlbaran = (TipoAlbaran) entidad;
    }
 
    public void validate(Messages errores) throws Exception {
        if (!tipoAlbaran.getAlbaranes().isEmpty()) {
            errores.add("no_borrar_tipo_albaran_si_albaranes", new Integer(getCodigo()));  // 3
        }
    }
 
    public int getCodigo() {
        return codigo;
    }
 
    public void setCodigo(int codigo) {
        this.codigo = codigo;
    }
 
}

Como se ve tiene que implementar IRemoveValidator (1) lo que le obliga a tener un método setEntity() (2) con el recibirá el objeto que va a ser borrado. Si hay algún error de validación se añade al objeto de tipo Messages enviado a validate() (3). Si después de ejecutar todas las validaciones OpenXava detecta al menos 1 error de validación no realizará el borrado del objeto y enviará la lista de mensajes al usuario.
En este caso si se comprueba si hay albaranes que usen este tipo de albarán antes de poder borrarlo.
Tal y como ocurre con @EntityValidator podemos usar varios @RemoveValidator por entidad usando la anotación @RemoveValidators.

Métodos de retrollamada de JPA

Con @PrePersist podemos indicar que se ejecute cierta lógica justo antes de crear el objeto como persistente.
Como sigue:

@PrePersist
private void antesDeCrear() {
    setDescripcion(getDescripcion() + " CREADO");
}

En este caso cada vez que se graba por primera vez un TipoAlbaran se añade un sufijo a su descripción.
Como se ve es exactamente igual que cualquier otro método solo que este se ejecuta automáticamente antes de crear.
Con @PreUpdate podemos indicar que se ejecute cierta lógica justo después de modificar un objeto y justo antes de actualizar su contenido en la base de dato, esto es justo antes de hacer el UPDATE.
Como sigue:

@PreUpdate
private void antesDeModificar() {
    setDescripcion(getDescripcion() + " MODIFICADO");
}

En este caso cada vez que se modifica un TipoAlbaran se añade un sufijo a su descripción.
Como se ve es exactamente igual que cualquier otro método solo que este se ejecuta automáticamente antes de modificar.
Podemos usar todas las anotaciones JPA de retrollamada: @PrePersist, @PostPersist, @PreRemove, @PostRemove, @PreUpdate, @PostUpdate y @PostLoad.

Clases incrustables (Embeddable)

Tal y como indica la especificación JPA:
"Una entidad puede usar otras clases finamente granuladas para representar su estado. Instancias de estas clases, no como en el caso de las entidades, no tiene identidad persistente. En vez de eso, existen solo como objetos incrustados de una entidad a la que pertenecen. Estos objetos incrustados son propiedad exclusiva de sus entidades dueñas, y no se comparten entre entidades persistentes."
La sintaxis para una clase incrustada es:

@Embeddable                      // 1
public class NombreIncrustada {  // 2
  // Propiedades                 // 3
  // Referencias                 // 4
  // Metodos                     // 5
}
 

1. @Embeddable (JPA, una, requerido): Indica que esta clase es una clase incrustada de JPA, en otras palabras, sus instancias serán parte de objetos persistente.
2. Declaración de la clase: Como una clase Java convencional. Podemos uar extends y implements.
3. Properties: Propiedades Java convencionales.
4. References: Referencias a entidades. Esto no esta soportado en JPA 1.0 (EJB 3.0), pero la implementación de Hibernate lo soporta.
5. Métodos: Métodos Java con lógica de negocio.

Referencias incrustadas

Este ejemplo es una Direccion incrustada (anotada con @Embedded) que es referenciada desde la entidad principal.
En la entidad principal podemos escribir:

@Embedded
private Direccion direccion;
 

Y hemos de definir la clase Direccion como incrustable:

package org.openxava.test.model;
 
import javax.persistence.*;
import org.openxava.annotations.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Embeddable
public class Direccion implements IConPoblacion {
 
    @Required @Column(length=30)
    private String calle;
 
    @Required @Column(length=5)
    private int codigoPostal;
 
    @Required @Column(length=20)
    private String poblacion;
 
    // ManyToOne dentro de un Embeddable no está soportado en JPA 1.0 (ver en 9.1.34),
    // pero la implementación de Hibernate lo soporta.
    @ManyToOne(fetch=FetchType.LAZY, optional=false) @JoinColumn(name="STATE")
    private Provincia provincia;
 
    public String getPoblacion() {
        return poblacion;
    }
 
    public void setPoblacion(String poblacion) {
        this.poblacion = poblacion;
    }
 
    public String getCalle() {
        return calle;
    }
 
    public void setCalle(String calle) {
        this.calle = calle;
    }
 
    public int getCodigoPostal() {
        return codigoPostal;
    }
 
    public void setCodigoPostal(int codigoPostal) {
        this.codigoPostal = codigoPostal;
    }
 
    public Provincia getProvincia() {
        return provincia;
    }
 
    public void setProvincia(Provincia provincia) {
        this.provincia = provincia;
    }
 
}

Como se ve una clase incrustable puede implementar una interfaz (1) y contener referencias (2), entre otras cosas, pero no puede tener colecciones persistentes ni usar métodos de retrollamada de JPA.
Este código se puede usar así, para leer:

Cliente cliente = ...
Direccion direccion = cliente.getDireccion();
direccion.getCalle(); // para obtener el valor

O así para establecer una nueva dirección

// para establecer una nueva dirección
Direccion direccion = new Direccion();
direccion.setCalle(“Mi calle”);
direccion.setCodigoPostal(46001);
direccion.setMunicipio(“Valencia”);
direccion.setProvincia(provincia);
cliente.setDireccion(direccion);

En este caso que tenemos una referencia simple, el código generado es un simple JavaBean, cuyo ciclo de vida esta asociado a su objeto contenedor, es decir, la Direccion se borrará y creará junto al Cliente, jamas tendrá vida propia ni podrá ser compartida por otro Cliente.

Colecciones incrustadas

Las colecciones incrustadas no se soportan en JPA 1.0. Pero podemos simularlas usando colecciones a entidades con tipo de cascada REMOVE o ALL. OpenXava trata estas colecciones de una manera especial, como si fueran colecciones incrustadas.
Ahora un ejemplo de una colección incrustada. En la entidad principal (por ejemplo de Factura) podemos poner:

@OneToMany (mappedBy="factura", cascade=CascadeType.REMOVE)
private Collection<LineaFactura> lineas;

Es de notar que usamos CascadeType.REMOVE y LineaFactura es una entidad y no una clase incrustable:

package org.openxava.test.model;
 
import java.math.*;
 
import javax.persistence.*;
 
import org.hibernate.annotations.Columns;
import org.hibernate.annotations.Type;
import org.hibernate.annotations.Parameter;
import org.hibernate.annotations.GenericGenerator;
import org.openxava.annotations.*;
import org.openxava.calculators.*;
import org.openxava.test.validators.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Entity
@EntityValidator(value=ValidadorLineaFactura.class,
    properties= {
        @PropertyValue(name="factura"),
        @PropertyValue(name="oid"),
        @PropertyValue(name="producto"),
        @PropertyValue(name="precioUnitario")
    }
)
public class LineaFactura {
 
    @ManyToOne // 'Lazy fetching' produce un falla al borrar una linea desde la factura
    private Factura factura;
 
    @Id @GeneratedValue(generator="system-uuid") @Hidden
    @GenericGenerator(name="system-uuid", strategy = "uuid")
    private String oid;
 
    private TipoServicio tipoServicio;
    public enum TipoServicio { ESPECIAL, URGENTE }
 
    @Column(length=4) @Required
    private int cantidad;
 
    @Stereotype("DINERO") @Required
    private BigDecimal precioUnitario;
 
    @ManyToOne(fetch=FetchType.LAZY, optional=false)
    private Producto producto;
 
    @DefaultValueCalculator(CurrentDateCalculator.class)
    private java.util.Date fechaEntrega;
 
    @ManyToOne(fetch=FetchType.LAZY)
    private Comercial vendidoPor;
 
    @Stereotype("MEMO")
    private String observaciones;
 
    @Stereotype("DINERO") @Depends("precioUnitario, cantidad")
    public BigDecimal getImporte() {
        return getPrecioUnitario().multiply(new BigDecimal(getCantidad()));
    }
 
    public boolean isGratis() {
        return getImporte().compareTo(new BigDecimal("0")) <= 0;
    }
 
     @PostRemove
    private void postRemove() {
        factura.setComentario(factura.getComentario() + "DETALLE BORRADO");
    }
 
    public String getOid() {
        return oid;
    }
    public void setOid(String oid) {
        this.oid = oid;
    }
    public TipoServicio getTipoServicio() {
        return tipoServicio;
    }
    public void setTipoServicio(TipoServicio tipoServicio) {
        this.tipoServicio = tipoServicio;
    }
    public int getCantidad() {
        return cantidad;
    }
    public void setCantidad(int cantidad) {
        this.cantidad = cantidad;
    }
    public BigDecimal getPrecioUnitario() {
        return precioUnitario==null?BigDecimal.ZERO:precioUnitario;
    }
    public void setPrecioUnitario(BigDecimal precioUnitario) {
        this.precioUnitario = precioUnitario;
    }
 
    public Product getProducto() {
        return producto;
    }
 
    public void setProducto(Producto producto) {
        this.producto = producto;
    }
 
    public java.util.Date getFechaEntrega() {
        return fechaEntrega;
    }
 
    public void setFechaEntrega(java.util.Date fechaEntrega) {
        this.fechaEntrega = fechaEntrega;
    }
 
    public Seller getVendidoPor() {
        return vendidoPor;
    }
 
    public void setVendidoPor(Comercial vendidoPor) {
        this.vendidoPor = vendidoPor;
    }
 
    public String getObservaciones() {
        return observaciones;
    }
 
    public void setObservaciones(String observaciones) {
        this.observaciones = observaciones;
    }
 
    public Invoice getFactura() {
        return factura;
    }
 
    public void setFactura(Factura factura) {
        this.factura = factura;
    }
 
}

Como se ve esto es una entidad compleja, con calculadores, validadores, referencias y así por el estilo. También hemos de definir una referencia a su clase contenedora (factura). En este caso cuando una factura se borre todas sus líneas se borrarán también. Además hay diferencias a nivel de interface gráfica (podemos aprender más en el capítulo de la vista).

Herencia

OpenXava soporta la herencia de herencia de JPA y Java.
Por ejemplo podemos definer una superclase mapeada (@MappedSuperclass) de esta manera:

package org.openxava.test.model;
 
import javax.persistence.*;
 
import org.hibernate.annotations.*;
import org.openxava.annotations.*;
 
/**
 * Clase base para definir entidades con un oid UUID. <p>
 *
 * @author Javier Paniza
 */
 
@MappedSuperclass
public class Identificable {
 
    @Id @GeneratedValue(generator="system-uuid") @Hidden
    @GenericGenerator(name="system-uuid", strategy = "uuid")
    private String oid;
 
    public String getOid() {
        return oid;
    }
 
    public void setOid(String oid) {
        this.oid = oid;
    }
 
}
 

Podemos definir otra @MappedSuperclass que extienda de esta, por ejemplo:

package org.openxava.test.model;
 
import javax.persistence.*;
 
import org.openxava.annotations.*;
 
/**
 * Clase base para entidades con una propiedad 'nombre'. <p>
 *
 * @author Javier Paniza
 */
@MappedSuperclass
public class ConNombre extends Identifiable {
 
    @Column(length=50) @Required
    private String nombre;
 
    public String getNombre() {
        return nombre;
    }
 
    public void setNombre(String nombre) {
        this.nombre = nombre;
    }
 
}
 

Ahora podemos usar Identificable y ConNombre para definir nuestra entidades, como sigue:

package org.openxava.test.model;
 
import javax.persistence.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Entity
@DiscriminatorColumn(name="TYPE")
@DiscriminatorValue("HUM")
@Table(name="PERSONA")
@AttributeOverrides(
    @AttributeOverride(name="name", column=@Column(name="PNOMBRE"))
)
public class Humano extends ConNombre {
 
    @Enumerated(EnumType.STRING)
    private Sexo sexo;
    public enum Sexo { MASCULINO, FEMENINO };
 
    public Sexo getSexo() {
        return sexo;
    }
    public void setSexo(Sexo sexo) {
        this.sexo = sexo;
    }
 
}
 

Y ahora, la auténtica herencia de entidades, una entidad que extiende de otra entidad:

package org.openxava.test.model;
 
import javax.persistence.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Entity
@DiscriminatorValue("PRO")
public class Programador extends Humano {
 
    @Column(length=20)
    private String lenguajePrincipal;
 
    public String getLenguajePrincipal() {
        return lenguajePrincipal;
    }
 
    public void setLenguajePrincipal(String lenguajePrincipal) {
        this.lenguajePrincipal = lenguajePrincipal;
    }
 
}
 

Podemo crear un módulo OpenXava para Humano y Programador (no para Identificable ni ConNombre directamente). En el módulo de Programador el usuario puede acceder solo a programadores, por otra parte usando el módulo de Humano el usuario puede acceder a objetos de tipo Humano y Programador. Además cuando el usuario trata de visualizar el detalle de un Programador desde el módulo de Humano se mostrará la vista de Programador. Polimorfismo puro.
Sobre el mapeo, se soporta @AttributeOverrides , pero, de momento, solo la estrategia una única tabla por jerarquía de clases funciona.

Clave múltiple

La forma preferida para definir la clave de una entidad es una clave única autogenerada (anotada con @Id y @GeneratedValue), pero a veces, por ejemplo cuando vamos contra bases de datos legadas, necesitamos tener una entidad mapeada a una tabla que usa varias columnas como clave. Este caso se pude resolver con JPA (y por tanto con OpenXava) de dos formas, usando @IdClass o usando @EmbeddedId

Clase id

En este caso usamos @IdClass en nuestra entidad para indicar una clase clave, y marcamos las propiedades clave como @Id en nuestra entidad:

package org.openxava.test.model;
 
import javax.persistence.*;
 
import org.openxava.annotations.*;
import org.openxava.jpa.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Entity
@IdClass(AlmacenKey.class)
public class Almacen {
 
    @Id
    // Column también se especifica en AlmacenKey por un bug en Hibernate, ver
    // http://opensource.atlassian.com/projects/hibernate/browse/ANN-361
    @Column(length=3, name="ZONA")
    private int codigoZona;
 
    @Id @Column(length=3)
    private int codigo;
 
    @Column(length=40) @Required
    private String nombre;
 
 
    public String getNombre() {
        return nombre;
    }
 
    public void setNombre(String nombre) {
        this.nombre = nombre;
    }
 
    public int getCodigo() {
        return codigo;
    }
 
    public void setCodigo(int codigo) {
        this.codigo = codigo;
    }
 
    public int getCodigoZona() {
        return codigoZona;
    }
 
    public void setCodigoZona(int codigoZona) {
        this.codigoZona = codigoZona;
    }
 
}
 

También necesitamos declarar una clase id, una clase serializable normal y corriente con todas las propiedades clave de la entidad:

package org.openxava.test.model;
 
import java.io.*;
import javax.persistence.*;
 
/**
 *
 * @author Javier Paniza
 */
 
public class AlmacenKey implements Serializable {
 
    @Column(name="ZONE")
    private int codigoZona;
    private int codigo;
 
    @Override
    public boolean equals(Object obj) {
        if (obj == null) return false;
        return obj.toString().equals(this.toString());
    }
 
    @Override
    public int hashCode() {
        return toString().hashCode();
    }
 
    @Override
    public String toString() {
        return "AlmacenKey::" + codigoZona + ":" + codigo;
    }
 
    public int getCodigo() {
        return codigo;
    }
 
    public void setCodigo(int codigo) {
        this.codigo = codigo;
    }
 
    public int getCodigoZona() {
        return codigoZona;
    }
 
    public void setCodigoZona(int codigoZona) {
        this.codigoZona = codigoZona;
    }
 
}

Id inscrustado

En este case tenemos una referencia a un objeto incrustado (@Embeddable) marcada como @EmbeddedId:

package org.openxava.test.model;
 
import javax.persistence.*;
 
import org.openxava.annotations.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Entity
public class Almacen {
 
    @EmbeddedId
    private AlmacenKey clave;
 
    @Column(length=40) @Required
    private String nombre;
 
    public AlmacenKey getClave() {
        return clave;
    }
 
    public void setClave(AlmacenKey clave) {
        this.clave = clave;
    }
 
    public String getNombre() {
        return nombre;
    }
 
    public void setNombre(String nombre) {
        this.nombre = nombre;
    }
 
}
 

Y nuestra clave es una clase incrustable que contiene las propiedades clave:

package org.openxava.test.model;
 
import javax.persistence.*;
 
/**
 *
 * @author Javier Paniza
 */
 
@Embeddable
public class AlmacenKey implements java.io.Serializable {
 
 
    @Column(length=3, name="ZONA")
    private int codigoZona;
 
    @Column(length=3)
    private int codigo;
 
    public int getCodigo() {
        return codigo;
    }
 
    public void setCodigo(int codigo) {
        this.codigo = codigo;
    }
 
    public int getCodigoZona() {
        return codigoZona;
    }
 
    public void setCodigoZona(int codigoZona) {
        this.codigoZona = codigoZona;
    }
 
}