Пакеты библиотек и ключевые классы

Введение в наиболее часто используемые классы см. в разделе ключевые классы .

Для ознакомления с пакетами библиотек Java источников данных перейдите по ссылкам ниже:

• источник данных
• источник данных.база
• источник данных.datatable
• источник данных.запрос
• источник данных.рендер
• источник данных.util

Ключевые классы

Ключевыми классами являются DataSourceServlet , DataTable , Query и DataSourceHelper .

Простейшая реализация библиотеки включает в себя наследование от DataSourceServlet , написание собственной реализации generateDataTable() и последующий запуск реализации в сервлете. Этот тип реализации описан в разделе « Начало работы ».

Класс DataTable определяет столбцы, типы столбцов, метки, идентификаторы и настраиваемые свойства для таблицы данных.

Класс Query является базовым классом для запросов данных, он обрабатывает запрос, сгенерированный визуализацией.

Для более сложных вариантов использования вспомогательный класс DataSourceHelper предоставляет набор вспомогательных функций. Этот тип реализации описан в разделе «Определение возможностей и потока событий» .

datasource

Это пакет верхнего уровня, содержащий классы API, с которыми взаимодействует большинство разработчиков источников данных.

Также на этом верхнем уровне находится Capabilities , который используется для определения возможностей запроса источника данных .

base

Этот пакет содержит все классы, используемые более чем одним пакетом, для предотвращения циклических зависимостей между пакетами. Наиболее примечательные элементы — это сообщения об ошибках на языке по умолчанию — английском (США). Чтобы интернационализировать вашу реализацию, вам потребуется перевести эти сообщения.

datatable

Этот пакет содержит классы, которые управляют структурой таблицы данных (столбцы, строки, ячейки) и функциональностью (вставка, добавление).

Этот пакет также содержит пакет value , который обрабатывает значения и типы значений, поддерживаемые библиотекой. Доступные типы значений определены в перечислении ValueType и включают в себя: логическое значение, дату, время суток, дату и время, нуль, число и текст.

query

Этот пакет содержит классы, обрабатывающие запросы, базовым классом является Query . Этот пакет также содержит следующие пакеты:

• parser — классы, которые занимаются разбором запросов.
  
• engine — классы, обрабатывающие выполнение запросов.
• scalarfunction — классы, обрабатывающие скалярные функции, используемые в запросе.

render

Этот пакет содержит классы, которые форматируют ответ. Например:

• CsvRenderer отображает таблицу данных в формате CSV.
• HtmlRenderer отображает таблицу данных как HTML.
• JsonRenderer отображает таблицу данных в формате JSON.
• EscapeUtil предоставляет утилиту для экранирования строк.

util

Этот пакет предоставляет два набора вспомогательных функций:

• CsvDataSourceHelper и CsvDataSourceException предоставляют вспомогательные функции для использования CSV-файла в качестве хранилища данных, но не обеспечивают полную реализацию источника данных. Пример реализации см. в разделе Использование внешнего хранилища данных .
• SqlDataSourceHelper и SqlDatabaseDescription предоставляют вспомогательные функции для использования базы данных mySQL в качестве хранилища данных, но не обеспечивают полную реализацию источника данных. Пример реализации см. в разделе SqlDataSourceServlet в пакете examples .