Bibliothekspakete und Schlüsselklassen

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

Unter den folgenden Links finden Sie eine Einführung in die Pakete der Java-Bibliothek für die Datenquelle:

• Datenquelle
• datasource.base
• datasource.datatable
• datasource.query
• datasource.render
• datasource.util

Schlüsselklassen

Die Schlüsselklassen sind DataSourceServlet, DataTable, Query und DataSourceHelper.

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

Die Klasse DataTable definiert die Spalten, Spaltentypen, Labels, IDs und benutzerdefinierte Eigenschaften 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 Ereignisfluss definieren beschrieben.

datasource

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

Auf dieser obersten Ebene befindet sich außerdem Capabilities, mit dem die capabilities der Datenquelle definiert werden.

base

Dieses Paket enthält alle Klassen, die von mehr als einem Paket verwendet werden, um zirkuläre Abhängigkeiten zwischen den Paketen zu vermeiden. Die wichtigsten Punkte sind Fehlermeldungen in der Standardsprache US-Englisch. Zur Internationalisierung Ihrer Implementierung müssen Sie diese Nachrichten übersetzen.

datatable

Dieses Paket enthält Klassen, die die Struktur der Datentabelle (Spalten, Zeilen, Zellen) und die Funktionen (Einfügen, Hinzufügen) übernehmen.

Dieses Paket enthält auch das Paket value, das von der Bibliothek unterstützte Werte und Werttypen verarbeitet. Verfügbare Werttypen werden in der Aufzählung ValueType definiert und umfassen: boolescher Wert, 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 handhaben.
• scalarfunction: Klassen, die in einer Abfrage verwendete Skalarfunktionen verarbeiten.

render

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

• CsvRenderer rendert eine Datentabelle als CSV.
• HtmlRenderer rendert eine Datentabelle als HTML.
• JsonRenderer rendert eine Datentabelle als JSON.
• EscapeUtil stellt ein Dienstprogramm zum Maskieren von Strings bereit.

util

Dieses Paket bietet zwei Gruppen von Hilfsfunktionen:

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