最もよく使用されるクラスの概要については、キークラスをご覧ください。
データソースの Java ライブラリ パッケージの概要については、以下のリンクをご覧ください。
鍵クラス
キークラスは DataSourceServlet
、DataTable
、Query
、DataSourceHelper
です。
ライブラリの最も簡単な実装は、DataSourceServlet
から継承し、generateDataTable()
の独自の実装を作成して、サーブレット内で実装を実行することです。このタイプの実装については、スタートガイドをご覧ください。
DataTable
クラスは、データテーブルの列、列の型、ラベル、ID、カスタム プロパティを定義します。
Query
クラスはデータクエリの基本クラスで、可視化によって生成されたクエリを処理します。
より複雑なユースケースの場合、ヘルパークラス DataSourceHelper
にはヘルパー関数のセットが用意されています。このタイプの実装については、機能とイベントのフローの定義をご覧ください。
datasource
これはトップレベル パッケージであり、ほとんどのデータソース デベロッパーが操作する API クラスが含まれています。
この最上位レベルには Capabilities
があり、データソースのクエリcapabilitiesの定義に使用されます。
base
このパッケージには、パッケージ間の循環依存関係を防ぐために複数のパッケージで使用されるすべてのクラスが含まれています。最も注目すべき項目は、デフォルトの言語 / 地域(英語(米国))のエラー メッセージです。実装を多言語化するには、これらのメッセージを翻訳する必要があります。
datatable
このパッケージには、データテーブルの構造(列、行、セル)と機能(挿入、追加)を処理するクラスが含まれています。
このパッケージには、ライブラリでサポートされている値と値の型を処理する value
パッケージも含まれています。使用可能な値の型は ValueType
列挙型で定義され、ブール値、日付、時刻、日時、null、数値、テキストなどがあります。
query
このパッケージにはクエリを処理するクラスが含まれています。基本クラスは Query
です。このパッケージには、次のパッケージも含まれています。
parser
- クエリ解析を処理するクラス。
engine
- クエリ実行を処理するクラス。scalarfunction
- クエリで使用されるスカラー関数を処理するクラス。
render
このパッケージには、レスポンスをフォーマットするクラスが含まれています。次に例を示します。
CsvRenderer
は、データ表を CSV としてレンダリングします。HtmlRenderer
はデータ表を HTML としてレンダリングします。JsonRenderer
は、データテーブルを JSON としてレンダリングします。EscapeUtil
には、文字列をエスケープするユーティリティが用意されています。
util
このパッケージには、次の 2 つのヘルパー関数セットが用意されています。
CsvDataSourceHelper
とCsvDataSourceException
は、CSV ファイルをデータストアとして使用するためのヘルパー関数を提供しますが、データソースの完全な実装を提供するものではありません。実装例については、外部データストアの使用をご覧ください。SqlDataSourceHelper
とSqlDatabaseDescription
は、mySQL データベースをデータストアとして使用するためのヘルパー関数を提供しますが、データソースの完全な実装を提供するものではありません。実装例については、examples
パッケージのSqlDataSourceServlet
をご覧ください。