Класс QAbstractXmlNodeModel

Класс QAbstractXmlNodeModel — это абстрактный базовый класс для моделирования данных, не являющихся XML, чтобы они выглядели как XML для QXmlQuery. Подробнее...

• Список всех членов, включая унаследованные члены

Примечание: Все функции в этом классе являются безопасными для потоков.

Открытые типы

Открытые функции

Защищённые функции

Защищённые переменные

Подробное описание

Класс QAbstractXmlNodeModel — это абстрактный базовый класс для моделирования данных, не являющихся XML, чтобы они выглядели как XML для QXmlQuery.

Класс QAbstractXmlNodeModel определяет интерфейс, который должна реализовать модель узла, чтобы эта модель узлов была доступна для движка запросов для обработки запросов XQuery. Модель узлов представляет данные как структуру, которую можно запросить так, как если бы данные были XML.

Модель узла, представленная подклассом QAbstractXmlNodeModel, предназначена для доступа к движку запросов Qt XML Patterns. Если API в некоторых местах кажется немного странным, это потому, что члены-функции вызываются движком запросов при оценке запроса XQuery. Они не предназначены для использования в программировании.

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

QAbstractXmlNodeModel заполняет пробел между произвольной структурой данных, не являющихся XML, которые нужно запросить, и хорошо определенной структурой данных XML, понятной QXmlQuery.

Представьте приложение химии, которое считывает файл chemistryData, содержащий данные, не являющиеся XML, представляющие химическую структуру, состоящую из молекул и атомов. Приложение запросит эти химические данные с помощью запроса XQuery, который оно считывает из файла queryFile. Мы напишем пользовательский подкласс QAbstractXmlNodeModel (ChemistryNodeModel), который считывает chemistryData и создает структуру данных, возможно, состоящую из объектов наших собственных классов molecule и atom. Очевидно, что эта структура данных не является XML. Наш пользовательский подкласс будет знать, как пройтись по этой структуре данных, не являющейся XML, и представить её через интерфейс модели данных XPath.

QFile queryFile(argv[1]);
QFile chemistryData(argv[2]);
QString moleculeName = argv[3];

QXmlQuery query;
query.setQuery(&queryFile, QUrl::fromLocalFile(queryFile.fileName()));

ChemistryNodeModel myNodeModel(query.namePool(), chemistryData);
QXmlNodeModelIndex startNode = myNodeModel.nodeFor(moleculeName);
query.bindVariable("queryRoot", startNode);

QFile out;
out.open(stdout, QIODevice::WriteOnly);

QXmlSerializer serializer(query, &out);
query.evaluateTo(&serializer);

Приложение сначала создает экземпляр QXmlQuery и вызывает setQuery() для чтения queryFile, содержащего запрос XQuery, который мы хотим выполнить. Затем оно создает экземпляр нашего пользовательского класса модели узла, ChemistryNodeModel, который является подклассом QAbstractXmlNodeModel. Его конструктор вызывается с пулом имен, полученным из нашего QXmlQuery, и со структурой молекул и атомов, которые нужно запросить. Пул имен необходим, потому что наш пользовательский класс модели узла имеет член-функцию name(), которая возвращает имя любого узла в модели. Запрос и пользовательская модель узлов должны использовать один и тот же пул имен для создания этих имён. Конструктор затем прочитал бы chemistryFile и построил структуру пользовательской модели узлов.

Для соединения query с пользовательской моделью узлов, мы должны связать имя переменной, используемой в запросе, с узлом в модели. Затем эта переменная может быть использована в запросе в качестве начального узла. Сначала индекс для желаемого начального узла извлекается путем вызова QAbstractXmlNodeModel::createIndex(). Затем индекс связывается с именем переменной, в данном случае queryRoot, путем передачи имени и индекса в QXmlQuery::bindVariable(). Запрос может затем использовать ссылку на переменную $queryRoot для ссылки на начальный узел. Обратите внимание, что если запрос использует несколько ссылок на переменные, вызов QXmlQuery::bindVariable() необходим для привязки каждого имени переменной к узлу в модели.

Запрос выполняется, когда приложение вызывает одну из функций вычисления QXmlQuery. Приложение использует QXmlQuery::evaluateTo(QAbstractXmlReceiver *), так как затем использует сериализатор для вывода результата запроса в формате XML в stdout. Мы могли бы использовать QXmlQuery::evaluateTo(QXmlResultItems *) для получения списка элементов результата или QXmlQuery::evaluateTo(QStringList *) для получения списка значений xs:string.

Во время выполнения запроса движок перебирает модель узлов, используя nextFromSimpleAxis(), чтобы получить индекс следующего узла для посещения. Движок может получить имя узла, вызвав name() с индексом узла. stringValue(), baseUri(), documentUri() и kind() также вызываются по мере необходимости с индексом узла.

Пример демонстрирует стандартный шаблон использования подкласса QAbstractXmlNodeModel в сочетании с QXmlQuery для выполнения запроса XQuery.

1. Создайте экземпляр QXmlQuery и передайте ему XQuery для выполнения;
2. Создайте экземпляр подкласса QAbstractXmlNodeModel или QSimpleXmlNodeModel;
3. Получите QXmlNodeModelIndex для узла в модели, с которого QXmlQuery должен начать запрос;
4. Используйте QXmlQuery::bindVariable(), чтобы привязать QXmlNodeModelIndex к $variable name;
5. Вызовите одну из функций оценки QXmlQuery для выполнения запроса.

Наследование

Поскольку интерфейс XPath Data Model, представленный QAbstractXmlNodeModel, позволяет QXmlQuery работать с данными, не являющимися XML, как если бы они были XML, реализация подклассов QAbstractXmlNodeModel может потребовать значительных усилий. Класс QSimpleXmlNodeModel предоставляется для упрощения реализации во многих распространённых случаях.

Безопасность потоков

Поскольку к модели узлов могут одновременно обращаться потоки в модуле Qt XML Patterns, подклассы QAbstractXmlNodeModel должны быть написаны с обеспечением потоковой безопасности. Классы, которые упрощают реализацию потоковой безопасности, включают QReadLocker и QWriteLocker.

См. пример Пример Файловой Системы для демонстрации.

Документация по типам членов

typedef QAbstractXmlNodeModel::List

Список списков умных указателей на экземпляры QAbstractXmlNodeModel.

См. также QExplicitlySharedDataPointer.

typedef QAbstractXmlNodeModel::Ptr

Умный указатель на экземпляр QAbstractXmlNodeModel.

См. также QExplicitlySharedDataPointer.

enum QAbstractXmlNodeModel::SimpleAxis

Четыре оси, каждая из которых содержит только один узел.

Документация по функциям-членам

QAbstractXmlNodeModel::QAbstractXmlNodeModel()

Конструктор по умолчанию.

[virtual] QAbstractXmlNodeModel::~QAbstractXmlNodeModel()

Деструктор.

[pure virtual protected] QVector<QXmlNodeModelIndex> QAbstractXmlNodeModel::attributes(const QXmlNodeModelIndex &element) const

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

[pure virtual] QUrl QAbstractXmlNodeModel::baseUri(const QXmlNodeModelIndex &n) const

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

Базовый URI узла может быть извлечён с помощью функции fn:base-uri(). Базовый URI обычно используется для разрешения относительных URI, которые появляются в узле или его дочерних элементах. Он соответствует возвращению только URI документа, хотя это может не точно отражать основополагающие данные.

Эта функция отображается на функцию-аксессор dm:base-uri, которая возвращает базовый URI в соответствии со следующим:

• Для узлов документов базовый URI и URI документа совпадают.
• Для элементов базовый URI — URI, появляющийся в атрибуте xml:base элемента, если он присутствует, или он разрешается к базовому URI родительского элемента.
• Узлы имён пространств не имеют базового URI.
• Базовый URI для инструкции обработки, комментария, атрибута или текстового узла — базовый URI родительского элемента узла.

Реализация гарантирует возврат корректного QUrl или QUrl по умолчанию. Если у узла нет базового URI, как в случае, когда у комментария нет родителя, возвращается QUrl по умолчанию.

См. также XQuery 1.0 и XPath 2.0 Data Model (XDM), 5.2 базовый-uri Аксессор.

[pure virtual] QXmlNodeModelIndex::DocumentOrder QAbstractXmlNodeModel::compareOrder(const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2) const

Эта функция возвращает относительный порядок документа для узлов, индексированных ni1 и ni2. Она используется для оператора Is и для сортировки узлов в порядке документа.

Вызывающий гарантирует, что ni1 и ni2 не null и что оба идентифицируют узлы в этой модели узлов.

Если ni1 идентична ni2, возвращается QXmlNodeModelIndex::Is. Если ni1 предшествует ni2 в порядке документа, возвращается QXmlNodeModelIndex::Precedes. Если ni1 следует за ni2 в порядке документа, возвращается QXmlNodeModelIndex::Follows.

См. также XQuery 1.0 и XPath 2.0 Data Model (XDM), 2.4 Порядок документа.

[protected] QXmlNodeModelIndex QAbstractXmlNodeModel::createIndex(qint64 data) const

Создаёт индекс узла с data в качестве его внутренних данных. data не ограничено.

[protected] QXmlNodeModelIndex QAbstractXmlNodeModel::createIndex(void *pointer, qint64 additionalData = 0) const

Создаёт индекс узла с pointer и additionalData в качестве его внутренних данных.

Что такое pointer и additionalData, не ограничено.

[protected] QXmlNodeModelIndex QAbstractXmlNodeModel::createIndex(qint64 data, qint64 additionalData) const

Это перегруженная функция.

Создаёт QXmlNodeModelIndex содержащий data и additionalData.

[pure virtual] QUrl QAbstractXmlNodeModel::documentUri(const QXmlNodeModelIndex &n) const

Возвращает URI документа n. URI документа идентифицирует ресурс, который является документом. Например, документ может быть обычным файлом, например, file:/, или это может быть http:// URL расположения файла. URI документа используется для разрешения URI и просто для того, чтобы знать, где находится документ.

Если модель узлов отображает URI естественным образом, верните этот URI. В противном случае верните URI компании или продукта. URI документа может быть любым URI, пока он корректен и абсолютен.

Вызывающий гарантирует, что n не null и что он принадлежит этому QAbstractXmlNodeModel.

Эта функция отображается на функцию-аксессор dm:document-uri, которая возвращает URI документа в соответствии со следующим:

• Если n является узлом документа, верните абсолютный QUrl содержащий URI документа или QUrl по умолчанию. Последний сигнализирует, что URI документа для узла документа недоступен.
• Для всех остальных узлов верните QUrl по умолчанию.

См. также XQuery 1.0 и XPath 2.0 Data Model (XDM), 5.4 Аксессор document-uri, QUrl::isValid() и QUrl::isRelative().

[pure virtual] QXmlNodeModelIndex QAbstractXmlNodeModel::elementById(const QXmlName &id) const

Возвращает индекс элемента, идентифицированного как id. Функция id() из XQuery вызывает эту функцию.

Возвращаемый индекс узла будет индексом узла элемента, значение которого имеет тип ID и равно id, или узлом элемента, у которого есть атрибут с типизированным значением типа ID и равным id. Если такого элемента нет, возвращается экземпляр QXmlNodeModelIndex по умолчанию. Реализатор гарантирует, что если возвращённый индекс узла не null, он идентифицирует элемент.

Недостаточно, чтобы атрибут или элемент просто именовались id. Тип его значения также должен быть ID. Однако, зарезервированное имя xml:id достаточно.

В id, namespace URI и prefix не определены, и local name — это ID, который следует искать.

См. также XQuery 1.0 и XPath 2.0 Функции и операторы, 15.5.2 fn:id.

[pure virtual] QXmlNodeModelIndex::NodeKind QAbstractXmlNodeModel::kind(const QXmlNodeModelIndex &ni) const

Возвращает значение, указывающее вид узла, идентифицированного ni. Вызывающий гарантирует, что ni не null и что он идентифицирует узел в этой модели узлов. Эта функция соответствует аксессору dm:node-kind().

См. также XQuery 1.0 и XPath 2.0 Модель данных (XDM), 5.10 аксессор node-kind.

[pure virtual] QXmlName QAbstractXmlNodeModel::name(const QXmlNodeModelIndex &ni) const

Возвращает имя ni. Вызывающий гарантирует, что ni не null и что он принадлежит к этому QAbstractXmlNodeModel.

Если у узла нет имени, например, у узлов комментариев, возвращается null QXmlName. QXmlNames должны создаваться с помощью экземпляра QXmlQuery, который используется для оценки запросов с помощью этого QAbstractXmlNodeModel.

Эта функция соответствует аксессору dm:node-name().

Если ni — инструкция обработки, возвращается QXmlName с локальным именем в качестве целевого имени, а URI и префикс пространства имён пусты.

См. также XQuery 1.0 и XPath 2.0 Модель данных (XDM), 5.11 аксессор node-name и QXmlName.

[pure virtual] QVector<QXmlName> QAbstractXmlNodeModel::namespaceBindings(const QXmlNodeModelIndex &n) const

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

Эта функция соответствует аксессору dm:namespace-nodes.

Возвращаемый вектор объявлений пространств имён включает пространства имён предков n.

Вызывающий гарантирует, что n — элемент, принадлежащий этому QAbstractXmlNodeModel.

[pure virtual protected] QXmlNodeModelIndex QAbstractXmlNodeModel::nextFromSimpleAxis(QAbstractXmlNodeModel::SimpleAxis axis, const QXmlNodeModelIndex &origin) const

При оценке выражений путей Qt XML Patterns эмулирует их, комбинируя вызовы с значениями QSimpleXmlNodeModel::SimpleAxis. Поэтому реализация этой функции должна возвращать узел, если таковой есть, который появляется на оси axis, исходящей из origin.

Если такой узел недоступен, возвращается QXmlNodeModelIndex по умолчанию.

QSimpleXmlNodeModel устраняет необходимость обработки избыточных крайних случаев, гарантируя, что он никогда не запросит:

• Подчиненные или соседние узлы для атрибутов.
• Подчиненные узлы для комментариев, инструкций обработки и текстовых узлов.
• Соседние узлы или родительские узлы для узлов документа.

Типичная реализация выполняет switch для значения axis:

QXmlNodeModelIndex MyTreeModel::nextFromSimpleAxis(SimpleAxis axis, const QXmlNodeModelIndex &origin) const
{
  // Convert the QXmlNodeModelIndex to a value that is specific to what we represent.
  const MyValue value = toMyValue(ni);

  switch(axis)
  {
      case Parent:
          return toNodeIndex(value.parent());
      case FirstChild:
      case PreviousSibling:
      case NextSibling:
          // and so on
  }
}

[pure virtual] QVector<QXmlNodeModelIndex> QAbstractXmlNodeModel::nodesByIdref(const QXmlName &idref) const

Возвращает элементы и/или атрибуты, имеющие значение IDREF равное idref. Функция idref() из XQuery вызывает эту функцию.

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

Недостаточно, чтобы атрибут или элемент просто именовался idref. Он также должен быть типа IDREF. Элементы должны быть типизированы как xs:IDREF или xs:IDREFS, или, в случае атрибутов, как IDREF или IDREFS в схеме.

В idref, namespace URI и prefix не определены, и local name — это ID, который следует искать.

См. также XQuery 1.0 и XPath 2.0 Функции и операторы, 15.5.3 fn:idref.

[pure virtual] QXmlNodeModelIndex QAbstractXmlNodeModel::root(const QXmlNodeModelIndex &n) const

Возвращает корневой узел дерева, содержащего узел с индексом n. Вызывающий гарантирует, что n не null и что он идентифицирует узел в этой модели узлов.

Если n идентифицирует узел, являющийся непосредственным потомком корня, parent() вернёт тот же QXmlNodeModelIndex, что и эта функция.

QSourceLocation QAbstractXmlNodeModel::sourceLocation(const QXmlNodeModelIndex &index) const

Возвращает расположение источника для объекта с заданным index или QSourceLocation по умолчанию в случае отсутствия информации о расположении.

Эта функция была введена в Qt 4.6.

[pure virtual] QString QAbstractXmlNodeModel::stringValue(const QXmlNodeModelIndex &n) const

Возвращает строковое значение для узла n.

Вызывающий гарантирует, что n не null и что он принадлежит этому экземпляру QAbstractXmlNodeModel.

Эта функция соответствует аксессору dm:string-value(), спецификация которого полностью определена. Вот краткий обзор:

• Для инструкций обработки строковое значение — это раздел данных (исключая пробелы, появляющиеся между именем и данными).
• Для текстовых узлов строковое значение равно текстовому узлу.
• Для комментариев — содержание комментария
• Для элементов — конкатенация всех текстовых узлов, являющихся потомками. Обратите внимание, это не только дочерние узлы, но и дочерние узлы дочерних узлов, и так далее.
• Для узлов документа — конкатенация всех текстовых узлов в документе.

См. также XQuery 1.0 и XPath 2.0 Модель данных (XDM), 5.13 аксессор string-value.

[pure virtual] QVariant QAbstractXmlNodeModel::typedValue(const QXmlNodeModelIndex &node) const

Возвращает типизированное значение для узла node.

Типизированное значение — это атомное значение, которое содержит элемент или атрибут.

Вызывающий гарантирует, что node — это либо элемент, либо атрибут. Реализатор гарантирует, что возвращаемый QVariant имеет значение, поддерживаемое в XQuery. Он не может быть произвольным значением QVariant. Реализатор также гарантирует, что stringValue() возвращает лексическое представление typedValue() (это гарантируется QSimpleXmlNodeModel::stringValue()).

Если возвращаемый QVariant — это экземпляр по умолчанию, это указывает, что у node нет типизированного значения.