Детейловые ассоциации и их свойства

Особенности связи Ассоциация, ее генерации и пример использования

Согласно базовой статье детейловыми являются композиции, подобные:

Note: Принято, чтобы конец ассоциации имел множественность *, а начало (где ромбик) - 1. Класс-шапка всегда должен находиться со стороны начала композиции, а детейловый класс - со стороны конца.

Important: При редактировании ассоциации на диаграмме классов нужно учитывать существующие особенности.

Композиция

Генерация в SQL DDL

Определение структуры SQL DDL создаётся так:

В таблице, соответствующему детейловому классу, - внешний ключ на таблицу, соответствующую шапке;
Constraint, связывающий таблицы.

Генерация в .Net-язык

Подробно описана в статье Структура классов объектов данных.

Основное:

В классе-детейле генерируется свойство с приписанным .Net-атрибутом AgregatorAttribute и приватный член, оба с типом класса-шапки;
Для хранения наборов детейловых объектов генерируется специальный класс-наследник от DetailArray;
В классе-шапке генерируется свойство и приватный член, объявленные типом спец.класса, - наследника от DetailArray.

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

Свойства композиции (ПКМ на связи):

Description

Описание детейлового свойства.

Генерация в .Net-язык

Описание (DocComment) свойства доступа к массиву детейловых объектов в классе-шапке

StartRole

Имя роли со стороны начала композиции, дублирует имя роли на диаграмме

Генерация в SQL DDL

В CREATE TABLE таблицы детейла генерируется определение поля для внешнего ключа с этим именем.

Генерация в .Net-язык

Имя свойства-агрегатора в классе-детейле.

StartMultiplicity

Множественность со стороны начала ассоциации, дублирует на диаграмме. Может принимать любые значения, однако при генерации может быть только 1. Если другое значение - генерация остановится с ошибкой.

EndRole

Имя роли со стороны конца композиции

Генерация в .Net-язык

Имя свойства и приватного члена в классе-шапке

EndRoleStored

Генерация в .Net-язык

Приватный член в классе-шапке не генерируется и код аксессоров get и set в свойстве остаётся пустым (просто по две скобки программиста в каждом аксессоре)

Aggregator AutogenerateTypeUsage

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

Автоматическая генерация работает следующим образом:

Выполняется поиск всех наследников агрегатора (в пределах стадии);
Найденные классы, вместе с агрегатором, сортируются по названию по возрастанию;
Результат является определением используемых типов.

Генерация в SQL DDL

В DDL-определении таблицы для класса - детейла генерируются внешние ключи на каждый найденный класс. При этом поля именуются следующим образом:

<AggregatorStorage>_M<ПорядкНомерВTypeUsage>

«ПорядкНомерВTypeUsage» — начинается с 0.

Генерация в .Net-язык

Свойству, указывающему на агрегатора, детейлового класса прописывается .NET-атрибут TypeUsageAttribute, с указанием всех найденных классов.

Aggregator TypeUsage

Используемые типы для агрегатора (шапки) в классе-детейле.

Не учитывается при установленном флаге Aggregator AutogenerateTypeUsage

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

Генерация в SQL DDL

В DDL-определении таблицы для класса - детейла генерируются внешние ключи на каждый из указанных классов. При этом поля именуются следующим образом:

<AggregatorStorage>_M<ПорядкНомерВTypeUsage>

«ПорядкНомерВTypeUsage» — начинается с 0.

Генерация в .Net-язык

Свойству, указывающему на агрегатора, детейлового класса прописывается .NET-атрибут TypeUsageAttribute, с указанием указанных классов.

AggregatorStorage

Имя хранения свойства-агрегатора детейлового класса.

Генерация в SQL DDL

Если указано, то такое и будет имя поля - внешнего ключа в таблице, соотв. классу-детейлу, а не StartRole.

Генерация в .Net-язык

Перед определением свойства, указывающего на агрегатор в детейловом классе, генерируется указание атрибута PropertyStorageAttribute (Namespace: ICSSoft.STORMNET, Assembly: ICSSoft.STORMNET.DataObject (in ICSSoft.STORMNET.DataObject.dll))

Detail AutogenerateTypeUsage

Автоматическая генерация используемых типов для детейла в классе-шапке.

Автоматическая генерация работает следующим образом:

Выполняется поиск всех наследников детейла (в пределах стадии);
Найденные классы, вместе с детейлом, сортируются по названию по возрастанию;
Результат является определением используемых типов.

Генерация в .Net-язык

Свойству, указывающему на массив детейловых объектов, класса-шапки, прописывается .NET-атрибут TypeUsageAttribute, с указанием указанных классов.

Detail TypeUsage

Используемые типы для детейла в классе-шапке.

Генерация в .Net-язык

Свойству, указывающему на массив детейловых объектов, класса-шапки, прописывается .NET-атрибут TypeUsageAttribute, с указанием всех найденных классов.

PBAggregatorCustomAttributes

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения .Net атрибутов перед кодом свойства-агрегатора в детейле.

PBAggregatorGetEnd

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода перед концом аксессора get свойства-агрегатора в детейле.

PBAggregatorGetStart

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода после начала аксессора get свойства-агрегатора в детейле.

PBAggregatorSetEnd

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода перед концом аксессора set свойства-агрегатора в детейле.

PBAggregatorSetStart

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода после начала аксессора set свойства-агрегатора в детейле.

PBDetailCustomAttributes

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения .Net атрибутов перед кодом свойства, указывающего на массив детейловых объектов.

PBDetailGetEnd

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода перед концом аксессора get свойства, указывающего на массив детейловых объектов.

PBDetailGetStart

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода после начала аксессора get свойства, указывающего на массив детейловых объектов.

PBDetailSetEnd

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода перед концом аксессора set свойства, указывающего на массив детейловых объектов.

PBDetailSetStart

Генерация в .Net-язык

Если галочка указана - генерируется скобка программиста для “ручного” внесения кода после начала аксессора set свойства, указывающего на массив детейловых объектов..

Пример

Для вышепоказанной диаграммы код на C# выглядит так (подробнее см. в статье Структура классов объектов данных:

Код для класса-детейла (класс-детейл - Шаг, свойство агрегатор с приватным членом - Ошибка, класс для хранения массива детейловых объектов - DetailArrayOfШаг):

 public class Шаг : ICSSoft.STORMNET.DataObject
    {
        private int fНомер;
        private string fОписание;
        private ICSSoft.BugLeR.Ошибка fОшибка;       
        // *** Start programmer edit section *** (Шаг CustomMembers)
        
        // *** End programmer edit section *** (Шаг CustomMembers)
        
        // *** Start programmer edit section *** (Шаг.Номер CustomAttributes)

        // *** End programmer edit section *** (Шаг.Номер CustomAttributes)
        public virtual int Номер
        {
            get
            {
                // *** Start programmer edit section *** (Шаг.Номер Get start)

                // *** End programmer edit section *** (Шаг.Номер Get start)
                int result = this.fНомер;
                // *** Start programmer edit section *** (Шаг.Номер Get end)

                // *** End programmer edit section *** (Шаг.Номер Get end)
                return result;
            }
            set
            {
                // *** Start programmer edit section *** (Шаг.Номер Set start)

                // *** End programmer edit section *** (Шаг.Номер Set start)
                this.fНомер = value;
                // *** Start programmer edit section *** (Шаг.Номер Set end)

                // *** End programmer edit section *** (Шаг.Номер Set end)
            }
        }
        // *** Start programmer edit section *** (Шаг.Описание CustomAttributes)

        // *** End programmer edit section *** (Шаг.Описание CustomAttributes)
        public virtual string Описание
        {
            get
            {
                // *** Start programmer edit section *** (Шаг.Описание Get start)

                // *** End programmer edit section *** (Шаг.Описание Get start)
                string result = this.fОписание;
                // *** Start programmer edit section *** (Шаг.Описание Get end)

                // *** End programmer edit section *** (Шаг.Описание Get end)
                return result;
            }
            set
            {
                // *** Start programmer edit section *** (Шаг.Описание Set start)

                // *** End programmer edit section *** (Шаг.Описание Set start)
                this.fОписание = value;
                // *** Start programmer edit section *** (Шаг.Описание Set end)

                // *** End programmer edit section *** (Шаг.Описание Set end)
            }
        }
        
        /// <summary>
        /// мастеровая ссылка на шапку ICSSoft.BugLeR.Ошибка
        /// </summary>
        // *** Start programmer edit section *** (Шаг.Ошибка CustomAttributes)

        // *** End programmer edit section *** (Шаг.Ошибка CustomAttributes)
        [Agregator())
        public virtual ICSSoft.BugLeR.Ошибка Ошибка
        {
            get
            {
                // *** Start programmer edit section *** (Шаг.Ошибка Get start)

                // *** End programmer edit section *** (Шаг.Ошибка Get start)
                ICSSoft.BugLeR.Ошибка result = this.fОшибка;
                // *** Start programmer edit section *** (Шаг.Ошибка Get end)

                // *** End programmer edit section *** (Шаг.Ошибка Get end)
                return result;
            }
            set
            {
                // *** Start programmer edit section *** (Шаг.Ошибка Set start)

                // *** End programmer edit section *** (Шаг.Ошибка Set start)
                this.fОшибка = value;
                // *** Start programmer edit section *** (Шаг.Ошибка Set end)

                // *** End programmer edit section *** (Шаг.Ошибка Set end)
            }
        }
    }
    
    /// <summary>
    /// Detail array of Шаг
    /// </summary>
    // *** Start programmer edit section *** (DetailArrayDetailArrayOfШаг CustomAttributes)

    // *** End programmer edit section *** (DetailArrayDetailArrayOfШаг CustomAttributes)
    public class DetailArrayOfШаг : ICSSoft.STORMNET.DetailArray
    {
        
        // *** Start programmer edit section *** (ICSSoft.BugLeR.DetailArrayOfШаг members)
        
        // *** End programmer edit section *** (ICSSoft.BugLeR.DetailArrayOfШаг members)
        
        /// <summary>
        /// Construct detail array
        /// </summary>
        public DetailArrayOfШаг(ICSSoft.BugLeR.Ошибка fОшибка) : 
                base(typeof(Шаг), ((ICSSoft.STORMNET.DataObject)(fОшибка)))
        {
        }
        
        /// <summary>
        /// Returns object with type Шаг by index
        /// </summary>
        public ICSSoft.BugLeR.Шаг this[int index)
        {
            get
            {
                return ((ICSSoft.BugLeR.Шаг)(this.ItemByIndex(index)));
            }
        }
        
        /// <summary>
        /// Adds object with type Шаг
        /// </summary>
        public virtual void Add(ICSSoft.BugLeR.Шаг dataobject)
        {
            this.AddObject(((ICSSoft.STORMNET.DataObject)(dataobject)));
        }
    }

Код для класса-шапки (фрагмент класса Ошибка: приватный член и свойство типа массива детейловых объектов - DetailArrayOfШаг):

public class Ошибка : ICSSoft.STORMNET.DataObject
    {

        // ...

        private ICSSoft.BugLeR.DetailArrayOfШаг fШагиДляВоспроизведения;

        // ...

        // *** Start programmer edit section *** (Ошибка.ШагиДляВоспроизведения CustomAttributes)

        // *** End programmer edit section *** (Ошибка.ШагиДляВоспроизведения CustomAttributes)
        public virtual ICSSoft.BugLeR.DetailArrayOfШаг ШагиДляВоспроизведения
        {
            get
            {
                // *** Start programmer edit section *** (Ошибка.ШагиДляВоспроизведения Get start)

                // *** End programmer edit section *** (Ошибка.ШагиДляВоспроизведения Get start)
                if ((this.fШагиДляВоспроизведения == null))
                {
                    this.fШагиДляВоспроизведения = new ICSSoft.BugLeR.DetailArrayOfШаг(this);
                }
                ICSSoft.BugLeR.DetailArrayOfШаг result = this.fШагиДляВоспроизведения;
                // *** Start programmer edit section *** (Ошибка.ШагиДляВоспроизведения Get end)

                // *** End programmer edit section *** (Ошибка.ШагиДляВоспроизведения Get end)
                return result;
            }
            set
            {
                // *** Start programmer edit section *** (Ошибка.ШагиДляВоспроизведения Set start)

                // *** End programmer edit section *** (Ошибка.ШагиДляВоспроизведения Set start)
                this.fШагиДляВоспроизведения = value;
                // *** Start programmer edit section *** (Ошибка.ШагиДляВоспроизведения Set end)

                // *** End programmer edit section *** (Ошибка.ШагиДляВоспроизведения Set end)
            }
        }

        // ...

    }