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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
/****************************************************************************
**
** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $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_XsdElement_H
#define Patternist_XsdElement_H
#include "qschemacomponent_p.h"
#include "qschematype_p.h"
#include "qxsdalternative_p.h"
#include "qxsdidentityconstraint_p.h"
#include "qxsdcomplextype_p.h"
#include <QtCore/QList>
#include <QtCore/QSet>
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short Represents a XSD element object.
*
* This class represents the <em>element</em> object of a XML schema as described
* <a href="http://www.w3.org/TR/xmlschema11-1/#cElement_Declarations">here</a>.
*
* It contains information from either a top-level element declaration (as child of a <em>schema</em> object)
* or a local element declaration (as descendant of an <em>complexType</em> object).
*
* @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSElementDecl">XML Schema API reference</a>
* @ingroup Patternist_schema
* @author Tobias Koenig <tobias.koenig@nokia.com>
*/
class XsdElement : public XsdTerm
{
public:
typedef QExplicitlySharedDataPointer<XsdElement> Ptr;
typedef QList<XsdElement::Ptr> List;
/**
* Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#ed-value_constraint">constraint type</a> of the element.
*/
enum ConstraintType
{
NoneConstraint, ///< The value of the element has no constraints.
DefaultConstraint, ///< The element has a default value set.
FixedConstraint ///< The element has a fixed value set.
};
/**
* Describes the scope of an element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#sc_e">Scope Definition</a>
*/
class Scope : public QSharedData
{
public:
typedef QExplicitlySharedDataPointer<Scope> Ptr;
/**
* Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#ad-scope">scope</a> of an attribute.
*/
enum Variety
{
Global, ///< The element is defined globally as child of the <em>schema</em> object.
Local ///< The element is defined locally as child of a complex type or model group definition.
};
/**
* Sets the @p variety of the element scope.
*/
void setVariety(Variety variety);
/**
* Returns the variety of the element scope.
*/
Variety variety() const;
/**
* Sets the @p parent complex type or model group definition of the element scope.
*/
void setParent(const NamedSchemaComponent::Ptr &parent);
/**
* Returns the parent complex type or model group definition of the element scope.
*/
NamedSchemaComponent::Ptr parent() const;
private:
Variety m_variety;
NamedSchemaComponent::Ptr m_parent;
};
/**
* Describes a type table of an element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#tt">Type Table Definition</a>
*/
class TypeTable : public QSharedData
{
public:
typedef QExplicitlySharedDataPointer<TypeTable> Ptr;
/**
* Adds an @p alternative to the type table.
*/
void addAlternative(const XsdAlternative::Ptr &alternative);
/**
* Returns the alternatives of the type table.
*/
XsdAlternative::List alternatives() const;
/**
* Sets the default @p type definition.
*/
void setDefaultTypeDefinition(const XsdAlternative::Ptr &type);
/**
* Returns the default type definition.
*/
XsdAlternative::Ptr defaultTypeDefinition() const;
private:
XsdAlternative::List m_alternatives;
XsdAlternative::Ptr m_defaultTypeDefinition;
};
/**
* Describes the value constraint of an element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#vc_e">Value Constraint Definition</a>
*/
class ValueConstraint : public QSharedData
{
public:
typedef QExplicitlySharedDataPointer<ValueConstraint> Ptr;
/**
* Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#ed-value_constraint">value constraint</a> of an element.
*/
enum Variety
{
Default, ///< The element has a default value set.
Fixed ///< The element has a fixed value set.
};
/**
* Sets the @p variety of the element value constraint.
*/
void setVariety(Variety variety);
/**
* Returns the variety of the element value constraint.
*/
Variety variety() const;
/**
* Sets the @p value of the constraint.
*/
void setValue(const QString &value);
/**
* Returns the value of the constraint.
*/
QString value() const;
/**
* Sets the lexical @p form of the constraint.
*/
void setLexicalForm(const QString &form);
/**
* Returns the lexical form of the constraint.
*/
QString lexicalForm() const;
private:
Variety m_variety;
QString m_value;
QString m_lexicalForm;
};
/**
* Creates a new element object.
*/
XsdElement();
/**
* Always returns @c true, used to avoid dynamic casts.
*/
virtual bool isElement() const;
/**
* Sets the @p type of the element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-type_definition">Type Definition</a>
*/
void setType(const SchemaType::Ptr &type);
/**
* Returns the type of the element.
*/
SchemaType::Ptr type() const;
/**
* Sets the @p scope of the element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-scope">Scope Definition</a>
*/
void setScope(const Scope::Ptr &scope);
/**
* Returns the scope of the element.
*/
Scope::Ptr scope() const;
/**
* Sets the value @p constraint of the element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-value_constraint">Value Constraint Definition</a>
*/
void setValueConstraint(const ValueConstraint::Ptr &constraint);
/**
* Returns the value constraint of the element.
*/
ValueConstraint::Ptr valueConstraint() const;
/**
* Sets the type table of the element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-type_table">Type Table Definition</a>
*/
void setTypeTable(const TypeTable::Ptr &table);
/**
* Returns the type table of the element.
*/
TypeTable::Ptr typeTable() const;
/**
* Sets whether the element is @p abstract.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-abstract">Abstract Definition</a>
*/
void setIsAbstract(bool abstract);
/**
* Returns whether the element is abstract.
*/
bool isAbstract() const;
/**
* Sets whether the element is @p nillable.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-nillable">Nillable Definition</a>
*/
void setIsNillable(bool nillable);
/**
* Returns whether the element is nillable.
*/
bool isNillable() const;
/**
* Sets the disallowed @p substitutions of the element.
*
* Only ExtensionConstraint, RestrictionConstraint and SubstitutionConstraint are allowed.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-disallowed_substitutions">Disallowed Substitutions Definition</a>
*/
void setDisallowedSubstitutions(const BlockingConstraints &substitutions);
/**
* Returns the disallowed substitutions of the element.
*/
BlockingConstraints disallowedSubstitutions() const;
/**
* Sets the substitution group @p exclusions of the element.
*
* Only SchemaType::ExtensionConstraint and SchemaType::RestrictionConstraint are allowed.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-substitution_group_exclusions">Substitution Group Exclusions Definition</a>
*/
void setSubstitutionGroupExclusions(const SchemaType::DerivationConstraints &exclusions);
/**
* Returns the substitution group exclusions of the element.
*/
SchemaType::DerivationConstraints substitutionGroupExclusions() const;
/**
* Sets the identity @p constraints of the element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-identity-constraint_definitions">Identity Constraint Definition</a>
*/
void setIdentityConstraints(const XsdIdentityConstraint::List &constraints);
/**
* Adds a new identity @p constraint to the element.
*/
void addIdentityConstraint(const XsdIdentityConstraint::Ptr &constraint);
/**
* Returns a list of all identity constraints of the element.
*/
XsdIdentityConstraint::List identityConstraints() const;
/**
* Sets the substitution group @p affiliations of the element.
*
* @see <a href="http://www.w3.org/TR/xmlschema11-1/#ed-substituion_group_affiliations">Substitution Group Affiliations</a>
*/
void setSubstitutionGroupAffiliations(const XsdElement::List &affiliations);
/**
* Returns the substitution group affiliations of the element.
*/
XsdElement::List substitutionGroupAffiliations() const;
/**
* Adds a substitution group to the element.
*/
void addSubstitutionGroup(const XsdElement::Ptr &elements);
/**
* Returns the substitution groups of the element.
*/
XsdElement::List substitutionGroups() const;
private:
SchemaType::Ptr m_type;
Scope::Ptr m_scope;
ValueConstraint::Ptr m_valueConstraint;
TypeTable::Ptr m_typeTable;
bool m_isAbstract;
bool m_isNillable;
BlockingConstraints m_disallowedSubstitutions;
SchemaType::DerivationConstraints m_substitutionGroupExclusions;
XsdIdentityConstraint::List m_identityConstraints;
XsdElement::List m_substitutionGroupAffiliations;
QSet<XsdElement::Ptr> m_substitutionGroups;
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif
|
