1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#ifndef Patternist_XsdSchema_H
#define Patternist_XsdSchema_H
#include <private/qschematype_p.h>
#include <private/qxsdannotated_p.h>
#include <private/qxsdattribute_p.h>
#include <private/qxsdattributegroup_p.h>
#include <private/qxsdcomplextype_p.h>
#include <private/qxsdelement_p.h>
#include <private/qxsdidentityconstraint_p.h>
#include <private/qxsdmodelgroup_p.h>
#include <private/qxsdnotation_p.h>
#include <private/qxsdsimpletype_p.h>
#include <QtCore/QHash>
#include <QtCore/QReadWriteLock>
/**
* @defgroup Patternist_schema XML Schema Processing
*/
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short Represents a XSD schema object.
*
* The class provides access to all components of a parsed XSD.
*
* @note In the documentation of this class objects, which are direct
* children of the <em>schema</em> object, are called top-level objects.
*
* @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSModel">XML Schema API reference</a>
* @ingroup Patternist_schema
* @author Tobias Koenig <tobias.koenig@nokia.com>
*/
class XsdSchema : public QSharedData, public XsdAnnotated
{
public:
typedef QExplicitlySharedDataPointer<XsdSchema> Ptr;
typedef QList<XsdSchema::Ptr> List;
/**
* Creates a new schema object.
*
* @param namePool The namepool that should be used for names of
* all schema components.
*/
XsdSchema(const NamePool::Ptr &namePool);
/**
* Destroys the schema object.
*/
~XsdSchema();
/**
* Returns the namepool that is used for names of
* all schema components.
*/
NamePool::Ptr namePool() const;
/**
* Sets the @p targetNamespace of the schema.
*/
void setTargetNamespace(const QString &targetNamespace);
/**
* Returns the target namespace of the schema.
*/
QString targetNamespace() const;
/**
* Adds a new top-level @p element to the schema.
*
* @param element The new element.
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-element">Element Declaration</a>
*/
void addElement(const XsdElement::Ptr &element);
/**
* Returns the top-level element of the schema with
* the given @p name or an empty pointer if none exist.
*/
XsdElement::Ptr element(const QXmlName &name) const;
/**
* Returns the list of all top-level elements.
*/
XsdElement::List elements() const;
/**
* Adds a new top-level @p attribute to the schema.
*
* @param attribute The new attribute.
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-attribute">Attribute Declaration</a>
*/
void addAttribute(const XsdAttribute::Ptr &attribute);
/**
* Returns the top-level attribute of the schema with
* the given @p name or an empty pointer if none exist.
*/
XsdAttribute::Ptr attribute(const QXmlName &name) const;
/**
* Returns the list of all top-level attributes.
*/
XsdAttribute::List attributes() const;
/**
* Adds a new top-level @p type to the schema.
* That can be a simple or a complex type.
*
* @param type The new type.
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-datatype">Simple Type Declaration</a>
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-type">Complex Type Declaration</a>
*/
void addType(const SchemaType::Ptr &type);
/**
* Returns the top-level type of the schema with
* the given @p name or an empty pointer if none exist.
*/
SchemaType::Ptr type(const QXmlName &name) const;
/**
* Returns the list of all top-level types.
*/
SchemaType::List types() const;
/**
* Returns the list of all top-level simple types.
*/
XsdSimpleType::List simpleTypes() const;
/**
* Returns the list of all top-level complex types.
*/
XsdComplexType::List complexTypes() const;
/**
* Adds an anonymous @p type to the schema.
* Anonymous types have no name and are declared
* locally inside an element object.
*
* @param type The new anonymous type.
*/
void addAnonymousType(const SchemaType::Ptr &type);
/**
* Returns the list of all anonymous types.
*/
SchemaType::List anonymousTypes() const;
/**
* Adds a new top-level attribute @p group to the schema.
*
* @param group The new attribute group.
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-attributeGroup">Attribute Group Declaration</a>
*/
void addAttributeGroup(const XsdAttributeGroup::Ptr &group);
/**
* Returns the top-level attribute group of the schema with
* the given @p name or an empty pointer if none exist.
*/
XsdAttributeGroup::Ptr attributeGroup(const QXmlName name) const;
/**
* Returns the list of all top-level attribute groups.
*/
XsdAttributeGroup::List attributeGroups() const;
/**
* Adds a new top-level element @p group to the schema.
*
* @param group The new element group.
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-namedModelGroup">Element Group Declaration</a>
*/
void addElementGroup(const XsdModelGroup::Ptr &group);
/**
* Returns the top-level element group of the schema with
* the given @p name or an empty pointer if none exist.
*/
XsdModelGroup::Ptr elementGroup(const QXmlName &name) const;
/**
* Returns the list of all top-level element groups.
*/
XsdModelGroup::List elementGroups() const;
/**
* Adds a new top-level @p notation to the schema.
*
* @param notation The new notation.
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-notation">Notation Declaration</a>
*/
void addNotation(const XsdNotation::Ptr ¬ation);
/**
* Returns the top-level notation of the schema with
* the given @p name or an empty pointer if none exist.
*/
XsdNotation::Ptr notation(const QXmlName &name) const;
/**
* Returns the list of all top-level notations.
*/
XsdNotation::List notations() const;
/**
* Adds a new identity @p constraint to the schema.
*/
void addIdentityConstraint(const XsdIdentityConstraint::Ptr &constraint);
/**
* Returns the identity constraint with the given @p name
* or an empty pointer if none exist.
*/
XsdIdentityConstraint::Ptr identityConstraint(const QXmlName &name) const;
/**
* Returns the list of all identity constraints in this schema.
*/
XsdIdentityConstraint::List identityConstraints() const;
private:
NamePool::Ptr m_namePool;
QString m_targetNamespace;
QHash<QXmlName, XsdElement::Ptr> m_elements;
QHash<QXmlName, XsdAttribute::Ptr> m_attributes;
QHash<QXmlName, SchemaType::Ptr> m_types;
QHash<QXmlName, SchemaType::Ptr> m_anonymousTypes;
QHash<QXmlName, XsdAttributeGroup::Ptr> m_attributeGroups;
QHash<QXmlName, XsdModelGroup::Ptr> m_elementGroups;
QHash<QXmlName, XsdNotation::Ptr> m_notations;
QHash<QXmlName, XsdIdentityConstraint::Ptr> m_identityConstraints;
mutable QReadWriteLock m_lock;
};
}
QT_END_NAMESPACE
#endif
|
