Программный продукт «QP8.Framework» (стр. 32 )

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

Автоматическая генерация файла

При автоматической генерации пользовательского файла отображения по умолчанию корректные идентификаторы. NET создаются по следующим правилам:

удаляются пробелы и подчёркивания, для данных на русском языке выполняется транслитерация, идентификаторы ссылочных полей генерируются на основе идентификаторов связанных контентов, к повторяющимся значениям идентификаторов добавляется числовой суффикс.

Пример файла отображения

<?xml version="1.0" encoding="utf-8" ?>

<schema connectionStringName="qp_database" replaceUrls="true" useLongUrls="true">

  <content name="Event Category" mapped_name="Category" plural_mapped_name="Categories">

  <attribute name="Title" />

  </content>

  <content name="Events" mapped_name="Event" plural_mapped_name="Events" use_default_filtration="false">

  <attribute name="Title" />

  <attribute name="Category" />

  <attribute name="Category 2" mapped_name="SecondCategory" mapped_back_name="EventsBySecondCategory" />

  <attribute name="Location" />

  <attribute name="Date" />

  <attribute name="Event Description" mapped_name="Description" />

  <attribute name="Many" />

  <attribute name="Related Event" mapped_name="RelatedEvent" />

  <attribute name="SubEvents" />

  <attribute name="InLive" />

  <attribute name="SubTitle" />

  </content>

  <content name="Event Location" mapped_name="Location" plural_mapped_name="Locations">

  <attribute name="Title" />

  </content>

  <content name="Photos" mapped_name="Photo" plural_mapped_name="Photos">

  <attribute name="Name" />

  <attribute name="Description" />

  <attribute name="OwnerID" />

  <attribute name="Photo" mapped_name="Picture" />

  </content>

  <link id="17" mapped_name="RelatedEvent" plural_mapped_name="RelatedEvents"  />

</schema>

Элементы файла отображения

Элемент schema

Корневой элемент файла.

Примечание: отображение может быть настроено с использованием бекэнда (свойства сайта, раздел «Параметры сборки в LINQ-классы»). При ручной настройке отображения конкретный сайт указывать не требуется, так как его идентификатор будет передан в процессе сборки.

Название	Описание
connectionStringName	В бекэнде – поле «Имя строки подключения» (Connection string name).
replaceUrls	В бекэнде – опция «Заменять URL» (Replace URLs).
useLongUrls	В бекэнде – опция «Использовать длинные URL» (Use long URLs).
namespace	В бекэнде – поле «Пространство имён для генерируемых классов» (Namespace for generated classes).
class	В бекэнде – поле «Имя контекстного класса» (Context Class Name).

Элемент content

Соответствует контенту QP.

Примечание: отображение может быть настроено с использованием бекэнда (свойства контента, раздел «Параметры сборки в LINQ-классы»).

Примечание: Если какой-либо контент не задан в отображении, то генерация класса для него проводиться не будет (в бекэнде – выключена опция «Отображать как класс»).

Название	Описание
name	Имя контента. По этому полю осуществляется поиск соответствия между отображением и БД. Если название контента (поля) в БД является недопустимым идентификатором в. NET, то необходимо задать атрибуты mapped_name и plural_mapped_name.
mapped_name	В бекэнде – поле «Имя (единственное)».
plural_mapped_name	В бекэнде – поле «Имя (множественное)».
use_default_filtration	В бекэнде – опция «Использовать фильтрацию по умолчанию».

Элемент attribute

Соответствует полю контента QP.

Примечание: отображение может быть настроено с использованием бекэнда (в свойствах поля раздел «Параметры сборки в LINQ-классы»).

Примечание: если какое-либо поле не задано в отображении, то генерация свойства для него проводиться не будет (в бекэнде – выключена опция «Отображать как LINQ-свойство»).

Название	Описание
name	Имя поля в QP. По этому полю осуществляется поиск соответствия между отображением и БД. Если название контента (поля) в БД является недопустимым идентификатором в. NET, то необходимо задать атрибут mapped_name. Кроме того, изменение имени при отображении поля может понадобиться, чтобы исключить конфликт имён между полем и контентом.
mapped_name	В бекэнде – поле «Имя LINQ-свойства».
mapped_back_name	В бекэнде – поле «Имя обратного LINQ-свойства».

Элемент link

Соответствует связи в QP (поле «Связь» типа M2M).

Примечание: отображение может быть настроено с использованием бекэнда (свойства поля, раздел «Параметры сборки в LINQ-классы».

Примечание: Если какая-либо связь не задана в отображении и не используется полями «Связь» типа M2M, то генерация класса для него не выполняется (в бекэнде – выключена опция «Отображать узловую таблицу как класс»).

Примечание: Если связь не задана в отображении, но используется полями, то будет сгенерирован класс с именем по умолчанию.

Название	Описание
id	Идентификатор связи (таблица CONTENT_TO_CONTENT). По этому полю осуществляется поиск соответствия между отображением и БД.
mapped_name	В бекэнде – поле «Имя узлового LINQ-класса (единственное)».
plural_mapped_name	В бекэнде – поле «Имя узлового LINQ-класса (множественное)».

Использование контекстного класса

Под контекстным классом понимается класс, сгенерированный механизмом сборки в LINQ to SQL. Этот класс наследуется от DataContext. Имя класса может быть задано на уровне сайта или контента. В случае отсутствия значения в качестве имени используется значение QPDataContext.

Экземпляр по умолчанию

Если требуется работать только с одним контекстным классом, то можно использовать экземпляр контекстного класса по умолчанию, доступный как LinqHelper. Context. Он создаётся при первом запросе к нему, в случае вызова в веб-среде сохраняется на время выполнения текущего веб-запроса. В случае прочих приложений экземпляр сохраняется в статическом свойстве класса LinqHelper на всё время жизни приложения.

При создании независимого от БД кода следует иметь в виду, что экземпляр контекстного класса, доступный как LinqHelper. Context, по умолчанию использует настройки, с которыми он был сгенерирован. Сменить эти настройки можно до первого обращения к LinqHelper. Context через изменение статических свойств контекстного класса.

В веб-среде существует возможность одновременного использования нескольких экземпляров по умолчанию. Условия использования:

экземпляры должны находиться в разных пространствах имён; должны различаться имена сайтов, с которыми работают экземпляры.

Явное инстанцирование контекстного класса

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

static QPDataContext Create(string connection, string siteName, MappingSource mappingSource)

static QPDataContext Create(string siteName, MappingSource mappingSource)

static QPDataContext Create(string connection, string siteName)

static QPDataContext Create(string connection)

static QPDataContext Create()

Параметры:

Название	Описание
connection	Строка подключения к БД
siteName	Имя сайта
mappingSource	Источник данных для отображения на основе MAP-файла, полученного в результате сборки контентов в классы LINQ to SQL

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

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

В обычном сценарии использования классов LINQ to SQL сущностные классы используют экземпляр контекстного по умолчанию (LinqHelper. DataContext) в тех случаях, когда им требуется внутри себя подгрузить какие-либо данные (например, для реализации полей «Связь» типа M2M). Однако в случае явного инстанцирования контекстного класса это не будет работать, так как внешний и внутренний контексты будут отличаться. Поэтому у каждого экземпляра сущностного класса имеется свойство InternalDataContext, которое позволяет явно задать внутренний контекст для подобных операций. По умолчанию свойство инициализируется значением LinqHelper. DataContext.

Необходимость задавать внутренний контекст возникает при явном инстанцировании контекстного класса и использовании следующих операций: