Skip to Content

Wiki source code of ultima-reports-api:1.2.2

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

Платформа НЕЙРОСС