Paquetes de biblioteca y clases clave

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

Para obtener una introducción a los paquetes de bibliotecas de Java de fuente de datos, sigue los vínculos que se indican a continuación:

• 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, ejecutar la implementación dentro de un servlet. Este tipo de implementación se describe en la sección Cómo comenzar.

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

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

Para casos de uso más complejos, la clase auxiliar DataSourceHelper proporciona un conjunto de funciones auxiliares. Este tipo de implementación se describe en Cómo definir funciones 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.

También en este nivel superior está Capabilities, que se usa para definir las capabilities de consulta de la fuente de datos.

base

Este paquete contiene todas las clases que usa más de un paquete para evitar las dependencias circulares entre los paquetes. Los elementos más destacados son los mensajes de error en la configuración regional predeterminada, que es el 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 la tabla 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 compatibles con la biblioteca. Los tipos de valores disponibles se definen en la enumeración ValueType. Estos son booleanos, fecha, hora del día, fecha y hora, nulo, número y texto.

query

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

• parser: Clases que controlan el análisis de consultas.
  
• engine: Clases que controlan la ejecución de la consulta.
• scalarfunction: Clases que controlan las funciones escalares usadas 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 Cómo usar un almacén de datos externo.
• SqlDataSourceHelper y SqlDatabaseDescription proporcionan funciones auxiliares para usar una base de datos MySQL como almacén de datos, pero no proporcionan una implementación completa de una fuente de datos. Para ver una implementación de ejemplo, consulta SqlDataSourceServlet en el paquete examples.