diff options
Diffstat (limited to 'umbrello/umbrello/entity.h')
| -rw-r--r-- | umbrello/umbrello/entity.h | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/umbrello/umbrello/entity.h b/umbrello/umbrello/entity.h new file mode 100644 index 00000000..7a4a2ce9 --- /dev/null +++ b/umbrello/umbrello/entity.h @@ -0,0 +1,155 @@ +/*************************************************************************** + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * copyright (C) 2003-2007 * + * Umbrello UML Modeller Authors <uml-devel@uml.sf.net> * + ***************************************************************************/ + +#ifndef ENTITY_H +#define ENTITY_H + +#include "classifier.h" + +class UMLEntityAttribute; + +/** + * This class contains the non-graphical information required for a UML + * Entity. + * This class inherits from @ref UMLClassifier which contains most of the + * information. + * + * @short Non-graphical Information for an Entity. + * @author Jonathan Riddell + * Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org + */ +class UMLEntity : public UMLClassifier { + Q_OBJECT +public: + /** + * Sets up an entity. + * + * @param name The name of the Entity. + * @param id The unique id of the Entity. + */ + explicit UMLEntity(const QString& name = "", Uml::IDType id = Uml::id_None); + + /** + * Standard deconstructor. + */ + virtual ~UMLEntity(); + + /** + * Overloaded '==' operator. + */ + bool operator==(UMLEntity& rhs); + + /** + * Copy the internal presentation of this object into the new + * object. + */ + virtual void copyInto(UMLEntity* rhs) const; + + /** + * Make a clone of this object. + */ + virtual UMLObject* clone() const; + + /** + * Creates an entity attribute for the parent concept. + * Reimplementation of method from UMLClassifier. + * + * @param name An optional name, used by when creating through UMLListView + * @param type An optional type, used by when creating through UMLListView + * @return The UMLEntityAttribute created + */ + UMLAttribute* createAttribute(const QString &name = QString::null, + UMLObject *type = 0); + + /** + * Adds an entityAttribute to the entity. + * + * @param name The name of the entityAttribute. + * @param id The id of the entityAttribute (optional.) + * If omitted a new ID is assigned internally. + * @return Pointer to the UMLEntityAttribute created. + */ + UMLObject* addEntityAttribute(const QString &name, Uml::IDType id = Uml::id_None); + + /** + * Adds an already created entityAttribute. + * The entityAttribute object must not belong to any other concept. + * + * @param att Pointer to the UMLEntityAttribute. + * @param Log Pointer to the IDChangeLog. + * @return True if the entityAttribute was successfully added. + */ + bool addEntityAttribute(UMLEntityAttribute* att, IDChangeLog* Log = 0); + + /** + * Adds an entityAttribute to the entity, at the given position. + * If position is negative or too large, the entityAttribute is added + * to the end of the list. + * + * @param att Pointer to the UMLEntityAttribute. + * @param position Position index for the insertion. + * @return True if the entityAttribute was successfully added. + */ + //TODO: give default value -1 to position (append) - now it conflicts with the method above.. + bool addEntityAttribute(UMLEntityAttribute* att, int position ); + + /** + * Removes an entityAttribute from the class. + * + * @param a The entityAttribute to remove. + * @return Count of the remaining entityAttributes after removal. + * Returns -1 if the given entityAttribute was not found. + */ + int removeEntityAttribute(UMLClassifierListItem* a); + + /** + * Emit the entityAttributeRemoved signal. + */ + void signalEntityAttributeRemoved(UMLClassifierListItem *eattr); + + /** + * Returns the number of entityAttributes for the class. + * + * @return The number of entityAttributes for the class. + */ + int entityAttributes() ; + + /** + * Resolve the types referenced by our UMLEntityAttributes. + * Reimplements the method from UMLClassifier. + */ + virtual bool resolveRef(); + + /** + * Creates the <UML:Entity> element including its entityliterals. + */ + virtual void saveToXMI(QDomDocument& qDoc, QDomElement& qElement); + +signals: + void entityAttributeAdded(UMLClassifierListItem*); + void entityAttributeRemoved(UMLClassifierListItem*); + +protected: + /** + * Loads the <UML:Entity> element including its entityAttributes. + */ + bool load(QDomElement& element); + +private: + /** + * Initializes key variables of the class. + */ + void init(); + +}; + +#endif // ENTITY_H + |