Packages de bibliothèque et classes de clés

Pour en savoir plus sur les classes les plus couramment utilisées, consultez la section sur les classes de clés.

Pour une introduction aux packages de la bibliothèque Java de sources de données, suivez les liens ci-dessous:

• source de données
• datasource.base
• datasource.datatable
• datasource.query
• datasource.render
• datasource.util

Classes clés

Les classes de clés sont DataSourceServlet, DataTable, Query et DataSourceHelper.

La mise en œuvre la plus simple de la bibliothèque consiste à hériter de DataSourceServlet, à écrire votre propre implémentation de generateDataTable(), puis à exécuter l'implémentation dans un servlet. Ce type d'implémentation est décrit dans la section Premiers pas.

La classe DataTable définit les colonnes, les types de colonne, les libellés, les ID et les propriétés personnalisées d'une table de données.

La classe Query est la classe de base des requêtes de données. Elle gère une requête générée par une visualisation.

Pour les cas d'utilisation plus complexes, la classe d'assistance DataSourceHelper fournit un ensemble de fonctions d'assistance. Ce type d'implémentation est décrit sur la page Définir des fonctionnalités et le flux d'événements.

datasource

Il s'agit du package de premier niveau qui contient les classes d'API avec lesquelles la plupart des développeurs de sources de données interagissent.

Capabilities se trouve également à ce niveau supérieur, qui permet de définir les capabilities de requête de la source de données.

base

Ce package contient toutes les classes utilisées par plusieurs packages pour empêcher les dépendances circulaires entre les packages. Les éléments les plus notables sont les messages d'erreur associés à la langue par défaut (anglais américain). Pour internationaliser votre implémentation, vous devrez traduire ces messages.

datatable

Ce package contient des classes qui gèrent la structure des tables de données (colonnes, lignes, cellules) et leurs fonctionnalités (insertion, ajout).

Ce package contient également le package value qui gère les valeurs et les types de valeurs acceptés par la bibliothèque. Les types de valeurs disponibles sont définis dans l'énumération ValueType et incluent: booléen, date, heure de la journée, date et heure, valeur nulle, nombre et texte. 

query

Ce package contient des classes qui gèrent les requêtes. La classe de base est Query. Ce package contient également les packages suivants:

• parser : classes qui gèrent l'analyse des requêtes.
  
• engine : classes qui gèrent l'exécution des requêtes.
• scalarfunction : classes qui gèrent les fonctions scalaires utilisées dans une requête.

render

Ce package contient les classes qui mettent en forme une réponse. Exemple :

• CsvRenderer affiche une table de données au format CSV.
• HtmlRenderer affiche un tableau de données au format HTML.
• JsonRenderer affiche une table de données au format JSON.
• EscapeUtil fournit un utilitaire pour échapper des chaînes.

util

Ce package fournit deux ensembles de fonctions d'assistance:

• CsvDataSourceHelper et CsvDataSourceException fournissent des fonctions d'aide permettant d'utiliser un fichier CSV en tant que datastore. Ils ne fournissent pas une implémentation complète d'une source de données. Pour obtenir un exemple de mise en œuvre, consultez la page Utiliser un data store externe.
• SqlDataSourceHelper et SqlDatabaseDescription fournissent des fonctions d'aide permettant d'utiliser une base de données MySQL en tant que magasin de données. Ils ne fournissent pas une implémentation complète d'une source de données. Pour obtenir un exemple d'implémentation, consultez SqlDataSourceServlet dans le package examples.