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_XsdParticle_H
53 #define Patternist_XsdParticle_H
54 
55 #include "qnamedschemacomponent_p.h"
56 #include "qxsdterm_p.h"
57 
58 #include <QtCore/QList>
59 
60 QT_BEGIN_HEADER
61 
62 QT_BEGIN_NAMESPACE
63 
64 namespace QPatternist
65 {
66     /**
67      * @short Represents a XSD particle object.
68      *
69      * This class represents the <em>particle</em> object of a XML schema as described
70      * <a href="http://www.w3.org/TR/xmlschema11-1/#cParticles">here</a>.
71      *
72      * It contains information about the number of occurrence and a reference to
73      * either an <em>element</em> object, a <em>group</em> object or an <em>any</em> object.
74      *
75      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSParticle">XML Schema API reference</a>
76      * @ingroup Patternist_schema
77      * @author Tobias Koenig <tobias.koenig@nokia.com>
78      */
79     class XsdParticle : public NamedSchemaComponent
80     {
81         public:
82             typedef QExplicitlySharedDataPointer<XsdParticle> Ptr;
83             typedef QList<XsdParticle::Ptr> List;
84 
85             /**
86              * Creates a new particle object.
87              */
88             XsdParticle();
89 
90             /**
91              * Sets the minimum @p occurrence of the particle.
92              *
93              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-min_occurs">Minimum Occurrence Definition</a>
94              */
95             void setMinimumOccurs(unsigned int occurrence);
96 
97             /**
98              * Returns the minimum occurrence of the particle.
99              */
100             unsigned int minimumOccurs() const;
101 
102             /**
103              * Sets the maximum @p occurrence of the particle.
104              *
105              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-max_occurs">Maximum Occurrence Definition</a>
106              */
107             void setMaximumOccurs(unsigned int occurrence);
108 
109             /**
110              * Returns the maximum occurrence of the particle.
111              *
112              * @note This value has only a meaning if maximumOccursUnbounded is @c false.
113              */
114             unsigned int maximumOccurs() const;
115 
116             /**
117              * Sets whether the maximum occurrence of the particle is unbounded.
118              *
119              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-max_occurs">Maximum Occurrence Definition</a>
120              */
121             void setMaximumOccursUnbounded(bool unbounded);
122 
123             /**
124              * Returns whether the maximum occurrence of the particle is unbounded.
125              */
126             bool maximumOccursUnbounded() const;
127 
128             /**
129              * Sets the @p term of the particle.
130              *
131              * The term can be an element, a model group or an element wildcard.
132              *
133              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-term">Term Definition</a>
134              */
135             void setTerm(const XsdTerm::Ptr &term);
136 
137             /**
138              * Returns the term of the particle.
139              */
140             XsdTerm::Ptr term() const;
141 
142         private:
143             unsigned int m_minimumOccurs;
144             unsigned int m_maximumOccurs;
145             bool         m_maximumOccursUnbounded;
146             XsdTerm::Ptr m_term;
147     };
148 }
149 
150 QT_END_NAMESPACE
151 
152 QT_END_HEADER
153 
154 #endif
155