Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Plataforma para El Desarrollo Rápido de Aplicaciones Empresariales
Plataforma para El Desarrollo Rápido de Aplicaciones Empresariales
gclid=Cj0KCQjwx7zzBRCcARIsABPRscPsC0MpIY29dmwMJpvpuJNEO3RMnFAboKZdJZxNMF-
IZhgQ-TX3RL8aAv2nEALw_wcB
https://openxava.org/downloads/confirmed/
openxava
Plataforma para el desarrollo rápido de
aplicaciones empresariales.
Escribe una pequeña cantidad de código.
Obtén una aplicación completa lista para
producción.
Alta productividad
XavaPro 6.3 disponible
XavaPro 6.3 tiene las siguientes novedades:
Leer más
infoopenxava.org
Curso: 1. Primeros pasos | 2. Modelar con Java | 3. Pruebas
automáticas | 4. Herencia | 5. Lógica de negocio básica | 6. Validación
avanzada | 7. Refinar el comportamiento predefinido | 8. Comportamiento y
lógica de negocio | 9. Referencias y colecciones | A. Arquitectura y filosofía | B.
Java Persistence API | C. Anotaciones
Instalar OpenXava
Ve a www.openxava.org y descarga la última distribución de OpenXava.
Es un archivo zip, algo así como openxava-6.x.zip. Simplemente
descomprímelo y tendrás un entorno listo para empezar a desarrollar.
Algo como esto:
Como ves, las distribución de OpenXava incluye un workspace de
Eclipse configurado y listo para usar. Empecemos a trabajar.
Crear el proyecto
Arranca tu Eclipse y abre el workspace de OpenXava con él (File >
Switch Workspace):
Con esto tienes el código suficiente (justo una clase) para ejecutar tu
aplicación. Hagámoslo.
Ejecutar la aplicación
Lo primero es contruir el proyecto pulsando el botón Build All o
presionando Ctrl-B:
Modificar la aplicación
A partir de ahora, desarrollar con OpenXava es muy fácil.
Simplemente, escribes una clase y ya puedes ver el resultado en el
navegador. Probémoslo.
Crea una nueva entidad para Producto con el siguiente código:
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
import org.openxava.annotations.*;
@Entity
public class Producto {
@Id @Column(length=9)
private int numero;
@Column(length=50) @Required
private String descripcion;
Resumen
Después de esta lección tienes instalado Eclipse y OpenXava.
Además, lo tienes configurado todo para poder trabajar. Ahora, tienes
tu entorno listo para desarrollar tu aplicación.
También, tienes una primera versión de tu
aplicación Facturacion funcionando.
Pero lo más importante es que has aprendido cómo crear un nuevo
proyecto, una nueva clase, cómo ejecutar un módulo OpenXava y
algunas otra cosas útiles que usarás en el resto del curso.
Ya estás listo para pasar a la siguiente lección, sin embargo deberías
considerar adquirir un poco de conocimiento base, tal como:
@Entity
public class Categoria {
@Id
@Hidden // La propiedad no se muestra al usuario. Es un identificador
interno
@GeneratedValue(generator="system-uuid") // Identificador Universal
Único (1)
@GenericGenerator(name="system-uuid", strategy = "uuid")
@Column(length=32)
private String oid;
@Column(length=50)
private String descripcion;
...
Estereotipos
La entidad Producto necesita tener al menos precio, además estaría
bien que tuviese fotos y un campo para observaciones. Vamos a usar
estereotipos para conseguirlo. Un estereotipo especifica un uso
específico de un tipo. Por ejemplo, puedes usar String para almacenar
nombres, comentarios o identificadores, y puedes
usar BigDecimal para almacenar porcentajes, dinero o cantidades. Es
decir, hacemos diferentes usos del mismo tipo. Los estereotipo son
justo para marcar este uso específico.
La mejor forma de entender que es un estereotipo es verlo en acción.
Añadamos las propiedades precio, fotos y observaciones a tu
entidad Producto:
@Stereotype("DINERO") // La propiedad precio se usa para almacenar dinero
private BigDecimal precio; // Incluye el import java.math.* BigDecimal
se suele usar para dinero
import javax.persistence.*;
@Column(length = 5)
private int codigoPostal;
@Column(length = 20)
private String municipio;
@Column(length = 30)
private String provincia;
...
Clave compuesta
No vamos a usar una clave compuesta para Factura. Es mejor evitar
el uso de claves compuestas. Siempre tienes la opción de usar un
identificador oculto autogenerado. Aunque, algunas veces tienes la
necesidad de conectarte a bases de datos legadas o puede que el
diseño del esquema lo haya hecho alguien que le gustan las claves
compuestas, y no tengas otra opción que usar claves compuestas
aunque no sea lo ideal. Por lo tanto, vamos a aprender como usar una
clave compuesta, aunque al final cambiaremos a una clave simple
autogenerada.
Empecemos con una versión sencilla de la entidad Factura:
package com.tuempresa.facturacion.modelo;
import java.time.*;
import java.util.*;
import javax.persistence.*;
import org.openxava.annotations.*;
@Entity
@IdClass(FacturaKey.class) // La clase id contiene todas las propiedades
clave (1)
public class Factura {
@Id // Aunque tenemos las clase id aún es necesario marcarlo como @Id
(2)
@Column(length = 4)
private int anyo;
@Id // Aunque tenemos las clase id aún es necesario marcarlo como @Id
(2)
@Column(length = 6)
private int numero;
@Required
private LocalDate fecha;
@Stereotype("MEMO")
private String observaciones;
import java.time.*;
import java.util.*;
import javax.persistence.*;
import org.hibernate.annotations.GenericGenerator; // AÑADE ESTE IMPORT
import org.openxava.annotations.*;
@Entity
// @IdClass(FacturaKey.class) // QUITA LA ANOTACIÓN @IdClass
public class Factura {
...
@Required
@DefaultValueCalculator(CurrentLocalDateCalculator.class) // Fecha actual
private LocalDate fecha;
Las paquetes son la forma que tiene Java de organizar el código. Deberías
cambiar com.tuempresa por el dominio de tu organización, es decir si trabajas
para Telefónica el paquete para los calculadores debería
ser es.telefonica.facturacion.calculadores.
Ahora crea en él una clase CalculadorSiguienteNumeroParaAnyo, con
el siguiente código:
package com.tuempresa.facturacion.calculadores;
import javax.persistence.*;
import org.openxava.calculators.*;
import org.openxava.jpa.*;
Los valores por defecto son solo los valores iniciales, el usuario los
puede cambiar si así lo desea.
import javax.persistence.*;
@Embeddable
public class Detalle {
Cuando una vista tiene un nombre, como en este caso, esa vista solo
se usa cuando ese nombre se especifica. Es decir,
aunque Cliente solo tiene esta anotación @View, cuando tratas de
visualizar un Cliente no usará esta vista Simple, sino la generada por
defecto. Si defines una @View sin nombre, esa vista será la vista por
defecto, aunque este no es el caso.
Ahora has de indicar que la referencia a Cliente desde Factura use
esta vista Simple. Esto se hace mediante @ReferenceView:
@ManyToOne(fetch=FetchType.LAZY, optional=false)
@ReferenceView("Simple") // La vista llamada 'Simple' se usará para
visualizar esta referencia
private Cliente cliente;
Desarrollo ágil
Hoy en día el desarrollo ágil ya no es una “una técnica nueva y
rompedora”, sino una forma establecida de hacer desarrollo de
software, es más, es la forma ideal de desarrollar software para
muchos.
Si no estás familiarizado con el desarrollo ágil puedes echar un vistazo
a www.agilemanifesto.org. Básicamente, el desarrollo ágil favorece el
uso de retroalimentación obtenida de un producto funcional sobre un
diseño previo meticuloso. Esto da más protagonismo a los
programadores y usuarios, y minimiza la importancia de los analistas y
los arquitectos de software.
Este tipo de desarrollo necesita también un nuevo tipo de
herramientas. Porque necesitas una aplicación funcional rápidamente.
Tiene que ser tan rápido desarrollar la aplicación inicial como lo sería
escribir la descripción funcional. Además, necesitas responder a las
peticiones y opiniones del usuario rápidamente. El usuario necesita
ver sus propuestas funcionando en corto tiempo.
OpenXava es ideal para el desarrollo ágil no sólo porque permite un
desarrollo inicial muy rápido, sino porque también te permite hacer
cambios y ver su efecto instantáneamente. Veamos un pequeño
ejemplo de esto.
Por ejemplo, una vez que el usuario ve tu aplicación y empieza a jugar
con ella, se da cuenta que él trabaja con libros, música, programas y
así por el estilo. Todos estos productos tienen autor, y sería útil
almacenar el autor, así como ver los productos por autor.
Añadir esta nueva funcionalidad a tu aplicación es simple y rápido. Lo
primero es crear una nueva clase para Autor con el siguiente código:
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
import org.hibernate.annotations.GenericGenerator;
import org.openxava.annotations.*;
@Entity
public class Autor {
@Column(length=50) @Required
private String nombre;
Resumen
Esta lección te ha enseñado como usar simples clases de Java para
crear una aplicación Web. Con solo escribir clases Java para definir tu
dominio, obtienes una aplicación lista para usar. También, has
aprendido como refinar la interfaz de usuario por defecto usando
algunas anotaciones de OpenXava. Si quieres conocer todas las
posibilidades que ofrece OpenXava para definir la interfaz de
usuario lee la guía de referencia.
Efectivamente tienes una aplicación funcional con poco esfuerzo.
Aunque esta aplicación “tal cual” puede servir como utilidad de
mantenimiento o un prototipo, todavía necesitas añadir validaciones,
lógica de negocio, comportamiento de la interfaz de usuario, seguridad
y así por el estilo para convertir estas entidades que has escrito en
una aplicación de gestión lista para tus usuarios.
Aprenderás estos temas avanzados en las siguientes lecciones.
JUnit
JUnit es una herramienta muy popular para hacer pruebas
automáticas. Esta herramienta está integrada con Eclipse, por tanto no
necesitas descargarla para poder usarla. OpenXava extiende las
capacidades de JUnit para permitir probar un módulo de OpenXava
exactamente de la misma forma que lo haría un usuario final. De
hecho, OpenXava usa HtmlUnit, un software que simula un navegador
real (incluyendo JavaScript) desde Java. Todo está disponible desde
la clase de OpenXava ModuleTestBase, que te permite automatizar
las pruebas que tú harías a mano usando un navegador de verdad de
una forma simple.
La mejor manera de entender como funcionan las pruebas en
OpenXava es verlo en acción.
import org.openxava.tests.*;
// Crear
execute("CRUD.new"); // Pulsa el botón 'Nuevo'
setValue("numero", "77"); // Teclea 77 como valor para el campo
'numero'
setValue("nombre", "Cliente JUNIT"); // Pone valor en el campo
'nombre'
setValue("direccion.viaPublica", "Calle JUNIT"); // Fíjate en la
notación del punto
// para acceder al
miembro de la referencia
setValue("direccion.codigoPostal", "77555"); // Etc
setValue("direccion.municipio", "La ciudad JUNIT"); // Etc
setValue("direccion.provincia", "La provincia JUNIT"); // Etc
execute("CRUD.save"); // Pulsa el botón 'Grabar'
assertNoErrors(); // Verifica que la aplicación no muestra
errores
assertValue("numero", ""); // Verifica que el campo 'numero' está
vacío
assertValue("nombre", ""); // Verifica que el campo 'nombre' está
vacío
assertValue("direccion.viaPublica", ""); // Etc
assertValue("direccion.codigoPostal", ""); // Etc
assertValue("direccion.municipio", ""); // Etc
assertValue("direccion.provincia", ""); // Etc
// Leer
setValue("numero", "77"); // Pone 77 como valor para el campo
'numero'
execute("CRUD.refresh"); // Pulsa el botón 'Refrescar'
assertValue("numero", "77"); // Verifica que el campo 'numero'
tiene un 77
assertValue("nombre", "Cliente JUNIT"); // y 'nombre' tiene
'Cliente JUNIT'
assertValue("direccion.viaPublica", "Calle JUNIT"); // Etc
assertValue("direccion.codigoPostal", "77555"); // Etc
assertValue("direccion.municipio", "La ciudad JUNIT"); // Etc
assertValue("direccion.provincia", "La provincia JUNIT"); // Etc
// Actualizar
setValue("nombre", "Cliente JUNIT MODIFICADO"); // Cambia el
valor del campo 'nombre'
execute("CRUD.save"); // Pulsa el botón 'Grabar'
assertNoErrors(); // Verifica que la aplicación no muestra
errores
assertValue("numero", ""); // Verifica que el campo 'numero' está
vacío
assertValue("nombre", ""); // Verifica que el campo 'nombre' está
vacío
// Verifica si se ha modificado
setValue("numero", "77"); // Pone 77 como valor para el campo
'numero'
execute("CRUD.refresh"); // Pulsa en el botón 'Refrescar'
assertValue("numero", "77"); // Verifica que el campo 'numero'
tiene un 77
assertValue("nombre", "Cliente JUNIT MODIFICADO"); // y 'nombre'
tiene
// 'Cliente JUNIT
MODIFICADO'
// Borrar
execute("CRUD.delete"); // Pulsa en el botón 'Borrar'
assertMessage("Cliente borrado satisfactoriamente"); // Verifica
que el mensaje
// 'Cliente borrado satisfactoriamente'
se muestra al usuario
}
import java.math.*;
import com.tuempresa.facturacion.modelo.*;
import org.openxava.tests.*;
import static org.openxava.jpa.XPersistence.*;
// Buscar producto1
execute("CRUD.new");
setValue("numero", Integer.toString(producto1.getNumero())); //
(1)
execute("CRUD.refresh");
assertFilesCount("fotos", 0);
// Subir fotos
uploadFile("fotos", "web/xava/images/add.gif"); // (2)
uploadFile("fotos", "web/xava/images/attach.gif"); // (2)
// Verificar
execute("CRUD.new");
assertFilesCount("fotos", 0);
setValue("numero", Integer.toString(producto1.getNumero())); //
(1)
execute("CRUD.refresh");
assertFilesCount("fotos", 2);
assertFile("fotos", 0, "image");
assertFile("fotos", 1, "image");
// Quitar fotos
removeFile("fotos", 1);
removeFile("fotos", 0);
}
import org.openxava.tests.*;
public class PruebaAutor extends ModuleTestBase {
import org.openxava.tests.*;
Probar colecciones
Es el momento de enfrentarnos a la prueba del módulo principal de tu
aplicación, PruebaFactura. Por ahora la funcionalidad del
módulo Factura es limitada, solo puedes añadir, borrar y modificar
facturas. Aun así, esta es la prueba más extensa; además contiene
una colección, por tanto aprenderás como probar las colecciones.
import java.time.*;
import java.time.format.*;
import javax.persistence.*;
import org.openxava.tests.*;
import static org.openxava.jpa.XPersistence.*; // Para usar JPA
Entrada de datos
Ahora es el momento de escogerCliente() de la factura:
private void escogerCliente() throws Exception {
setValue("cliente.numero", "1");
assertValue("cliente.nombre", "JAVIER PANIZA"); // El cliente 1 debe
de existir en la DB
}
// Fila 0
assertValueInCollection("detalles", 0, "producto.numero", "1");
assertValueInCollection("detalles", 0, "producto.descripcion",
"Peopleware: Productive Projects and Teams");
assertValueInCollection("detalles", 0, "cantidad", "2");
// Fila 1
assertValueInCollection("detalles", 1, "producto.numero", "2");
assertValueInCollection("detalles", 1, "producto.descripcion",
"Arco iris de lágrimas");
assertValueInCollection("detalles", 1, "cantidad", "1");
assertValue("observaciones", "Esto es una prueba JUNIT");
}
Suite
Tienes 5 casos de prueba que velan por tu código, preservando la
calidad de tu aplicación. Cuando termines alguna mejora o corrección
en tu aplicación ejecuta todas tus pruebas unitarias para verificar que
la funcionalidad existente no se ha roto.
Tradicionalmente, para ejecutar todos las pruebas de tu aplicación
deberías crear una suite de pruebas, y ejecutarla. Una suite de
pruebas es una clase que agrega todas tus pruebas JUnit para que
puedas ejecutarlas todas de un golpe. Afortunadamente, si trabajas
con Eclipse no necesitas escribir una clase de suite, Eclipse te permite
ejecutar todas las pruebas de tu aplicación automáticamente:
Resumen
Has automatizado las pruebas de toda la funcionalidad actual de tu
aplicación. Puede parecer que este código de prueba es mucho más
largo y aburrido que el código real de la aplicación. Pero recuerda, el
código de prueba es el tesoro más valioso que tienes. Quizás ahora
no me creas, pero trata de hacer pruebas JUnit y una vez te hayan
salvado la vida, ya no podrás desarrollar sin pruebas automáticas
nunca más.
¿Qué probar? No hagas pruebas exhaustivas al principio. Es mejor
probar poco que no probar nada. Si tratas de hacer pruebas muy
exhaustivas acabarás no haciendo pruebas en absoluto. Empieza
haciendo algunas pruebas JUnit para tu código, y con cada nueva
característica o nuevo arreglo añade nuevas pruebas. Al final, tendrás
una suite de pruebas muy completa. En resumen, prueba poco, pero
prueba siempre.
Sí, hacer pruebas automáticas es una tarea continua. Y para predicar
con el ejemplo a partir de ahora escribiremos todas las pruebas para
el código que desarrollemos en el resto del libro. De esta manera
aprenderás más trucos sobre las pruebas JUnit en las siguientes
lecciones.
Lección 4: Herencia
La herencia es una forma práctica de reutilizar el código en el mundo de la
orientación a objetos. Usar herencia con JPA y OpenXava es tan fácil como
hacerlo con puro Java. Vamos a usar la herencia para quitar el código repetitivo
y aburrido, como la definición de los UUID. También, añadiremos una nueva
entidad, Pedido, y usaremos la herencia para hacerlo con muy poco código.
Además, aprenderás cuán práctico es usar herencia incluso para código de
pruebas.
Este código es exactamente el mismo para todas estas clases. Ya sabes que
copiar y pegar es un pecado mortal, por eso tenemos que buscar una forma de
quitar este código repetido, y así evitar ir al infierno.
Una solución elegante en este caso es usar herencia. JPA permite varias
formas de herencia. Una de ellas es heredar de una superclase mapeada. Una
superclase mapeada es una clase Java con anotaciones de mapeo JPA, pero
no es una entidad en sí. Su único objetivo es ser usada como clase base para
definir entidades. Usemos una, y verás su utilidad rápidamente.
Primero, movemos el código común a una clase marcada
como @MappedSuperclass. La llamamos Identificable:
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
import org.hibernate.annotations.*;
import org.openxava.annotations.*;
@MappedSuperclass // Marcada como una superclase mapeada en vez de
como una entidad
public class Identificable {
@Id @GeneratedValue(generator="system-uuid") @Hidden
@GenericGenerator(name="system-uuid", strategy = "uuid")
@Column(length=32)
private String oid; // La definición de propiedad incluye
anotaciones de OpenXava y JPA
public String getOid() {
return oid;
}
public void setOid(String oid) {
this.oid = oid;
}
}
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
@Entity
public class Categoria extends Identificable { // Extiende de
Identificable
// por tanto no necesita tener una propiedad
id
@Column(length = 50)
private String descripcion;
public String getDescripcion() {
return descripcion;
}
public void setDescripcion(String descripcion) {
this.descripcion = descripcion;
}
}
Herencia de entidades
Una entidad puede heredar de otra entidad. Esta herencia de entidades es una
herramienta muy útil para simplificar tu modelo. Vamos a usarla para añadir
una nueva entidad, Pedido, a tu aplicación Facturacion.
@Entity
public class Factura {
@OneToMany(mappedBy="factura")
private Collection<Pedido> pedidos;
...
}
@Entity
public class Pedido {
@ManyToOne // Sin carga vaga (1)
private Invoice invoice;
...
}
Es decir, una factura tiene varios pedidos, y un pedido puede referenciar a una
factura. Fíjate como no usamos inicialización vaga (lazy fetching) para la
referencia factura (1), esto es por un bug de Hibernate cuando la referencia
contiene la relación bidireccional (es decir, es la referencia declarada en el
atributo mappedBy del @OneToMany).
¿Cómo es Pedido? Bien, tiene un cliente, unas líneas de detalle con producto y
cantidad, un año y un número. Algo así como esto:
Curiosamente, este diagrama UML es idéntico al diagrama de Factura. Es
decir, para crear tu entidad Pedido puedes copiar y pegar la clase Factura, y
asunto zanjado. Pero, ¡espera un momento! ¿“Copiar y pegar” no era un
pecado mortal? Hemos de encontrar una forma de
reutilizar Factura para Pedido.
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
@Entity
public class Factura extends DocumentoComercial {
}
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
@Entity
public class Pedido extends DocumentoComercial {
@ManyToOne
private Factura factura; // Referencia a factura añadida
public Factura getFactura() {
return factura;
}
public void setFactura(Factura factura) {
this.factura = factura;
}
}
package com.tuempresa.facturacion.modelo;
import java.util.*; // Añade este import para usar Collection
import javax.persistence.*;
@Entity
public class Factura extends DocumentoComercial {
@OneToMany(mappedBy="factura")
private Collection<Pedido> pedidos; // Colección de entidades
Pedido añadida
public Collection<Pedido> getPedidos() {
return pedidos;
}
public void setPedidos(Collection<Pedido> pedidos) {
this.pedidos = pedidos;
}
}
Después de escribir este código tan simple, ya puedes probar estas, recién
creadas, relaciones. Abre tu navegador y explora los
módulos Pedido y Factura. Fíjate como al final de la interfaz de usuario
de Pedido tienes una referencia a Factura. El usuario puede usar esta
referencia para asociar una factura al pedido actual. Por otra parte, si exploras
el módulo Factura, verás una colección de pedidos al final. El usuario puede
usarla para añadir pedidos a la factura actual.
Intenta añadir pedidos a la factura, y asociar una factura a un pedido. Funciona,
aunque la interfaz de usuario es un poco fea, de momento.
Herencia de vistas
La herencia no solo sirve para reutilizar código Java y mapeos, sino también
para reutilizar la definición de la interfaz de usuario, las definiciones @View.
Esta sección muestra como funciona la herencia de vistas.
El atributo extendsView
Tanto Pedido como Factura usan una interfaz de usuario generada por defecto
con todos sus miembros uno por cada línea. Nota como la @View que hemos
declarado en DocumentoComercial no se ha heredado. Es decir, si no defines
una vista para la entidad se genera una por defecto, la @View de la entidad
padre no se usa. Como se muestra aquí:
@View( members=
"anyo, numero, fecha;" +
"datos {" +
"cliente;" +
"detalles;" +
"observaciones" +
"}" +
"pedidos { pedidos } "
)
Puedes notar como todos los miembros, excepto la parte de pedidos, son
comunes para todos los DocumentoComercial. Por lo tanto, vamos a mover
esta parte común a DocumentoComercial y redefinir la vista usando herencia.
Quita el viejo @View de DocumentoComercial, y escribe esto:
@View(members=
"anyo, numero, fecha," + // Los miembros para la cabecera en una
línea
"datos {" + // Una pestaña 'datos' para los datos principales del
documento
"cliente;" +
"detalles;" +
"observaciones" +
"}"
)
abstract public class DocumentoComercial extends Identifiable {
Esta vista indica como distribuir los datos comunes para todos los documentos
comerciales. Ahora podemos redefinir la vista de Factura a partir de esta:
@OneToMany(mappedBy="factura")
@CollectionView("SinClienteNiFactura") // Esta vista se usa para
visualizar pedidos
private Collection<Pedido> pedidos;
Y tan solo con este código la colección pedidos usará una vista más apropiada
de Factura para visualizar elementos individuales.
Además, queremos que desde la interfaz de usuario de Pedido la factura no
muestre el cliente y los pedidos, porque son datos redundantes en este caso.
Para conseguirlo, vamos a definir una vista más simple en Factura:
package com.tuempresa.facturacion.pruebas;
import java.text.*;
import java.util.*;
import javax.persistence.*;
import org.openxava.tests.*;
import org.openxava.util.*;
import static org.openxava.jpa.XPersistence.*;
abstract public class PruebaDocumentoComercial // Añade abstract a la
definición de clase
extends ModuleTestBase {
private String numero;
public PruebaDocumentoComercial(
String nombrePrueba,
String nombreModulo) // nombreModulo añadido como argumento en
el constructor
{
super(nombrePrueba, "Facturacion", nombreModulo); //
nombreModulo en vez de "Factura"
}
public void testCrear() throws Exception { … } // Como el original
private void anyadirDetalles() throws Exception { … } // Como el
original
private String getNumero() {
if (numero == null) {
Query query = getManager().
createQuery(
"select max(f.numero) "
+ "from DocumentoComercial f " // Factura cambiada
por DocumentoComercial
+ "where f.anyo = :anyo");
query.setParameter("anyo", Dates.getYear(new Date()));
Integer ultimoNumero = (Integer) query.getSingleResult();
if (ultimoNumero == null) ultimoNumero = 0;
numero = Integer.toString(ultimoNumero + 1);
}
return numero;
}
private void borrar() throws Exception { … } // Como original
private void verificarCreado() throws Exception { … } // Como
original
private void grabar() throws Exception { … } // Como original
private void ponerOtrasPropiedades() throws Exception { … } //
Como original
private void escogerCliente() throws Exception { … } // Como
original
private void verificarValoresDefecto() throws Exception { … } //
Como original
private String getAnyoActual() { … } // Como original
private String getFechaActual() { … } // Como original
}
Como ves has tenido que hacer unos pocos cambios para
adaptar PruebaDocumentoComercial. Primero, la has declarado abstracta, de
esta forma esta clase no es ejecutada por Eclipse como una prueba JUnit, es
solo válida como clase base para crear pruebas, pero ella misma no es una
prueba.
Otro cambio importante nos lo encontramos en el constructor, donde ahora
tienes nombreModulo en vez de “Factura”, así puedes usar esta prueba
para Pedido, Factura o cualquier otro módulo que quieras. El otro cambio es un
simple detalle: has de cambiar “Factura” por “DocumentoComercial” en la
consulta para obtener el siguiente número.
Ahora ya tienes una clase base lista para crear los módulos de prueba
para Pedido y Factura. Hagámoslo sin más dilación.
package com.tuempresa.facturacion.pruebas;
public class PruebaFactura extends PruebaDocumentoComercial {
public PruebaFactura(String nombrePrueba) {
super(nombrePrueba, "Factura");
}
}
Y PruebaPedido:
package com.tuempresa.facturacion.pruebas;
public class PruebaPedido extends PruebaDocumentoComercial {
public PruebaPedido(String nombrePrueba) {
super(nombrePrueba, "Pedido");
}
}
En este caso asumimos que hay al menos una factura, y que la primera factura
de la lista no tiene pedidos. Antes de ejecutar esta prueba, si no tienes facturas
todavía, crea una sin pedidos, o si ya tienes facturas, asegúrate de que la
primera no tiene pedidos.
Para probar como asignar una factura a un pedido añade el
método testPonerFactura() a PruebaPedido:
Resumen
Esta lección te ha mostrado algunos ejemplos prácticos sobre como usar
herencia con Java y JPA para simplificar tu código. Hemos usado la
configuración por defecto de JPA para la herencia, aunque puedes refinar el
comportamiento de JPA para la herencia con anotaciones
como @Inheritance, @DiscriminatorColumn, @DiscriminatorValue, etc. Para
aprender más acerca de la herencia en JPA puedes leer la documentación
del apéndice B.
Propiedades calculadas
Quizás la lógica de negocio más simple que puedes añadir a tu aplicación es
una propiedad calculada. Las propiedades que has usado hasta ahora son
persistentes, es decir, cada propiedad se almacena en una columna de una
tabla de la base de datos. Una propiedad calculada es una propiedad que no
almacena su valor en la base de datos, sino que se calcula cada vez que se
accede a la propiedad. Observa la diferencia entre una propiedad persistente y
una calculada:
// Propiedad persistente
private int cantidad; // Tiene un campo, por tanto es persistente
public int getCantidad() { // Un getter para devolver el valor del
campo
return cantidad;
}
public void setCantidad(int cantidad) { // Cambia el valor del campo
this.cantidad = cantidad;
}
// Propiedad calculada
public int getImporte() { // No tiene campo, ni setter, solo un getter
return cantidad * precio; // con un cálculo
}
@Stereotype("DINERO")
@Depends("producto.numero, cantidad") // Cuando usuario cambie
producto o cantidad
public BigDecimal getImporte() { // esta propiedad se recalculará y se
redibujará
return new BigDecimal(cantidad).multiply(producto.getPrecio());
}
@ElementCollection
@ListProperties("producto.numero, producto.descripcion, cantidad,
importe") // importe añadida
private Collection<Detalle> detalles;
Nota:
Verifica que los productos tengan precio
registrado.
Usar @DefaultValueCalculator
La forma en que calculamos el importe de la línea de detalle no es la mejor.
Tiene, al menos, dos inconvenientes. El primero es que el usuario puede
querer tener la posibilidad de cambiar el precio unitario. Y segundo, si el precio
de un producto cambia los importes de todas las facturas cambian también, y
esto no es bueno.
Para evitar estos inconvenientes lo mejor es almacenar el precio de cada
producto en cada línea de detalle. Añadamos pues una propiedad
persistente precioPorUnidad a la clase Detalle, y calculemos su valor
desde precio de Producto usando un @DefaultValueCalculator. De tal forma
que consigamos el efecto que puedes ver en la siguiente figura:
@DefaultValueCalculator(
value=CalculadorPrecioPorUnidad.class, // Esta clase calcula el
valor inicial
properties=@PropertyValue(
name="numeroProducto", // La propiedad numeroProducto del
calculador...
from="producto.numero") // ... se llena con el valor de
producto.numero de la entidad
)
@Stereotype("DINERO")
private BigDecimal precioPorUnidad; // Una propiedad persistente
convencional...
public BigDecimal getPrecioPorUnidad() { // ... con sus getter y
setter
return precioPorUnidad == null ? BigDecimal.ZERO :
precioPorUnidad; // así nunca devuelve nulo
}
public void setPrecioPorUnidad(BigDecimal precioPorUnidad) {
this.precioPorUnidad = precioPorUnidad;
}
@Stereotype("DINERO")
@Depends("precioPorUnidad, cantidad") // precioPorUnidad en vez de
producto.numero
public BigDecimal getImporte() {
return new BigDecimal(cantidad).multiply(getPrecioPorUnidad()); //
getPrecioPorUnidad() en vez de producto.getPrecio()
}
@ElementCollection
@ListProperties("producto.numero, producto.descripcion, cantidad,
precioPorUnidad, importe") // precioPorUnidad añadida
private Collection<Detalle> detalles;
Prueba los módulos Pedido y Factura y podrás observar el nuevo
comportamiento al añadir líneas de detalle.
Es un cálculo simple.
Solo nos queda importeTotal por añadir. Puedes ver su código:
@Entity
@View(members=
"anyo, numero, fecha, porcentajeIVA;" + // Añadido porcentajeIVA
"datos {" +
"cliente;" +
"detalles;" +
"observaciones" +
"}"
)
abstract public class DocumentoComercial extends Identificable {
@ElementCollection
@ListProperties(
"producto.numero, producto.descripcion, cantidad,
precioPorUnidad, " +
"importe[factura.importeBase, factura.iva,
factura.importeTotal]" // Entidad padre Factura =>
[factura.importeBase, ...]
)
private Collection<Detalle> detalles;
// El resto del código fuente
...
}
// @ElementCollection
// @ListProperties("producto.numero, producto.descripcion, cantidad,
precioPorUnidad, " +
// "importe[factura.importeBase, factura.iva,
factura.importeTotal]" // Entidad padre Factura =>
[factura.importeBase, ...]
// )
// private Collection<Detalle> detalles; // La colección 'detalles'
eliminada
//
// public Collection<Detalle> getDetalles() { // Getter eliminado
// return detalles;
// }
//
// public void setDetalles(Collection<Detalle> detalles) { // Setter
eliminado
// this.detalles = detalles;
// }
abstract public Collection<Detalle> getDetalles(); // Añadido método
abstracto
Nota:
Elimina la tabla DOCUMENTOCOMERCIAL_DETALLES, aprendiste a hacerlo en la lección
anterior.
Ahora puedes probar tu aplicación. Debería funcionar casi como en la figura del
inicio de esta sección. “Casi” porque porcentajeIVA todavía no tiene un valor
por defecto. Lo añadiremos en la siguiente sección.
porcentajeIVADefecto=18
@DefaultValueCalculator(CalculadorPorcentajeIVA.class)
private BigDecimal porcentajeIVA;
Con este código cuando el usuario pulsa para crear una nueva factura, el
campo porcentajeIVA se rellenará con 18, o cualquier otro valor que hayas
puesto en facturacion.properties.
@Column(length = 6)
//
@DefaultValueCalculator(value=CalculadorSiguienteNumeroParaAnyo.class,
// Quita esto
// properties=@PropertyValue(name="anyo")
// )
@ReadOnly // El usuario no puede modificar el valor
private int numero;
@Stereotype("DINERO")
private BigDecimal importe;
public BigDecimal getImporte() {
return importe;
}
public void setImporte(BigDecimal importe) {
this.importe = importe;
}
@Version
private Integer version; // Añadida propiedad 'version', sin getter,
ni setter
@PreUpdate // Añadido '@PreUPdate'
public void recalcularImporte() { // Ejecutado justo antes de
actualizar el objeto
setImporte(getImporteTotal());
}
Nota:
Elimina la tabla DOCUMENTOCOMERCIAL para que se vuelva a generar incluyendo la
columna "version".
@Stereotype("DINERO")
public BigDecimal getBeneficioEstimado() {
return getImporte().multiply(new BigDecimal("0.10"));
}
Pruebas JUnit
Antes de ir a la siguiente lección, vamos a escribir el código JUnit para ésta.
Recuerda, el código no está terminado si no tiene pruebas JUnit. Puedes
escribir las pruebas antes, durante o después del código principal. Pero
siempre has de escribirlas.
El código de prueba mostrado aquí no es solo para darte un buen ejemplo, sino
también para enseñarte maneras de probar diferentes casos en tu aplicación
OpenXava.
Como ves, añadimos una nueva línea, después de login(...), para calcular el
siguiente número de documento, y una llamada al nuevo
método verificarImporteYBeneficioEstimado().
Ahora nos conviene más calcular el siguiente número de documento al principio
para usarlo en el resto de la prueba. Para hacer esto, cambia el viejo
método getNumero() por los dos métodos mostrados en el siguiente código:
Dado que ahora vamos a modo lista y después volvemos a detalles, hemos de
hacer una pequeña modificación en el método verificarCreado(), que es
ejecutado justo después de verificarImporteYBeneficioEstimado(). Veamos la
modificación:
Resumen
En esta lección has aprendido algunas formas comunes de añadir lógica de
negocio a tus entidades. No hay duda sobre la utilidad de las propiedades
calculadas, los métodos de retrollamada o @Formula. Sin embargo, todavía
tenemos muchas otras formas de añadir lógica a tu aplicación OpenXava, que
vamos a aprender a usar.
En futuros lecciones verás como añadir validación, modificar el funcionamiento
estándar del módulo y añadir tu propia lógica de negocio, entre otras formas de
añadir lógica personalizada a tu aplicación.
Alternativas de validación
Vamos a refinar tu código para que el usuario no pueda asignar pedidos a una
factura si los pedidos no han sido entregados todavía. Es decir, solo los
pedidos entregados pueden asociarse a una factura. Aprovecharemos la
oportunidad para explorar diferentes formas de hacer esta validación.
@Views({
@View( extendsView="super.DEFAULT",
members="entregado; factura { factura } " // Propiedad
'entregado' añadida
),
...
})
public class Pedido extends DocumentoComercial
Nota:
Al arrancar la aplicación se añadirá la columna entregado a la tabla DocumentoComercial,
ésta tendrá el valor null para todos los registros. Debemos actualizar esta columna con las
siguiente sentencia SQL:
UPDATE DocumentoComercial
SET entregado = false
Validar con @EntityValidator
En tu aplicación actual el usuario puede añadir cualquier pedido que le plazca a
una factura usando el módulo Factura, y puede asignar una factura a cualquier
pedido desde el módulo Pedido. Vamos a restringir esto. Solo los pedidos
entregados podrán añadirse a una factura.
La primera alternativa que usaremos para implementar esta validación es
mediante @EntityValidator. Esta anotación te permite asignar a tu entidad
una clase con la lógica de validación deseada. Anotemos tu entidad Pedido tal
como muestra el siguiente código:
@EntityValidator(
value=ValidadorEntregadoParaEstarEnFactura.class, // Clase con la
lógica de validación
properties= {
@PropertyValue(name="anyo"), // El contenido de estas
propiedades
@PropertyValue(name="numero"), // se mueve desde la entidad
'Pedido'
@PropertyValue(name="factura"), // al validador antes de
@PropertyValue(name="entregado") // ejecutar la validación
})
public class Pedido extends DocumentoComercial {
Ahora puedes intentar añadir pedidos a una factura con la aplicación, verás
como los pedidos no servidos son rechazados. Como se ve en la siguiente
figura:
Ya tienes tu validación hecha con @EntityValidator. No es difícil, pero es un
poco verboso, porque necesitas escribir una clase nueva solo para añadir 2
línea de lógica. Aprendamos otras formas de hacer esta misma validación.
Validar en el setter
Otra alternativa para hacer tu validación es poner tu lógica de validación dentro
del método setter. Es un enfoque simple y llano. Para probarlo, quita el
método validar() de tu entidad Pedido y modifica el método setFactura() de la
forma que mostramos a continuación:
// @RemoveValidator(ValidadorBorrarPedido.class) // Quitamos
'@RemoveValidator'
public class Pedido extends DocumentoComercial {
@PreRemove
private void validarPreBorrar() {
if (factura != null) { // La lógica de validación
throw new javax.validation.ValidationException( // Lanza una
excepción runtime
XavaResources.getString( // Para obtener un mensaje de
texto
"no_puede_borrar_pedido_con_factura"));
}
}
@ISBN // Esta anotación indica que esta propiedad tiene que validarse
como un ISBN
private String isbn;
Solo con añadir @ISBN a tu propiedad, y ésta será validada justo antes de que
la entidad se grabe en la base de datos, ¡genial! El problema es que @ISBN no
está incluida como un validador predefinido en el marco de validación Bean
Validation. Esto no es un gran problema, si quieres una anotación @ISBN,
hazla tú mismo. De hecho, vamos a crear la anotación de validación @ISBN en
esta sección.
Antes de nada, añadamos una nueva propiedad isbn a Producto. Edita tu
clase Producto y añádele el siguiente código:
@Column(length=13)
private String isbn;
public String getIsbn() {
return isbn;
}
public void setIsbn(String isbn) {
this.isbn = isbn;
}
Como puedes ver, es una definición de anotación normal y corriente, solo que
usas @Constraint para indicar la clase con la lógica de validación. Escribamos
la clase ValidadorISBN.
@Column(length=13) @ISBN
private String isbn;
Pruebas JUnit
Nuestra meta no es desarrollar una ingente cantidad de código, sino crear
software de calidad. Al final, si creas software de calidad acabarás escribiendo
más cantidad de software, porque podrás dedicar más tiempo a hacer cosas
nuevas y excitantes, y menos depurando legiones de bugs. Y tú sabes que la
única forma de conseguir calidad es mediante las pruebas automáticas, por
tanto actualicemos nuestro código de prueba.
Aquí ves una buena técnica para hacer un bucle sobre los elementos
visualizados de una lista para seleccionarlos y coger algunos datos, o cualquier
otra cosa que quieras hacer con los datos de la lista.
Resumen
En esta lección has aprendido varias formas de hacer validación en una
aplicación OpenXava. Además, ahora estás preparado para encapsular toda la
lógica de validación reutilizable en anotaciones usando Bean Validation.
La validación es una parte importante de la lógica de tu aplicación, y te ánimo a
que la pongas en el modelo, es decir en las entidades; tal y como esta lección
ha mostrado. Aun así, a veces es conveniente poner algo de lógica fuera de las
clases del modelo. Aprenderás a hacer esto en las siguientes lecciones.
Acciones personalizadas
Por defecto, un módulo OpenXava te permite manejar tu entidad de una forma
bastante buena: es posible añadir, modificar, borrar, buscar, generar informes PDF,
exportar a Excel (CSV) e importar datos a las entidades. Estas acciones por defecto
están contenidas en el controlador Typical. Puedes refinar o extender el
comportamiento de tu módulo definiendo tu propio controlador. Esta sección te
enseñará como definir tu propio controlador y escribir tus acciones personalizadas.
Controlador Typical
Por defecto el módulo Factura usa las acciones del controlador Typical. El
controlador Typical está definido en default-controllers.xml que se encuentra en la
carpeta OpenXava/xava de tu workspace. Una definición de controlador es un
fragmento de XML con una lista de acciones. OpenXava aplica por defecto el
controlador Typical a todos los módulos. Puedes ver su definición:
Aquí puedes ver como se puede definir un controlador a partir de otros controladores.
Este es un uso sencillo de la herencia. En este caso el controlador Typical tiene todas
las acciones de los
controladores Navigation, Print, CRUD e ImportData. Navigation tiene las acciones
para navegar por los registros en modo detalle. Print tiene las acciones para imprimir
informes PDF y exportar a Excel, CRUD tiene las acciones para crear, leer, actualizar
y borrar, e ImportData tiene la acción que permite cargar un archivo, con formato de
tabla (csv, xls, xlsx), para importar registros al módulo. El siguiente código muestra un
extracto del controlador CRUD:
<controller name="CRUD">
<action name="new"
class="org.openxava.actions.NewAction"
image="images/new.gif"
icon="library-plus"
keystroke="Control N">
<!--
name="new": Nombre para referenciar la acción desde otras
partes
class="org.openxava.actions.NewAction" : La clase con la
lógica de la acción
image="images/new.gif": Imagen a mostrar para esta acción,
en caso "useIconsInsteadOfImages=false" de
"xava.properties"
icon="library-plus": Icono a mostrar para esta acción, ésta es
por defecto
keystroke="Control N": Teclas que se pueden pulsar para
ejecutar la acción
-->
<set property="restoreModel" value="true"/> <!-- La propiedad
restoreModel de la acción
se pondrá a true antes de ejecutarla -->
</action>
<action name="save" mode="detail"
by-default="if-possible"
class="org.openxava.actions.SaveAction"
image="save.gif"
icon="content-save"
keystroke="Control S"/>
<!--
mode="detail": Esta acción se mostrará solo en modo detalle
by-default=”if-possible”: Esta acción se ejecutará cuando el
usuario pulse INTRO
-->
<action name="delete" mode="detail"
confirm="true"
class="org.openxava.actions.DeleteAction"
image="delete.gif"
icon="delete"
available-on-new="false"
keystroke="Control D"/>
<!--
confirm="true" : Pide confirmación al usuario antes de
ejecutar la acción
available-on-new="false" : La acción no estará disponible
mientras se crea una nueva entidad
-->
<!-- Otras acciones... -->
</controller>
Aquí se ve como definir las acciones. Básicamente consiste en vincular un nombre con
una clase con la lógica a ejecutar. Además, define un icono y un atajo de teclado.
También vemos como se puede configurar la acción usando <set />.
Las acciones se muestran por defecto en modo lista y detalle, aunque puedes, por
medio del atributo mode, especificar que sea mostrada solo en modo lista (list) o
detalle (detail).
Para definir un controlador para tu entidad, has de crear un controlador con el mismo
nombre que la entidad. Es decir, si existe un controlador llamado “Factura”, cuando
ejecutes el módulo Factura éste será el controlador a usar en vez de Typical.
Extendemos el controlador Factura de Typical, así todas las acciones de Typical están
disponible en tu módulo Factura. Cualquier acción que definas en tu
controlador Factura estará disponible como un botón para que el usuario pueda
pulsarlo. Aunque en este caso hemos llamado a nuestra acción “delete”, precisamente
el nombre de una acción del controlador Typical, de esta forma estamos anulando la
acción de Typical. Es decir, solo una acción delete se mostrará al usuario y será la
nuestra.
Como ves, es una propiedad booleana simple y llana. El único detalle es el uso de la
anotación @Hidden. Indica que cuando una vista o lista tabular por defecto sea
generada la propiedad eliminado no se mostrará; aunque si la pones explícitamente
en @View(members=) o @Tab(properties=) sí que se mostrará. Usa esta anotación
para marcar aquellas propiedades de uso interno del programador pero que no tienen
sentido para el usuario final.
Usamos @Column(columnDefinition=) para llenar la columna con falses en lugar de
con nulos. Aquí puedes poner definición SQL de la columna para enviar a la base de
datos. Es más sencillo que actualizar la base de datos pero el código es más
dependiente de la base de datos.
Ya estamos preparados para escribir el código real de la acción:
Acciones genéricas
El código actual de EliminarFactura refleja la forma típica de escribir acciones. Es
código concreto que accede directamente a entidades concretas para manipularlas.
Pero a veces puedes encontrarte alguna lógica en tu acción susceptible de ser usada
y reusada por toda tu aplicación, incluso en todas tus aplicaciones. En este caso,
puedes utilizar algunas técnicas para crear código más reutilizable, y así convertir tus
acciones personalizadas en acciones genéricas.
Aprendamos estas técnicas para escribir código más genérico en nuestras acciones.
<accion nombre="delete"
modo="detail" confirmar="true"
clase="com.tuempresa.facturacion.acciones.EliminarParaFacturacion"
icono="delete"
disponible-en-nuevo="false"
atajo-de-teclado="Control D"/>
package com.tuempresa.facturacion.acciones;
import java.util.*;
import org.openxava.actions.*;
import org.openxava.model.*;
public class EliminarParaFacturacion extends ViewBaseAction {
public void execute() throws Exception {
Map<String, Object> valores =
new HashMap<String, Object>(); // Los valores a modificar
en la entidad
valores.put("eliminado", true); // Asignamos true a la
propiedad 'eliminado'
MapFacade.setValues( // Modifica los valores de la entidad
indicada
getModelName(), // Un método de ViewBaseAction
getView().getKeyValues(), // La clave de la entidad a
modificar
valores); // Los valores a cambiar
resetDescriptionsCache(); // Reinicia los caches para los
combos
addMessage("object_deleted", getModelName());
getView().clear();
getView().setKeyEditable(true);
getView().setEditable(false); // Dejamos la vista como no
editable
}
}
Esta acción hace lo mismo que la anterior, pero no tiene ninguna referencia a la
entidad Factura. Por tanto, es genérica, puedes usarla con Pedido, Autor o cualquier
otra entidad siempre y cuando tenga una propiedad eliminado. El truco está
en MapFacade la cual permite modificar una entidad a partir de mapas. Puedes
obtener esos mapas directamente de la vista
(usando getView().getKeyValues() por ejemplo) o puedes crearlos de una
manera genérica, como en el caso del mapa valores.
Adicionalmente puedes ver dos pequeñas mejoras sobre la versión antigua. Primero,
llamamos a resetDescriptionsCache(), un método de BaseAction. Este método
borra el caché usado para los combos. Cuando modificas una entidad, si quieres que
los combos reflejen los cambios en la sesión actual has de llamar a este método.
Segundo, llamamos a getView().setEditable(false). Esto inhabilita los
controles de la vista, para impedir que el usuario rellene datos en la vista. Para crear
una nueva entidad el usuario tiene que pulsar el botón “nuevo”.
Ahora tu acción está lista para ser usada por cualquier otra entidad. Podríamos copiar
y pegar el controlador Factura como Pedido en controladores.xml. De esta forma,
nuestra lógica genérica para borrar se usaría para Pedido. ¡Espera un momento! ¿He
dicho “copiar y pegar”? No queremos arder en el fuego eterno del infierno, ¿verdad?
Así que usaremos una forma más automática de insuflar nuestra nueva acción a todos
lo módulos. Aprendámoslo en la siguiente sección.
<controlador nombre="Facturacion">
<hereda-de controlador="Typical"/>
<accion nombre="delete" modo="detail" confirmar="true"
clase="com.tuempresa.facturacion.acciones.EliminarParaFacturacion"
icono="delete"
disponible-en-nuevo="false"
atajo-de-teclado="Control D"/>
</controlador>
Como ya sabes, cuando usas el nombre de una entidad, como Factura, como nombre
de controlador, ese controlador será usado por defecto en el módulo de esa entidad.
Por lo tanto, si cambiamos el nombre del controlador, este controlador no se usará
para la entidad. De hecho el controlador Facturacion no es usado por ningún módulo,
porque no hay ninguna entidad llamada "Facturacion".
Queremos que el controlador Facturacion sea el controlador usado por defecto por
todos los módulos de la aplicación. Para hacer esto hemos de modificar el
archivo aplicacion.xml que tienes en la carpeta xava de tu aplicación. Dejándolo así:
package com.tuempresa.facturacion.modelo;
import javax.persistence.*;
import org.openxava.annotations.*;
@MappedSuperclass
public class Eliminable extends Identificable {
@Hidden
@Column(columnDefinition="boolean default false")
private boolean eliminado;
public boolean isEliminado() {
return eliminado;
}
public void setEliminado(boolean eliminado) {
this.eliminado = eliminado;
}
}
XavaResources.getString("no_puede_borrar_pedido_con_factura"));
}
}
@Override
public void setEliminado(boolean eliminado) {
if (eliminado) validarPreBorrar(); // Llamamos a la validación
explícitamente
super.setEliminado(eliminado);
}
}
Con este cambio la validación funciona igual que en el caso de un borrado de verdad,
así preservamos el comportamiento original intacto.
package com.tuempresa.facturacion.acciones;
import java.util.*;
import org.openxava.actions.*;
import org.openxava.model.*;
public class EliminarParaFacturacion extends ViewBaseAction
implements IChainAction { // Encadena con otra acción, indicada en
el método getNextAction()
private String nextAction = null; // Para guardar la siguiente
acción a ejecutar
public void execute() throws Exception {
if (!getView().getMetaModel()
.containsMetaProperty("eliminado"))
{
nextAction = "CRUD.delete"; // 'CRUD.delete' se ejecutará
cuando esta
return; // acción finalice
}
Map<String, Object> valores = new HashMap<String, Object>();
valores.put("eliminado", true);
MapFacade.setValues(
getModelName(),
getView().getKeyValues(),
valores);
resetDescriptionsCache();
addMessage("object_deleted", getModelName());
getView().clear();
getView().setKeyEditable(true);
getView().setEditable(false);
}
public String getNextAction() // Obligatorio por causa de
'IChainAction'
throws Exception
{
return nextAction; // Si es nulo no se encadena con ninguna
acción
}
}
Como ves, la acción estándar para buscar en modo detalle no hace nada,
simplemente redirige a otra acción. Esta otra acción se define en una variable de
entorno llamada XAVA_SEARCH_ACTION, que lee usando getEnvironment(). Por
la tanto, si quieres refinar la lógica de búsqueda de OpenXava la mejor manera es
definiendo tu acción como valor para XAVA_SEARCH_ACTION. Hagámoslo pues de
esta manera.
Para dar valor a la variable de entorno edita el archivo controladores.xml en la carpeta
xava de tu proyecto, y añade al principio la línea <var-entorno /> como ves a
continuación:
...
<controladores>
<!-- Para definir un valor global para una variable de entorno -->
<var-entorno
nombre="XAVA_SEARCH_ACTION"
valor="Facturacion.buscarExcluyendoEliminados" />
<controlador nombre="Facturacion">
...
<controlador nombre="Facturacion">
...
<accion nombre="buscarExcluyendoEliminados"
oculta="true"
clase="com.tuempresa.facturacion.acciones.BuscarExcluyendoEliminados"
/>
<!-- oculta="true" : Así la acción no se mostrará en la barra
de botones -->
</controlador>
package com.tuempresa.facturacion.acciones;
import java.util.*;
import javax.ejb.*;
import org.openxava.actions.*;
public class BuscarExcluyendoEliminados
extends SearchByViewKeyAction { // La acción estándar de OpenXava
para buscar
private boolean esEliminable() { // Pregunta si la entidad tiene
una propiedad 'eliminado'
return getView().getMetaModel()
.containsMetaProperty("eliminado");
}
@Override
protected Map getValuesFromView() // Coge los valores visualizados
desde la vista
throws Exception // Estos valores se usan como clave al buscar
{
if (!esEliminable()) { // Si no es 'eliminable' usamos la
lógica estándar
return super.getValuesFromView();
}
Map<String, Object> valores = super.getValuesFromView();
valores.put("eliminado", false) ; // Llenamos la propiedad
'eliminado' con false
return valores;
}
@Override
protected Map getMemberNames() // Los miembros a leer de la
entidad
throws Exception
{
if (!esEliminable()) { // Si no es 'eliminable' ejecutamos la
lógica estándar
return super.getMemberNames();
}
Map<String, Object> miembros = super.getMemberNames();
miembros.put("eliminado", null); // Queremos obtener la
propiedad 'eliminado'
return miembros; // aunque no esté en la vista
}
@Override
protected void setValuesToView(Map valores) // Asigna los valores
desde
throws Exception // la entidad a la vista
{
if (esEliminable() && // Si tiene una propiedad 'eliminado' y
(Boolean) valores.get("eliminado")) { // vale true
throw new ObjectNotFoundException(); // lanzamos la misma
excepción que
// OpenXava lanza cuando el objeto no se encuentra
}
else {
super.setValuesToView(valores); // En caso contrario
usamos la lógica estándar
}
}
}
<modulo nombre="Producto">
<!--Para dar un valor local a la variable de entorno para este
módulo -->
<var-entorno
nombre="XAVA_SEARCH_ACTION"
valor="Producto.buscarPorNumero"/>
<modelo nombre="Producto"/>
<controlador nombre="Producto"/>
<controlador nombre="Facturacion"/>
</modulo>
Modo lista
Ya casi tenemos el trabajo hecho. Cuando el usuario borra una entidad con una
propiedad eliminado la entidad se marca como borrada en vez de ser borrada
físicamente de la base de datos. Y si el usuario trata de buscar una entidad “marcada
como borrada” no puede verla en modo detalle. Aunque, el usuario todavía puede ver
las entidades “marcadas como borradas” en modo lista, y lo que es peor si borra las
entidades desde modo lista, éstas son efectivamente borradas de la base de datos.
Atemos estos cabos sueltos.
Y de esta forma tan sencilla el modo lista no mostrará las entidades “marcadas como
borradas”.
Acciones de lista
El único detalle que nos queda es el borrar las entidades desde modo lista, éstas han
de marcarse como borradas si procede. Vamos a refinar la acción
estándar CRUD.deleteSelected de la misma manera que hemos hecho
con CRUD.delete.
Primero, sobrescribimos la acciones deleteSelected y deleteRow para nuestra
aplicación. Añade la siguiente definición de acción a tu
controlador Facturacion definido en controladores.xml:
<controlador nombre="Facturacion">
<hereda-de controlador="Typical"/>
<!-- ... -->
<accion nombre="deleteSelected" modo="list" confirmar="true"
clase="com.tuempresa.facturacion.acciones.EliminarSeleccionadoParaFact
uracion"
atajo-de-teclado="Control D"/>
<accion nombre="deleteRow" modo="NONE" confirmar="true"
clase="com.tuempresa.facturacion.acciones.EliminarSeleccionadoParaFact
uracion"
icono="delete"
en-cada-fila="true"/>
</controlador>
package com.tuempresa.facturacion.acciones;
import java.util.*;
import org.openxava.actions.*;
import org.openxava.model.*;
import org.openxava.model.meta.*;
import org.openxava.validators.*;
public class EliminarSeleccionadoParaFacturacion
extends TabBaseAction // Para trabajar con datos tabulares (lista)
por medio de getTab()
implements IChainActionWithArgv { // Encadena con otra acción,
indicada con getNextAction()
private String nextAction = null; // Para almacenar la siguiente
acción a ejecutar
public void execute() throws Exception {
if (!getMetaModel().containsMetaProperty("eliminado")) {
nextAction="CRUD.deleteSelected"; // 'CRUD.deleteSelected'
se ejecutará
// cuando esta acción finalice
return;
}
marcarEntidadesSeleccionadasComoEliminadas(); // La lógica
para marcar las
// filas seleccionadas como objetos borrados
}
private MetaModel getMetaModel() {
return MetaModel.get(getTab().getModelName());
}
public String getNextAction() // Obligatorio por causa de
IChainAction
throws Exception
{
return nextAction; // Si es nulo no se encadena con ninguna
acción
}
public String getNextActionArgv() throws Exception {
return "row=" + getRow(); // Argumento a enviar a la la acción
encadenada
}
private void marcarEntidadesSeleccionadasComoEliminadas() throws
Exception {
// ...
}
}
Como ves la lógica es un simple bucle sobre las claves de las filas seleccionadas, y en
cada iteración ponemos a true la propiedad eliminado usando el
método MapFacade.setValues(). Atrapamos las excepciones dentro de la iteración
del bucle, así si hay algún problema borrando la entidad, esto no afecta al borrado de
las demás entidades. Hemos hecho un pequeño refinamiento para el caso
de ValidationException, añadiendo los errores de validación (ex.getErrors()) a
los errores a mostrar al usuario.
Al final deseleccionamos todas las filas mediante getTab().deselectAll(), porque
estamos borrando filas, por tanto si no eliminamos la selección, esta se habría
recorrido después de la ejecución de la acción.
Hemos llamado a resetDescriptionsCache() para actualizar las entidades
borradas en todos los combos de la actual sesión de usuario. Los combos, es decir las
referencias marcadas con @DescriptionsList, usan el @Tab de la entidad
referenciada para filtrar los datos. Es decir, si tuvieras un combo de facturas o pedidos
con la condición “deleted = false” en el @Tab, en este caso el contenido del combo
cambiaría.
Ahora ya tienes refinada del todo la forma en que tu aplicación borra las entidades.
Aunque aún nos quedan cosas interesante por hacer.
Es decir, una lista de facturas o pedidos donde el usuario pueda seleccionar varias y
pulsar en el botón "Restaurar", o simplemente pulsar en el vínculo "Restaurar" en la
fila del documento que quiera restaurar.
La lógica de esta acción de restaurar es simplemente poner la propiedad eliminado de
las entidades seleccionadas a false. Es decir, es exactamente la misma lógica que
usamos para borrar, pero poniendo false en vez de true. Dado que nuestra conciencia
no nos permite copiar y pegar, vamos a reutilizar nuestro código actual. La forma de
reutilizar es añadiendo una propiedad restaurar a la
acción EliminarSeleccionadoParaFacturacion, para poder restaurar las entidades
borradas.
El siguiente código muestra lo necesario para añadir una propiedad restaurar a la
acción:
<controlador nombre="Papelera">
<accion nombre="restaurar" modo="list"
clase="com.tuempresa.facturacion.acciones.EliminarSeleccionadoParaFact
uracion">
<poner propiedad="restaurar" valor="true"/> <!-- Pone la
propiedad restaurar a true -->
<!-- antes de llamar al método execute() de la acción -->
</accion>
</controlador>
Módulos personalizados
Como ya sabes, OpenXava genera un módulo por defecto para cada entidad de tu
aplicación. Aunque, siempre tienes la opción de definir los módulos a mano, bien para
refinar el comportamiento del módulo para cierta entidad, o bien para definir una
funcionalidad completamente nueva sobre esa entidad. En este caso vamos a crear
dos nuevos módulos, PapeleraFactura y PapeleraPedido, para restaurar los
documentos borrados. Usaremos el controlador Papelera en ellos. El siguiente código
muestra la definición de módulos en el archivo aplicacion.xml:
<aplicacion nombre="Facturacion">
<modulo-defecto>
<controlador nombre="Facturacion"/>
</modulo-defecto>
<modulo nombre="PapeleraFactura">
<var-entorno nombre="XAVA_LIST_ACTION"
valor="Papelera.restaurar"/> <!-- La acción a mostrar en
cada fila -->
<modelo nombre="Factura"/>
<tab nombre="Eliminado"/> <!-- Para mostrar solo las entidades
borradas -->
<controlador nombre="Papelera"/> <!-- Con solo una acción:
restaurar -->
<controlador-modo nombre="ListOnly"/> <!-- Modo lista solo -->
</modulo>
<modulo nombre="PapeleraPedido">
<var-entorno nombre="XAVA_LIST_ACTION"
valor="Papelera.restaurar"/>
<modelo nombre="Pedido"/>
<tab nombre="Eliminado"/>
<controlador nombre="Papelera"/>
<controlador-modo nombre="ListOnly"/>
</modulo>
</aplicacion>
Estos módulos van contra Factura y Pedido, pero son módulos de solo lista, gracias al
controlador ListOnly usado como controlador-modo. Además, definen una acción
especial como acción de fila usando la variable de entorno XAVA_LIST_ACTION. La
siguiente figura muestra PapeleraFactura:
<modulo nombre="...">
...
<tab nombre="Eliminado"/> <!-- 'Eliminado' es un @Tab definido en
la entidad -->
...
</modulo>
Pruebas JUnit
Hemos refinado la manera en que tu aplicación borra entidades, además hemos
añadido dos módulos personalizados, los módulos papelera. Antes de seguir adelante,
tenemos que escribir las pruebas de estas nuevas funcionalidades.
// En el archivo PruebaCliente.java
public class PruebaCliente extends ModuleTestBase {
...
public void testCrearLeerActualizarBorrar() throws Exception {
...
// Borrar
// execute("CRUD.delete");
execute("Facturacion.delete");
assertMessage("Cliente borrado satisfactoriamente");
}
...
}
// En el archivo PruebaDocumentoComercial.java
abstract public class PruebaDocumentoComercial extends ModuleTestBase
{
...
private void borrar() throws Exception {
// execute("CRUD.delete");
execute("Facturacion.delete");
assertNoErrors();
}
...
}
// En el archivo PruebaProducto.java
public class PruebaProducto extends ModuleTestBase {
...
public void testBorrarDesdeLista() throws Exception {
//execute("CRUD.deleteSelected");
execute("Facturacion.deleteSelected");
assertListRowCount(1);
}
...
}
// En el archivo PruebaPedido.java
public class PruebaPedido extends PruebaDocumentoComercial {
...
public void testPonerFactura() throws Exception {
...
//execute("CRUD.deleteRow", "row=0");
execute("Facturacion.deleteRow", "row=0");
// assertError("Imposible borrar Pedido por: " +
// "Pedido asociado a factura no puede ser eliminado");
assertErrorsCount(1); // Ahora mostramos un mensaje genérico.
...
}
}
Después de estos cambios todas tus prueba funcionarán bien, y esto confirma que tus
acciones para borrar personalizadas conservan la semántica original. Solo ha
cambiado la implementación.
Empezamos en el módulo Factura.
Borramos una factura desde modo detalle y verificamos que ha sido borrada.
Borramos una factura desde modo lista y verificamos que ha sido borrada.
Vamos al módulo PapeleraFactura.
Verificamos que contiene las dos facturas borradas.
Las restauramos y verificamos que desaparecen de la lista del módulo
papelera.
Volvemos al módulo Factura.
Verificamos que las dos facturas restauradas están en la lista.
Resumen
El comportamiento estándar de OpenXava solo es el punto de partida. Usando la
acción de borrar como excusa, hemos explorado algunas formas de refinar los detalles
del comportamiento de la aplicación. Con las técnicas de esta lección no solo puedes
refinar la lógica de borrado, sino también definir completamente la forma en que una
aplicación OpenXava funciona. Así, tienes la posibilidad de adaptar el comportamiento
de tu aplicación para cubrir las expectativas de tus usuarios.
El comportamiento por defecto de OpenXava es limitado: solo mantenimientos y
listados. Si quieres una aplicación que de verdad aporte valor a tu usuario necesitas
añadir funcionalidad específica que le ayude a resolver sus problemas. Haremos esto
en la próxima lección.
@OneToMany(mappedBy="invoice")
@CollectionView("NoCustomerNoInvoice")
@NewAction("Invoice.addOrders") // @NewAction ya no se usa para
definir la acción de añadir
private Collection<Order> orders;
Por::
@OneToMany(mappedBy="invoice")
@CollectionView("NoCustomerNoInvoice")
@AddAction("Invoice.addOrders") // @AddAction en su lugar
private Collection<Order> orders;
Los conceptos
Aunque OpenXava tiene una visión muy pragmática del desarrollo, está basado
en un refinamiento de conceptos preexistentes, algunos populares y otros no
tanto. El más popular es el Desarrollo Dirigido por el Modelo (Model-Driven
Development, MDD), que OpenXava usa de una manera ligera. El otro
concepto, el Componente de Negocio, es raíz y principio básico de OpenXava,
además de ser la alternativa opuesta a MVC.
Veamos estos conceptos con más detalles.
Podemos decir pues, que OpenXava es un Marco de trabajo Ligero Dirigido por
el Modelo:
A partir de clases Java simples obtienes una aplicación lista para usar. La
siguiente sección sobre el concepto de Componente de Negocio revelará
algunos detalles importantes sobre la naturaleza de estas clases.
Componente de Negocio
Un Componente de Negocio consiste en todos los artefactos de software
relacionados con un concepto de negocio. Los componentes de negocio son
tan solo una forma de organizar el software. La otra forma de organizar
software es MVC (Model-View Controller), donde clasificas el código por datos
(modelo), interfaz de usuario (vista) y lógica (controlador).
Así se organizan los artefactos de software en una aplicación MVC:
Aquí, todos los artefactos de software acerca del concepto de factura, como la
interfaz de usuario, acceso a base de datos, lógica de negocio, etc. están en un
mismo lugar.
¿Qué enfoque es mejor? Eso depende de tus necesidades. Si tienes que
cambiar frecuentemente la estructura de los datos y la lógica de negocio
entonces la opción de los componentes de negocio es muy práctica, porque
todas las cosas que necesitas tocar cuando haces un cambio están en el
mismo sitio y no esparcidas por multitud de archivos.
La pieza básica para desarrollar aplicaciones OpenXava es el componente de
negocio y la forma de definir un componente de negocio en OpenXava es
usando una simple clase Java con anotaciones. Tal como se ilustra en este
código:
/**
* Una clase Java para definir un componente de negocio.
*/
@Entity // Base de datos
@Table(name="GSTFCT") // Base de datos
@View(members= // Interfaz de usuario
"anyo, numero, fecha, pagada;" +
"cliente, comercial;" +
"detalles;" +
"totales [ sumaImportes, porcentajeIva, iva ]"
)
public class Factura {
@Id // Base de datos
@Column(length=4) // Base de datos
@Max(9999) // Validación
@Required // Validación
@DefaultValueCalculator( // Lógica de negocio declarativa
CurrentYearCalculator.class
)
private int anyo; // Estructura de datos (1)
@ManyToOne(fetch=FetchType.LAZY) // Base de datos
@DescriptionsList // Interfaz de usuario
private Comercial comercial; // Estructura de datos
public void aplicarDescuentos() { // Lógica de negocio
programática (2)
...
}
...
}
Como puedes ver, todo acerca del concepto de negocio de factura se define en
un único lugar, la clase Factura. En esta clase defines cosas de base de datos,
estructura de los datos, lógica de negocio, interfaz de usuario, validación, etc.
Esto se hace usando la facilidad de metadatos de Java, las famosas
anotaciones. Estas son las anotaciones usadas en este ejemplo:
Faceta Metadatos Implementado por
Gracias a los metadatos puedes hacer la mayor parte del trabajo de una forma
declarativa y el motor de JPA (el estándar Java para persistencia), Bean
Validation (el estándar Java para validación) y OpenXava harán el trabajo sucio
por ti.
Además, usamos Java básico, como propiedades (anyo y comercial, 1) para
definir la estructura de los datos, y los métodos (aplicarDescuentos(), 2) para la
lógica de negocio programada.
Todo lo que se necesita escribir sobre factura está en Factura.java. Es un
componente de negocio. La magia de OpenXava es que puede producir una
aplicación funcional a partir de componentes de negocio.
Arquitectura de la aplicación
Has visto como los componentes de negocio son las células básicas para
construir una aplicación OpenXava, es más, puedes crear una aplicación
OpenXava completa usando únicamente componentes de negocio. No
obstante, hay otros ingredientes que puedes usar en una aplicación OpenXava.
Flexibilidad
OpenXava genera automáticamente una aplicación desde clases con
metadatos. Esto incluye la generación automática de la interfaz de usuario.
Puedes pensar que esto es demasiado “automático”, y es fácil que la interfaz
de usuario resultante no cumpla con tus requerimientos, especialmente si estos
son muy específicos. Esto no es así, las anotaciones de OpenXava te ofrecen
flexibilidad suficiente para interfaces de usuario muy potentes que cubren la
mayoría de los casos.
A pesar de eso, OpenXava te proporciona puntos de extensión para darte la
oportunidad de personalizar la generación de la interfaz de usuario. Estos
puntos de extensión incluyen editores y vistas personalizadas.
Editores
Los editores son los elementos de la interfaz de usuario para ver y editar los
miembros de tu componente de negocio. OpenXava usa editores predefinidos
para los tipos básicos, pero puedes crearte tus propios editores. En el siguiente
ejemplo se usan editores predefinidos para números y cadenas, pero para la
propiedad color se usa un editor personalizado:
Vista personalizada
A veces necesitas visualizar tu componente de negocio usando una interfaz de
usuario especial, por ejemplo, usando una galería de fotos, un mapa, un
gráfico, un calendario, etc. Para esto puedes usar una vista personalizada, que
te permite generar la interfaz de usuario usando JavaScript, HTML, JSP, etc. a
mano, y entonces usarla dentro de tu aplicación OpenXava. El siguiente
pantallazo muestra un módulo OpenXava que usa una vista personalizada:
Resumen
OpenXava usa un enfoque dirigido por el modelo para hacer desarrollo rápido,
donde tú escribes el modelo y obtienes una aplicación completa a partir de él.
Lo especial de OpenXava es que el modelo está formado por componentes de
negocio.
Un componente de negocio te permite estructurar la aplicación alrededor de los
conceptos de negocio. En OpenXava una simple y llana clase Java con
anotaciones es suficiente para definir un componente de negocio, haciendo el
desarrollo de la aplicación bastante declarativo.
Aparte de los componentes de negocio una aplicación OpenXava tiene
módulos, controladores, validadores, calculadores, etc. que puedes usar para
personalizar tu aplicación. Es posible, incluso, personalizar la forma en que
OpenXava genera la interfaz de usuario con los editores y las vistas
personalizadas.
OpenXava es una solución pragmática para el desarrollo Java Empresarial.
Genera muchísimas cosas automáticamente, pero a la vez es suficientemente
flexible como para ser útil en el desarrollo de aplicaciones de gestión de la vida
real.
Como conclusión, podrás desarrollar aplicaciones con simples clases Java con
anotaciones. En los otro apéndices puedes aprender más detalles sobre las
anotaciones que podemos usar con OpenXava.
Anotaciones JPA
JPA tiene 2 aspectos diferenciados, el primero es un conjunto de anotaciones
Java para añadir a tus clases marcándolas como persistentes y dando detalles
acerca del mapeo entre las clases y las tablas. Y el segundo es un API para
leer y escribir objetos desde tu aplicación. Veamos primero las anotaciones.
Entidad
En la nomenclatura JPA a una clase persistente se le llama entidad. Podemos
decir que una entidad es una clase cuyas instancias se graban en la base de
datos. Usualmente cada entidad representa un concepto del dominio, por lo
tanto usamos una entidad JPA como base para definir un componente de
negocio en OpenXava, de hecho puedes crear un aplicación completa de
OpenXava a partir de simples entidades JPA. Una entidad JPA se define así:
Propiedades
El estado básico de una entidad se representa mediante propiedades. Las
propiedades de una entidad son propiedades Java convencionales,
con getters y setters:
Por defecto las propiedades son persistentes, es decir, JPA asume que la
propiedad nombre se almacena en la columna llamada 'nombre' de la tabla en
la base de datos. Si quieres que una determinada propiedad no se guarde en la
base de datos has de marcarla como @Transient:
Nota que hemos anotado el campo, puedes anotar el getter en su lugar, si así
lo prefieres:
@Entity
@Table(name="GSTCST")
public class Cliente {
@Id // Indica que number es la propiedad clave (1)
@Column(length=5) // Aquí @Column indica solo la longitud (2)
private int numero;
@Column(name="CSTNAM", length=40) // La propiedad name se mapea a
la columna
private String nombre; // CSTNAM en la base de datos
public int getNumero() {
return numero;
}
public void setNumero(int numero) {
this.numero = numero;
}
public String getNombre() {
return nombre;
}
public void setNombre(String nombre) {
this.nombre = nombre;
}
}
Es obligatorio que al menos una propiedad sea clave (1). Has de marcar la
propiedad clave con @Id y normalmente se mapea contra la columna clave de
la tabla. @Column puede usarse para indicar la longitud sin el nombre de
columna (2). La longitud es usada por el motor JPA para la generación de
esquema, pero también es usada por OpenXava para conocer el tamaño del
editor en la interfaz de usuario. A partir del código de la
entidad Cliente OpenXava genera la siguiente interfaz de usuario:
Ahora que ya sabes como definir propiedades básicas en tu entidad,
aprendamos como declarar relaciones entre entidades usando referencias y
colecciones.
Referencias
Una entidad puede hacer referencia a otra entidad. Únicamente has de definir
una referencia Java convencional anotada con la anotación JPA
@ManyToOne:
@Entity
public class Factura {
@ManyToOne( // La referencia se almacena como una relación a
nivel de base de datos (1)
fetch=FetchType.LAZY, // La referencia se cargará bajo
demanda (2)
optional=false) // La referencia tiene que tener valor
siempre
@JoinColumn(name="INVCST") // INVCST es la columna para la clave
foranea (3)
private Cliente cliente; // Una referencia Java convencional (4)
// Getter y setter para cliente
Has visto como hacer referencia a otras entidades, pero también puedes hacer
referencia a otros objetos que no son entidades, por ejemplo, a objetos
incrustados.
Clases incrustables
Además de entidades puedes usar clases incrustables para modelar algunos
conceptos de tu dominio. Si tienes una entidad A que tiene una referencia a B,
modelarías B como una clase incrustable cuando:
@Entity
@Table(name="GSTCST")
public class Cliente {
@Embedded // Referencia a una clase incrustable
private Direccion direccion; // Una referencia Java convencional
// Getter y setter para address
...
}
Colecciones
Una entidad puede tener una colección de entidades. Sólo has de definir una
colección de Java convencional anotada con las anotaciones
JPA @OneToMany o @ManyToMany:
@Entity
public class Cliente {
@OneToMany( // La colección es persistente (1)
mappedBy="cliente") // La referencia cliente de Factura
se usa
// para mapear la relación a
nivel de base de datos (2)
private Collection<Factura> facturas; // Una colección Java
convencional (3)
// Getter y setter para facturas
...
}
@Entity
public class Factura {
@OneToMany (mappedBy="factura",
cascade=CascadeType.REMOVE) // Cascade REMOVE para simular
incrustamiento
private Collection<DetalleFactura> detalles;
// Getter y setter para detalles
...
}
@Entity
public class DetalleFactura {
...
}
Así, cuando una factura se borra sus líneas de detalle se borran también.
Podemos decir que una factura tiene líneas de detalle.
Esta es la interfaz de usuario que OpenXava genera automáticamente para una
colección de entidades:
Hay algunas ligeras diferencias en el comportamiento de la interfaz de usuario
si usas cascade REMOVE o ALL. Con cascade REMOVE o ALL cuando el
usuario pulsa para añadir un nuevo elemento, puede introducir todos los datos
del elemento, por otra parte si tu colección no es cascade REMOVE o ALL ,
cuando el usuario pulsa para añadir un nuevo elemento se muestra una lista de
entidades para escoger.
Además, se puede definir una colección de auténticos objetos embebidos.
Podriamos reescribir el ejemplo de los detalles de factura así:
@Entity
public class Factura {
@ElementCollection
private Collection<DetalleFactura> detalles;
// Getter and setter for details
...
}
@Embeddable
public class DetalleFactura {
...
}
Has visto como escribir tus entidades usando anotaciones JPA, y como
OpenXava las interpreta para así generar una interfaz de usuario adecuada.
Ahora vas a aprender como usar el API JPA para leer y escribir de la base de
datos de desde tu propio código.
API JPA
La clase de JPA más importante es javax.persistence.EntityManager.
Un EntityManager te permite grabar, modificar y buscar entidades.
El siguiente código muestra la forma típica de usar JPA en una aplicación no
OpenXava:
Resumen
Esta lección ha sido una breve introducción a la tecnología JPA. Por desgracia,
muchas e interesantes cosas sobre JPA se nos han quedado en el tintero,
como la herencia, el polimorfismo, las claves compuestas, relaciones uno a uno
y muchos a muchos, relaciones unidireccionales, métodos de retrollamada,
consultas avanzadas, etc. De hecho, hay más de 80 anotaciones en JPA.
Necesitaríamos varios libros completos para aprender todos los detalles sobre
JPA.
Afortunadamente, tendrás la oportunidad de aprender algunos casos de uso
avanzados de JPA en el transcurso de este curso. Y si aun quieres aprender
más, lee libros y referencias, como por ejemplo:
Apéndice C: Anotaciones
Las anotaciones son la herramienta que Java provee para definir metadatos en tus
aplicaciones, en otras palabras, es la forma de hacer desarrollo declarativo con Java,
donde dices el “qué” y no el “cómo”.
En esta lección verás las anotaciones que puedes usar en una aplicación OpenXava
para definir validaciones, la interfaz de usuario y otros aspectos para ajustar la
aplicación a tus necesidades.
El objetivo de esta lección es introducirte a estas anotaciones, pero no te muestra
todas su sutilezas y posibles casos de uso; lo cual requeriría varios libros de los
gordos.
Validación
OpenXava incluye un marco de validación fácil de usar y extensible. Además
soporta Bean Validation e Hibernate Validator.
Validación declarativa
La forma preferida de hacer validación en OpenXava es mediante anotaciones, es
decir, de manera declarativa. Por ejemplo, sólo has de marcar una propiedad
como @Required:
Validaciones predefinidas
Las anotaciones de validación que OpenXava tiene incluidas
(en org.openxava.annotations) son:
A partir de OpenXava 6.1 se soporta Bean Validation 2.0, por lo que también tenemos
disponibles las siguientes anotaciones en javax.validation.constraints:
Anotación Aplica a Validación
A partir de OpenXava 6.1 se soporta Hibernate Validator 6.0, por lo que también
tenemos disponibles las siguiente anotaciones en org.hibernate.validator.constraints:
Anotación Aplica a Validación
@PropertyValidator(ValidadorPrecioUnitario.class) // Contiene la
lógica de validación
private BigDecimal precioUnitario;
@Entity
public class Comercial {
@Id @Column(length=3)
private int numero;
@Column(length=40) @Required
private String nombre;
@OneToMany(mappedBy="comercial")
private Collection<Cliente> clientes;
// Getters y setters
...
}
OpenXava producirá para ti la siguiente interfaz de usuario:
La anotación @View
@View sirve para definir la disposición de los miembros en la interfaz de usuario. Se
define a nivel de entidad:
@Entity
@View(members=
"ano, numero, fecha;" + // Coma indica en la misma línea
"descuentos [" + // Entre corchetes indica dentro de un marco
" descuentoCliente, descuentoTipoCliente;" +
"];" +
"observaciones;" + // Punto y coma indica nueva línea
"cliente { cliente }" + // Entre llaves indica dentro de una
pestaña
"detalles { detalles }" +
"importes { sumaImportes; porcentajeIVA; iva }" +
"albaranes { albaranes }"
)
public class Factura {
Como ves, definir la disposición de los miembros es fácil, solo necesitas enumerarlos
dentro de una cadena, usando comas para separar los elementos, punto y coma para
salto de línea, corchetes para grupos (marcos), llavecitas para secciones (pestañas) y
así por el estilo.
Puedes tener varias vistas por cada entidad, para eso usa la anotación @Views,
dando un nombre a cada vista:
@Entity
@Views({
@View(
members="codigo, nombre; direccion; facturas"
),
@View(
name="Simple", members="codigo, nombre"
)
})
public class Cliente {
Si dejas una vista sin nombre, será la vista por defecto. Los nombres de vista se
usarán desde otras partes de la aplicación para escoger que vista usar.
Con @View defines la distribución, pero también necesitas definir la forma en que
cada miembro es visualizado, para eso, OpenXava te proporciona un conjunto de
anotaciones bastante útiles que verás en la siguiente sección.
Puedes pensar que hay muchas anotaciones, pero en realidad hay todavía más,
porque la mayoría de estas anotaciones tienen una versión en plural para definir
diferentes valores para diferentes vistas:
No te preocupes si aún no sabes como usar todas las anotaciones. Las irás
aprendiendo poco a poco a medida que desarrolles aplicaciones OpenXava.
Otras anotaciones
Aparte de las validaciones y de la interfaz de usuario, OpenXava dispone de algunas
otras anotaciones interesantes:
Resumen
Este capítulo ha mostrado como usar anotaciones Java para hacer programación
declarativa con OpenXava. Cosas como la interfaz de usuario o las validaciones, que
típicamente son pura programación, se pueden hacer con tan solo anotar nuestro
código.
Puedes aprender más detalles sobre estas anotaciones e incluso aprender más
anotaciones en la Guía de Referencia de OpenXava y en OpenXava API Doc de
org.openxava.annotations. Sin embargo, la mejor forma de aprender es con ejemplos,
y el resto del curso es justo eso, un conjunto de ejemplos y más ejemplos que te
mostrarán como usar estas anotaciones.
Empecemos a aprender.