有关最常用的类的说明,请参阅关键类。
如需了解数据源 Java 库软件包,请访问以下链接:
关键类
关键类是 DataSourceServlet
、DataTable
、Query
和 DataSourceHelper
。
该库最简单的实现涉及从 DataSourceServlet
继承、编写自己的 generateDataTable()
实现,然后在 servlet 中运行该实现。使用入门部分介绍了此类实现。
DataTable
类用于定义数据表的列、列类型、标签、ID 和自定义属性。
Query
类是数据查询的基类,它会处理可视化生成的查询。
对于更复杂的用例,帮助程序类 DataSourceHelper
提供了一组辅助函数。定义功能和事件流中介绍了此类实现。
datasource
这是顶级软件包,其中包含大多数数据源开发者需要与之交互的 API 类。
此外,最顶层的也是 Capabilities
,用于定义数据源的查询功能。
base
此软件包包含由多个软件包使用的所有类,用于防止软件包之间的循环依赖关系。最明显的内容是采用美国英语的默认语言区域的错误消息。若要将您的实现国际化,您需要翻译这些消息。
datatable
此软件包包含处理数据表结构(列、行、单元格)和功能(插入、添加)的类。
此软件包还包含用于处理库支持的值和值类型的 value
软件包。可用的值类型在 ValueType
枚举中定义,包括布尔值、日期、时间、日期和时间、null、数字和文本。
query
此软件包包含处理查询的类,基类为 Query
。此软件包还包含以下软件包:
parser
- 处理查询解析的类。
engine
- 处理查询执行的类。scalarfunction
- 处理查询中使用的标量函数的类。
render
此软件包包含用于设置响应格式的类。例如:
CsvRenderer
会以 CSV 格式呈现数据表。HtmlRenderer
,可将数据表呈现为 HTML。JsonRenderer
会将数据表呈现为 JSON。EscapeUtil
提供了用于对字符串进行转义的实用程序。
util
此软件包提供了两组辅助函数:
CsvDataSourceHelper
和CsvDataSourceException
提供了用于将 CSV 文件用作数据存储区的辅助函数,但不能提供数据源的完整实现。如需查看实现示例,请参阅使用外部数据存储区。SqlDataSourceHelper
和SqlDatabaseDescription
提供了用于将 mySQL 数据库用作数据存储区的辅助函数,但它们并未提供完整的数据源实现。如需查看示例实现,请参阅examples
软件包中的SqlDataSourceServlet
。