Спецификация
формата обмена данными о временных потоках и их элементах (событиях)
Версия: Редакция 2.03 от 08.06.2008
Статус: Финальная версия
1Основные понятия
Временной поток (ВП) - это тематическая подборка элементов, выстроенных
в хронологическом порядке, с привязкой каждого элемента к дате или интервалу дат и месту.
Элемент временного потока (ЭВП) – это отдельное событие, факт, некоторый временной интервал (историческая эпоха) или другой, например, менее масштабный временной поток. Для краткости изложения вместо термина элемент временного потока, может использоваться термин событие, под которым будет подразумеваться элемент временного потока.
Данные ВП и ЭВП– совокупность данных, содержащих необходимую тематическую информацию как о самих событиях и ВП, так и об их связях. Имя файла(ов) данных задается разработчиками ВП. Структура и состав файлов регламентируется настоящим документом и описывается в разделе спецификация данных ВП и ЭВП.
Формат обмена данных о ВП и ЭВП – технологический формат, описывающий правила обмена данными о ВП и ЭВП между различными программными средами. Включает в себя спецификацию формата обмена данными о ВП и ЭВП, спецификацию данных ВП и ЭВП, спецификацию декларации ВП (ЭВП).
Декларация ВП (ЭВП) - описание содержания и структуры ВП (ЭВП) в рамках данного документа. Имя файла декларации регламентировано: oc3manifest.xml
2Спецификация формата обмена
Для обмена ВП (ЭВП) упаковывается вместе с декларацией в архивный файл формата
PKZip v2.04g (.zip) или файл формата ZIP, соответствующий RFC1951.
Архивный файл содержит ВП (ЭВП) в виде набора файлов и директорий. Обязательными файлами архива являются декларация (oc3manifest.xml), стартовый файл ВП (ЭВП). Спецификация оставляет выбор названий файла ВП (ЭВП) за разработчиком, однако требует, чтобы имена файлов в архиве включали только латинские буквы, цифры и символы ‘-’,’_’,’.’ ,‘[’,‘]’,‘+’,‘(’,‘)’. Другие символы использовать в именах файлах запрещено.
В качестве разделителя имен файлов и директорий нужно использовать слэш Unix '/'.
Каждому ВП (ЭВП) присваивается глобальный уникальный идентификатор GUID (Global Unique identifier). Значение GUID формируется на этапе создания ВП (ЭВП) и остаётся неизменным для всех последующих версий ВП (ЭВП). Для генерации конкретного значения можно воспользоваться общедоступным генератором глобальных идентификаторов http://kruithof.xs4all.nl/uuid/uuidgen .
Имя архивного файла имеет вид TL_.zip. Аббревиатура TL соответствует фразе “Time Line”.
Примеры глобальных уникальных идентификаторов (должны генерироваться специальной программой):
25BCE99F-59E4-4C96-8C7C-24A4FA130145
Пример имени файла, содержащего упакованный ВП (ЭВП):
TL_25BCE99F-59E4-4C96-8C7C-24A4FA130145.zip
3Спецификация декларации ВП (ЭВП)
3.1Пространство имен
Декларация префиксов в XML элементах
Назначение
xmlns="http://www.<ссылка>.ru/xsd/tl_v2/"
По умолчанию, элементы размещаются тут.
3.2Спецификация
Ниже приведены основные элементы, используемые в рамках данного документа. Атрибуты элементов приведены в колонке "Описание", из названия подчеркнуты. (см. также пример в п. 6.1 настоящего документа, файл «oc3manifest.xml»).
type: тип ресурса, значение "timeline" или "timelineelement" или
или "multipletimeline"
"rubricator"
href: имя стартового файла. (обязательный)
1
N
Обязательный
file
Файл ресурса.
Параметр:
href: имя и путь к файлу в формате "path_name/file_name.ext" с учетом общих требований к именам файлов и директорий. Например, "html_path/index.jpg".
1
N
Список файлов ресурса. (Обязательно должен быть регламентирован стартовый файл)
Таблица 3 1.
Основные элементы декларации ВП.
4 Спецификация данных ВП и ЭВП
4.1Пространство имен
Декларация префиксов в XML элементах
Назначение
xmlns="http://www.<ссылка>.ru/xsd/tl_v2/"
По умолчанию элементы размещаются тут.
4.2Базовая структура.
Данные ВП и ЭВП сохраняются в международном открытом формате OpenXML [1]. Данный формат сертифицирован международной организации сертификации стандартов ISO [2] (ISO 29500).
Данные ВП (ЭВП) представляются в виде контейнера, представляющего из себя zip-архив. Содержимое контейнера имеет структуру, состоящую из нескольких директорий. Данная структура описывается в файле «.rels» расположенном в директории «_rels» (см. пример в п. 6.3 настоящего документа). В соответствии с [1] в данном файле в формате XML описываются расположение следующих структурных элементов контейнера с помощью элемента , при этом атрибут «Type» определяет тип структурного элемента, а атрибут «Target» задает местоположение данного структурного элемента в контейнере. Используемые типы структурных элементов приведены в таблице ниже.
содержит в формате описание дополнительных характеристик ВП (указывается ссылка на файл относительно корневой директории контейнера)
Таблица 4 2.
Структура контейнера. Дополнительно к файлу «.rels», форматом предусмотрено стандартное расположение файла «[Content_types].xml» содержащий список описание всех типов файлов использованных в данном контейнере в формате [1] (см. пример в п.6.5 настоящего документа).
В директории, указанной в качестве базовой для размещения данных ВП (см. таблицу выше) присутствуют поддиректории «media» и «_rels».
Поддиректория «media» содержит медиафайлы ВП.
В поддиректории «_rels» располагается файл «document.xml.rels» содержащий список используемых медиафайлов в соответствии с [1] (см. пример в п. 6.4 настоящего документа).
Пример допустимой структуры директорий контейнера приводится в п. 6.1 настоящего документа.
4.3Модель данных
Для представления данных ВП используется модель данных, представленная на рисунке ниже. Как видно из рисунка, в данной модели используются несколько наборов данных, взаимосвязь между элементами которых осуществляется за счет разделения идентификаторов. Используются следующие наборы данных
Название
Описание
TimeLine
Содержит указатели на узловые ЭВП
Event
Содержит описание ЭВП
TimeLineEventSet
Определяет иерархию ЭВП
Attribute
Содержит список используемых пользовательских атрибутов
EventAttributeValue
Содержит значения пользовательских атрибутов
AttributeEnumerated
Содержит список допустимых значений для перечислимых атрибутов
Media
Содержит описания медиафайлов
EventMediaSet
Определяет соответствия между событиями и медиафайлами
Таблица 4 3.
Наборы данных.
Рисунок 1
Схема модели данных.
4.4Спецификация файла «document.xml»
Файл «document.xml» содержащий описание ВП (ЭВП) и их иерархию располагается в директории указанной в файле «_rels» в соответствии с [1] (см. п. 4.2 настоящего документа). Ниже приведены его основные элементы, их допустимые значения а также отображена общая структура данных.
Рисунок 2
Графическое представление XML-схемы файла «document.xml».
Родит.
элемент
Элемент
Описание
EventDataSet
Обязательный корневой элемент данной XML-схемы
EventDataSet
TimeLine
Содержит указатели на узловые ЭВП
TimeLine
ID
Уникальный идентификатор
TimeLine
EventID
Идентификатор узлового ЭВП (соответствует ID элемента Event)
EventDataSet
TimeLineEventSet
Определяет иерархию ЭВП
TimeLineEventSet
ID
Уникальный идентификатор
TimeLineEventSet
TimeLineID
Идентификатор ВП (соответствует ID элемента TimeLine)
TimeLineEventSet
EventID
Идентификатор ЭВП (соответствует ID элемента Event)
EventDataSet
Event
Содержит описание ЭВП
Event
ID
Уникальный идентификатор
Event
StartDate
Определяет начальное время ЭВП (см. п.4.4.1 настоящего документа)
Event
StopDate
Определяет время окончания ЭВП (см. п.4.4.1 настоящего документа)
Event
Name
Содержит название ЭВП
Event
Place
Содержит описание места ВП(ЭВП)
Event
Source
Содержит список источников информации использованных при подготовке описаний ЭВП
Event
Description
Содержит описание ЭВП
Event
Guid
GUID глобальный уникальный идентификатор ВП (ЭВП)
EventDataSet
Attribute
Содержит список используемых пользовательских атрибутов
Attribute
ID
Уникальный идентификатор
Attribute
Name
Содержит название атрибута
Attribute
Type
Тип атрибутов.
Допустимые
значения
описание
System.String
строка
System.Int
число
System.Drawing.Color
цвет
Enumeration
перечислимый
System.Boolean
логический
EventDataSet
EventAttributeValue
Содержит значения пользовательских атрибутов
EventAttributeValue
ID
Уникальный идентификатор
EventAttributeValue
EventID
Идентификатор ЭВП (соответствует ID элемента Event)
EventAttributeValue
AttributeID
Идентификатор атрибута (соответствует ID элемента Attribute)
EventAttributeValue
Value
Содержит значение атрибута
EventDataSet
AttributeEnumerated
Содержит список допустимых значений для атрибутов перечислимого типа
AttributeEnumerated
ID
Уникальный идентификатор
AttributeEnumerated
AttributeID
Идентификатор атрибута (соответствует ID элемента Attribute)
AttributeEnumerated
Value
Допустимое значение
EventDataSet
Media
Содержит описания медиафайлов
Media
ID
Уникальный идентификатор
Media
Name
Содержит название
Media
Description
Содержит описание медиафайла
Media
Source
Описание информационного источника медиафайла
Media
FileName
Имя файла медиафайла
Media
Image
Содержит уменьшенную копию изображения медиафайла в виде байтового массива
EventDataSet
EventMediaSet
Определяет соответствия между событиями и медиафайлами
EventMediaSet
ID
Уникальный идентификатор
EventMediaSet
EventID
Идентификатор ЭВП (соответствует ID элемента Event)
EventMediaSet
MediaID
Идентификатор медиафайла (соответствует ID элемента Media)
EventMediaSet
Position
Пользовательский порядковый номер медиафайла.
4.4.1Спецификация формата представления даты и времени.
Настоящая спецификация разработана на базе ГОСТ 7.64-90 [3] с учетом необходимых специфических требований.
В настоящей спецификации используются следующие обозначения (см. таблицу ниже).
Наименование
Описание
-
Модификатор упрощенного написания дат до нашей эры
до н.э.
Модификатор написания дат до нашей эры. Допустимые форматы:
до н.э.
до нэ
дон.э.
донэ.
донэ
дон.э
YYYY
год, целое число в диапазоне от -15 000 000 000 до 9 999 исключая 0 (от 1 до 11 символов)
Mon
месяц, целое число от 1 до 12 (один или два символа)
DD
день, целое число от 1 до 31 (один или два символа)
HH
час, целое число от 0 до 23 (один или два символа)
mm
минута, целое число от 0 до 59 (один или два символа)
SS
Секунда, допускаются две формы:
в виде целого числа секунд от 0 до 59 (один или два символа)
в виде числа секунд в формате числа с плавающей запятой (разделитель разрядов символ «.» - точка) целая часть от 0 до 59 (один или два символа), дробная часть от 1 до 11 символов
Un
Модификатор расширенного формата написания даты, допускаются следующие значения:
«тыс.» или «тыс» – тысячелетия
«млн.» или «млн» – миллионы лет
«млрд.» или «млрд» – миллиарды лет
Cal
Модификатор указания календаря, допускаются следующие значения:
«ЮЛ.» или «ЮЛ» – Юлианский календарь
«ГР.» или «ГР» – Григорианский календарь
ws
один или более пробелов
Допустимые форматы представления даты/времени описываются ниже:
Всего три года было будущему Ивану Грозному, когда внезапно тяжело заболел его отец. Болезнь поначалу была пустяковой - царапина. Но царапина стала нарывать, нарыв перешел в карбункул, а дальше (ведь антисептики еще не знали) - общее заражение крови, сепсис. И 54-летний великий князь, только вчера еще "тешившийся" охотой, умер, успев перед смертью благословить старшего сына на великое княжение. Впоследствии Иван IV очень гордился тем, что он монарх всю свою жизнь, что не помнит даже, как его "батюшка пожаловал благословил государством".
Ад — это зал, заполненный наполовину.
Роберт Фрост ещё >>