/****************************************************************************
**
** Copyright (C) 2013 Sandro S. Andrade <sandroandrade@kde.org>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtUml 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$
**
****************************************************************************/
#ifndef QUMLPACKAGEOBJECT_H
#define QUMLPACKAGEOBJECT_H

#include <QtUml/QtUmlGlobal>

#include <QtModeling/QModelingObject>

#include <QtUml/QtUmlNamespace>

QT_BEGIN_NAMESPACE

QT_MODULE(QtUml)

class QUmlPackage;
class QModelingObjectPrivate;
class Q_UML_EXPORT QUmlPackageObject : public QModelingObject
{
    Q_OBJECT
    Q_DISABLE_COPY(QUmlPackageObject)
    Q_DECLARE_PRIVATE(QModelingObject)

    // Properties [Element]
    Q_PROPERTY(QSet<QObject *> ownedComments READ ownedComments NOTIFY ownedCommentsChanged)
    Q_PROPERTY(QSet<QObject *> ownedElements READ ownedElements NOTIFY ownedElementsChanged)
    Q_PROPERTY(QObject * owner READ owner NOTIFY ownerChanged)

    // Properties [NamedElement]
    Q_PROPERTY(QSet<QObject *> clientDependencies READ clientDependencies NOTIFY clientDependenciesChanged)
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(QObject * nameExpression READ nameExpression WRITE setNameExpression NOTIFY nameExpressionChanged)
    Q_PROPERTY(QObject * namespace_ READ namespace_ NOTIFY namespaceChanged)
    Q_PROPERTY(QString qualifiedName READ qualifiedName NOTIFY qualifiedNameChanged STORED false)

    // Properties [Namespace]
    Q_PROPERTY(QSet<QObject *> elementImports READ elementImports NOTIFY elementImportsChanged)
    Q_PROPERTY(QSet<QObject *> importedMembers READ importedMembers NOTIFY importedMembersChanged STORED false)
    Q_PROPERTY(QSet<QObject *> members READ members NOTIFY membersChanged)
    Q_PROPERTY(QSet<QObject *> ownedMembers READ ownedMembers NOTIFY ownedMembersChanged)
    Q_PROPERTY(QSet<QObject *> ownedRules READ ownedRules NOTIFY ownedRulesChanged)
    Q_PROPERTY(QSet<QObject *> packageImports READ packageImports NOTIFY packageImportsChanged)

    // Properties [ParameterableElement]
    Q_PROPERTY(QObject * owningTemplateParameter READ owningTemplateParameter WRITE setOwningTemplateParameter NOTIFY owningTemplateParameterChanged)
    Q_PROPERTY(QObject * templateParameter READ templateParameter WRITE setTemplateParameter NOTIFY templateParameterChanged)

    // Properties [PackageableElement]
    Q_PROPERTY(QtUml::VisibilityKind visibility READ visibility WRITE setVisibility NOTIFY visibilityChanged RESET unsetVisibility)

    // Properties [TemplateableElement]
    Q_PROPERTY(QObject * ownedTemplateSignature READ ownedTemplateSignature WRITE setOwnedTemplateSignature NOTIFY ownedTemplateSignatureChanged)
    Q_PROPERTY(QSet<QObject *> templateBindings READ templateBindings NOTIFY templateBindingsChanged)

    // Properties [Package]
    Q_PROPERTY(QString URI READ URI WRITE setURI NOTIFY URIChanged)
    Q_PROPERTY(QSet<QObject *> nestedPackages READ nestedPackages NOTIFY nestedPackagesChanged STORED false)
    Q_PROPERTY(QObject * nestingPackage READ nestingPackage WRITE setNestingPackage NOTIFY nestingPackageChanged)
    Q_PROPERTY(QSet<QObject *> ownedStereotypes READ ownedStereotypes NOTIFY ownedStereotypesChanged STORED false)
    Q_PROPERTY(QSet<QObject *> ownedTypes READ ownedTypes NOTIFY ownedTypesChanged STORED false)
    Q_PROPERTY(QSet<QObject *> packageMerges READ packageMerges NOTIFY packageMergesChanged)
    Q_PROPERTY(QSet<QObject *> packagedElements READ packagedElements NOTIFY packagedElementsChanged)
    Q_PROPERTY(QSet<QObject *> profileApplications READ profileApplications NOTIFY profileApplicationsChanged)

public:
    Q_INVOKABLE explicit QUmlPackageObject(QUmlPackage *modelingElement);

    // Owned attributes [Element]
    Q_INVOKABLE const QSet<QObject *> ownedComments() const;
    Q_INVOKABLE const QSet<QObject *> ownedElements() const;
    Q_INVOKABLE QObject *owner() const;

    // Owned attributes [NamedElement]
    Q_INVOKABLE const QSet<QObject *> clientDependencies() const;
    Q_INVOKABLE QString name() const;
    Q_INVOKABLE QObject *nameExpression() const;
    Q_INVOKABLE QObject *namespace_() const;
    Q_INVOKABLE QString qualifiedName() const;

    // Owned attributes [Namespace]
    Q_INVOKABLE const QSet<QObject *> elementImports() const;
    Q_INVOKABLE const QSet<QObject *> importedMembers() const;
    Q_INVOKABLE const QSet<QObject *> members() const;
    Q_INVOKABLE const QSet<QObject *> ownedMembers() const;
    Q_INVOKABLE const QSet<QObject *> ownedRules() const;
    Q_INVOKABLE const QSet<QObject *> packageImports() const;

    // Owned attributes [ParameterableElement]
    Q_INVOKABLE QObject *owningTemplateParameter() const;
    Q_INVOKABLE QObject *templateParameter() const;

    // Owned attributes [PackageableElement]
    Q_INVOKABLE QtUml::VisibilityKind visibility() const;

    // Owned attributes [TemplateableElement]
    Q_INVOKABLE QObject *ownedTemplateSignature() const;
    Q_INVOKABLE const QSet<QObject *> templateBindings() const;

    // Owned attributes [Package]
    Q_INVOKABLE QString URI() const;
    Q_INVOKABLE const QSet<QObject *> nestedPackages() const;
    Q_INVOKABLE QObject *nestingPackage() const;
    Q_INVOKABLE const QSet<QObject *> ownedStereotypes() const;
    Q_INVOKABLE const QSet<QObject *> ownedTypes() const;
    Q_INVOKABLE const QSet<QObject *> packageMerges() const;
    Q_INVOKABLE const QSet<QObject *> packagedElements() const;
    Q_INVOKABLE const QSet<QObject *> profileApplications() const;

    // Operations [Element]
    Q_INVOKABLE QSet<QObject *> allOwnedElements() const;

    // Operations [NamedElement]
    Q_INVOKABLE QList<QObject *> allNamespaces() const;
    Q_TODO Q_INVOKABLE QSet<QObject *> allOwningPackages() const;
    Q_TODO Q_INVOKABLE bool isDistinguishableFrom(QObject *n, QObject *ns) const;
    Q_INVOKABLE QString separator() const;

    // Operations [Namespace]
    Q_TODO Q_INVOKABLE QSet<QObject *> excludeCollisions(QSet<QObject *> imps) const;
    Q_TODO Q_INVOKABLE QSet<QString> getNamesOfMember(QObject *element) const;
    Q_TODO Q_INVOKABLE QSet<QObject *> importMembers(QSet<QObject *> imps) const;
    Q_TODO Q_INVOKABLE bool membersAreDistinguishable() const;

    // Operations [ParameterableElement]
    Q_TODO Q_INVOKABLE bool isCompatibleWith(QObject *p) const;
    Q_TODO Q_INVOKABLE bool isTemplateParameter() const;

    // Operations [TemplateableElement]
    Q_TODO Q_INVOKABLE bool isTemplate() const;
    Q_TODO Q_INVOKABLE QSet<QObject *> parameterableElements() const;

    // Operations [Package]
    Q_TODO Q_INVOKABLE QSet<QObject *> allApplicableStereotypes() const;
    Q_TODO Q_INVOKABLE QObject *containingProfile() const;
    Q_TODO Q_INVOKABLE bool makesVisible(QObject *el) const;
    Q_INVOKABLE bool mustBeOwned() const;
    Q_TODO Q_INVOKABLE QSet<QObject *> visibleMembers() const;

public Q_SLOTS:

    // Slots for owned attributes [Element]
    void addOwnedComment(QObject *ownedComment);
    void removeOwnedComment(QObject *ownedComment);
    void Q_DECL_HIDDEN addOwnedElement(QObject *ownedElement);
    void Q_DECL_HIDDEN removeOwnedElement(QObject *ownedElement);
    void Q_DECL_HIDDEN setOwner(QObject *owner = 0);

    // Slots for owned attributes [NamedElement]
    void addClientDependency(QObject *clientDependency);
    void removeClientDependency(QObject *clientDependency);
    void setName(QString name);
    void setNameExpression(QObject *nameExpression = 0);
    void Q_DECL_HIDDEN setNamespace(QObject *namespace_ = 0);
    void Q_DECL_HIDDEN setQualifiedName(QString qualifiedName);

    // Slots for owned attributes [Namespace]
    void addElementImport(QObject *elementImport);
    void removeElementImport(QObject *elementImport);
    void Q_DECL_HIDDEN addImportedMember(QObject *importedMember);
    void Q_DECL_HIDDEN removeImportedMember(QObject *importedMember);
    void Q_DECL_HIDDEN addMember(QObject *member);
    void Q_DECL_HIDDEN removeMember(QObject *member);
    void Q_DECL_HIDDEN addOwnedMember(QObject *ownedMember);
    void Q_DECL_HIDDEN removeOwnedMember(QObject *ownedMember);
    void addOwnedRule(QObject *ownedRule);
    void removeOwnedRule(QObject *ownedRule);
    void addPackageImport(QObject *packageImport);
    void removePackageImport(QObject *packageImport);

    // Slots for owned attributes [ParameterableElement]
    void setOwningTemplateParameter(QObject *owningTemplateParameter = 0);
    void setTemplateParameter(QObject *templateParameter = 0);

    // Slots for owned attributes [PackageableElement]
    void setVisibility(QtUml::VisibilityKind visibility);
    void unsetVisibility();

    // Slots for owned attributes [TemplateableElement]
    void setOwnedTemplateSignature(QObject *ownedTemplateSignature = 0);
    void addTemplateBinding(QObject *templateBinding);
    void removeTemplateBinding(QObject *templateBinding);

    // Slots for owned attributes [Package]
    void setURI(QString URI);
    void addNestedPackage(QObject *nestedPackage);
    void removeNestedPackage(QObject *nestedPackage);
    void setNestingPackage(QObject *nestingPackage = 0);
    void Q_DECL_HIDDEN addOwnedStereotype(QObject *ownedStereotype);
    void Q_DECL_HIDDEN removeOwnedStereotype(QObject *ownedStereotype);
    void addOwnedType(QObject *ownedType);
    void removeOwnedType(QObject *ownedType);
    void addPackageMerge(QObject *packageMerge);
    void removePackageMerge(QObject *packageMerge);
    void addPackagedElement(QObject *packagedElement);
    void removePackagedElement(QObject *packagedElement);
    void addProfileApplication(QObject *profileApplication);
    void removeProfileApplication(QObject *profileApplication);

Q_SIGNALS:

    // Signals for owned attributes [Element]
    void ownedCommentsChanged(QSet<QObject *> ownedComments);
    void ownedElementsChanged(QSet<QObject *> ownedElements);
    void ownerChanged(QObject *owner);

    // Signals for owned attributes [NamedElement]
    void clientDependenciesChanged(QSet<QObject *> clientDependencies);
    void nameChanged(QString name);
    void nameExpressionChanged(QObject *nameExpression);
    void namespaceChanged(QObject *namespace_);
    void qualifiedNameChanged(QString qualifiedName);

    // Signals for owned attributes [Namespace]
    void elementImportsChanged(QSet<QObject *> elementImports);
    void importedMembersChanged(QSet<QObject *> importedMembers);
    void membersChanged(QSet<QObject *> members);
    void ownedMembersChanged(QSet<QObject *> ownedMembers);
    void ownedRulesChanged(QSet<QObject *> ownedRules);
    void packageImportsChanged(QSet<QObject *> packageImports);

    // Signals for owned attributes [ParameterableElement]
    void owningTemplateParameterChanged(QObject *owningTemplateParameter);
    void templateParameterChanged(QObject *templateParameter);

    // Signals for owned attributes [PackageableElement]
    void visibilityChanged(QtUml::VisibilityKind visibility);

    // Signals for owned attributes [TemplateableElement]
    void ownedTemplateSignatureChanged(QObject *ownedTemplateSignature);
    void templateBindingsChanged(QSet<QObject *> templateBindings);

    // Signals for owned attributes [Package]
    void URIChanged(QString URI);
    void nestedPackagesChanged(QSet<QObject *> nestedPackages);
    void nestingPackageChanged(QObject *nestingPackage);
    void ownedStereotypesChanged(QSet<QObject *> ownedStereotypes);
    void ownedTypesChanged(QSet<QObject *> ownedTypes);
    void packageMergesChanged(QSet<QObject *> packageMerges);
    void packagedElementsChanged(QSet<QObject *> packagedElements);
    void profileApplicationsChanged(QSet<QObject *> profileApplications);

protected:
    virtual void setGroupProperties();
    virtual void setPropertyData();
};

QT_END_NAMESPACE

#endif // QUMLPACKAGEOBJECT_H