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

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

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

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

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

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

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

Класс 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 в качестве хранилища данных, но не обеспечивают полную реализацию источника данных. Пример реализации см. в разделе SqlDataSourceServlet в пакете examples .