Skip to Content

Wiki source code of ultima-reports-api:1.1.7

Last modified by superadmin on 2026/06/15 21:57
Hide last authors
pugachevskaya_elena 1.1 1 В данном разделе приведено описание API подсистемы подготовки отчётов Платформы НЕЙРОСС.
2
3 Основные классы API в составе артефакта {{code language="none"}}ultima-reports-api_<версия>.jar{{/code}}:
4
5 |=(((
6 Класс
7 )))|=(((
8 Описание
9 )))
10 |(((
admin 2.1 11 ##extensions.reports.ReportDefinition(%%)##
pugachevskaya_elena 1.1 12 )))|(((
13 (% style="text-align: left;" %)
14 Базовый абстрактный класс для всех классов реализации шаблонов отчётов.
15
16 (% style="text-align: left;" %)
17 Основные методы класса:
18
19 (% style="text-align: left;" %)
20 {{code language="none"}}def init(conf: Config, loader: ReportDefinitionLoader): Unit
21 {{/code}}В реализации данного метода следует выполнить инициализацию шаблона. Метод вызывается логикой Платформы НЕЙРОСС в тот момент, когда пользователь хочет сформировать отчёт по выбранному шаблону. В метод передаются объекты классов {{code language="none"}}Config{{/code}} (соответствует содержимому файла {{code language="none"}}report.conf{{/code}}) и {{code language="none"}}ReportDefinitionLoader{{/code}} — последний позволяет получить доступ к файлам в папке шаблона отчёта (например, для загрузки jasper-файла).
22
23 (% style="text-align: left;" %)
24 {{code language="none"}}def title: String
25 {{/code}}Должен возвращать название шаблона, которое будет выведено в веб-интерфейсе Платформы НЕЙРОСС.
26
27 (% style="text-align: left;" %)
28 {{code language="none"}}def description: String
29 {{/code}}Должен возвращать описание шаблона, которое будет выведено в веб-интерфейсе Платформы НЕЙРОСС.
30
31 (% style="text-align: left;" %)
32 {{code language="none"}}def renderForm(...): Result{{/code}}
33 {{code language="none"}}def renderFormAction(...): Action{{/code}}
34 Генерация и выдача формы ввода параметров для формирования отчёта. Два метода позволяют как переопределить работу с Action (при использовании views в Play Framework, например), так и просто обработать «голый» HTTP-запрос и вернуть «голый» HTTP-ответ.
35
36 (% style="text-align: left;" %)
37 {{code language="none"}}def processForm(...): AnyRef{{/code}}
38 Обработка введённых пользователем параметров. Метод должен вернуть объект (любого типа), содержащий разобранные параметры. Этот объект впоследствии будет передан в метод {{code language="none"}}generateReport{{/code}}. Если параметры заданы неверно, то метод должен выбросить исключение.
39
40 (% style="text-align: left;" %)
41 {{code language="none"}}def generateReport(format: String, form: AnyRef, dataSource: javax.sql.DataSource, to: File){{/code}}
42 Данный метод вызывается внутренней логикой Платформы НЕЙРОСС для непосредственной генерации отчёта. В параметрах передаются:
43
44 (% style="text-align: left;" %)
45 1. требуемый формат отчёта (один из заданных в {{code language="none"}}report.conf{{/code}}) — например, {{code language="none"}}"pdf"{{/code}}.
46 1. объект параметров, который ранее был получен вызовом метода {{code language="none"}}processForm{{/code}}.
47 1. объект доступа к источнику данных;
48 1. хэндлер файла, в который следует записать сгенерированный отчёт.
49
50 (% style="text-align: left;" %)
51 {{code language="none"}}def customAction(path: String): Action{{/code}}
52 Данный метод позволяет реализовать кастомное HTTP-API для шаблона отчёта. Например, выдавать в форму отчёта список объектов из базы данных по запросу и пр.
53 )))
54 |(((
admin 2.1 55 ##extensions.reports.JasperReportDefinition(%%)##
pugachevskaya_elena 1.1 56 )))|(((
57 (% style="text-align: left;" %)
admin 2.1 58 Класс реализации шаблона отчёта с поддержкой JasperReports Library, который формирует отчёт на основе jasper-шаблонов. Является потомком ##extensions.reports.ReportDefinition(%%)##.
pugachevskaya_elena 1.1 59
60 (% style="text-align: left;" %)
61 Можно использовать этот класс как есть, если не требуется поддержки формы ввода параметров.
62 )))
63 |(((
64 {{code language="none"}}
65 extensions.reports.GenericFormField
66 {{/code}}
67 )))|(((
68 Интерфейс для класса поля ввода. Определяет обязательные методы любого класса поля ввода:
69
70 {{code language="none"}}def key(): String{{/code}}
71 Должен возвращать имя параметра, для которого определено данное поле ввода.
72
73 {{code language="none"}}def title(): String{{/code}}
74 Должен возвращать удобочитаемое название поля ввода. Данный текст выводится в форме в интерфейс пользователя.
75
76 {{code language="none"}}def render(): Html{{/code}}
77 Должен возвращать объект-представление HTML-фрагмента поля ввода.
78
79 {{code language="none"}}def parse(value: String): AnyRef{{/code}}
80 Преобразует введённое строковое значение параметра к Java-объекту требуемого типа.
81 )))
82 |(((
83 {{code language="none"}}
84 extensions.reports.GenericFormSupport
85 {{/code}}
86 )))|(((
87 Утилитарный трэйт поддержки базовой формы ввода параметров. Хранит карту объектов полей ввода (потомков {{code language="none"}}extensions.reports.GenericFormField{{/code}}), генерирует базовую форму ввода параметров со списком полей ввода. Основные методы:
88
89 {{code language="none"}}def registerField(field: GenericFormField): Unit{{/code}}
90 Регистрирует новое поле ввода. Данный метод должен вызываться в классах реализации шаблонах, наследуемых от {{code language="none"}}extensions.reports.GenericFormSupport{{/code}}, для составления списка полей ввода.
91
92 {{code language="none"}}def renderFormAction: Action[AnyContent]{{/code}}
93 Генерирует базовую форму ввода параметров на основе заданного через registerField списка полей ввода.
94
95 {{code language="none"}}def processForm(request: Request[MultipartFormData[TemporaryFile]]): AnyRef{{/code}}
96 Выполняет разбор значений формы ввода параметров, вызывая метод {{code language="none"}}extensions.reports.GenericFormField.parse(...){{/code}} и формируя карту вида «имя параметра — значение».
97 )))
98 |(((
99 {{code language="none"}}
100 extensions.reports.JasperFormField
101 {{/code}}
102 )))|(((
103 Интерфейс поля ввода для Jasper-параметра. Является потомком {{code language="none"}}extensions.reports.GenericFormField{{/code}}.
104
admin 2.1 105 Определяет новый метод {{code language="none"}}def init(jrParameter: JRParameter): Unit{{/code}}, который вызывается в ##extensions.reports.GenericJasperReportDefinition(%%)## при инициализации списка полей ввода по Jasper-параметрам.
pugachevskaya_elena 1.1 106 )))
107 |(((
admin 2.1 108 ##extensions.reports.GenericJasperReportDefinition(%%)##
pugachevskaya_elena 1.1 109 )))|(((
110 (% style="text-align: left;" %)
admin 2.1 111 Класс [[базовой реализации шаблона отчёта>>doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Базовый шаблон отчёта с JasperReports.WebHome]], который формирует отчёт на основе jasper-шаблонов и умеет генерировать по jasper-файлу форму для ввода параметров. Является потомком ##extensions.reports.JasperReportDefinition(%%)## и ##extensions.reports.GenericFormSupport.(%%)##
pugachevskaya_elena 1.1 112 )))
113 |(((
114 {{code language="none"}}
115 extensions.reports.generic.AbstractJasperFormField
116 {{/code}}
117 )))|(((
118 Абстрактный класс базовой реализации поля ввода для Jasper-параметра. Реализует интерфейс {{code language="none"}}extensions.reports.JasperFormField{{/code}}:
119
120 {{code language="none"}}def key(): String{{/code}}
121 Возвращает имя (name) Jasper-параметра в роли ключа.
122
123 {{code language="none"}}def title(): String{{/code}}
124 Возвращает описание (description) Jasper-параметра в роли названия поля.
125 )))
126 |(((
127 {{code language="none"}}
128 extensions.reports.generic.DateTimeFormField
129 {{/code}}
130 )))|(((
131 Реализация поля ввода даты / времени. Возможности по использованию данного поля описаны в [[doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Поля ввода параметров для отчётов JasperReports.WebHome]].
132 )))
133 |(((
134 {{code language="none"}}
135 extensions.reports.generic.InputFormField
136 {{/code}}
137 )))|(((
138 Реализация полей ввода текста / числа. Возможности по использованию данного поля описаны в [[doc:neyross.Настройка Платформы НЕЙРОСС.Настройка функций подготовки отчётов.Руководство разработчика | Отчёты.Поля ввода параметров для отчётов JasperReports.WebHome]].
139 )))