1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2015 The Qt Company Ltd. 4 ** Contact: http://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit. 7 ** 8 ** $QT_BEGIN_LICENSE:LGPL$ 9 ** Commercial License Usage 10 ** Licensees holding valid commercial Qt licenses may use this file in 11 ** accordance with the commercial license agreement provided with the 12 ** Software or, alternatively, in accordance with the terms contained in 13 ** a written agreement between you and The Qt Company. For licensing terms 14 ** and conditions see http://www.qt.io/terms-conditions. For further 15 ** information use the contact form at http://www.qt.io/contact-us. 16 ** 17 ** GNU Lesser General Public License Usage 18 ** Alternatively, this file may be used under the terms of the GNU Lesser 19 ** General Public License version 2.1 or version 3 as published by the Free 20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and 21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the 22 ** following information to ensure the GNU Lesser General Public License 23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and 24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 25 ** 26 ** As a special exception, The Qt Company gives you certain additional 27 ** rights. These rights are described in The Qt Company LGPL Exception 28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. 29 ** 30 ** GNU General Public License Usage 31 ** Alternatively, this file may be used under the terms of the GNU 32 ** General Public License version 3.0 as published by the Free Software 33 ** Foundation and appearing in the file LICENSE.GPL included in the 34 ** packaging of this file. Please review the following information to 35 ** ensure the GNU General Public License version 3.0 requirements will be 36 ** met: http://www.gnu.org/copyleft/gpl.html. 37 ** 38 ** $QT_END_LICENSE$ 39 ** 40 ****************************************************************************/ 41 42 // 43 // W A R N I N G 44 // ------------- 45 // 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. 49 // 50 // We mean it. 51 52 #ifndef Patternist_XsdValidatedXmlNodeModel_H 53 #define Patternist_XsdValidatedXmlNodeModel_H 54 55 #include "qabstractxmlnodemodel.h" 56 57 #include "qabstractxmlforwarditerator_p.h" 58 #include "qitem_p.h" 59 #include "qschematype_p.h" 60 #include "qxsdelement_p.h" 61 62 QT_BEGIN_HEADER 63 64 QT_BEGIN_NAMESPACE 65 66 namespace QPatternist 67 { 68 /** 69 * @short A delegate class that wraps around a QAbstractXmlNodeModel and provides 70 * additional validation specific information. 71 * 72 * This class represents the input XML document enriched with additional type 73 * information that has been assigned during validation. 74 * 75 * @ingroup Patternist_schema 76 * @author Tobias Koenig <tobias.koenig@nokia.com> 77 */ 78 class XsdValidatedXmlNodeModel : public QAbstractXmlNodeModel 79 { 80 public: 81 typedef QExplicitlySharedDataPointer<XsdValidatedXmlNodeModel> Ptr; 82 typedef QList<Ptr> List; 83 84 /** 85 * Creates a new validated xml node model. 86 */ 87 XsdValidatedXmlNodeModel(const QAbstractXmlNodeModel *model); 88 89 /** 90 * Destroys the validated xml node model. 91 */ 92 virtual ~XsdValidatedXmlNodeModel(); 93 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; 112 113 /** 114 * Sets the @p element that is assigned to the xml node at @p index. 115 */ 116 void setAssignedElement(const QXmlNodeModelIndex &index, const XsdElement::Ptr &element); 117 118 /** 119 * Returns the element that is assigned to the xml node at @p index. 120 */ 121 XsdElement::Ptr assignedElement(const QXmlNodeModelIndex &index) const; 122 123 /** 124 * Sets the @p attribute that is assigned to the xml node at @p index. 125 */ 126 void setAssignedAttribute(const QXmlNodeModelIndex &index, const XsdAttribute::Ptr &attribute); 127 128 /** 129 * Returns the attribute that is assigned to the xml node at @p index. 130 */ 131 XsdAttribute::Ptr assignedAttribute(const QXmlNodeModelIndex &index) const; 132 133 /** 134 * Sets the @p type that is assigned to the xml node at @p index. 135 * 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. 139 */ 140 void setAssignedType(const QXmlNodeModelIndex &index, const SchemaType::Ptr &type); 141 142 /** 143 * Returns the type that is assigned to the xml node at @p index. 144 */ 145 SchemaType::Ptr assignedType(const QXmlNodeModelIndex &index) const; 146 147 /** 148 * Adds the attribute or element @p binding with the given @p id. 149 */ 150 void addIdIdRefBinding(const QString &id, const NamedSchemaComponent::Ptr &binding); 151 152 /** 153 * Returns a list of all binding ids. 154 */ 155 QStringList idIdRefBindingIds() const; 156 157 /** 158 * Returns the set of bindings with the given @p id. 159 */ 160 QSet<NamedSchemaComponent::Ptr> idIdRefBindings(const QString &id) const; 161 162 protected: 163 virtual QXmlNodeModelIndex nextFromSimpleAxis(SimpleAxis axis, const QXmlNodeModelIndex &origin) const; 164 virtual QVector<QXmlNodeModelIndex> attributes(const QXmlNodeModelIndex &element) const; 165 166 private: 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; 172 }; 173 } 174 175 QT_END_NAMESPACE 176 177 QT_END_HEADER 178 179 #endif 180