Перейти к содержимому

Исходный код вики ultima-reports-api:1.2.2

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

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