1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://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 https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_XsdParticle_H
51#define Patternist_XsdParticle_H
52
53#include <private/qnamedschemacomponent_p.h>
54#include <private/qxsdterm_p.h>
55
56#include <QtCore/QList>
57
58QT_BEGIN_NAMESPACE
59
60namespace QPatternist
61{
62 /**
63 * @short Represents a XSD particle object.
64 *
65 * This class represents the <em>particle</em> object of a XML schema as described
66 * <a href="http://www.w3.org/TR/xmlschema11-1/#cParticles">here</a>.
67 *
68 * It contains information about the number of occurrence and a reference to
69 * either an <em>element</em> object, a <em>group</em> object or an <em>any</em> object.
70 *
71 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSParticle">XML Schema API reference</a>
72 * @ingroup Patternist_schema
73 * @author Tobias Koenig <tobias.koenig@nokia.com>
74 */
75 class XsdParticle : public NamedSchemaComponent
76 {
77 public:
78 typedef QExplicitlySharedDataPointer<XsdParticle> Ptr;
79 typedef QList<XsdParticle::Ptr> List;
80
81 /**
82 * Creates a new particle object.
83 */
84 XsdParticle();
85
86 /**
87 * Sets the minimum @p occurrence of the particle.
88 *
89 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-min_occurs">Minimum Occurrence Definition</a>
90 */
91 void setMinimumOccurs(unsigned int occurrence);
92
93 /**
94 * Returns the minimum occurrence of the particle.
95 */
96 unsigned int minimumOccurs() const;
97
98 /**
99 * Sets the maximum @p occurrence of the particle.
100 *
101 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-max_occurs">Maximum Occurrence Definition</a>
102 */
103 void setMaximumOccurs(unsigned int occurrence);
104
105 /**
106 * Returns the maximum occurrence of the particle.
107 *
108 * @note This value has only a meaning if maximumOccursUnbounded is @c false.
109 */
110 unsigned int maximumOccurs() const;
111
112 /**
113 * Sets whether the maximum occurrence of the particle is unbounded.
114 *
115 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-max_occurs">Maximum Occurrence Definition</a>
116 */
117 void setMaximumOccursUnbounded(bool unbounded);
118
119 /**
120 * Returns whether the maximum occurrence of the particle is unbounded.
121 */
122 bool maximumOccursUnbounded() const;
123
124 /**
125 * Sets the @p term of the particle.
126 *
127 * The term can be an element, a model group or an element wildcard.
128 *
129 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-term">Term Definition</a>
130 */
131 void setTerm(const XsdTerm::Ptr &term);
132
133 /**
134 * Returns the term of the particle.
135 */
136 XsdTerm::Ptr term() const;
137
138 private:
139 unsigned int m_minimumOccurs;
140 unsigned int m_maximumOccurs;
141 bool m_maximumOccursUnbounded;
142 XsdTerm::Ptr m_term;
143 };
144}
145
146QT_END_NAMESPACE
147
148#endif
149

source code of qtxmlpatterns/src/xmlpatterns/schema/qxsdparticle_p.h