qxsdelement_p.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_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_XsdElement_H
#define Patternist_XsdElement_H

#include "qschemacomponent_p.h"
#include "qschematype_p.h"
#include "qxsdalternative_p.h"
#include "qxsdidentityconstraint_p.h"
#include "qxsdcomplextype_p.h"

#include <QtCore/QList>
#include <QtCore/QSet>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist
{
    class XsdElement : public XsdTerm
    {
        public:
            typedef QExplicitlySharedDataPointer<XsdElement> Ptr;
            typedef QList<XsdElement::Ptr> List;
            typedef QList<XsdElement *> WeakList;

            enum ConstraintType
            {
                NoneConstraint,     
                DefaultConstraint,  
                FixedConstraint     
            };

            class Scope : public QSharedData
            {
                public:
                    typedef QExplicitlySharedDataPointer<Scope> Ptr;

                    enum Variety
                    {
                        Global,    
                        Local      
                    };

                    void setVariety(Variety variety);

                    Variety variety() const;

                    void setParent(const NamedSchemaComponent::Ptr &parent);

                    NamedSchemaComponent::Ptr parent() const;

                private:
                    Variety                   m_variety;
                    NamedSchemaComponent      *m_parent;
            };

            class TypeTable : public QSharedData
            {
                public:
                    typedef QExplicitlySharedDataPointer<TypeTable> Ptr;

                    void addAlternative(const XsdAlternative::Ptr &alternative);

                    XsdAlternative::List alternatives() const;

                    void setDefaultTypeDefinition(const XsdAlternative::Ptr &type);

                    XsdAlternative::Ptr defaultTypeDefinition() const;

                private:
                    XsdAlternative::List m_alternatives;
                    XsdAlternative::Ptr  m_defaultTypeDefinition;
            };


            class ValueConstraint : public QSharedData
            {
                public:
                    typedef QExplicitlySharedDataPointer<ValueConstraint> Ptr;

                    enum Variety
                    {
                        Default,  
                        Fixed     
                    };

                    void setVariety(Variety variety);

                    Variety variety() const;

                    void setValue(const QString &value);

                    QString value() const;

                    void setLexicalForm(const QString &form);

                    QString lexicalForm() const;

                private:
                    Variety m_variety;
                    QString m_value;
                    QString m_lexicalForm;
            };

            XsdElement();

            virtual bool isElement() const;

            void setType(const SchemaType::Ptr &type);

            SchemaType::Ptr type() const;

            void setScope(const Scope::Ptr &scope);

            Scope::Ptr scope() const;

            void setValueConstraint(const ValueConstraint::Ptr &constraint);

            ValueConstraint::Ptr valueConstraint() const;

            void setTypeTable(const TypeTable::Ptr &table);

            TypeTable::Ptr typeTable() const;

            void setIsAbstract(bool abstract);

            bool isAbstract() const;

            void setIsNillable(bool nillable);

            bool isNillable() const;

            void setDisallowedSubstitutions(const BlockingConstraints &substitutions);

            BlockingConstraints disallowedSubstitutions() const;

            void setSubstitutionGroupExclusions(const SchemaType::DerivationConstraints &exclusions);

            SchemaType::DerivationConstraints substitutionGroupExclusions() const;

            void setIdentityConstraints(const XsdIdentityConstraint::List &constraints);

            void addIdentityConstraint(const XsdIdentityConstraint::Ptr &constraint);

            XsdIdentityConstraint::List identityConstraints() const;

            void setSubstitutionGroupAffiliations(const XsdElement::List &affiliations);

            XsdElement::List substitutionGroupAffiliations() const;

            void addSubstitutionGroup(const XsdElement::Ptr &elements);

            XsdElement::WeakList substitutionGroups() const;

        private:
            SchemaType                        *m_type;
            Scope::Ptr                        m_scope;
            ValueConstraint::Ptr              m_valueConstraint;
            TypeTable::Ptr                    m_typeTable;
            bool                              m_isAbstract;
            bool                              m_isNillable;
            BlockingConstraints               m_disallowedSubstitutions;
            SchemaType::DerivationConstraints m_substitutionGroupExclusions;
            XsdIdentityConstraint::List       m_identityConstraints;
            XsdElement::List                  m_substitutionGroupAffiliations;
            QSet<XsdElement *>                m_substitutionGroups;
    };
}

QT_END_NAMESPACE

QT_END_HEADER

#endif