如需最常用的類別簡介,請參閱金鑰類別。
如需資料來源 Java 程式庫套件的簡介,請點選下方連結:
重要類別
主要類別為 DataSourceServlet
、DataTable
、Query
和 DataSourceHelper
。
如要實作程式庫,最簡單的實作方法就是沿用 DataSourceServlet
,編寫自己的 generateDataTable()
實作內容,然後在 ++ 中執行實作。如需這類實作的說明,請參閱入門指南。
DataTable
類別會定義資料表的資料欄、資料欄類型、標籤、ID 和自訂屬性。
Query
類別是資料查詢的基礎類別,可處理視覺化產生的查詢。
如果是較複雜的用途,輔助類別 DataSourceHelper
會提供一組輔助函式。有關這類實作的說明,請參閱「定義功能與事件流」。
datasource
這是頂層套件,內含大部分資料來源開發人員互動的 API 類別。
此外,這個頂層也是 Capabilities
,用於定義資料來源的查詢capabilities。
base
這個套件包含由多個套件使用的所有類別,以避免套件之間的循環依附元件。其中最值得注意的項目是預設語言代碼 (美國英文) 的錯誤訊息。如要將實作項目國際化,您需要翻譯這些訊息。
datatable
這個套件包含處理資料表結構 (資料欄、資料列、儲存格) 和功能 (insert、add) 的類別。
這個套件也包含 value
套件,用於處理程式庫支援的值和值類型。可用值類型是在 ValueType
列舉中定義,包括:布林值、日期、時間、日期和時間、空值、數字和文字。
query
這個套件包含處理查詢的類別,基本類別為 Query
。這個套件也包含以下套件:
parser
:處理查詢剖析的類別。
engine
- 處理查詢執行作業的類別。scalarfunction
- 處理查詢中使用的純量函式的類別。
render
這個套件包含用於設定回應格式的類別。例如:
CsvRenderer
會將資料表轉譯為 CSV。HtmlRenderer
會將資料表轉譯為 HTML。JsonRenderer
會將資料表轉譯為 JSON。EscapeUtil
提供逸出字串的公用程式。
util
這個套件提供兩組輔助函式:
CsvDataSourceHelper
和CsvDataSourceException
提供使用 CSV 檔案做為資料儲存庫的輔助函式,因此無法提供資料來源的完整實作。如需實作範例,請參閱「使用外部資料儲存庫」。SqlDataSourceHelper
和SqlDatabaseDescription
會提供使用 mySQL 資料庫做為資料儲存庫的輔助函式,但這些函式並未提供資料來源的完整實作。如需實作範例,請參閱examples
套件中的SqlDataSourceServlet
。