openxava / documentación / Datos tabulares

• Filtrar por cualquier columna o combinación de ellas.
• Ordenar por cualquier columna con un simple click.
• Visualizar los datos paginados, y así podemos leer eficientemente tablas de millones de registros.
• Personalizar la lista: añadir, quitar y cambiar de orden las columnas (con el lapicito que hay en la parte superior izquierdas). Las personalizaciones se recuerdan por cada usuario.
• Acciones genéricas para procesar la lista: Como la de generar un informe en PDF, exportar a Excel o borrar los registros seleccionados.

@Tab(
    name="nombre",                           // 1
    filter=clase del filtro,                 // 2
    rowStyles=array de @RowStyle,            // 3
    properties="propiedades",                // 4
    baseCondition="condición base",          // 5
    defaultOrder="orden por defecto",        // 6
    editor="editor por defecto",             // 7  Nuevo en v4.6
    editors="todos los editores disponibles" // 8  Nuevo en v5.7
)
public class MiEntidad {

1. name (opcional): Podemos definir varios tabs para una entidad (usa @Tabspara versiones anteriores a la 6.1), y ponerle un nombre a cada uno. Este nombre se usará después para indicar que tab queremos usar (normalmente en aplicación.xml al definir un módulo).
2. filter (opcional): Permite definir programáticamente un filtro a realizar sobre los valores que introduce el usuario cuando quiere filtrar.
3. rowStyles (varios, opcional): Una forma sencilla de especificar una estilo de visualización diferente para ciertas filas. Normalmente para resaltar filas que cumplen cierta condición. Especificamos un array de @RowStyle, así podemos usar varios estilo por tab.
4. properties (opcional): La lista de propiedades a visualizar inicialmente. Pueden ser calificadas. El sufijo + (nuevo en v4.1) se puede añadir a una propiedad para mostrar la suma de la columna abajo.
5. baseCondition (opcional): Es una condición que aplicará siempre a los datos visualizados añadiendose a las que pueda poner el usuario.
6. defaultOrder (opcional): Para especificar el orden en que aparece los datos en la lista inicialmente.
7. editor (opcional): (Nuevo en v4.6) Editor de default-editors.xml o editores.xml usado para visualizar la lista. Se usa para el formato por defecto, si la lista tiene varios formatos los otros permanecen inalterados.
8. editores (opcional): (Nuevo en v5.7) Lista de editores separados por coma usados para visualizar la lista. Cada editor corresponde a un formato disponible para los usuarios. Los editores se declaran en default-editors.xml o editores.xml.

Propiedades iniciales y resaltar filas

@Tab(
    rowStyles=@RowStyle(style="row-highlight", property="tipo", value="fijo"),
    properties="nombre, tipo, comercial.nombre, direccion.municipio," +
        "comercial.nivel.descripcion, direccion.estado.nombre"
)

Filtros y condición base

@Tab(name="Actuales",
    filter=FiltroAñoActual.class,
    properties="año, numero, sumaImportes, iva, cantidadLineas, pagada, cliente.nombre",
    baseCondition="${año} = ?"
)
 

package org.openxava.test.filtros;
 
import java.util.*;
 
import org.openxava.filters.*;
 
/**
 * @author Javier Paniza
 */
 
public class FiltroAñoActual implements IFilter {            // (1)
 
    public Object filter(Object o) throws FilterException {  // (2)
        Calendar cal = Calendar.getInstance();
        cal.setTime(new java.util.Date());
        Integer año = new Integer(cal.get(Calendar.YEAR));
        Object [] r = null;
        if (o == null) {                                    // (3)
            r = new Object[1];
            r[0] = año;
        }
        else if (o instanceof Object []) {                  // (4)
            Object [] a = (Object []) o;
            r = new Object[a.length + 1];
            r[0] = año;
            for (int i = 0; i < a.length; i++) {
                r[i+1]=a[i];
            }
        }
        else {                                              // (5)
            r = new Object[2];
            r[0] = año;
            r[1] = o;
        }
 
        return r;
    }
 
}

@Tab(name="AñoDefecto",
    filter=FiltroAñoDefecto.class,
    properties="año, numero, cliente.numero, cliente.nombre, sumaImportes, " +
        "iva, cantidadLineas, pagada, importancia",
    baseCondition="${año} = ?"
)
 

package org.openxava.test.filtros;
 
import java.util.*;
 
import org.openxava.filters.*;
 
/**
 * @author Javier Paniza
 */
 
public class FiltroAñoDefecto extends BaseContextFilter {    // (1)
 
    public Object filter(Object o) throws FilterException {
        if (o == null) {
            return new Object [] { getAñoDefecto() };        // (2)
        }
        if (o instanceof Object []) {
            List c = new ArrayList(Arrays.asList((Object []) o));
            c.add(0, getAñoDefecto());                       // (2)
            return c.toArray();
        }
        else {
            return new Object [] { getAñoDefecto(), o };     // (2)
        }
    }
 
    private Integer getAñoDefecto() throws FilterException {
        try {
            return getInteger("xavatest_añoDefecto");        // (3)
        }
        catch (Exception ex) {
            ex.printStackTrace();
            throw new FilterException(
            "Imposible obtener año defecto asociado a esta sesión");
        }
    }
 
}

<objeto nombre="xavatest_añoDefecto" clase="java.lang.Integer" valor="1999"/>

new Integer(getEnvironment().getValue("XAVATEST_AÑO_DEFECTO"));

Select parcial (nuevo en v5.6)

@Tab(name="DeValencia",
    baseCondition="from Cliente e, in (e.provincias) p where p.id = 'V'")

Select íntegro

@Tab(name="SelectIntegro",
    properties="codigo, descripcion, familia",
    baseCondition=
        "select e.codigo, e.descripcion, f.descripcion " +
        "from Subfamilia e, Familia f " +
        "where e.codigoFamilia  = f.codigo"
)

@Tab(name="SelectIntegro",
    properties="codigo, descripcion, familia",
    baseCondition=
        "select" +
        "    ${codigo}, ${descripcion}, XAVATEST.FAMILIA.DESCRIPCION " +
        "from " +
        "    XAVATEST.SUBFAMILIA, XAVATEST.FAMILIA " +
        "where " +
        "    XAVATEST.SUBFAMILIA.FAMILIA = " +
        "    XAVATEST.FAMILIA.CODIGO"
)

Orden por defecto

@Tab(name="Simple", properties="año, numero, fecha",
    defaultOrder="${año} desc, ${numero} desc"
}
 

Valores por defecto para los tabs a nivel de aplicación (new v4m4)

<?xml version = "1.0" encoding = "ISO-8859-1"?>
 
<!DOCTYPE valores-defecto-tabs SYSTEM "dtds/valores-defecto-tabs.dtd">
 
<valores-defecto-tabs>
 
    <tab>
        <filtro clase="org.openxava.test.filtros.FiltroAnoActivo"/>
        <condicion-base>${ano} = ?</condicion-base>
 
        <para-modelo modelo="Albaran"/>
        <para-modelo modelo="Factura"/>
    </tab>
 
    <tab>
        <propiedades>ano, numero, fecha</propiedades>
        <orden-defecto>${numero} desc</orden-defecto>
 
        <para-modelo modelo="Albaran"/>
    </tab>
 
    <tab>
        <filtro clase="org.openxava.filters.UserFilter"/>
        <condicion-base>${usuario} = ?</condicion-base>
 
        <excepto-para-modelo modelo="Usuario"/>
    </tab>
 
    <tab>
        <orden-defecto>${oid} asc</orden-defecto>
        <para-todos-los-modelos/>
    </tab>
 
</valores-defecto-tabs>

Sumatorio de columna (nuevo en v4.1)

@Tab( properties = "año, numero, descripcion, importe+" )

Escoger un editor (nuevo en v4.6)

@Tab ( name ="Fichas", editor="ListaFichasCliente",
    properties="codigo, nombre, tipo, direccion.ciudad, direccion.provincia.nombre"
)

<editor nombre="ListaFichasCliente" url="fichasClienteListEditor.jsp"/>

Inhabilitar personalización

customizeList=false

public class MiAccion extends TabBaseAction {
 
    public void execute() throws Exception {
        if (miCondicion) {
            getTab().setCustomizeAllowed(false);
        }
        ...
    }
 
}

<modulo nombre="Almacen">
    <modelo nombre="Almacen"/>
    <controlador nombre="Typical"/>
    <controlador nombre="NoCustomizeList"/>
</modulo>

Varios formatos de presentación usando editores (nuevo en v5.7)

@Tab ( name ="ConTarjetas", editors ="List, Charts, ListaTarjetasClientes",
    properties="numero, nombre, tipo, direccion.poblacion, direccion.provincia.nombre"
)

Quitar los gráficos de modo lista (nuevo en v5.7)

@Tab ( name ="SoloLista", editors ="List",
    properties="numero, nombre, tipo, direccion.poblacion, direccion.provincia.nombre"
)

<?xml version = "1.0" encoding = "ISO-8859-1"?>
 
<!DOCTYPE valores-defecto-tabs SYSTEM "dtds/valores-defecto-tabs.dtd">
 
<valores-defecto-tabs>
 
    <tab editores="List">
        <para-todos-los-modelos/>
    </tab>
 
</valores-defecto-tabs>

Buscar por el contenido de una colección desde modo lista (nuevo en v6.4)

@Tab(properties="anyo, numero, fecha, cliente.nombre, lineas.producto.descripcion")
public class Factura {

	...
	
	@ElementCollection // o @OneToMany
	private Collection<LineaFactura> lineas;

}

@Embeddable // o @Entity
public class LineaFactura {

	...

	@ManyToOne
	private Producto producto; // Con una propiedad descripcion

}