umlentity.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2003-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef ENTITY_H
#define ENTITY_H
 
#include "umlclassifier.h"
 
// forward declarations
class UMLEntityAttribute;
class UMLEntityConstraint;
class UMLUniqueConstraint;
class UMLForeignKeyConstraint;
class UMLCheckConstraint;
class UMLEntityAttributeList;

class UMLEntity : public UMLClassifier
{
    Q_OBJECT
public:
    explicit UMLEntity(const QString& name = QString(), Uml::ID::Type id = Uml::ID::None);
    virtual ~UMLEntity();
 
    bool operator==(const UMLEntity& rhs) const;
 
    virtual void copyInto(UMLObject *lhs) const;
 
    virtual UMLObject* clone() const;
 
    virtual UMLAttribute* createAttribute(const QString &name = QString(),
                                  UMLObject  *type = nullptr, Uml::Visibility::Enum vis = Uml::Visibility::Private,
                                  const QString &init = QString());
 
    UMLUniqueConstraint* createUniqueConstraint(const QString &name = QString());
    UMLForeignKeyConstraint* createForeignKeyConstraint(const QString &name = QString());
    UMLCheckConstraint* createCheckConstraint(const QString &name = QString());
 
    UMLObject* addEntityAttribute(const QString &name, Uml::ID::Type id = Uml::ID::None);
    bool addEntityAttribute(UMLEntityAttribute *att, IDChangeLog *log = nullptr);
    bool addEntityAttribute(UMLEntityAttribute* att, int position);
 
    int removeEntityAttribute(UMLClassifierListItem* att);
 
    void signalEntityAttributeRemoved(UMLClassifierListItem *eattr);
 
    int entityAttributes() const;
 
    bool setAsPrimaryKey(UMLUniqueConstraint* uconstr);
    void unsetPrimaryKey();
    bool hasPrimaryKey() const;
    bool isPrimaryKey(const UMLUniqueConstraint* uConstr) const;
 
    bool addConstraint(UMLEntityConstraint* constr);
    bool removeConstraint(UMLEntityConstraint* constr);
 
    virtual bool resolveRef();
 
    virtual void saveToXMI(QXmlStreamWriter& writer);
 
    UMLClassifierListItemList getFilteredList(UMLObject::ObjectType ot) const;
 
    UMLEntityAttributeList getEntityAttributes() const;
 
    virtual UMLClassifierListItem* makeChildObject(const QString& xmiTag);
 
private Q_SLOTS:
    void slotEntityAttributeRemoved(UMLClassifierListItem*);
 
Q_SIGNALS:
    void entityAttributeAdded(UMLClassifierListItem*);
    void entityAttributeRemoved(UMLClassifierListItem*);
    void entityConstraintAdded(UMLClassifierListItem*);
    void entityConstraintRemoved(UMLClassifierListItem*);
 
protected:
    bool load1(QDomElement& element);
 
private:

    UMLUniqueConstraint* m_PrimaryKey;
 
};
 
#endif // ENTITY_H