Тип: Булево. Содержит признак обязательного присутствие атрибута. Истина - обязателен.
Полное описание, параметры и ограничения
ИспользованиеАтрибутаXS.Обязательный (XSAttributeUse.IsRequired)
ИспользованиеАтрибутаXS (XSAttributeUse)
Обязательный (IsRequired)
Доступен, начиная с версии 8.1.
Использование:
Только чтение.
Описание:
Тип: Булево.
Содержит признак обязательного присутствие атрибута.
Истина - обязателен.
Доступность:
Сервер, толстый клиент, внешнее соединение.
Использование в версии:
Доступен, начиная с версии 8.1.
Методическая информация
Практические примеры
Прочитать группу необязательного атрибута currency
Группа OptionalAttributes содержит один необязательный currency. Получаем фактические использования атрибутов, а маску anyAttribute не придумываем.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Запускайте фрагменты отдельно на сервере учебной базы. Полная собственная XSD товара включена в код, external include/import и рабочие данные не используются.
Глобальная PriceFields содержит price типа decimal, OptionalAttributes содержит currency типа string. Product включает ссылки на обе группы, кроме собственных name, quantity, note и code.
Проверка набора проверяет схему. Эти уроки не утверждают, что был проверен XML-документ импорта товара.
XSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema""
| xmlns:g=""urn:guide:product"" targetNamespace=""urn:guide:product""
| elementFormDefault=""qualified"" version=""1.0"" xml:lang=""ru"">
| <xs:annotation><xs:documentation>Учебный товар, не контракт внешнего API</xs:documentation></xs:annotation>
| <xs:simpleType name=""Sku""><xs:restriction base=""xs:string"">
| <xs:length value=""4""/><xs:pattern value=""[A-Z][0-9]{3}""/>
| </xs:restriction></xs:simpleType>
| <xs:complexType name=""Product""><xs:sequence>
| <xs:element name=""name"" type=""xs:string""/>
| <xs:element name=""quantity"" type=""xs:nonNegativeInteger""/>
| <xs:element name=""note"" type=""xs:string"" minOccurs=""0""/>
| <xs:group ref=""g:PriceFields""/></xs:sequence><xs:attribute name=""code"" type=""g:Sku"" use=""required""/><xs:attributeGroup ref=""g:OptionalAttributes""/>
| </xs:complexType>
| <xs:element name=""product"" type=""g:Product""/>
| <xs:attribute name=""globalCode"" type=""g:Sku""/>
| <xs:group name=""PriceFields""><xs:sequence><xs:element name=""price"" type=""xs:decimal""/></xs:sequence></xs:group>
| <xs:attributeGroup name=""OptionalAttributes""><xs:attribute name=""currency"" type=""xs:string""/></xs:attributeGroup>
|</xs:schema>";
Чтение = Новый ЧтениеXML;
Чтение.УстановитьСтроку(XSD);
Попытка
ЧтениеДерева = Новый ПостроительDOM;
ДокументСхемы = ЧтениеДерева.Прочитать(Чтение);
Чтение.Закрыть();
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
Построитель = Новый ПостроительСхемXML;
Схема = Построитель.СоздатьСхемуXML(ДокументСхемы.ЭлементДокумента);
Если Схема = Неопределено Тогда
ВызватьИсключение "Не удалось построить учебную схему";
КонецЕсли;
Набор = Новый НаборСхемXML;
Набор.Добавить(Схема);
Если Не Набор.Проверить() Тогда
ВызватьИсключение "Учебная XSD не прошла проверку";
КонецЕсли;
ГруппаПолей = Схема.ОпределенияГруппМоделей.Получить("PriceFields", "urn:guide:product");
ГруппаАтрибутов = Схема.ОпределенияГруппАтрибутов.Получить("OptionalAttributes", "urn:guide:product");
Если ГруппаПолей = Неопределено Или ГруппаАтрибутов = Неопределено Тогда
ВызватьИсключение "Не найдены собственные глобальные группы";
КонецЕсли;
Если ТипЗнч(ГруппаПолей) <> Тип("ОпределениеГруппыМоделиXS") Или ТипЗнч(ГруппаАтрибутов) <> Тип("ОпределениеГруппыАтрибутовXS") Тогда
ВызватьИсключение "Получены неверные типы собственных групп";
КонецЕсли;
Сообщить(ГруппаАтрибутов.Имя = "OptionalAttributes");
Сообщить(ГруппаАтрибутов.URIПространстваИмен = "urn:guide:product");
Сообщить(ГруппаАтрибутов.Контейнер = Схема);
Сообщить(ГруппаАтрибутов.КорневойКонтейнер <> Неопределено);
Сообщить(ГруппаАтрибутов.Схема.ПространствоИмен = "urn:guide:product");
Сообщить(ГруппаАтрибутов.Аннотация = Неопределено);
Сообщить(Не ГруппаАтрибутов.ЭтоСсылка);
Сообщить(Не ГруппаАтрибутов.ЭтоОпределениеЗациклено());
Сообщить("Тип компонента: " + Строка(ГруппаАтрибутов.ТипКомпоненты));
Сообщить("Число компонентов: " + Строка(ГруппаАтрибутов.Компоненты.Количество()));
Сообщить("Тип свойства Ссылка: " + Строка(ТипЗнч(ГруппаАтрибутов.Ссылка)));
ГруппаАтрибутов.ОбновитьЭлементDOM();
Сообщить(ГруппаАтрибутов.ЭлементDOM.ПолучитьАтрибут("name") = "OptionalAttributes");
Сообщить(ГруппаАтрибутов.Содержимое.Количество() = 1);
Если ГруппаАтрибутов.Содержимое.Количество() <> 1 Тогда
ВызватьИсключение "Ожидался один компонент собственной группы атрибутов";
КонецЕсли;
Сообщить("Тип маски дополнительных атрибутов: " + Строка(ТипЗнч(ГруппаАтрибутов.Маска)));
Использования = ГруппаАтрибутов.ИспользованиеАтрибутов();
Если Использования.Количество() <> 1 Тогда
ВызватьИсключение "Ожидалось одно фактическое использование currency";
КонецЕсли;
Использование = Использования.Получить(0);
Если ТипЗнч(Использование) <> Тип("ИспользованиеАтрибутаXS") Тогда
ВызватьИсключение "Ожидалось использование собственного атрибута";
КонецЕсли;
Объявление = Использование.ОбъявлениеАтрибута;
Если Объявление = Неопределено Тогда
ВызватьИсключение "Не получено объявление currency";
КонецЕсли;
Сообщить(Объявление.Имя = "currency");
Сообщить(Не Использование.Обязательный);
Сообщить(ГруппаАтрибутов.Содержит(ГруппаАтрибутов.Содержимое.Получить(0)));Разбор по шагам
Содержимое показывает собственный состав группы, ИспользованиеАтрибутов — фактические использования атрибутов.
До Получить(0) проверено количество, тип использования проверен перед чтением объявления.
currency объявлен без use=required, поэтому не является обязательным.
Маска предназначена для дополнительных атрибутов. В полной XSD нет anyAttribute: тип значения диагностируется без выдуманного содержимого.
Оригинальная группа и её компоненты остаются в своей схеме.
Как проверить результат
Тринадцать сравнений Истина и четыре диагностические строки.
Фактическое использование currency одно и необязательное.
Ожидаемый результат
Определение атрибута и его использование разобраны отдельно.
На что обратить внимание
Атрибут currency не становится глобальным только потому, что входит в глобальную группу.
Не используйте Маска как свидетельство разрешения произвольных полей, когда anyAttribute не задан.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Отличить объявление атрибута code от его обязательного использования
У Product один обязательный атрибут code типа Sku. Читаем фактический список атрибутов и определение типа, не ищем локальный code среди глобальных атрибутов схемы.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
В схеме code объявлен внутри Product с use=required; глобальных xs:attribute в ней нет.
Запустите код на сервере учебной базы с исходной схемой из начала примера.
XSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema""
| xmlns:g=""urn:guide:product"" targetNamespace=""urn:guide:product""
| elementFormDefault=""qualified"" version=""1.0"" xml:lang=""ru"">
| <xs:annotation><xs:documentation>Учебный товар, не контракт внешнего API</xs:documentation></xs:annotation>
| <xs:simpleType name=""Sku""><xs:restriction base=""xs:string"">
| <xs:length value=""4""/><xs:pattern value=""[A-Z][0-9]{3}""/>
| </xs:restriction></xs:simpleType>
| <xs:complexType name=""Product""><xs:sequence>
| <xs:element name=""name"" type=""xs:string""/>
| <xs:element name=""quantity"" type=""xs:nonNegativeInteger""/>
| <xs:element name=""note"" type=""xs:string"" minOccurs=""0""/>
| </xs:sequence><xs:attribute name=""code"" type=""g:Sku"" use=""required""/>
| </xs:complexType>
| <xs:element name=""product"" type=""g:Product""/>
|</xs:schema>";
Чтение = Новый ЧтениеXML;
Чтение.УстановитьСтроку(XSD);
Попытка
ЧтениеДерева = Новый ПостроительDOM;
ДокументСхемы = ЧтениеДерева.Прочитать(Чтение);
Чтение.Закрыть();
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
Построитель = Новый ПостроительСхемXML;
Схема = Построитель.СоздатьСхемуXML(ДокументСхемы.ЭлементДокумента);
Если Схема = Неопределено Тогда
ВызватьИсключение "Не удалось построить учебную схему";
КонецЕсли;
Набор = Новый НаборСхемXML;
Набор.Добавить(Схема);
Если Не Набор.Проверить() Тогда
ВызватьИсключение "Учебная XSD не прошла проверку";
КонецЕсли;
ТипТовара = Схема.ОпределенияТипов.Получить("Product", "urn:guide:product");
Сообщить(ТипТовара.Атрибуты.Количество() = 1);
ФактическиеАтрибуты = ТипТовара.ИспользованиеАтрибутов();
Сообщить(ФактическиеАтрибуты.Количество() = 1);
ИспользованиеКода = ФактическиеАтрибуты.Получить(0);
Сообщить(ФактическиеАтрибуты.Содержит(ИспользованиеКода));
Сообщить(ИспользованиеКода.Обязательный);
Сообщить("Категория использования: " + Строка(ИспользованиеКода.Использование));
Сообщить("Ограничение fixed/default: " + Строка(ИспользованиеКода.Ограничение));
Код = ИспользованиеКода.ОбъявлениеАтрибута;
Сообщить(Код.Имя = "code");
Сообщить(Не Код.ЭтоГлобальноеОбъявление);
Сообщить(Не Код.ЭтоСсылка);
Сообщить(Код.АнонимноеОпределениеТипа = Неопределено);
Сообщить("Форма атрибута: " + Строка(Код.Форма));
Сообщить("URI атрибута: [" + Код.URIПространстваИмен + "]");
ТипКода = Код.ОпределениеТипа();
Сообщить(ТипКода.Имя = "Sku");
Сообщить(ТипКода.URIПространстваИмен = "urn:guide:product");
Сообщить(ТипКода.Фасеты.Количество() = 2);
Сообщить(Схема.ОбъявленияАтрибутов.Количество() = 0);Разбор по шагам
Атрибуты показывает собственное описание типа, ИспользованиеАтрибутов — фактический список, включая наследуемые атрибуты.
Из фиксированного списка получаем использование атрибута. Обязательный отражает use=required.
ОбъявлениеАтрибута описывает имя, форму и тип. Обязательность использования не следует угадывать по имени code.
Атрибут не ссылка ref и не анонимный тип: ОпределениеТипа возвращает именованный Sku.
По умолчанию атрибуты этой схемы неквалифицированные, даже при qualified для элементов. URI самого атрибута отличается от URI его типа.
Глобальная коллекция ОбъявленияАтрибутов пуста — это не означает, что у Product нет атрибутов.
Как проверить результат
Один собственный и один фактический атрибут; обязательность Истина.
Имя code, тип Sku в urn:guide:product, два фасета типа.
Атрибут локальный, не ref, глобальных объявлений атрибутов ноль.
Ожидаемый результат
На конкретном обязательном атрибуте отделены использование, объявление, пространство имени и определение типа.
На что обратить внимание
Унаследованные атрибуты могут входить в фактический список, но не в собственный список нового типа.
Отсутствующий атрибут и атрибут с пустой строкой — разные случаи; Sku дополнительно ограничен длиной/образцом.
URI типа атрибута не нужно переносить на имя самого XML-атрибута автоматически.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.