Paket Library dan Class Kunci

Untuk pengantar class yang paling umum digunakan, lihat class kunci.

Untuk pengantar paket library Java sumber data, ikuti link di bawah ini:

• sumber data
• datasource.base
• datasource.datatable
• datasource.query
• datasource.render
• datasource.util

Kelas Utama

Class utamanya adalah DataSourceServlet, DataTable, Query, dan DataSourceHelper.

Implementasi library yang paling sederhana melibatkan pewarisan dari DataSourceServlet, menulis implementasi generateDataTable() Anda sendiri, lalu menjalankan implementasi dalam servlet. Jenis penerapan ini dijelaskan di bagian Memulai.

Class DataTable menentukan kolom, jenis kolom, label, ID, dan properti kustom untuk tabel data.

Class Query adalah class dasar untuk kueri data. Class ini menangani kueri yang dihasilkan visualisasi.

Untuk kasus penggunaan yang lebih kompleks, class helper DataSourceHelper menyediakan serangkaian fungsi bantuan. Jenis penerapan ini diuraikan dalam Menentukan Kemampuan dan Alur Peristiwa.

datasource

Ini adalah paket tingkat teratas dan berisi class API yang berinteraksi dengan sebagian besar developer sumber data.

Selain itu, di tingkat teratas ini adalah Capabilities, yang digunakan untuk menentukan capabilities kueri sumber data.

base

Paket ini berisi semua class yang digunakan oleh lebih dari satu paket untuk mencegah dependensi sirkular di antara paket. Item yang paling penting adalah pesan error dalam lokalitas default bahasa Inggris AS. Untuk menginternasionalkan implementasi, Anda perlu menerjemahkan pesan ini.

datatable

Paket ini berisi class yang menangani struktur tabel data (kolom, baris, sel) dan fungsionalitas (insert, add).

Paket ini juga berisi paket value yang menangani nilai dan jenis nilai yang didukung oleh library. Jenis nilai yang tersedia ditentukan dalam enumerasi ValueType dan mencakup: boolean, tanggal, waktu, tanggal dan waktu, null, angka, serta teks. 

query

Paket ini berisi class yang menangani kueri, class dasarnya adalah Query. Paket ini juga berisi paket-paket berikut:

• parser - class yang menangani penguraian kueri.
  
• engine - class yang menangani eksekusi kueri.
• scalarfunction - class yang menangani fungsi skalar yang digunakan dalam kueri.

render

Paket ini berisi class yang memformat respons. Contoh:

• CsvRenderer merender tabel data sebagai CSV.
• HtmlRenderer merender tabel data sebagai HTML.
• JsonRenderer merender tabel data sebagai JSON.
• EscapeUtil menyediakan utilitas untuk meng-escape string.

util

Paket ini menyediakan dua kumpulan fungsi bantuan:

• CsvDataSourceHelper dan CsvDataSourceException menyediakan fungsi bantuan untuk menggunakan file CSV sebagai penyimpanan data, tetapi tidak menyediakan implementasi sumber data secara lengkap. Untuk contoh implementasi, lihat Menggunakan Penyimpanan Data Eksternal.
• SqlDataSourceHelper dan SqlDatabaseDescription menyediakan fungsi bantuan untuk menggunakan database MySQL sebagai penyimpanan data, tetapi tidak menyediakan implementasi sumber data yang lengkap. Untuk contoh implementasi, lihat SqlDataSourceServlet dalam paket examples.