1 /****************************************************************************
3 ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
52 #ifndef Patternist_XsdValidatedXmlNodeModel_H
53 #define Patternist_XsdValidatedXmlNodeModel_H
55 #include "qabstractxmlnodemodel.h"
57 #include <private/qabstractxmlforwarditerator_p.h>
58 #include <private/qitem_p.h>
59 #include <private/qschematype_p.h>
60 #include <private/qxsdelement_p.h>
69 * @short A delegate class that wraps around a QAbstractXmlNodeModel and provides
70 * additional validation specific information.
72 * This class represents the input XML document enriched with additional type
73 * information that has been assigned during validation.
75 * @ingroup Patternist_schema
76 * @author Tobias Koenig <tobias.koenig@nokia.com>
78 class XsdValidatedXmlNodeModel : public QAbstractXmlNodeModel
81 typedef QExplicitlySharedDataPointer<XsdValidatedXmlNodeModel> Ptr;
82 typedef QList<Ptr> List;
85 * Creates a new validated xml node model.
87 XsdValidatedXmlNodeModel(const QAbstractXmlNodeModel *model);
90 * Destroys the validated xml node model.
92 virtual ~XsdValidatedXmlNodeModel();
94 virtual QUrl baseUri(const QXmlNodeModelIndex &ni) const;
95 virtual QUrl documentUri(const QXmlNodeModelIndex &ni) const;
96 virtual QXmlNodeModelIndex::NodeKind kind(const QXmlNodeModelIndex &ni) const;
97 virtual QXmlNodeModelIndex::DocumentOrder compareOrder(const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2) const;
98 virtual QXmlNodeModelIndex root(const QXmlNodeModelIndex &n) const;
99 virtual QXmlName name(const QXmlNodeModelIndex &ni) const;
100 virtual QString stringValue(const QXmlNodeModelIndex &n) const;
101 virtual QVariant typedValue(const QXmlNodeModelIndex &n) const;
102 virtual QExplicitlySharedDataPointer<QAbstractXmlForwardIterator<QXmlNodeModelIndex> > iterate(const QXmlNodeModelIndex &ni, QXmlNodeModelIndex::Axis axis) const;
103 virtual QPatternist::ItemIteratorPtr sequencedTypedValue(const QXmlNodeModelIndex &ni) const;
104 virtual QPatternist::ItemTypePtr type(const QXmlNodeModelIndex &ni) const;
105 virtual QXmlName::NamespaceCode namespaceForPrefix(const QXmlNodeModelIndex &ni, const QXmlName::PrefixCode prefix) const;
106 virtual bool isDeepEqual(const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2) const;
107 virtual void sendNamespaces(const QXmlNodeModelIndex &n, QAbstractXmlReceiver *const receiver) const;
108 virtual QVector<QXmlName> namespaceBindings(const QXmlNodeModelIndex &n) const;
109 virtual QXmlNodeModelIndex elementById(const QXmlName &NCName) const;
110 virtual QVector<QXmlNodeModelIndex> nodesByIdref(const QXmlName &NCName) const;
111 virtual void copyNodeTo(const QXmlNodeModelIndex &node, QAbstractXmlReceiver *const receiver, const NodeCopySettings &) const;
114 * Sets the @p element that is assigned to the xml node at @p index.
116 void setAssignedElement(const QXmlNodeModelIndex &index, const XsdElement::Ptr &element);
119 * Returns the element that is assigned to the xml node at @p index.
121 XsdElement::Ptr assignedElement(const QXmlNodeModelIndex &index) const;
124 * Sets the @p attribute that is assigned to the xml node at @p index.
126 void setAssignedAttribute(const QXmlNodeModelIndex &index, const XsdAttribute::Ptr &attribute);
129 * Returns the attribute that is assigned to the xml node at @p index.
131 XsdAttribute::Ptr assignedAttribute(const QXmlNodeModelIndex &index) const;
134 * Sets the @p type that is assigned to the xml node at @p index.
136 * @note The type can be a different than the type of the element or
137 * attribute that is assigned to the index, since the instance
138 * document can overwrite it by xsi:type.
140 void setAssignedType(const QXmlNodeModelIndex &index, const SchemaType::Ptr &type);
143 * Returns the type that is assigned to the xml node at @p index.
145 SchemaType::Ptr assignedType(const QXmlNodeModelIndex &index) const;
148 * Adds the attribute or element @p binding with the given @p id.
150 void addIdIdRefBinding(const QString &id, const NamedSchemaComponent::Ptr &binding);
153 * Returns a list of all binding ids.
155 QStringList idIdRefBindingIds() const;
158 * Returns the set of bindings with the given @p id.
160 QSet<NamedSchemaComponent::Ptr> idIdRefBindings(const QString &id) const;
163 virtual QXmlNodeModelIndex nextFromSimpleAxis(SimpleAxis axis, const QXmlNodeModelIndex &origin) const;
164 virtual QVector<QXmlNodeModelIndex> attributes(const QXmlNodeModelIndex &element) const;
167 QExplicitlySharedDataPointer<const QAbstractXmlNodeModel> m_internalModel;
168 QHash<QXmlNodeModelIndex, XsdElement::Ptr> m_assignedElements;
169 QHash<QXmlNodeModelIndex, XsdAttribute::Ptr> m_assignedAttributes;
170 QHash<QXmlNodeModelIndex, SchemaType::Ptr> m_assignedTypes;
171 QHash<QString, QSet<NamedSchemaComponent::Ptr> > m_idIdRefBindings;