よく使用されるクラスについては、キークラスをご覧ください。
データソースの Java ライブラリ パッケージの概要については、以下のリンクをご覧ください。
キークラス
キークラスは DataSourceServlet
、DataTable
、Query
、DataSourceHelper
です。
ライブラリの最も簡単な実装は、DataSourceServlet
から継承し、generateDataTable()
の独自の実装を作成してからサーブレット内で実装を実行することです。このタイプの実装については、スタートガイドをご覧ください。
DataTable
クラスは、データテーブルの列、列タイプ、ラベル、ID、カスタム プロパティを定義します。
Query
クラスは、データクエリの基本クラスで、可視化によって生成されたクエリを処理します。
より複雑なユースケースでは、ヘルパークラス DataSourceHelper
にヘルパー関数のセットが用意されています。このタイプの実装については、機能とイベントフローの定義をご覧ください。
datasource
これはトップレベル パッケージであり、ほとんどのデータソース デベロッパーがやり取りする API クラスが含まれています。
このトップレベルでは、Capabilities
がデータソースのクエリ機能の定義に使用されます。
base
このパッケージには、パッケージ間の循環的依存関係を防ぐために、複数のパッケージで使用されるすべてのクラスが含まれています。最も注目すべき項目は、デフォルトの英語(ロケール: US)のエラー メッセージです。実装を国際化するには、これらのメッセージを翻訳する必要があります。
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
をご覧ください。