src/xmlpatterns/schema/qxsdidentityconstraint_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  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_XsdIdentityConstraint_H
  53 #define Patternist_XsdIdentityConstraint_H
  54
  55 #include <private/qnamedschemacomponent_p.h>
  56 #include <private/qxsdannotated_p.h>
  57 #include <private/qxsdxpathexpression_p.h>
  58
  59 #include <QtCore/QStringList>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 namespace QPatternist
  66 {
  67     /**
  68      * @short Represents a XSD identity constraint object.
  69      *
  70      * This class represents the <em>identity constraint</em> object of a XML schema as described
  71      * <a href="http://www.w3.org/TR/xmlschema11-1/#cIdentity-constraint_Definitions">here</a>.
  72      *
  73      * It contains information from either a <em>key</em> object, a <em>keyref</em> object or an
  74      * <em>unique</em> object.
  75      *
  76      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSIdentityConstraint">XML Schema API reference</a>
  77      * @ingroup Patternist_schema
  78      * @author Tobias Koenig <tobias.koenig@nokia.com>
  79      */
  80     class XsdIdentityConstraint : public NamedSchemaComponent, public XsdAnnotated
  81     {
  82         public:
  83             typedef QExplicitlySharedDataPointer<XsdIdentityConstraint> Ptr;
  84             typedef QList<XsdIdentityConstraint::Ptr> List;
  85
  86             /**
  87              * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#icd-identity-constraint_category">category</a> of the identity constraint.
  88              */
  89             enum Category
  90             {
  91                 Key = 1,        ///< The constraint is a key constraint
  92                 KeyReference,   ///< The constraint is a keyref constraint
  93                 Unique          ///< The constraint is an unique constraint
  94             };
  95
  96             /**
  97              * Sets the @p category of the identity constraint.
  98              *
  99              * @see Category
 100              */
 101             void setCategory(Category category);
 102
 103             /**
 104              * Returns the category of the identity constraint.
 105              */
 106             Category category() const;
 107
 108             /**
 109              * Sets the @p selector of the identity constraint.
 110              *
 111              * The selector is a restricted XPath 1.0 expression,
 112              * that selects a set of nodes.
 113              *
 114              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#icd-selector"></a>
 115              */
 116             void setSelector(const XsdXPathExpression::Ptr &selector);
 117
 118             /**
 119              * Returns the selector of the identity constraint.
 120              */
 121             XsdXPathExpression::Ptr selector() const;
 122
 123             /**
 124              * Sets the @p fields of the identity constraint.
 125              *
 126              * Each field is a restricted XPath 1.0 expression,
 127              * that selects a set of nodes.
 128              *
 129              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#icd-fields"></a>
 130              */
 131             void setFields(const XsdXPathExpression::List &fields);
 132
 133             /**
 134              * Adds a new @p field to the identity constraint.
 135              */
 136             void addField(const XsdXPathExpression::Ptr &field);
 137
 138             /**
 139              * Returns all fields of the identity constraint.
 140              */
 141             XsdXPathExpression::List fields() const;
 142
 143             /**
 144              * Sets the referenced @p key of the identity constraint.
 145              *
 146              * The key points to a identity constraint of type Key or Unique.
 147              *
 148              * The identity constraint has only a referenced key if its
 149              * type is KeyReference.
 150              *
 151              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#icd-referenced_key"></a>
 152              */
 153             void setReferencedKey(const XsdIdentityConstraint::Ptr &key);
 154
 155             /**
 156              * Returns the referenced key of the identity constraint or an empty
 157              * pointer if its type is not KeyReference.
 158              */
 159             XsdIdentityConstraint::Ptr referencedKey() const;
 160
 161         private:
 162             Category                   m_category;
 163             XsdXPathExpression::Ptr    m_selector;
 164             XsdXPathExpression::List   m_fields;
 165             XsdIdentityConstraint::Ptr m_referencedKey;
 166     };
 167 }
 168
 169 QT_END_NAMESPACE
 170
 171 QT_END_HEADER
 172
 173 #endif