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_XsdAnnotation_H
53 #define Patternist_XsdAnnotation_H
54 
55 #include "qderivedstring_p.h"
56 #include "qxsdapplicationinformation_p.h"
57 #include "qxsddocumentation_p.h"
58 
59 QT_BEGIN_HEADER
60 
61 QT_BEGIN_NAMESPACE
62 
63 namespace QPatternist
64 {
65     /**
66      * @short Represents a XSD annotation object.
67      *
68      * This class represents the <em>annotation</em> object of a XML schema as described
69      * <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>.
70      *
71      * @ingroup Patternist_schema
72      * @author Tobias Koenig <tobias.koenig@nokia.com>
73      */
74     class XsdAnnotation : public NamedSchemaComponent
75     {
76         public:
77             typedef QExplicitlySharedDataPointer<XsdAnnotation> Ptr;
78             typedef QList<XsdAnnotation::Ptr> List;
79 
80             /**
81              * Sets the @p id of the annotation.
82              */
83             void setId(const DerivedString<TypeID>::Ptr &id);
84 
85             /**
86              * Returns the @p id of the annotation.
87              */
88             DerivedString<TypeID>::Ptr id() const;
89 
90             /**
91              * Adds an application @p information to the annotation.
92              *
93              * The application information is meant to be interpreted by
94              * a software system, e.g. other parts of the XML processor pipeline.
95              */
96             void addApplicationInformation(const XsdApplicationInformation::Ptr &information);
97 
98             /**
99              * Returns the list of all application information of the annotation.
100              */
101             XsdApplicationInformation::List applicationInformation() const;
102 
103             /**
104              * Adds a @p documentation to the annotation.
105              *
106              * The documentation is meant to be read by human being, e.g. additional
107              * constraints or information about schema components.
108              */
109             void addDocumentation(const XsdDocumentation::Ptr &documentation);
110 
111             /**
112              * Returns the list of all documentations of the annotation.
113              */
114             XsdDocumentation::List documentation() const;
115 
116         private:
117             DerivedString<TypeID>::Ptr      m_id;
118             XsdApplicationInformation::List m_applicationInformation;
119             XsdDocumentation::List          m_documentations;
120     };
121 }
122 
123 QT_END_NAMESPACE
124 
125 QT_END_HEADER
126 
127 #endif
128