openxava / documentación / Lección 8: Herencia de vistas

Curso: 1. Primeros pasos | 2. Modelo básico del dominio (1) | 3. Modelo básico del dominio (2) | 4. Refinar la interfaz de usuario | 5. Desarrollo ágil | 6. Herencia de superclases mapeadas | 7. Herencia de entidades | 8. Herencia de vistas | 9. Propiedades Java | 10. Propiedades calculadas | 11. @DefaultValueCalculator en colecciones | 12. @Calculation y totales de colección | 13. @DefaultValueCalculator desde archivo | 14. Evolución del esquema manual | 15. Cálculo de valor por defecto multiusuario | 16. Sincronizar propiedades persistentes y calculadas | 17. Lógica desde la base de datos | 18. Validando con @EntityValidator | 19. Alternativas de validación | 20. Validación al borrar | 21. Anotación Bean Validation propia | 22. Llamada REST desde una validación | 23. Atributos en anotaciones | 24. Refinar el comportamiento predefinido | 25. Comportamiento y lógica de negocio | 26. Referencias y colecciones | A. Arquitectura y filosofía | B. Java Persistence API | C. Anotaciones | D. Pruebas automáticas

Tabla de contenidos

Lección 8: Herencia de vistas
El atributo extendsView
Vista para Invoice usando herencia
Vista para Order usando herencia
Usar @ReferenceView y @CollectionView para refinar vistas
Resumen
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 lección muestra como funciona la herencia de vistas.

El atributo extendsView

Tanto Order como Invoice 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 CommercialDocument 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 = "a, b, c;") // Esta vista se usa para visualizar Parent, pero no para Child
public class Parent { ... }
 
public class Child extends Parent { ... }   // Child se visualiza usando la vista generada
                                            // automáticamente, no la vista de Parent
Generalmente la vista de la entidad padre “tal cual” no es demasiado útil porque no contiene todas las propiedades de la entidad actual. Por tanto este comportamiento suele venir bien como comportamiento por defecto.
Aunque, en una entidad no trivial necesitas refinar la interfaz de usuario y quizás sea útil heredar (en lugar de copiar y pegar) la vista del padre. Puedes hacer esto usando el atributo extendsView en @View:
@View(members = "a, b, c;") // Esta vista sin nombre es la vista DEFAULT
public class Parent { ... }
 
@View(name="A" members = "d", // Añade d a la vista heredada
    extendsView = "super.DEFAULT") // Extiende la vista por defecto de Parent
@View(name="B" members = "a, b, c; d") // La vista B es igual a la vista A
public class Child extends Parent { ... }   // Child se visualiza usando la vista generada
                                            // automáticamente, no la vista de Parent
Usando extendsView los miembros a mostrar serán aquellos en la vista que extendemos más aquellos en members de la actual.
Vamos a usar esta característica para definir las vistas para CommercialDocument, Order e Invoice.

Vista para Invoice usando herencia

Dado que la @View de CommercialDocument no se hereda, la interfaz de usuario actual para Invoice es bastante fea: todos los miembros, uno por línea. Vamos a definir una interfaz de usuario mejor. Una vista parecida a la que ya teníamos, pero añadiendo una pestaña para pedidos, así:
inheritance_en060.png
Nota que ponemos todos los miembros de la parte de CommercialDocument de Invoice en la cabecera y la primera pestaña (data), y la colección de pedidos en la otra pestaña. El siguiente código muestra la forma de definir esto sin herencia.
@View( members=
    "year, number, date;" +
    "data {" +
        "customer;" +
        "details;" +
    "remarks" +
    "}" +
    "orders { orders } "
)
public class Invoice extends CommercialDocument {
Puedes notar como todos los miembros, excepto la parte de orders, son comunes para todos los CommercialDocument. Por lo tanto, vamos a mover esta parte común a CommercialDocument y redefinir la vista usando herencia.
Quita el viejo @View de CommercialDocument y escribe esto:
@View(members=
    "year, number, date," + // Los miembros para la cabecera en una línea
    "data {" + // Una pestaña 'data' para los datos principales del documento
        "customer;" +
        "details;" +
        "remarks" +
    "}"
)
abstract public class CommercialDocument extends Identifiable {
Esta vista indica como distribuir los datos comunes para todos los documentos comerciales. Ahora podemos redefinir la vista de Invoice a partir de esta:
@View(extendsView="super.DEFAULT", // Extiende de la vista de CommercialDocument
    members="orders { orders }" // Añadimos orders dentro de una pestaña
)
public class Invoice extends CommercialDocument {
De esta forma declarar la vista para Invoice es más corto, es más, la distribución común para Order, Invoice y todos los demás posibles CommercialDocument está en un único sitio, por tanto, si añades una nueva propiedad a CommercialDocument solo has de tocar la vista de CommercialDocument.

Vista para Order usando herencia

Ahora que tienes una vista adecuada para CommercialDocument, declarar una vista para Order es lo más fácil del mundo. Queremos algo así:
inheritance_en070.png
Para obtener este resultado, puedes definir la vista de Order extendiendo la vista por defecto de CommercialDocument y añadiendo la referencia a factura en una nueva pestaña:
@View(extendsView="super.DEFAULT", // Extiende de la vista de CommercialDocument
    members="invoice { invoice } " // Añadimos invoice dentro de una pestaña
)
public class Order extends CommercialDocument {
Con esto conseguimos toda la información de CommercialDocument más una pestaña con la factura.

Usar @ReferenceView y @CollectionView para refinar vistas

Queremos que cuando un pedido sea visualizado desde la interfaz de usuario de Invoice la vista a usar sea simple, sin cliente ni factura, porque estos datos son redundantes en este caso:
inheritance_en080.png
Para obtener este resultado define una vista más simple en Order:
@View( extendsView="super.DEFAULT", // La vista por defecto
    members="invoice { invoice } "
)
@View( name="NoCustomerNoInvoice", // Una vista llamada NoCustomerNoInvoice
    members=                       // que no incluye cliente ni factura.
        "year, number, date;" +    // Ideal para ser usada desde Invoice
        "details;" +
        "remarks"
)
public class Order extends CommercialDocument {
Esta nueva vista definida en Order llamada NoCustomerNoInvoice puede ser referenciada desde Invoice para visualizar elementos individuales de la colección orders usando @CollectionView:
public class Invoice extends CommercialDocument {

    ...

    @OneToMany(mappedBy="invoice")
    @CollectionView("NoCustomerNoInvoice") // Esta vista se usa para visualizar pedidos
    private Collection<Order> orders;
Y tan solo con este código la colección orders usará una vista más apropiada de Invoice para visualizar elementos individuales.
Además, queremos que desde la interfaz de usuario de Order 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 Invoice:
@View( extendsView="super.DEFAULT", // La vista por defecto
    members="orders { orders }"
)
@View( name="NoCustomerNoOrders", // Una vista llamada NoCustomerNoOrders
    members=                      // que no incluye cliente ni pedidos
        "year, number, date;" +   // Ideal para usarse desde Order
        "details;" +
        "remarks"
)
public class Invoice extends CommercialDocument {
Esta nueva vista definida en Invoice llamada NoCustomerNoOrders puede ser referenciada desde Order para visualizar la referencia a Invoice usando @ReferenceView:
public class Order extends CommercialDocument {
 
    @ManyToOne
    @ReferenceView("NoCustomerNoOrders") // Esta vista se usa para visualizar invoice
    private Invoice invoice;
 
    ...
Ahora la referencia invoice será visualizada desde Order sin incluir el cliente y los pedidos, por lo que tendrás una interfaz de usuario más simple:
inheritance_en090.png

Resumen

Esta lección ha mostrado cómo usar la herencia para simplificar la definición de la interfaz de usuario, por medio del atributo extendsView de @View. Por el camino hemos visto también algunos ejemplo de simplificar la forma en que se visualizan las referencias y colecciones usando @ReferenceView y @CollectionView.

¿Problemas con la lección? Pregunta en el foro ¿Ha ido bien? Ve a la lección 9