1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** 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_XsdSchema_H
53 #define Patternist_XsdSchema_H
55 #include <private/qschematype_p.h>
56 #include <private/qxsdannotated_p.h>
57 #include <private/qxsdattribute_p.h>
58 #include <private/qxsdattributegroup_p.h>
59 #include <private/qxsdcomplextype_p.h>
60 #include <private/qxsdelement_p.h>
61 #include <private/qxsdidentityconstraint_p.h>
62 #include <private/qxsdmodelgroup_p.h>
63 #include <private/qxsdnotation_p.h>
64 #include <private/qxsdsimpletype_p.h>
66 #include <QtCore/QHash>
67 #include <QtCore/QReadWriteLock>
70 * @defgroup Patternist_schema XML Schema Processing
80 * @short Represents a XSD schema object.
82 * The class provides access to all components of a parsed XSD.
84 * @note In the documentation of this class objects, which are direct
85 * children of the <em>schema</em> object, are called top-level objects.
87 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSModel">XML Schema API reference</a>
88 * @ingroup Patternist_schema
89 * @author Tobias Koenig <tobias.koenig@nokia.com>
91 class XsdSchema : public QSharedData, public XsdAnnotated
94 typedef QExplicitlySharedDataPointer<XsdSchema> Ptr;
95 typedef QList<XsdSchema::Ptr> List;
98 * Creates a new schema object.
100 * @param namePool The namepool that should be used for names of
101 * all schema components.
103 XsdSchema(const NamePool::Ptr &namePool);
106 * Destroys the schema object.
111 * Returns the namepool that is used for names of
112 * all schema components.
114 NamePool::Ptr namePool() const;
117 * Sets the @p targetNamespace of the schema.
119 void setTargetNamespace(const QString &targetNamespace);
122 * Returns the target namespace of the schema.
124 QString targetNamespace() const;
127 * Adds a new top-level @p element to the schema.
129 * @param element The new element.
130 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-element">Element Declaration</a>
132 void addElement(const XsdElement::Ptr &element);
135 * Returns the top-level element of the schema with
136 * the given @p name or an empty pointer if none exist.
138 XsdElement::Ptr element(const QXmlName &name) const;
141 * Returns the list of all top-level elements.
143 XsdElement::List elements() const;
146 * Adds a new top-level @p attribute to the schema.
148 * @param attribute The new attribute.
149 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-attribute">Attribute Declaration</a>
151 void addAttribute(const XsdAttribute::Ptr &attribute);
154 * Returns the top-level attribute of the schema with
155 * the given @p name or an empty pointer if none exist.
157 XsdAttribute::Ptr attribute(const QXmlName &name) const;
160 * Returns the list of all top-level attributes.
162 XsdAttribute::List attributes() const;
165 * Adds a new top-level @p type to the schema.
166 * That can be a simple or a complex type.
168 * @param type The new type.
169 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-datatype">Simple Type Declaration</a>
170 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-type">Complex Type Declaration</a>
172 void addType(const SchemaType::Ptr &type);
175 * Returns the top-level type of the schema with
176 * the given @p name or an empty pointer if none exist.
178 SchemaType::Ptr type(const QXmlName &name) const;
181 * Returns the list of all top-level types.
183 SchemaType::List types() const;
186 * Returns the list of all top-level simple types.
188 XsdSimpleType::List simpleTypes() const;
191 * Returns the list of all top-level complex types.
193 XsdComplexType::List complexTypes() const;
196 * Adds an anonymous @p type to the schema.
197 * Anonymous types have no name and are declared
198 * locally inside an element object.
200 * @param type The new anonymous type.
202 void addAnonymousType(const SchemaType::Ptr &type);
205 * Returns the list of all anonymous types.
207 SchemaType::List anonymousTypes() const;
210 * Adds a new top-level attribute @p group to the schema.
212 * @param group The new attribute group.
213 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-attributeGroup">Attribute Group Declaration</a>
215 void addAttributeGroup(const XsdAttributeGroup::Ptr &group);
218 * Returns the top-level attribute group of the schema with
219 * the given @p name or an empty pointer if none exist.
221 XsdAttributeGroup::Ptr attributeGroup(const QXmlName name) const;
224 * Returns the list of all top-level attribute groups.
226 XsdAttributeGroup::List attributeGroups() const;
229 * Adds a new top-level element @p group to the schema.
231 * @param group The new element group.
232 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-namedModelGroup">Element Group Declaration</a>
234 void addElementGroup(const XsdModelGroup::Ptr &group);
237 * Returns the top-level element group of the schema with
238 * the given @p name or an empty pointer if none exist.
240 XsdModelGroup::Ptr elementGroup(const QXmlName &name) const;
243 * Returns the list of all top-level element groups.
245 XsdModelGroup::List elementGroups() const;
248 * Adds a new top-level @p notation to the schema.
250 * @param notation The new notation.
251 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#declare-notation">Notation Declaration</a>
253 void addNotation(const XsdNotation::Ptr ¬ation);
256 * Returns the top-level notation of the schema with
257 * the given @p name or an empty pointer if none exist.
259 XsdNotation::Ptr notation(const QXmlName &name) const;
262 * Returns the list of all top-level notations.
264 XsdNotation::List notations() const;
267 * Adds a new identity @p constraint to the schema.
269 void addIdentityConstraint(const XsdIdentityConstraint::Ptr &constraint);
272 * Returns the identity constraint with the given @p name
273 * or an empty pointer if none exist.
275 XsdIdentityConstraint::Ptr identityConstraint(const QXmlName &name) const;
278 * Returns the list of all identity constraints in this schema.
280 XsdIdentityConstraint::List identityConstraints() const;
283 NamePool::Ptr m_namePool;
284 QString m_targetNamespace;
285 QHash<QXmlName, XsdElement::Ptr> m_elements;
286 QHash<QXmlName, XsdAttribute::Ptr> m_attributes;
287 QHash<QXmlName, SchemaType::Ptr> m_types;
288 QHash<QXmlName, SchemaType::Ptr> m_anonymousTypes;
289 QHash<QXmlName, XsdAttributeGroup::Ptr> m_attributeGroups;
290 QHash<QXmlName, XsdModelGroup::Ptr> m_elementGroups;
291 QHash<QXmlName, XsdNotation::Ptr> m_notations;
292 QHash<QXmlName, XsdIdentityConstraint::Ptr> m_identityConstraints;
293 mutable QReadWriteLock m_lock;