summaryrefslogtreecommitdiffstats
path: root/src/xmlpatterns/schema/qxsdidentityconstraint_p.h
blob: 6870b1e48f004485804f685e6de9537f29c4a61e (plain)
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
/****************************************************************************
**
** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the $MODULE$ of the Qt Toolkit.
**
** $TROLLTECH_DUAL_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_XsdIdentityConstraint_H
#define Patternist_XsdIdentityConstraint_H

#include "qnamedschemacomponent_p.h"
#include "qxsdannotated_p.h"
#include "qxsdxpathexpression_p.h"

#include <QtCore/QStringList>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist
{
    /**
     * @short Represents a XSD identity constraint object.
     *
     * This class represents the <em>identity constraint</em> object of a XML schema as described
     * <a href="http://www.w3.org/TR/xmlschema11-1/#cIdentity-constraint_Definitions">here</a>.
     *
     * It contains information from either a <em>key</em> object, a <em>keyref</em> object or an
     * <em>unique</em> object.
     *
     * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSIdentityConstraint">XML Schema API reference</a>
     * @ingroup Patternist_schema
     * @author Tobias Koenig <tobias.koenig@trolltech.com>
     */
    class XsdIdentityConstraint : public NamedSchemaComponent, public XsdAnnotated
    {
        public:
            typedef QExplicitlySharedDataPointer<XsdIdentityConstraint> Ptr;
            typedef QList<XsdIdentityConstraint::Ptr> List;

            /**
             * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#icd-identity-constraint_category">category</a> of the identity constraint.
             */
            enum Category
            {
                Key = 1,        ///< The constraint is a key constraint
                KeyReference,   ///< The constraint is a keyref constraint
                Unique          ///< The constraint is an unique constraint
            };

            /**
             * Sets the @p category of the identity constraint.
             *
             * @see Category
             */
            void setCategory(Category category);

            /**
             * Returns the category of the identity constraint.
             */
            Category category() const;

            /**
             * Sets the @p selector of the identity constraint.
             *
             * The selector is a restricted XPath 1.0 expression,
             * that selects a set of nodes.
             *
             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#icd-selector"></a>
             */
            void setSelector(const XsdXPathExpression::Ptr &selector);

            /**
             * Returns the selector of the identity constraint.
             */
            XsdXPathExpression::Ptr selector() const;

            /**
             * Sets the @p fields of the identity constraint.
             *
             * Each field is a restricted XPath 1.0 expression,
             * that selects a set of nodes.
             *
             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#icd-fields"></a>
             */
            void setFields(const XsdXPathExpression::List &fields);

            /**
             * Adds a new @p field to the identity constraint.
             */
            void addField(const XsdXPathExpression::Ptr &field);

            /**
             * Returns all fields of the identity constraint.
             */
            XsdXPathExpression::List fields() const;

            /**
             * Sets the referenced @p key of the identity constraint.
             *
             * The key points to a identity constraint of type Key or Unique.
             *
             * The identity constraint has only a referenced key if its
             * type is KeyReference.
             *
             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#icd-referenced_key"></a>
             */
            void setReferencedKey(const XsdIdentityConstraint::Ptr &key);

            /**
             * Returns the referenced key of the identity constraint or an empty
             * pointer if its type is not KeyReference.
             */
            XsdIdentityConstraint::Ptr referencedKey() const;

        private:
            Category                   m_category;
            XsdXPathExpression::Ptr    m_selector;
            XsdXPathExpression::List   m_fields;
            XsdIdentityConstraint::Ptr m_referencedKey;
    };
}

QT_END_NAMESPACE

QT_END_HEADER

#endif