Bibliothekspakete und Schlüsselklassen

Eine Einführung in die am häufigsten verwendeten Klassen finden Sie unter Schlüsselklassen.

Über die folgenden Links erhalten Sie eine Einführung in die Java-Bibliothekspakete für die Datenquelle:

Wichtige Klassen

Die wichtigsten Klassen sind DataSourceServlet, DataTable, Query und DataSourceHelper.

Die einfachste Implementierung der Bibliothek umfasst die Übernahme von DataSourceServlet, das Schreiben Ihrer eigenen Implementierung von generateDataTable() und die anschließende Ausführung der Implementierung in einem Servlet. Diese Art der Implementierung wird im Abschnitt Erste Schritte beschrieben.

Die Klasse DataTable definiert die Spalten, Spaltentypen, Labels, IDs und benutzerdefinierten Attribute für eine Datentabelle.

Die Klasse Query ist die Basisklasse für Datenabfragen und verarbeitet eine von der Visualisierung generierte Abfrage.

Für komplexere Anwendungsfälle bietet die Hilfsklasse DataSourceHelper eine Reihe von Hilfsfunktionen. Diese Art der Implementierung wird unter Funktionen und den Ablauf von Ereignissen definieren beschrieben.

datasource

Dies ist das Paket der obersten Ebene. Es enthält die API-Klassen, mit denen die meisten Datenquellenentwickler interagieren.

Auf dieser obersten Ebene befindet sich auch Capabilities, mit dem die Abfragefunktionen der Datenquelle definiert werden.

base

Dieses Paket enthält alle Klassen, die von mehreren Paketen verwendet werden, um kreisförmige Abhängigkeiten zwischen den Paketen zu vermeiden. Die wichtigsten Elemente sind Fehlermeldungen in der Standardsprache von US-Englisch. Für die Internationalisierung Ihrer Implementierung müssen Sie diese Nachrichten übersetzen.

datatable

Dieses Paket enthält Klassen, die die Datentabellenstruktur (Spalten, Zeilen, Zellen) und Funktionen (einfügen, hinzufügen) verarbeiten.

Dieses Paket enthält auch das Paket value, das die von der Bibliothek unterstützten Werte und Werttypen verarbeitet. Die verfügbaren Werttypen sind in der Aufzählung ValueType definiert und umfassen: boolesche Werte, Datum, Uhrzeit, Datum und Uhrzeit, Null, Zahl und Text. 

query

Dieses Paket enthält Klassen, die Abfragen verarbeiten. Die Basisklasse ist Query. Dieses Paket enthält auch die folgenden Pakete:

  • parser: Klassen, die das Parsen von Abfragen verarbeiten.
  • engine – Klassen, die die Abfrageausführung verarbeiten.
  • scalarfunction: Klassen, die skalare Funktionen in einer Abfrage verarbeiten.

render

Dieses Paket enthält die Klassen, die eine Antwort formatieren. Beispiel:

  • CsvRenderer rendert eine Datentabelle im CSV-Format.
  • HtmlRenderer rendert eine Datentabelle als HTML.
  • JsonRenderer rendert eine Datentabelle im JSON-Format.
  • EscapeUtil bietet ein Dienstprogramm zum Maskieren von Strings.

util

Dieses Paket bietet zwei Hilfsfunktionen:

  • CsvDataSourceHelper und CsvDataSourceException bieten Hilfsfunktionen für die Verwendung einer CSV-Datei als Datenspeicher. Sie bieten keine vollständige Implementierung einer Datenquelle. Eine Beispielimplementierung finden Sie unter Externen Datenspeicher verwenden.
  • SqlDataSourceHelper und SqlDatabaseDescription bieten Hilfsfunktionen für die Verwendung einer MySQL-Datenbank als Datenspeicher. Sie bieten keine vollständige Implementierung einer Datenquelle. Eine Beispielimplementierung finden Sie unter SqlDataSourceServlet im Paket examples.