openxava / documentación / Lección 11: @DefaultValueCalculator en colecciones

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 11: @DefaultValueCalculator en colecciones
Usar @DefaultValueCalculator
Resumen
Hemos agregado lógica del negocio a nuestra aplicación utlizando propiedades persistentes y propiedas calculadas, ahora utilizaremos la anotación @DefaultValueCalculator para las colecciones.

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 pricePerUnit (precio por unidad) a la clase Detail y calculemos su valor desde price de Product usando un @DefaultValueCalculator. De tal forma que consigamos el efecto que puedes ver en la siguiente figura:
business-logic_en020.png
La lógica para calcular el valor inicial la tendremos en PricePerUnitCalculator que simplemente lee el precio del producto. Observa el código de este calculador:
package com.yourcompany.invoicing.calculators; // En el paquete 'calculators'

import org.openxava.calculators.*;
import com.yourcompany.invoicing.model.*;
import lombok.*;
 
import static org.openxava.jpa.XPersistence.*; // Para usar getManager()
 
public class PricePerUnitCalculator implements ICalculator {
 
    @Getter @Setter
    int productNumber; // Contiene el número de producto cuando se llama a calculate()
 
    public Object calculate() throws Exception {
        Product product = getManager() // getManager() de XPersistence
            .find(Product.class, productNumber); // Busca el producto
        return product.getPrice(); // Retorna su precio
    }
 
}
El siguiente paso es añadir la propiedad pricePerUnit. Añade el siguiente código a la clase Detail:
@DefaultValueCalculator(
    value=PricePerUnitCalculator.class, // Esta clase calcula el valor inicial
    properties=@PropertyValue(
        name="productNumber", // La propiedad productNumber del calculador...
        from="product.number") // ...se llena con el valor de product.number del detalle
)
@Money
BigDecimal pricePerUnit; // Una propiedad persistente convencional
De esta forma cuando el usuario escoge un producto el campo de precio unitario se rellena con el precio del producto, pero dado que es una propiedad persistente, el usuario puede cambiar este valor. Y si en el futuro el precio del producto cambiara este precio unitario de la línea de detalle no cambiaría.
Esto implica que has de adaptar la propiedad calculada amount:
@Money
@Depends("pricePerUnit, quantity") // pricePerUnit en vez de product.number
public BigDecimal getAmount() {
    if (pricePerUnit == null) return BigDecimal.ZERO; // pricePerUnit en vez de product y product.getPrice()
    return new BigDecimal(quantity).multiply(pricePerUnit); // pricePerUnit en vez de product.getPrice()
}
Ahora getAmount() usa pricePerUnit como fuente en lugar de product.price.
Finalmente, debemos editar la entidad CommercialDocument y modificar la lista de propiedades de la colección para mostrar la nueva propiedad:
@ElementCollection
@ListProperties("product.number, product.description, quantity, pricePerUnit, amount") // pricePerUnit añadida
Collection<Detail> details;
Prueba los módulos Order e Invoice y podrás observar el nuevo comportamiento al añadir líneas de detalle.

Resumen

En esta lección hemos aprendido cómo podemos utilizar la anotación @DefaultValueCalculator para definir el valor de diferentes propiedades.

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