Pour obtenir une présentation des classes les plus couramment utilisées, consultez la page Classes clés.
Pour obtenir une présentation des packages de la bibliothèque Java de source de données, cliquez sur les liens ci-dessous:
- source de données
- datasource.base.
- datasource.datatable.
- datasource.query.
- datasource.render
- sourcesource.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 à l'exécuter 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 colonnes, 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 pour les requêtes de données. Elle gère une requête générée par la 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 dans la section Définir les fonctionnalités et le flux d'événements.
datasource
Il s'agit du package de premier niveau. Il contient les classes d'API avec lesquelles la plupart des développeurs de sources de données interagissent.
De plus, à ce niveau supérieur, Capabilities est utilisé pour définir les fonctionnalités de requête de la source de données.
base
Ce package contient toutes les classes utilisées par plusieurs packages afin d'empêcher les dépendances circulaires entre les packages. Les éléments les plus importants sont des messages d'erreur dans la langue par défaut de l'anglais américain. Pour internationaliser votre mise en œuvre, vous devrez traduire ces messages.
datatable
Ce package contient des classes qui gèrent la structure du tableau de données (colonnes, lignes, cellules) et les 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: booléen, date, heure, date et heure, valeur NULL, nombre et texte.
query
Ce package contient des classes qui traitent 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 de requêtes.scalarfunction: classes qui gèrent les fonctions scalaires utilisées dans une requête.
render
Ce package contient les classes qui formatent une réponse. Exemple :
CsvRendereraffiche un tableau de données au format CSV.HtmlRendereraffiche un tableau de données au format HTML.JsonRendereraffiche une table de données au format JSON.EscapeUtilfournit un utilitaire pour échapper les chaînes.
util
Ce package fournit deux ensembles de fonctions d'assistance:
CsvDataSourceHelperetCsvDataSourceExceptionfournissent des fonctions d'aide permettant d'utiliser un fichier CSV en tant que datastore. Elles 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 datastore externe.SqlDataSourceHelperetSqlDatabaseDescriptionfournissent des fonctions d'aide permettant d'utiliser une base de données mySQL en tant que datastore. Elles ne fournissent pas une implémentation complète d'une source de données. Pour un exemple de mise en œuvre, consultezSqlDataSourceServletdans le packageexamples.