src/xmlpatterns/schema/qxsdidchelper_p.h
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2008 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 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    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_XsdIdcHelper_H
       
    53 #define Patternist_XsdIdcHelper_H
       
    54 
       
    55 #include "qreportcontext_p.h"
       
    56 #include "qschematype_p.h"
       
    57 
       
    58 #include <QtXmlPatterns/QXmlItem>
       
    59 
       
    60 QT_BEGIN_HEADER
       
    61 
       
    62 QT_BEGIN_NAMESPACE
       
    63 
       
    64 namespace QPatternist
       
    65 {
       
    66 
       
    67     /**
       
    68      * @short A helper class for validating identity constraints.
       
    69      *
       
    70      * This class represents a field node from the key-sequence as defined in
       
    71      * the validation rules at http://www.w3.org/TR/xmlschema11-1/#d0e32243.
       
    72      */
       
    73     class FieldNode
       
    74     {
       
    75         public:
       
    76             /**
       
    77              * Creates an empty field node.
       
    78              */
       
    79             FieldNode();
       
    80 
       
    81             /**
       
    82              * Creates a field node that is bound to a xml node.
       
    83              *
       
    84              * @param item The xml node the field is bound to.
       
    85              * @param data The string content of that field.
       
    86              * @param type The type that is bound to that field.
       
    87              */
       
    88             FieldNode(const QXmlItem &item, const QString &data, const SchemaType::Ptr &type);
       
    89 
       
    90             /**
       
    91              * Returns whether this field is empty.
       
    92              *
       
    93              * A field can be empty, if the xpath expression selects an absent attribute
       
    94              * or element.
       
    95              */
       
    96             bool isEmpty() const;
       
    97 
       
    98             /**
       
    99              * Returns whether this field is equal to the @p other field.
       
   100              *
       
   101              * Equal means that both have the same type and there content is equal in the
       
   102              * types value space.
       
   103              */
       
   104             bool isEqualTo(const FieldNode &other, const NamePool::Ptr &namePool, const ReportContext::Ptr &context, const SourceLocationReflection *const reflection) const;
       
   105 
       
   106             /**
       
   107              * Returns the xml node item the field is bound to.
       
   108              */
       
   109             QXmlItem item() const;
       
   110 
       
   111         private:
       
   112             QXmlItem m_item;
       
   113             QString m_data;
       
   114             SchemaType::Ptr m_type;
       
   115     };
       
   116 
       
   117     /**
       
   118      * @short A helper class for validating identity constraints.
       
   119      *
       
   120      * This class represents a target or qualified node from the target or qualified
       
   121      * node set as defined in the validation rules at http://www.w3.org/TR/xmlschema11-1/#d0e32243.
       
   122      *
       
   123      * A target node is part of the qualified node set, if all of its fields are not empty.
       
   124      */
       
   125     class TargetNode
       
   126     {
       
   127         public:
       
   128             /**
       
   129              * Defines a set of target nodes.
       
   130              */
       
   131             typedef QSet<TargetNode> Set;
       
   132 
       
   133             /**
       
   134              * Creates a new target node that is bound to the xml node @p item.
       
   135              */
       
   136             explicit TargetNode(const QXmlItem &item);
       
   137 
       
   138             /**
       
   139              * Returns the xml node item the target node is bound to.
       
   140              */
       
   141             QXmlItem item() const;
       
   142 
       
   143             /**
       
   144              * Returns all xml node items, the fields of that target node are bound to.
       
   145              */
       
   146             QVector<QXmlItem> fieldItems() const;
       
   147 
       
   148             /**
       
   149              * Returns the number of fields that are empty.
       
   150              */
       
   151             int emptyFieldsCount() const;
       
   152 
       
   153             /**
       
   154              * Returns whether the target node has the same fields as the @p other target node.
       
   155              */
       
   156             bool fieldsAreEqual(const TargetNode &other, const NamePool::Ptr &namePool, const ReportContext::Ptr &context, const SourceLocationReflection *const reflection) const;
       
   157 
       
   158             /**
       
   159              * Adds a new field to the target node with the given values.
       
   160              */
       
   161             void addField(const QXmlItem &item, const QString &data, const SchemaType::Ptr &type);
       
   162 
       
   163             /**
       
   164              * Returns whether the target node is equal to the @p other target node.
       
   165              */
       
   166             bool operator==(const TargetNode &other) const;
       
   167 
       
   168         private:
       
   169             QXmlItem m_item;
       
   170             QVector<FieldNode> m_fields;
       
   171     };
       
   172 
       
   173     /**
       
   174      * Creates a hash value for the given target @p node.
       
   175      */
       
   176     inline uint qHash(const QPatternist::TargetNode &node)
       
   177     {
       
   178         return qHash(node.item().toNodeModelIndex());
       
   179     }
       
   180 }
       
   181 
       
   182 QT_END_NAMESPACE
       
   183 
       
   184 QT_END_HEADER
       
   185 
       
   186 #endif