Редактор сущностей: ELMA Entity

Описание типа объекта хранится в файле с расширением *.md. Тип объекта является наследником класса , где T - тип идентификатора объекта. Редактор для ELMA Entity имеет 4 вкладки: Общие, Свойства, Дополнительные, Документация.


Общие



Отображаемое имя

Поле используется для отображения названия типа. Является обязательным для заполнения. Это поле является локализуемым.

Описание

Описаниетипа объекта. Поле является локализуемым.

Имя класса

Имя класса, описывающего тип объекта. В результате настройки типа объекта в системе будет сгенерирован класс, значение данного поля будет использовано в качестве имени этого класса.

Таблица в базе данных

Имя таблицы в БД, в которую будет происходить сохранение объектов описываемого типа.

Свойства



Создание, редактирование и удаление свойств объекта. Каждое свойство имеет перечень атрибутов.

Общие



Отображаемое имя

Поле используется при отображение названия свойства. Является обязательным для заполнения. Это поле является локализуемым

Тип

Типы могут быть как простыми так и объектами других типов. Является обязательным для заполнения. В зависимости от выбранного типа определяются дополнительные настройки для поля.

Да/Нет

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Дата/Время

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Показывать дату
Показывать и давать редактировать дату на форме создания объекта.

Показывать время
Показывать и давать редактировать время на форме создания объекта.

Дробное число

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Строка

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Несколько строк
На форме редактирования будет <input type="text"> (однострочное поле) или <textarea>(многострочное поле).

Является наименованием
Значение этого поля будет использоваться в качестве наименования объекта.

Уникальный идентификатор (GUID)

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Целое число

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Целое число (16 бит)

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Цело число (32 бит)

Значение по умолчанию
Значение, которое будет присвоено свойству при создании объекта.

Дата\Время (Диапазон)

Показывать дату
Показывать и давать редактировать дату на форме создания объекта.

Показывать время
Показывать и давать редактировать время на форме создания объекта.

Любой объект

Тип связи – определяет, каким образом связаны объекты. Может принимать следующие значения:

  1. Одиночная – связь 1–1 или N–1;
  2. Множественная (1–N);
  3. Многие-ко-многим (N–N).

Ключевая колонка
Если выбрана связь 1–N, нужно указать поле, по которому будет происходить join дочернего объекта.

Обязательно для заполнения

Если свойство установлено в true, то при вводе свойства на форме будет проверяться обязательность его заполнения.

Описание

Подробное описание свойства.

Имя свойства

Значение поля используется для генерации свойства класса. Должна удовлетворять правилам для наименования свойств в C#.

Имя поля в БД

Имя колонки в БД для хранения значения описываемого свойства. При вводе проверяется на соответствие правилам именования столбцов в СУБД.

Таблица связи

Отображается при настройке свойства типа объект и выбранной связи Многие-ко-многим. Атрибут содержит имя таблицы, в которой будет храниться связь родительского объекта (тот, для которого создается свойство) и дочернего объекта (определяется типом объекта, который указан в типе свойства).

Поле ссылки на данный объект

Отображается при настройке свойства типа Объект и выбранной связи Многие-ко-многим. Название колонки в таблице связи, в которой будет храниться ссылка на настраиваемый объекта.

Поле ссылки на другой объект

Отображается при настройке свойства типа объект и выбранной связи Многие-ко-многим. Название колонки в таблице связи, в которой будет храниться ссылка на дочерний объект (определяется типом объекта, который указан в типе свойства).

Дополнительно



Участвует в быстром поиске

Если true, то значение данного свойства будет учитывается при выполнение быстрого поиска.

Участвует в поиске (фильтре)

 

 

Если true, то в фильтре для сущности будет сгенерировано поле для ввода ограничений по этом свойству. Значение данное поле будет учитываться в процессе поиска по фильтру.

Показывать в таблице

Если true, то данное свойство будет по умолчанию видимо при отображениии списка объектов (в табличном виде, используя DefaultColumns()).

Тип вычисления значения

Определяет способ вычисления значения для вычисляемого свойства.

Дополнительные настройки по типам свойств

Дата/Время

Обработчики
Доступные значения: Дата создания и Дата изменения. Используется для автоматического проставления даты создания и даты изменения объекта в настраиваемое свойство.

Установить текущую
Если true, то в конструкторе в данное свойство установится дата создания объекта.

Ограничения
Устанавливается допустимое минимальное и максимальное значение для свойства. Проверяется на форме ввода свойства.

Дробное число

Точность
Число знаков после запятой. Учитывается в контроле ввода дробного числа.

Минимальное и максимальное значение
Устанавливается допустимое минимальное и максимальное значение для свойства. Проверяется на форме ввода свойства.

Строка

Длина
Накладывается ограничение на длину вводимой строки. Учитывается в контроле ввода строки.

Регулярное выражение
Служит для ограничения вводимой строки по регулярному выражению. Например ограничения для ввода адреса электронной почты выглядит так:

(([0-9a-z][.\-\w]*)@((?:[0-9a-z][\-0-9a-z]*[0-9a-z]\.)+[a-z]{2,6}))|^$

Целое число

Минимальное и максимальное значение
Устанавливается допустимое минимальное и максимальное значение для свойства. Проверяется на форме ввода свойства.

Целое число(16 бит)

Минимальное и максимальное значение
Устанавливается допустимое минимальное и максимальное значение для свойства. Проверяется на форме ввода свойства.

Целое число(32 бит)

Минимальное и максимальное значение
Устанавливается допустимое минимальное и максимальное значение для свойства. Проверяется на форме ввода свойства.

Любой тип объекта

Каскадное обновление
Возможны варианты:

  1. Сохранение изменений (каскадное изменение сохранений –  Cascade.SaveUpdate());
  2. Удаление и сохранение изменений (каскадное изменение и удаление – Cascade.All()).

Обработчики
Доступен, если тип объекта Пользователь.
Автор создания – при сохранении нового объекта будет автоматически прописан текущий пользователь.
Автор последнего изменения – при сохранении существующего объекта прописывается текущий пользователь.

Документация



Для формирования документации по коду используется стандартный механизм документирующих комментариев. Синтаксис – http://msdn.microsoft.com/ru-ru/library/b2s063f7.aspx. Если установлен флажок Использовать отображаемое имя и описание для документации, то для генерации документации по типу объекта используется шаблон:

<summary>
@{DisplayName}
</summary>
<remarks>
@{Description}
</remarks>

В ином случае можно самостоятельно написать шаблон. Для включения свойства в шаблон используется запись вида @{Имя свойства}.

Дополнительно


 

Базовый класс

Указывается базовый клас для настраиваемого тип объекта.

Тип идентификатора

Тип PRIMARY KEY для объекта.

Разрешать создание наследников

Если false, то настраиваемый тип объекта не может быть базовым классом для других типов.

Хранить историю изменения

Если true, при изменении свойств объекта, настраиваемого типа, в отдельную таблицу БД будет сохраняться история производимых изменений.

Показывать в списке справочников

Если true, данный тип объекта отображается в дереве справочников.

Показывать в дереве типов

Если true, то тип видно в дереве типов системы (если тип системный, то установить в false).

Генерировать фильтр

Если true, то для настраиваемого типа генерируется класс фильтра. Поля фильтра формируются по свойствам типа объекта. В фильтр попадают только те свойства, которые помечены как участвующие в фильтр. Для чисел и дат формируются свойства-интервал (с мин. значаения по макс. значение).

Документирование



 

Для формирования документации по коду используется стандартный механизм документирующих комментариев. Синтаксис - http://msdn.microsoft.com/ru-ru/library/b2s063f7.aspx. Если установлен флажок Использовать отображаемое имя и описание для документации, то для генерации документации по типу объекта используется шаблон:

 

<summary>
@{DisplayName}
</summary>
<remarks>
@{Description}
</remarks>

В ином случае можно самостоятельно написать шаблон. Для включения свойства в шаблон используется запись вида @{Имя свойства}.