На этом уроке мы познакомимся с объектом DatabaseTree, который отображает данные в виде дерева значений, что позволяет лучше воспринимать иерархическую структуру данных. Для этого создадим форму списка товарно-материальных ценностей (ТМЦ), которые будут разделяться на категории.
Если хотите начать практику с этого урока, то вам необходимо развернуть учебный проект по инструкции в статье Разворачивание проекта.
При разворачивании проекта используйте backup базы данных, который можете найти в архиве из раздела Ответы прошлого урока. Скопируйте папки Forms, Workflow и Patterns в папку с развернутым проектом, например, в папку D:\WT\Projects\Template\Projects\1. Template.
Инструкция по подключению шаблонов находится по ссылке.
Новый список
Для начала создадим простенький список единиц измерений, который пригодится при создании списка ТМЦ.
База данных
Для списка единиц измерения создайте таблицу template.unit с колонками:
unit_id smallint NOT NULL - первичный ключ;
title character varying NOT NULL - наименование;
short_title character varying NOT NULL - сокращенное обозначение;
archive boolean NOT NULL DEFAULT false - признак архивной записи.
Создайте формы для редактирования списка единиц измерения:
Для этого можете воспользоваться паттерном ArchiveList из архива:
Пример заполнение настроек паттерна для списка единиц измерения:
Редактор автоматически создаст формы списка (TemplateUnitList.xml) и карточки сущности (TemplateUnitEdit.xml), а также в серверный xml-файл добавит все необходимые запросы.
После применения паттерна перейдем в xml-файл серверной части и перенесем роль UnitEditRole в группу GuestGroup, а также добавим нужные поля на форму карточки сущности, колонки в таблицу на форме списка и скорректируем запросы.
На главной форме в меню добавьте пункт Списки -> Единицы измерения..., по которому будет открываться новая формаTemplateUnitList.xml.
Дерево значений
Нам необходимо создать форму списка для создания и редактирования новой сущности - товарно-материальных ценностей.
Но в этот раз помимо таблицы товарно-материальных ценностей на форме будет список категорий ценностей, который будет представлен в виде дерева, чтобы иметь возможность разбивать категории на подкатегории.
Должна получиться форма вида:
База данных
Создадим в базе данных таблицы:
template.material_category - категории товарно-материальных ценностей;
Создайте пустую форму TemplateMaterialList.xml с заголовком "Товарно-материальные ценности".
В главном меню на стартовой форме (TemplateStart.xml) добавьте пункт меню Списки -> ТМЦ..., по которому будет открываться новая форма со списком товарно-материальных ценностей.
Перейдем в файл TemplateMaterialList.xml, где в ContentPanel добавим три панели:
MaterialCategoryPanel - левая панель, в которой будет описываться дерево категорий товарно-материальные ценностей. Ей можно задать ширину в 400 пикселей;
MaterialPanel - правая панель, в которой будет описываться таблица товарно-материальных ценностей. Эта панель будет занимать все оставшееся место;
MaterialSeparatePanel - разделитель между панелей.
Дерево значений
Займемся левой частью формы, а именно созданием дерева категорий для товарно-материальных ценностей. В итоге у вас должна получится форма подобного вида:
В панели MaterialCategoryPanel создайте:
Надпись "Категории" (MaterialCategoryLabel), которая будет выступать заголовком для дерева значений;
Дерево категорий (MaterialCategoryDatabaseTree) - объект типа DatabaseTree. Тэг <Items> оставьте пустым - его заполним позже;
Кнопки редактирования дерева категорий (добавить, редактировать и удалить).
Для проверки наличия выделенного узла дерева DatabaseTree будем использовать get-проперти SelectedItemId, которое будем проверять в условии типа IsNotNullCondition:
В командах используем тэг <Multiple>, чтобы иметь возможность открывать несколько экземпляров формы одновременно.
Для отслеживания двойного клика по узлу дерева используйте условие DoubleClickCondition. Создайте <Execution>, который будет отслеживать это условие.
Создайте самостоятельно команду MaterialCategoryDeleteMessageBoxCommand для кнопки удаления записи в дереве категорий.
Конструкции <Execution> на эти команды можете оставить пустыми.
Карточка редактирования узла дерева
Создадим форму для редактирования категории (TemplateMaterialCategoryEdit.xml), используя паттерн EntityForm:
Добавьте на форму объекты ParentMaterialCategoryLabel и ParentMaterialCategoryComboBox, которые будут описывать родительскую категорию. Тэги <ValueList> и <Value> для выпадающего списка оставьте пустыми - их заполним позже.
Таким образом, у вас должна получиться форма вида:
Перейдем в xml-файл серверной части (Template.xml) и создадим запрос для получения списка категорий:
Template.xml
<SqlQueryName="ParentMaterialCategorySelectSqlQuery"> <Text> WITH RECURSIVE tree_tmp (material_category_id, parent_material_category_id, title, path) AS ( SELECT material_category_id, parent_material_category_id, title, ARRAY[material_category_id]::bigint[] FROM parent_mc UNION ALL SELECT MC.material_category_id, MC.parent_material_category_id, MC.title, T.path || ARRAY[MC.material_category_id]::bigint[]
FROM mc_tmp MC JOIN tree_tmp T ON T.material_category_id = MC.parent_material_category_id ), mc_tmp AS ( SELECT * FROM template.material_category WHERE material_category_id IS DISTINCT FROM {MaterialCategoryId} OR {WithChild} ), parent_mc AS ( SELECT * FROM mc_tmp WHERE parent_material_category_id IS NULL ) SELECT T.material_category_id AS "MaterialCategoryId", CASE WHEN array_length(T.path, 1) > 1 THEN COALESCE(repeat('—', (array_length(T.path, 1) - 1)), '') || ' ' ELSE '' END || T.title AS "Title"
FROM tree_tmp T ORDER BY T.path, T.material_category_id; </Text></SqlQuery>
Этот запрос будем использовать в двух местах: в карточке категории ТМЦ для выбора родительской категории и в карточке ТМЦ для выбора категории товарно-материальной ценности. Поэтому сразу добавим в него параметр {WithChild}, которым будем разделять место использования запроса: из карточки категории будем передавать false, а из карточки ТМЦ - true.
В запросе стоит обратить внимание на условие IS DISTINCT FROM, которое для значений не NULL работает так же, как оператор <>. Однако, если оба сравниваемых значения NULL, результат будет false, и только если одно из значений NULL, возвращается true. Следовательно, если параметр {MaterialCategoryId} будет иметь значение NULL, то условие вернет true.
Таким образом, для карточки категории в параметр {MaterialCategoryId} будем передавать идентификатор редактируемой категории, чтобы исключить ее из списка возможных родительских категорий. Тем самым мы избежим того, что бы в качестве родительской категории была выбрана сама редактируемая категория или ее дочерние категории.
В этом запросе используется вычисление рекурсивного запроса, с помощью указания служебного слова RECURSIVE. Подробнее про рекурсивные запросы можете почитать по ссылке.
Добавьте запрос ParentMaterialCategorySelectSqlQuery в разрешение MaterialCategoryViewSqlQueryPermission, которое создалось автоматически при выполнении паттерна EntityForm.
Скорректируем запрос MaterialCategoryByIdSelectSqlQuery, чтобы он возвращал идентификатор родительской категории:
Template.xml
<SqlQueryName="MaterialCategoryByIdSelectSqlQuery"> <Text> SELECT MC.title AS "Title", MC.parent_material_category_id AS "ParentMaterialCategoryId" FROM template.material_category MC WHERE MC.material_category_id = {MaterialCategoryId}; </Text></SqlQuery>
Скорректируйте самостоятельно запросы MaterialCategoryInsertSqlQuery и MaterialCategoryUpdateSqlQuery, чтобы они сохраняли значение ParentMaterialCategoryId, переданное с формы.
Вернемся в файл TemplateMaterialCategoryEdit.xml и скорректируем MaterialCategoryPrimaryGetDataConnection:
Обратите внимание, что у MaterialCategoryPrimaryGetDataConnection появился тэг <ManualLoad> - признак определяет, будет ли загрузка данных происходить вместе с загрузкой формы или только после ручного обновления соединения с данными. Значение тэга обратно значению параметра Edit. Когда форма открыта на редактирование (значение параметра Edit = True), значение тэга <ManualLoad> будет False - DataConnection будет обновляться вместе с загрузкой формы. А если форма будет открыта на создание, то значение тэга станет True, и DataConnection будет обновляться только по команде. Таким образом, мы можем исключать лишнее обращение к базе данных, если уверены, что там нет нужных данных.
Самостоятельно измените MaterialCategoryInsertSetDataConnection и MaterialCategoryUpdateSetDataConnection, добавив параметр ParentMaterialCategoryId, в который будет передаваться значение из ParentMaterialCategoryComboBox.
Создадим соединения с данными для загрузки списка родительских категорий:
Как вы помните, на форме TemplateMaterialList.xml в команде MaterialCategoryAddFormShowCommand на дочернюю форму передавался параметр ParentMaterialCategoryId, давайте создадим этот параметр:
TemplateMaterialCategoryEdit.xml
<ParameterName="ParentMaterialCategoryId" />
Теперь можем доделать ParentMaterialCategoryComboBox, заполнив его тэги <ValueList> и <Value>:
Откройте приложение, проверьте загрузку форм и попробуйте создать несколько категорий, одна из которых не будет иметь родительской категории (например, категория "Бумага"), а остальные категории будут ссылаться на нее. Выпадающий список будет иметь вид:
Отлично! Теперь можем продолжить работать с деревом значений на форме списка.
Запрос для DatabaseTree
Перейдем в xml-файл серверной части (Template.xml) и добавим запрос для получения списка категорий (MaterialCategoryListSelectSqlQuery) и запрос для получения взаимосвязей элементов дерева (MaterialCategoryRelationSelectSqlQuery):
Template.xml
<SqlQueryName="MaterialCategoryListSelectSqlQuery"> <Text> SELECT MC.material_category_id AS "MaterialCategoryId", MC.title AS "Title" FROM template.material_category MC ORDER BY MC.title, MC.material_category_id; </Text></SqlQuery><SqlQueryName="MaterialCategoryRelationSelectSqlQuery"> <Text> SELECT material_category_id AS "MaterialCategoryId", parent_material_category_id AS "ParentMaterialCategoryId" FROM template.material_category; </Text></SqlQuery>
Не забудем добавить их в MaterialCategoryViewSqlQueryPermission.
Вернемся в файл формы списка ТМЦ (TemplateMaterialList.xml) и создадим загружающее соединение с данными:
Обязательный тэг <Items> объекта MaterialCategoryDatabaseTree ожидает соединение с данными с двумя таблицами:
Первая таблица должна описывать линейный список элементов дерева и иметь два поля, соответствующие идентификатору элемента и его отображаемое значение;
Вторая таблица должна описывать взаимосвязи элементов дерева и иметь поля: идентификатор элемента и идентификатор родительского элемента.
Таким образом, в тэге <Items> пропишем следующее значение:
Вызов команды UpdatedTrueValueSetCommand позволит при закрытии формы списка ТМЦ уведомить родительскую форму о наличии изменений.
Запустите приложение и попробуйте добавить пару категорий, чтобы проверить работу <Execution>.
Удаление категории
Сложность удаления категории ТМЦ заключается в том, что мы не можем удалить категорию, если она содержит подкатегории и/или позиции ТМЦ. Для проверки этих условий создадим функции.
Первая будет на проверку наличия вложенных позиций ТМЦ:
CREATE OR REPLACEFUNCTIONtemplate.material_category_has_materials(in_material_category_id bigint)RETURNSbooleanAS$BODY$BEGINIF (EXISTS (SELECT*FROM template.material WHERE material_category_id = in_material_category_id))THENRETURN TRUE;ENDIF;RETURN bool_or(template.material_category_has_materials(material_category_id))FROM template.material_categoryWHERE parent_material_category_id = in_material_category_id;END;$BODY$LANGUAGE plpgsql;
Вторая будет на попытку удаления категории с проверкой на наличие подкатегорий и вложенных позиций ТМЦ:
CREATE OR REPLACEFUNCTIONtemplate.material_category_try_delete(in_material_category_id bigint)RETURNScharacter varying AS$BODY$DECLARE _has_child_categories boolean= FALSE; _has_child_materials boolean= FALSE; _result character varying;BEGINIF (SELECTNOTEXISTS(SELECT*FROM template.material_category WHERE material_category_id = in_material_category_id))THENRETURNNULL;ENDIF; IF (SELECT used FROM template.is_used('material_category', 'material_category_id', ARRAY[]::text[], ARRAY[]::text[], in_material_category_id))
THEN _has_child_categories = EXISTS (SELECT * FROM template.material_category WHERE parent_material_category_id = in_material_category_id);
_has_child_materials = template.material_category_has_materials(in_material_category_id); _result ='Выбранная категория ТМЦ '||CASEWHEN _has_child_categories AND _has_child_materialsTHEN'содержит вложенные категории и позиции ТМЦ.'WHEN _has_child_categoriesTHEN'содержит вложенные категории ТМЦ.'WHEN _has_child_materialsTHEN'содержит вложенные позиции ТМЦ.'ELSE'используется в программе.'END;RETURN _result;ELSEDELETEFROM template.material_categoryWHERE material_category_id = in_material_category_id;RETURNNULL;ENDIF;END;$BODY$LANGUAGE plpgsql;
Если мы не можем удалить категорию с подкатегориями и/или вложенными позициями ТМЦ, то будем возвращать сообщение с причиной невозможности удаления и предлагать пользователю сделать каскадное удаление категорий, подкатегорий и вложенных позиций ТМЦ.
Создадим функцию для каскадного удаления:
CREATE OR REPLACEFUNCTIONtemplate.material_category_delete_cascade(in_material_category_id bigint)RETURNS void AS$BODY$BEGIN IF (SELECT NOT EXISTS(SELECT * FROM template.material_category WHERE material_category_id = in_material_category_id)) THEN
RETURN;ENDIF; PERFORM template.material_try_delete(array_agg(material_id))FROM template.materialWHERE material_category_id = in_material_category_id; PERFORM template.material_category_delete_cascade(material_category_id)FROM template.material_categoryWHERE parent_material_category_id = in_material_category_id; IF (SELECT used FROM template.is_used('material_category', 'material_category_id', ARRAY[]::text[], ARRAY[]::text[], in_material_category_id))
THENUPDATE template.material_categorySET archive = TRUEWHERE material_category_id = in_material_category_id ANDNOT archive;ELSEDELETEFROM template.material_categoryWHERE material_category_id = in_material_category_id;ENDIF;END;$BODY$LANGUAGE plpgsql;
CREATE OR REPLACEFUNCTIONtemplate.material_try_delete(in_material_id_array bigint[])RETURNScharacter varying AS$BODY$DECLARE _material_id bigint; _deleted_count integer :=0; _archived_count integer :=0; _archived_array varchar[];BEGINFOR i IN1..COALESCE(array_length(in_material_id_array, 1), 0)LOOP _material_id = in_material_id_array[i]; raise notice '_material_id: %', _material_id;IF (SELECT used FROM template.is_used('material', 'material_id', ARRAY[]::text[], ARRAY[]::text[], _material_id))THENUPDATE template.materialSET archive = TrueWHERE material_id = _material_id ANDNOT archive; _archived_count = _archived_count +1; _archived_array = _archived_array || (SELECT title FROM template.material WHERE material_id = _material_id);ELSEDELETEFROM template.materialWHERE material_id = _material_id; _deleted_count = _deleted_count +1;ENDIF;ENDLOOP;RETURNCASEWHEN _archived_count >0THEN'Удалено ТМЦ: '|| _deleted_count || E'.\rПеремещено в архив: '|| _archived_count || E'.\r\rСписок ТМЦ, перемещенных в архив:\r'|| array_to_string(array_sort(_archived_array), E',\r') ELSENULLEND;END;$BODY$LANGUAGE plpgsql;
Функция template.material_try_delete(bigint[]) возвращает сообщение о количестве удаленных и перемещенных в архив записей, а также наименования ТМЦ, отправленных в архив. Но функция template.material_category_delete_cascade(bigint), которая ее вызывает, никак не обрабатывает возвращаемое сообщение и не передает его в результат SQL-запроса, чтобы можно было получить сообщение на форме и отобразить его пользователю. Вы можете самостоятельно реализовать данную функциональность.
В функции template.material_try_delete(bigint[]) используется функция сортировки массива:
CREATE OR REPLACEFUNCTIONpublic.array_sort(anyarray)RETURNS anyarray AS$BODY$SELECTARRAY(SELECT unnest($1) ORDER BY1);$BODY$LANGUAGEsql;
Перейдем в серверный xml-файл и создадим запросы на удаление категорий:
И создадим команду для отображения полученного от сервера сообщения:
TemplateMaterialList.xml
<CommandName="MaterialCategoryTryDeleteUsedMessageBoxCommand"Type="MessageBoxCommand"Assembly="Commands"> <Caption>Удаление</Caption> <Text> <String> <Format>{0}\rВы можете попытаться удалить выбранную категорию вместе с вложенными элементами. В случае невозможности удаления записи будут отправлены в архив.\rПродолжить?</Format>
<Items> <Item> <CommandName="MaterialCategoryDeleteCommand" /> </Item> </Items> </String> </Text> <IconType="Question" /> <ButtonsType="YesNo" /></Command>
Теперь можем заняться правой частью формы и создать сам список товарно-материальных ценностей.
На панель MaterialPanel добавим таблицу с кнопками редактирования. Для этого воспользуйтесь паттерном Table:
Выполним следующие настройки паттерна:
После применения паттерна перейдем в xml-файл серверной части и перенесем роль MaterialEditRole в группу GuestGroup, а также скорректируем текст запроса:
Template.xml
<SqlQueryName="MaterialSelectSqlQuery"> <Text> SELECT M.material_id AS "MaterialId", M.material_category_id AS "MaterialCategoryId", M.title AS "Title", M.unit_id AS "UnitId", M.unit_price AS "UnitPrice" FROM template.material M ORDER BY M.title; </Text></SqlQuery>
Таким образом форма списка (TemplateMaterialList.xml) примет вид:
Добавим на форму соединение с данными для загрузки списка единиц измерений:
В нем используем запрос ParentMaterialCategorySelectSqlQuery, который писали для карточки редактирования категории ТМЦ.
Самостоятельно создайте все необходимые элементы формы, чтобы форма имела вид:
Если форма открыта на редактирование, то в поле "Категория" (MaterialCategoryComboBox) должна отображаться категория редактируемого ТМЦ, иначе должен подставляться идентификатор из параметра MaterialCategoryId.
Для создания выпадающего списка единиц измерений (UnitComboBox) используйте материал прошлого урока, где мы реализовывали логику редактирования выпадающего списка клиентов и режим выбора на форме списка клиентов. Также для UnitComboBox используйте соединение с данными: