程式庫套件和重要類別

如需最常用的類別簡介,請參閱金鑰類別一文。

如需資料來源 Java 程式庫的簡介,請點選下方連結:

主要類別

主要類別包括 DataSourceServletDataTableQueryDataSourceHelper

最簡單的程式庫實作包括從 DataSourceServlet 繼承、自行編寫 generateDataTable() 的實作,然後在 Servlet 中執行實作。請參閱開始使用一節,瞭解這類實作。

DataTable 類別定義了資料表的資料欄、資料欄類型、標籤、ID 和自訂屬性。

Query 類別是資料查詢的基礎類別,可處理以視覺化方式產生的查詢。

如果是更複雜的用途,輔助類別 DataSourceHelper 會提供一組輔助函式。「定義功能與事件流程」一文將說明這類實作方式。

datasource

此為頂層套件,包含大部分資料來源開發人員與之互動的 API 類別。

這個頂層的 Capabilities 是用來定義資料來源的查詢功能

base

此套件包含由多個套件使用的所有類別,以避免套件之間的循環依附元件。最值得注意的項目是美國預設語言代碼中的錯誤訊息。如果要將實作方式國際化,您必須翻譯這些訊息。

datatable

這個套件包含處理資料表結構 (欄、列、儲存格) 和功能 (插入、新增) 的類別。

這個套件也包含 value 套件,用來處理程式庫支援的值和值類型。可用值類型在 ValueType 列舉中定義,包括布林值、日期、時段、日期和時間、空值、數字和文字。

query

這個套件包含可處理查詢的類別,基本類別為 Query。這個套件也包含下列套件:

  • parser - 處理查詢剖析的類別。
  • engine - 處理查詢執行作業的類別。
  • scalarfunction - 處理查詢中使用的純量函式的類別。

render

這個套件包含格式化回應的類別。例如:

  • CsvRenderer 會將資料表轉譯為 CSV。
  • HtmlRenderer 會將資料表轉譯為 HTML。
  • JsonRenderer 會將資料表轉譯為 JSON。
  • EscapeUtil 提供可逸出字串的公用程式。

util

這個套件提供兩組輔助函式:

  • CsvDataSourceHelperCsvDataSourceException 提供使用 CSV 檔案做為資料儲存庫的輔助函式,但無法提供資料來源的完整實作。如需實作範例,請參閱使用外部資料儲存庫
  • SqlDataSourceHelperSqlDatabaseDescription 提供使用 mySQL 資料庫做為資料儲存庫的輔助函式,但無法提供資料來源的完整實作。 如需實作範例,請參閱 examples 套件中的 SqlDataSourceServlet