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

Редактировал(а) admin 2026/09/03 12:17

Управление
- Копировать
Действия
- Экспорт
- Предварительный просмотр
Просмотр

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