Cette section présente SimpleExampleServlet
, qui est l'exemple de mise en œuvre le plus simple d'une source de données fournie avec la bibliothèque. Cette section fournit également des instructions détaillées sur l'exécution et le test de SimpleExampleServlet
.
Découvrez SimpleExampleServlet
La classe SimpleExampleServlet
se trouve dans le package examples
. Cette classe fournit un exemple de mise en œuvre la plus simple d'une source de données. SimpleExampleServlet
hérite de DataSourceServlet
, implémente generateDataTable()
et doit être exécuté dans un conteneur de podcast.
Un extrait de SimpleExampleServlet
est fourni ci-dessous. La fonction generateDataTable
expose les données à la bibliothèque. Cette fonction crée une description du tableau de données, définit les colonnes du tableau de données et renseigne celui-ci avec les données.
La bibliothèque gère toutes les autres actions requises pour renvoyer la table de données dans la visualisation des requêtes.
// This example extends DataSourceServlet public class SimpleExampleServlet extends DataSourceServlet { @Override public DataTable generateDataTable(Query query, HttpServletRequest request) { // Create a data table, DataTable data = new DataTable(); ArrayListcd = new ArrayList (); cd.add(new ColumnDescription("name", ValueType.TEXT, "Animal name")); cd.add(new ColumnDescription("link", ValueType.TEXT, "Link to wikipedia")); cd.add(new ColumnDescription("population", ValueType.NUMBER, "Population size")); cd.add(new ColumnDescription("vegeterian", ValueType.BOOLEAN, "Vegetarian?")); data.addColumns(cd); // Fill the data table. try { data.addRowFromValues("Aye-aye", "http://en.wikipedia.org/wiki/Aye-aye", 100, true); data.addRowFromValues("Sloth", "http://en.wikipedia.org/wiki/Sloth", 300, true); data.addRowFromValues("Leopard", "http://en.wikipedia.org/wiki/Leopard", 50, false); data.addRowFromValues("Tiger", "http://en.wikipedia.org/wiki/Tiger", 80, false); } catch (TypeMismatchException e) { System.out.println("Invalid type!"); } return data; } }
Exécuter et tester SimpleExampleServlet
Cette section explique comment exécuter et tester SimpleExampleServlet
.
Si vous ne l'avez pas déjà fait, consultez la section Installation pour obtenir des informations sur les prérequis et des instructions sur le téléchargement et la création de la bibliothèque. Assurez-vous d'installer un serveur Web qui fonctionne également comme un conteneur de webhook, comme Apache Tomcat, si vous n'en avez pas déjà un sur votre système. Les instructions de cette section sont spécifiques à Apache Tomcat sur un système Windows.
Pour exécuter et tester SimpleExampleServlet
, créez une application Web qui exécute la source de données SimpleExampleServlet
, puis exécutez un exemple de page Web avec une visualisation des données interrogées à partir de la source de données. Ce point est décrit dans les sections suivantes:
Créer une application Web sur Apache Tomcat
Suivez ou adaptez les instructions ci-dessous pour créer une application Web sur Apache Tomcat. Ces instructions sont spécifiques à Apache Tomcat sur un système Windows:
- Accédez au répertoire dans lequel vous avez installé Tomcat. Dans ce document, il est écrit sous la forme
<tomcat_home>
.
- Accédez au sous-répertoire
webapps
.
- Créez un sous-répertoire appelé
myWebApp
.
- Accédez au sous-répertoire que vous venez de créer et créez un autre sous-répertoire appelé
WEB-INF
.
- Accédez au sous-répertoire
WEB-INF
et créez un autre sous-répertoire appelélib
.
Le chemin d'accès complet doit être<tomcat_home>/webapps/myWebApp/WEB-INF/lib
.
- Copiez
web.xml
à partir de<data_source_library_install>/examples/src/html
dans le répertoireWEB-INF
. Où<data_source_library_install>
correspond au répertoire dans lequel vous avez installé la bibliothèque de sources de données. Les lignes suivantes dansweb.xml
définissent et mappentSimpleExampleServlet
:
<servlet> <servlet-name>My Servlet</servlet-name> <description>My servlet description.</description> <servlet-class>SimpleExampleServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>My Servlet</servlet-name> <url-pattern>/simpleexample</url-pattern> </servlet-mapping>
- Accédez au répertoire dans lequel vous avez installé la bibliothèque de sources de données.
Ce document est écrit sous la forme
<data_source_library_install>
.
- Copiez tous les packages de dépendances dans
<tomcat_home>/webapps/myWebApp/WEB-INF/lib
. Les packages sont installés dans<data_source_library_install>/lib
, sauf si vous les placez dans un autre répertoire.
- Si vous avez créé la bibliothèque vous-même, copiez
visualization-datasource-1.0.2.jar
etvisualization-datasource-examples.jar
depuis<data_source_library_install>/build
vers<tomcat_home>/webapps/myWebApp/WEB-INF/lib
.
Si vous avez décompressé le fichier ZIP, copiezvisualization-datasource-1.0.2.jar
etvisualization-datasource-examples.jar
de<data_source_library_install>
dans<tomcat_home>/webapps/myWebApp/WEB-INF/lib
.
Notez que le numéro de version indiqué dans le nom du fichier JAR peut varier en fonction du dernier numéro de version. - Lancez Tomcat, ou redémarrez-le s'il est déjà en cours d'exécution.
- Cliquez sur le lien suivant:
http://localhost:8080/myWebApp/simpleexample
L'écran affiche entre 6 et 7 lignes de texte, en fonction de la largeur de l'écran.
Le texte commence pargoogle.visualization.Query.setResponse
et se termine par/Tiger'},{v:80.0},{v:false}]}]}});
Il s'agit des données renvoyées par votre source de données à une visualisation de requête.
Utiliser une visualisation pour consulter les données
Le fichier getting_started.html
du répertoire <data_source_library_install>/examples/src/html
permet d'afficher une visualisation des données. La ligne suivante, tirée de getting_started.html
, spécifie le jeton à utiliser. Le mappage de webhook a été configuré à l'étape 8 de la section Créer une application Web sur Apache Tomcat.
var query = new google.visualization.Query('simpleexample');
Pour en savoir plus sur la spécification d'une visualisation et l'utilisation du langage de requête, consultez les pages Utiliser des graphiques et Documentation de référence sur le langage de requête.
Suivez ou adaptez les instructions ci-dessous pour afficher une visualisation des données fournies par la source de données:
- Copiez le fichier
getting_started.html
du répertoire<data_source_library_install>/examples/src/html
dans le répertoire<tomcat_home>/webapps/myWebApp/
.
- Cliquez sur le lien suivant http://localhost:8080/myWebApp/getting_started.html.
Vous devriez voir le résultat suivant :
Et voilà ! Vous avez configuré votre première source de données.
Next Steps
L'exemple suivant est décrit dans la section Utiliser un datastore externe. Vous pouvez également revenir à l'introduction ou explorer les liens suivants:
- Pour une présentation des classes les plus couramment utilisées de la bibliothèque, consultez la page Classes clés.
- Pour obtenir un exemple de mise en œuvre de votre propre flux d'événements et de vos requêtes, consultez la section Définir les fonctionnalités et le flux d'événements.
- Si vous ne souhaitez pas hériter de
DataSourceServlet
, vous pouvez implémenter une source de données comme décrit dans Utiliser votre propre jeton. Par exemple, vous ne voudriez peut-être pas hériter deDataSourceServlet
si vous héritez d'un webhook d'une autre classe. - Si vous ne souhaitez pas utiliser de webhook, consultez l'article Mettre en œuvre une source de données sans webhook.
- Pour savoir comment transmettre des paramètres d'une application à une source de données, consultez la section Transmettre des paramètres à
DataTableGenerator.generateDataTable
.