Paquetes de biblioteca y clases de claves

Para obtener una introducción a las clases más usadas, consulta clases clave.

Para obtener una introducción a los paquetes de la biblioteca de fuentes de datos de Java, sigue estos vínculos:

• fuente de datos
• datasource.base.
• datasource.datatable.
• datasource.query.
• datasource.render.
• datasource.util;

Clases clave

Las clases clave son DataSourceServlet, DataTable, Query y DataSourceHelper.

La implementación más simple de la biblioteca implica heredar de DataSourceServlet, escribir tu propia implementación de generateDataTable() y, luego, ejecutarla en un servlet. Este tipo de implementación se describe en la sección de introducción.

La clase DataTable define las columnas, los tipos de columnas, las etiquetas, los ID y las propiedades personalizadas de una tabla de datos.

La clase Query es la clase base para las consultas de datos y controla una consulta generada por una visualización.

Para casos prácticos más complejos, la clase auxiliar DataSourceHelper proporciona un conjunto de funciones auxiliares. Este tipo de implementación se describe en Cómo definir capacidades y el flujo de eventos.

datasource

Este es el paquete de nivel superior y contiene las clases de API con las que interactúan la mayoría de los desarrolladores de fuentes de datos.

En este nivel superior, también está Capabilities, que se usa para definir las capacidades de consulta de la fuente de datos.

base

Este paquete contiene todas las clases que usan más de un paquete para evitar dependencias circulares entre los paquetes. Los elementos más notables son los mensajes de error en la configuración regional predeterminada de inglés de EE.UU. Para internacionalizar tu implementación, deberás traducir estos mensajes.

datatable

Este paquete contiene clases que controlan la estructura de tablas de datos (columnas, filas, celdas) y la funcionalidad (insertar, agregar).

Este paquete también contiene el paquete value que controla los valores y los tipos de valores admitidos por la biblioteca. Los tipos de valores disponibles se definen en la enumeración ValueType y se incluyen valores booleanos, fecha, hora del día, fecha y hora, nulo, número y texto. 

query

Este paquete contiene clases que controlan las consultas; la clase base es Query. Este paquete también contiene los siguientes paquetes:

• parser: Son las clases que controlan el análisis de consultas.
  
• engine: Son las clases que controlan la ejecución de consultas.
• scalarfunction: Son clases que controlan las funciones escalares utilizadas en una consulta.

render

Este paquete contiene las clases que dan formato a una respuesta. Por ejemplo:

• CsvRenderer renderiza una tabla de datos como CSV.
• HtmlRenderer renderiza una tabla de datos como HTML.
• JsonRenderer renderiza una tabla de datos como JSON.
• EscapeUtil proporciona una utilidad para escapar strings.

util

Este paquete proporciona dos conjuntos de funciones auxiliares:

• CsvDataSourceHelper y CsvDataSourceException proporcionan funciones auxiliares para usar un archivo CSV como almacén de datos. No proporcionan una implementación completa de una fuente de datos. Para ver una implementación de ejemplo, consulta Usa un almacén de datos externo.
• SqlDataSourceHelper y SqlDatabaseDescription proporcionan funciones auxiliares para usar una base de datos MySQL como almacén de datos. No proporcionan una implementación completa de una fuente de datos. Para ver una implementación de ejemplo, consulta SqlDataSourceServlet en el paquete examples.