Использование выражений

Использование выражений рассмотрим на примере отчета Example3. Создадим отчет и в Dataset and Query Dialog создадим запрос

Информацию, как и в отчете Example2,  будем получать из двух таблиц: f_dp_rkkbase и  f_dp_rkk. Запрос будет выглядеть следующим образом:

Select
rkkbase.type, rkkbase.subject, rkkbase.complect, rkkbase.id, 
rkk.regnumprist || rkk.regnumcnt || rkk.regnumfin as regNumber,
rkk.regdate
from
f_dp_rkkbase rkkbase
join  f_dp_rkk rkk on rkkbase.id=rkk.id
where
rkkbase.complect in ('InputDocs','InternalDocs') 

Из таблицы  f_dp_rkkbase  выбираем  поля type, subject, complect, id, regdate.   Из таблицы  f_dp_rkk  выбираем  поля regnumprist, regnumcnt, regnumfin, если значение поля id в таблице f_dp_rkk  совпадает со значением  поля  id  в   таблице f_dp_rkkbase.

Объединяем эти поля и получаем поле regNumber (rkk.regnumprist || rkk.regnumcnt || rkk.regnumfin as regNumber).

В отчет отбираем только входящие и внутренние документы (where  rkkbase.complect in ('InputDocs','InternalDocs') ).\

Заполняем форму отчета, как показано на рис. 2.4.7.2.

Рис. 2.4.7.2. Форма отчета Example3.

На вкладке Preview смотрим результат. Отчет будет выглядеть так, как показано на рис. 2.4.7.3.

Рис. 2.4.7.3.  Отчет Example3.

Формируем колонку № п/п. Для того, чтобы в этой колонке печатались номера строк по порядку, делаем следующее. В секции Detail1 создаем текстовое поле. Дважды щелкаем по этому полю мышкой и получаем диалог Expression Editor – редактор выражений, как показано на рис. 2.2.7.4.

Рис. 2.4.7.4. Добавление переменной для получения  порядкового номера.

Для получения  порядкового номера выбираем встроенную переменную $V(COLUMN_COUNT). $V – означает — переменная.

В колонке  «Номер», если документ  не зарегистрирован, будем печатать «Проект». Для этого   поле, где помещается Regnumber  редактируем, как показано на рис. 2.4.7.5 .

Рис. 2.4.7.5 . Редактирование колонки, где отображается номер документа.

Здесь выражение   ( $F{regnumber} !=null ? $F{regnumber} : "Проект") означает следующее- если regnumber не равно null, то печатается регистрационный номер документа, иначе печатается «Проект».

Форматируем дату таким образом, чтобы получить формат «дд.мм.гггг» (Рис. 2.4.7.6). В данном случае время нам выводить не нужно.

Рис. 2.4.7.6.   Форматирование даты.

Заголовок группировки редактируем так, чтобы вместо «InputDocs »  печаталось «Входящие документы», а вместо «Internaldocs» - «Внутренние документы» (Рис. 2.4.7.7).

Рис. 2.4.7.7. Выражение для вывода заголовка группировки.

Форма будет выглядеть, как показано на рис. 2.4.7.8.

Рис. 2.4.7.8.  Форма отчета Example3.

Отчет теперь будет выглядеть, как показано на рис. 2.4.7.9.

Рис. 2.4.7.9. Отчет Example3.\

8.  Использование параметров.

Параметры — это входные аргументы. Их значения неизменны во всём отчёте.

Параметры используются при формировании отчета, для отбора в отчет определённых документов. В качестве параметров могут быть, например:

• Интервал дат -в отчет должны попадать документы, зарегистрированные в определенный период времени
• Место регистрации - в отчет должны попадать документы, зарегистрированные в определённом подразделении
• Подпись - в отчет должны попадать документы, подписанные определённым руководителем
• Cписок переменных, полей, передаваемых в подотчет в качестве входных параметров (Subreport parameters)

Добавим следующие параметры в отчет Example3:

- RepTitle – c помощью этого параметра пользователь может менять заголовок отчета

- Date.Start – начало периода регистрации документов, за который нужно выводить информацию в отчет

- Date.End – конец  периода регистрации документов, за который нужно выводить информацию в отчет.

Создаем параметр  RepTitle. Для этого на вкладке Outline выделяем   Parameters и нажатием правой кнопки мыши получаем  меню (Рис. 2.4.8.1).

Рис. 2.4.8.1. Добавление параметра в отчет.

Выбираем Create Parameter. И создаётся параметр Parameter1 (Рис. 2.4.8.2).

Рис. 2.4.8.2. Создание параметра.

Щёлкаем правой кнопкой мыши и получаем меню (Рис.2.4.8.3).

Рис. 2.4.8.3.  Свойства параметра.

В меню выбираем  Show Propertiesи получаем диалог, показанный на рис. 2.4.8.4.

Рис. 2.4.8.4. Переименование параметра.

В поле Name – название параметра меняем   “Parameter1” на  “RepTitle”.   В поле Class указываем java.lang.String – в параметре будет тип данных — строка.

Default Value Expression – значение параметра по умолчанию. Это значение можно будет поменять при запуске отчета на выполнение - Is For Prompting.

Редактируем на форме заголовок отчета (Рис. 2.4.8.5.). Выбираем параметр RepTitle.

Рис.2.4.8.5. Редактирование заголовка  отчета.

Форма будет выглядеть, как показано на рис.2.4.8.6..

Рис. 2.4.8.6. Форма отчета с параметром $P{RepTitle}.

Создаем параметр Date.Start. Как и в предыдущем случае создаем параметр и редактируем его (Рис. 2.4.8.7).

Рис. 2.4.8.7. Редактирование параметра Date.Start .

Заполняем поля Name – название параметраDate.Startи поле Class – тип данных java.util.Date – Дата.

Подобным образом создаем параметр Date.End, но для этого параметра присваиваем значение по умолчанию — текущая дата (Рис.2.4.8.8.) .

Рис.  2.4.8.8. Редактирование параметра  Date.End.

Для того, чтобы присвоить значение по умолчанию, нажимаем на пиктограмму .  В открывшемся диалоге выбираем значение — встроенную функцию TODAY( ) - текущую дату (Рис. 2.4.8.9.)

Рис. 2.4.8.9.  Присвоение значения по умолчанию.

Для того, чтобы выбирать интервал дат, за который документы будут отображаться в отчете, изменим запрос (Рис.2.4.8.10).

Рис. 2.4.8.10. Запрос с параметрами.

Добавляем в запрос   - and (regDate between $P{Date.Start}and $P{Date.End}). Здесь $P – обозначает — параметр.  Чтобы в отчет не попадали проекты документов добавим в запрос:

and  rkk.regnumcnt is not null.

Открываем вкладку Preview . Предлагается ввести параметры отчета (Рис. 2.2.8.11).

Рис. 2.4.8.11.  Ввод параметров отчета.

Значение по умолчанию для заголовка отчета изменяем на  «Список корреспонденции».

Дата окончания интервала  заполняется по умолчанию. Оставляем её без изменения. Для выбора даты начала интервала нажимаем на пиктограмму  , выбираем нужную дату (Рис. 2.2.8.11 …) и нажимаем пиктограмму.

Рис. 2.4.8.11. Выбор даты начала интервала..

Для продолжения выполнения отчета нажимаем пиктограмму (Рис. 2.4.8.12)

Рис. 2.4.8.12. Запустить выполнение отчета.

Результат выполнения отчета на рис. 2.4.8.12-а

Рис. 2.4.8.12-а. Результат выполнения отчета.

9. Использование подотчетов (Subreport).

Элемент подотчет используется для создания внутри отчета другого отчета. Эта возможность   позволяет создавать более сложные отчеты. Подотчет использует тоже самое подключение, что и родительский отчет. Подотчет способен реализовать все на что способен обычный отчет, результат исполнения подотчета будет расположен внутри элемента. Часто используется для создания вложенных таблиц и распределения логики в отчете.

SubreportExpression– используется для задания выражения класса объекта, возвращающего элемент Jasper. В случае, если результатом выражения является строка, Jasperreports будет искать файл по указанному в строке пути относительно .jrxml файла.

Using cache – указывает, следует ли располагать объект подотчета в памяти.  Данный флаг следует устанавливать в случае, если подотчет будет вызываться несколько раз.

Connection Expression – указывает выражение, используемое для получения подключения к БД через объект java.sql.Connection. По умолчанию используется тоже подключение, что и основной отчет.

Subreport parameters– список переменных, полей, передаваемых в подотчет в качестве входных параметров.

Subreportreturnvalues– список локальных переменных, которые примут значения из подотчета.

Использование подотчетов рассмотрим на примере отчета Example4. Отчет создаем  в папке  Example4.

9.1. Создание основного отчета.

            Создадим сначала форму отчета, как показано на рис. 2.4.9.1.

Рис.2.4.9.1          Подготовка основного отчета.

Этот отчет строится также, как и в примере Example3. Отличие состоит только в том, что в него отбираются только входящие документы -   where  rkkbase.complect in ('InputDocs').

Рис. . 2.4.9.2.   Запрос для отбора документов в отчет.

Все элементы на форме отчета и параметры сформированы также, как и в отчете Example3.

Если построить этот отчет, то увидим результат, показанный на рис. 2.4.9.3.

Рис. 2.4.9.3. Результат построения основного отчета без подотчета (subreport).

            В основной отчет необходимо добавить  колонку, в которой будут отображаться адресаты документа. Причем адресатов может быть как один, так и несколько. Для этого в основной  отчет добавим колонку «Адресаты» и встроим в нее подотчет (subreport).

9.2.  Создание подотчета (subreport).

В папке  Example4 создаем отчет Example4-sub  (Рис. ...).  В отчет добавляем поле adresseeи параметр Rkkid. Запрос для отбора документов в отчет показан на рис. 2.4.9.4.

Рис.  2.4.9.4.   Отчет (подотчет) Example4-sub в папке Example4.

Рис. 2.4.9.5.     Запрос в подотчете Example4-sub.

В этом запросе вычисляются фамилии сотрудников — адресатов документа. Так как адресатов может быть несколько, используется функция используется функция STRING_AGG для объединения строк.

Структура таблицы so_beard:

• id bigint NOT NULL,-числовой идентификатор объекта
• id_type integer,
• created_date timestamp without time zone NOT NULL,
• updated_date timestamp without time zone NOT NULL,
• created_by bigint,
• created_by_type integer,
• updated_by bigint,
• updated_by_type integer,
• status bigint,
• status_type integer,
• access_object_id bigint,
• migrationid character varying(48),
• migrationisabsent smallint NOT NULL,
• orgname character varying(253),
• hierparent bigint,
• hierparent_type integer,
• isactive smallint NOT NULL,
• isnotvacancy smallint,
• cmjunid character varying(48) NOT NULL,
• orig_type bigint NOT NULL,
• orig_shortname character varying(253) NOT NULL,-фамилия и инициалы сотрудника
• orig_postname character varying(253),
• orig_departmentname character varying(253),
• eff_type bigint,
• eff_shortname character varying(253),
• eff_postname character varying(253),
• eff_departmentname character varying(253)

Структура таблицы f_dp_inputrkk_addressee:

• id bigint NOT NULL,-числовой идентификатор объекта
• id_type integer,
• created_date timestamp without time zone NOT NULL,
• updated_date timestamp without time zone NOT NULL,
• created_by bigint,
• created_by_type integer,
• updated_by bigint,
• updated_by_type integer,
• status bigint,
• status_type integer,
• access_object_id bigint,
• addressee bigint,- числовой ид. объекта («читай сотрудника») в таблице so_beard
• addressee_type integer,
• idx bigint NOT NULL,
• owner bigint NOT NULL,- числовой ид. объекта («читай документа») в таблице f_dp_rkkbase
• owner_type integer NOT NULL

Форматируем текстовое поле adressee, как показано на рисунках  Рис.2.4.9.6. и Рис.2.4.9.7..

Рис.2.4.9.6.    Закладка Appearanceполяadressee.

На закладке  Appearanceпоказываем размещение поля.

Рис. 2.4.9.7.   Закладка Borders поляadressee.

На закладке  Borders форматируем границы поля в отчете. В   данном случае границы отсутствуют. 

В подотчет добавляем параметр Rkkid.

Рис. 2.4.9.8.   Параметр  Rkkidв подотчете.

9.3. Добавление подотчета в основной отчет.

Сначала изменяем форму основного отчета для того, чтобы вставить колонку «Адресаты», как показано на рис.2.4.9.9.

Рис. 2.4.9.9. Изменение  формы, для вставки дополнительной колонки.

Добавляем статический текст в заголовок столбца и форматируем его как показано на рис. 2.4.9.10.

Рис.  2.4.9.10.  Форматирование текста заголовка  столбца «Адресаты».

Далее в строке, где будут показаны адресаты, размещаем Frame. Для этого на закладке  Paletteвыделяем элемент  Frameи перетаскиваем мышкой в нужное место  (Рис. 2.4.9.11).

Рис.  2.4.9.11.   Размещение фрейма в строке отчета.

Далее форматируем размещение фрейма на форме отчета и его границы, как показано на рисунках Рис. 2.4.9.12 и Рис.  2.4.9.13

Рис.  2.4.9.12.  Размещение фрейма на форме отчета.

Рис. 2.4.9.13.    Форматирование границ фрейма.

Затем  выделяем мышкой элемент  Subreportна вкладке Palette (Рис. 2.4.9.14) и перетаскиваем  его в поле фрейма.

Рис.   2.4.9.14.    Элемент Subreport на вкладке Palette.

Появляется первое окно для настройки параметров подотчета. Предлагается выбрать существующий подотчет или разработать новый (Рис.2.4.9.15.).

Рис. 2.4.9.15.   Выбираем ранее разработанный подотчет.

Выбираем ранее разработанный подотчет , для этого нажимаем кнопку  Select report file. Появляется окно для выбора файла (Рис. 2.4.9.16). 

Рис. 2.4.9.16. Окно для выбора файла.

Выбираем  Example4-sub.jasperиз папки Example/Example4. 

Рис. 2.4.9.17.     Окно с выбранным подотчетом.

Далее нажимаем кнопку Nextи выбираем источник данных тот же, что и в основном отчете (Рис. 2.4.9.18).

Рис. 2.4.9.18.  Выбор источника данных.

Далее нажимаем кнопку Next и настраиваем параметры отчета (Рис. 2.4.9.19).

Рис. 2.4.9.19.  Настройка параметров отчета.

Нажимаем кнопку Add и получаем следующее окно для настройки параметров (Рис. 2.4.9.20).

Рис. 2.4.9.20.  Окно для  указания параметра подотчёта.

Указываем параметр подотчета Rkkid. Нажимаем на кнопку редактироватьи получаем окно редактора выражений (Рис. 2.4.9.21)

Рис. 2.4.9.21. Окно редактора выражений.

В окне редактора выражений выбираем поле  idосновного отчета. Фактически в редакторе выражений мы связываем параметр подотчета — Rkkidи поле $F(id)в основном отчете.

Рис. 2.4.9.22. Окно с выбранным параметром выражения.

Нажимаем кнопку ОК и получаем  окно с настроенными параметрами (Рис.2.4.9.23)

Рис. 2.4.9.23. Настроенные параметры подотчета.

Нажимаем кнопку Finish.

На рис. 2.4.9.24  показано примерное изображение формы отчета после нажатия кнопки Finish.

Рис. 2.4.9.24.Форма основного отчета с подотчетом до форматирования размещения подотчета.

Далее отформатируем размещение подотчета на форме основного отчета(Рис. 2.4.9.25).

Рис.2.4.9.25. Форма основного отчета с подотчетом.

Результат построения отчета с подотчетом показан на рис.  2.4.9.2.6 .

Рис. 2.4.9.2.6.   Отчет с заполненным столбцом «Адресаты»

10. Использование скриптлетов (Scriptlet).

            Скриптлеты - это классы Java, которые предоставляют JasperReports дополнительные функции. Мы можем использовать скриптлеты, когда выражения отчета не могут выполнять более сложные операции. В приведенном примере используется UtilScriptlet для формирования списка, состоящего из названий "Тип документа". Разработку отчета начнем с создания скриптлета UtilScriptlet.

            Описание некоторых скриптлетов, разработанных для отчетов CompanyMedia приведено в разделе "Часто применяемые скриптлеты и их описание ".

Рис. 2.4.10.1.  Скриптлет  UtilScriptlet.

Скриптлет формирует список значений:

• Письмо
• Извещение
• Служебная записка
• Приказ
• Докладная записка

Разработаем форму отчета, SQL-запрос.

Рис. 2.4.10.2. SQL-запрос отчета.

Рис. 2.4.10.3. Отображение формы и свойств отчета Example3LP в JasperSoft Studio.

• В свойствах отчета - вкладка Properties /Dataset заполняем поле Scriplet Class  -UtilScriptlet (Рис. 2.4.10.3). Сохраняем отчет.
• В свойствах системного параметра  REPORT_SCRIPTLET в поле Class появляетсязначение UtilScriptlet (Рис. 2.4.10.4)
• 
  

  Рис. 2.4.10.4. Свойства параметра REPORT_SCRIPTLET.

• Создаем параметры DOC_Type. Name и Doctypes (Рис. 2.4.10.5)
• 
  

  Рис. 2.4.10.5. Свойства параметра DOC_Type. Name.

• Doctypes (Рис. 2.4.10.6)

Рис. 2.4.10.6. Свойства параметра DOC_Type. Name.

В SQL-запрос добавляем

and rkkbase.type  in($P!{DocTypes}).

В запросе ($P!{DocTypes}) означает, что передаётся напрямую список отобранных при выполнении отчета значений.

Более подробно формирование списка, передаваемого в отчет, будет рассмотрено в разделе 3 (Включение отчетов в систему Company Media).