umbrello  2.32.1
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
Signals | Public Member Functions | Protected Member Functions | Private Slots | Private Attributes | List of all members
UMLEntity Class Reference

Non-graphical Information for an Entity. More...

#include <entity.h>

Inheritance diagram for UMLEntity:
UMLClassifier UMLPackage UMLCanvasObject UMLObject

Signals

void entityAttributeAdded (UMLClassifierListItem *)
 
void entityAttributeRemoved (UMLClassifierListItem *)
 
void entityConstraintAdded (UMLClassifierListItem *)
 
void entityConstraintRemoved (UMLClassifierListItem *)
 
- Signals inherited from UMLClassifier
void operationAdded (UMLClassifierListItem *)
 
void operationRemoved (UMLClassifierListItem *)
 
void templateAdded (UMLClassifierListItem *)
 
void templateRemoved (UMLClassifierListItem *)
 
void attributeAdded (UMLClassifierListItem *)
 
void attributeRemoved (UMLClassifierListItem *)
 
- Signals inherited from UMLCanvasObject
void sigAssociationEndAdded (UMLAssociation *assoc)
 
void sigAssociationEndRemoved (UMLAssociation *assoc)
 
- Signals inherited from UMLObject
void modified ()
 

Public Member Functions

 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 UMLObjectclone () const
 
virtual UMLAttributecreateAttribute (const QString &name=QString(), UMLObject *type=0, Uml::Visibility::Enum vis=Uml::Visibility::Private, const QString &init=QString())
 
UMLUniqueConstraintcreateUniqueConstraint (const QString &name=QString())
 
UMLForeignKeyConstraintcreateForeignKeyConstraint (const QString &name=QString())
 
UMLCheckConstraintcreateCheckConstraint (const QString &name=QString())
 
UMLObjectaddEntityAttribute (const QString &name, Uml::ID::Type id=Uml::ID::None)
 
bool addEntityAttribute (UMLEntityAttribute *att, IDChangeLog *log=0)
 
bool addEntityAttribute (UMLEntityAttribute *att, int position)
 
int removeEntityAttribute (UMLClassifierListItem *att)
 
void signalEntityAttributeRemoved (UMLClassifierListItem *eattr)
 
int entityAttributes ()
 
bool setAsPrimaryKey (UMLUniqueConstraint *uconstr)
 
void unsetPrimaryKey ()
 
bool hasPrimaryKey () const
 
bool isPrimaryKey (UMLUniqueConstraint *uConstr) const
 
bool addConstraint (UMLEntityConstraint *constr)
 
bool removeConstraint (UMLEntityConstraint *constr)
 
virtual bool resolveRef ()
 
virtual void saveToXMI1 (QDomDocument &qDoc, QDomElement &qElement)
 
UMLClassifierListItemList getFilteredList (UMLObject::ObjectType ot) const
 
UMLEntityAttributeList getEntityAttributes () const
 
virtual UMLClassifierListItemmakeChildObject (const QString &xmiTag)
 
- Public Member Functions inherited from UMLClassifier
 UMLClassifier (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLClassifier ()
 
virtual void setNameCmd (const QString &strName)
 
UMLAttributeaddAttribute (const QString &name, Uml::ID::Type id=Uml::ID::None)
 
UMLAttributeaddAttribute (const QString &name, UMLObject *type, Uml::Visibility::Enum scope)
 
bool addAttribute (UMLAttribute *att, IDChangeLog *log=0, int position=-1)
 
int removeAttribute (UMLAttribute *att)
 
UMLAttributeList getAttributeList () const
 
UMLAttributeList getAttributeList (Uml::Visibility::Enum scope) const
 
UMLAttributeList getAttributeListStatic (Uml::Visibility::Enum scope) const
 
UMLOperationcreateOperation (const QString &name=QString(), bool *isExistingOp=0, Model_Utils::NameAndType_List *params=0)
 
bool addOperation (UMLOperation *op, int position=-1)
 
bool addOperation (UMLOperation *op, IDChangeLog *log)
 
UMLOperationcheckOperationSignature (const QString &name, UMLAttributeList opParams, UMLOperation *exemptOp=0)
 
int removeOperation (UMLOperation *op)
 
int operations ()
 
UMLOperationList getOpList (bool includeInherited=false, UMLClassifierSet *alreadyTraversed=0)
 
UMLObjectcreateTemplate (const QString &name=QString())
 
UMLTemplateaddTemplate (const QString &name, Uml::ID::Type id=Uml::ID::None)
 
bool addTemplate (UMLTemplate *newTemplate, IDChangeLog *log=0)
 
bool addTemplate (UMLTemplate *templt, int position)
 
int removeTemplate (UMLTemplate *umltemplate)
 
UMLTemplatefindTemplate (const QString &name)
 
int templates ()
 
UMLTemplateList getTemplateList () const
 
int takeItem (UMLClassifierListItem *item)
 
UMLOperationList findOperations (const QString &n)
 
virtual UMLObjectfindChildObjectById (Uml::ID::Type id, bool considerAncestors=false)
 
UMLOperationfindOperation (const QString &name, Model_Utils::NameAndType_List params)
 
UMLClassifierList findSuperClassConcepts (ClassifierType type=ALL)
 
UMLClassifierList findSubClassConcepts (ClassifierType type=ALL)
 
virtual bool acceptAssociationType (Uml::AssociationType::Enum type)
 
void setBaseType (UMLObject::ObjectType ot)
 
bool isInterface () const
 
bool hasAbstractOps ()
 
bool hasAssociations ()
 
bool hasAttributes ()
 
bool hasStaticAttributes ()
 
bool hasMethods ()
 
bool hasAccessorMethods ()
 
bool hasOperationMethods ()
 
bool hasVectorFields ()
 
virtual UMLAssociationList getUniAssociationToBeImplemented ()
 
- Public Member Functions inherited from UMLPackage
 UMLPackage (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLPackage ()
 
bool addObject (UMLObject *pObject)
 
void removeObject (UMLObject *pObject)
 
virtual void removeAllObjects ()
 
UMLObjectListcontainedObjects ()
 
void addAssocToConcepts (UMLAssociation *assoc)
 
void removeAssocFromConcepts (UMLAssociation *assoc)
 
UMLObjectfindObject (const QString &name)
 
UMLObjectfindObjectById (Uml::ID::Type id)
 
void appendPackages (UMLPackageList &packages, bool includeNested=true)
 
void appendClassifiers (UMLClassifierList &classifiers, bool includeNested=true)
 
void appendClassesAndInterfaces (UMLClassifierList &classifiers, bool includeNested=true)
 
void appendEntities (UMLEntityList &entities, bool includeNested=true)
 
- Public Member Functions inherited from UMLCanvasObject
 UMLCanvasObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLCanvasObject ()
 
bool operator== (const UMLCanvasObject &rhs) const
 
bool addAssociationEnd (UMLAssociation *assoc)
 
bool hasAssociation (UMLAssociation *assoc)
 
int removeAssociationEnd (UMLAssociation *assoc)
 
void removeAllAssociationEnds ()
 
int associations ()
 
UMLAssociationList getAssociations ()
 
UMLAssociationList getSpecificAssocs (Uml::AssociationType::Enum assocType)
 
UMLClassifierList getSuperClasses (bool withRealizations=true)
 
UMLClassifierList getSubClasses ()
 
virtual UMLAssociationList getRealizations ()
 
UMLAssociationList getAggregations ()
 
UMLAssociationList getCompositions ()
 
UMLAssociationList getRelationships ()
 
virtual UMLObjectfindChildObject (const QString &n, UMLObject::ObjectType t=UMLObject::ot_UMLObject)
 
virtual QString uniqChildName (const UMLObject::ObjectType type, const QString &prefix=QString())
 
virtual void removeAllChildObjects ()
 
UMLObjectListsubordinates () const
 
- Public Member Functions inherited from UMLObject
 UMLObject (const UMLObject &other)
 
 UMLObject (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 
 UMLObject (UMLObject *parent)
 
 UMLObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLObject ()
 
bool operator== (const UMLObject &rhs) const
 
ObjectType baseType () const
 
QLatin1String baseTypeStr () const
 
virtual void setID (Uml::ID::Type NewID)
 
virtual Uml::ID::Type id () const
 
QString doc () const
 
bool hasDoc () const
 
void setDoc (const QString &d)
 
void setVisibility (Uml::Visibility::Enum visibility)
 
void setVisibilityCmd (Uml::Visibility::Enum visibility)
 
Uml::Visibility::Enum visibility () const
 
void setStereotype (const QString &_name)
 
void setStereotypeCmd (const QString &_name)
 
QString stereotype (bool includeAdornments=false) const
 
void setUMLStereotype (UMLStereotype *stereo)
 
UMLStereotypeumlStereotype ()
 
QString package (const QString &separator=QString(), bool includeRoot=false)
 
UMLPackageList packages (bool includeRoot=false) const
 
bool setUMLPackage (UMLPackage *pPkg)
 
UMLPackageumlPackage () const
 
void setUMLParent (UMLObject *parent)
 
UMLObjectumlParent () const
 
virtual void setName (const QString &strName)
 
QString name () const
 
virtual QString fullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const
 
void setAbstract (bool bAbstract)
 
bool isAbstract () const
 
virtual bool showPropertiesDialog (QWidget *parent=0)
 
virtual bool loadFromXMI1 (QDomElement &element)
 
bool loadStereotype (QDomElement &element)
 
void setStatic (bool bStatic)
 
bool isStatic () const
 
void setSecondaryId (const QString &id)
 
QString secondaryId () const
 
void setSecondaryFallback (const QString &id)
 
QString secondaryFallback () const
 
QDomElement save1 (const QString &tag, QDomDocument &qDoc)
 
bool isUMLActor ()
 
bool isUMLArtifact ()
 
bool isUMLAssociation ()
 
bool isUMLAttribute ()
 
bool isUMLCategory ()
 
bool isUMLCheckConstraint ()
 
bool isUMLClassifier ()
 
bool isUMLComponent ()
 
bool isUMLDatatype ()
 
bool isUMLEntity ()
 
bool isUMLEntityAttribute ()
 
bool isUMLEntityConstraint ()
 
bool isUMLEnum ()
 
bool isUMLEnumLiteral ()
 
bool isUMLFolder ()
 
bool isUMLForeignKeyConstraint ()
 
bool isUMLInstance ()
 
bool isUMLInstanceAttribute ()
 
bool isUMLNode ()
 
bool isUMLObject ()
 
bool isUMLOperation ()
 
bool isUMLPackage ()
 
bool isUMLPort ()
 
bool isUMLRole ()
 
bool isUMLStereotype ()
 
bool isUMLTemplate ()
 
bool isUMLUniqueConstraint ()
 
bool isUMLUseCase ()
 
UMLActorasUMLActor ()
 
UMLArtifactasUMLArtifact ()
 
UMLAssociationasUMLAssociation ()
 
UMLAttributeasUMLAttribute ()
 
UMLCanvasObjectasUMLCanvasObject ()
 
UMLCategoryasUMLCategory ()
 
UMLCheckConstraintasUMLCheckConstraint ()
 
UMLClassifierasUMLClassifier ()
 
UMLClassifierListItemasUMLClassifierListItem ()
 
UMLClassifierSetasUMLClassifierSet ()
 
UMLComponentasUMLComponent ()
 
UMLDatatypeasUMLDatatype ()
 
UMLEntityasUMLEntity ()
 
UMLEntityAttributeasUMLEntityAttribute ()
 
UMLEntityConstraintasUMLEntityConstraint ()
 
UMLEnumasUMLEnum ()
 
UMLEnumLiteralasUMLEnumLiteral ()
 
UMLFolderasUMLFolder ()
 
UMLForeignKeyConstraintasUMLForeignKeyConstraint ()
 
UMLInstanceasUMLInstance ()
 
UMLInstanceAttributeasUMLInstanceAttribute ()
 
UMLNodeasUMLNode ()
 
UMLObjectasUMLObject ()
 
UMLOperationasUMLOperation ()
 
UMLPackageasUMLPackage ()
 
UMLPortasUMLPort ()
 
UMLRoleasUMLRole ()
 
UMLStereotypeasUMLStereotype ()
 
UMLTemplateasUMLTemplate ()
 
UMLUniqueConstraintasUMLUniqueConstraint ()
 
UMLUseCaseasUMLUseCase ()
 

Protected Member Functions

bool load1 (QDomElement &element)
 
- Protected Member Functions inherited from UMLObject
void init ()
 
void maybeSignalObjectCreated ()
 

Private Slots

void slotEntityAttributeRemoved (UMLClassifierListItem *)
 

Private Attributes

UMLUniqueConstraintm_PrimaryKey
 

Additional Inherited Members

- Public Types inherited from UMLClassifier
enum  ClassifierType { ALL = 0, CLASS, INTERFACE, DATATYPE }
 
- Public Types inherited from UMLObject
enum  ObjectType {
  ot_Unknown = -1, ot_UMLObject = 100, ot_Actor, ot_UseCase,
  ot_Package, ot_Interface, ot_Datatype, ot_Enum,
  ot_Class, ot_Instance, ot_Association, ot_Attribute,
  ot_Operation, ot_EnumLiteral, ot_Template, ot_Component,
  ot_Artifact, ot_Node, ot_Stereotype, ot_Role,
  ot_Entity, ot_EntityAttribute, ot_Folder, ot_EntityConstraint,
  ot_UniqueConstraint, ot_ForeignKeyConstraint, ot_CheckConstraint, ot_Category,
  ot_Port, ot_InstanceAttribute, ot_SubSystem
}
 
- Public Slots inherited from UMLObject
void emitModified ()
 
- Static Public Member Functions inherited from UMLObject
static QString toString (ObjectType ot)
 
static QString toI18nString (ObjectType t)
 
static Icon_Utils::IconType toIcon (ObjectType t)
 
- Protected Attributes inherited from UMLPackage
UMLObjectList m_objects
 
- Protected Attributes inherited from UMLObject
Uml::ID::Type m_nId
 object's id More...
 
QString m_Doc
 object's documentation More...
 
QPointer< UMLStereotypem_pStereotype
 stereotype of the object if applicable More...
 
QString m_name
 objects name More...
 
ObjectType m_BaseType
 objects type More...
 
Uml::Visibility::Enum m_visibility
 objects visibility More...
 
bool m_bAbstract
 state of whether the object is abstract or not More...
 
bool m_bStatic
 flag for instance scope More...
 
bool m_bInPaste
 caller sets this true when in paste operation More...
 
bool m_bCreationWasSignalled
 auxiliary to maybeSignalObjectCreated() More...
 
QPointer< UMLObjectm_pSecondary
 
QString m_SecondaryId
 
QString m_SecondaryFallback
 
UMLObjectPrivatem_d
 private data More...
 

Detailed Description

Non-graphical Information for an Entity.

This class contains the non-graphical information required for a UML Entity. This class inherits from UMLClassifier which contains most of the information.

Author
Jonathan Riddell Bugs and comments to umbre.nosp@m.llo-.nosp@m.devel.nosp@m.@kde.nosp@m..org or https://bugs.kde.org

Constructor & Destructor Documentation

◆ UMLEntity()

UMLEntity::UMLEntity ( const QString &  name = QString(),
Uml::ID::Type  id = Uml::ID::None 
)
explicit

Constructor.

◆ ~UMLEntity()

UMLEntity::~UMLEntity ( )
virtual

Standard destructor.

Member Function Documentation

◆ addConstraint()

bool UMLEntity::addConstraint ( UMLEntityConstraint constr)

Adds a Constraint to this UMLEntity. To set a UMLUniqueConstraint as Primary Key use setAsPrimaryKey.

Parameters
constrThe UMLEntityConstraint that is to be added
Returns
true if the constraint could be added successfully

◆ addEntityAttribute() [1/3]

UMLObject * UMLEntity::addEntityAttribute ( const QString &  name,
Uml::ID::Type  id = Uml::ID::None 
)

Adds an entityAttribute. The entityAttribute object must not belong to any other concept.

Parameters
namename of the UMLEntityAttribute
idid of the UMLEntityAttribute
Returns
True if the entityAttribute was successfully added.

◆ addEntityAttribute() [2/3]

bool UMLEntity::addEntityAttribute ( UMLEntityAttribute att,
IDChangeLog log = 0 
)

Adds an already created entityAttribute. The entityAttribute object must not belong to any other concept.

Parameters
attPointer to the UMLEntityAttribute.
logPointer to the IDChangeLog.
Returns
True if the entityAttribute was successfully added.

◆ addEntityAttribute() [3/3]

bool UMLEntity::addEntityAttribute ( UMLEntityAttribute att,
int  position 
)

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. TODO: give default value -1 to position (append) - now it conflicts with the method above..

Parameters
attPointer to the UMLEntityAttribute.
positionPosition index for the insertion.
Returns
True if the entityAttribute was successfully added.

◆ clone()

UMLObject * UMLEntity::clone ( ) const
virtual

Make a clone of this object.

Reimplemented from UMLClassifier.

◆ copyInto()

void UMLEntity::copyInto ( UMLObject lhs) const
virtual

Copy the internal presentation of this object into the new object.

Reimplemented from UMLClassifier.

◆ createAttribute()

UMLAttribute * UMLEntity::createAttribute ( const QString &  name = QString(),
UMLObject type = 0,
Uml::Visibility::Enum  vis = Uml::Visibility::Private,
const QString &  iv = QString() 
)
virtual

Create an UMLAttribute.

Parameters
namean optional name for the attribute
typean optional type object for the attribute
visthe visibility of the attribute
ivthe initial value for the attribute
Returns
the just created attribute or null

Reimplemented from UMLClassifier.

◆ createCheckConstraint()

UMLCheckConstraint * UMLEntity::createCheckConstraint ( const QString &  name = QString())

Creates a Check Constraint for this Entity.

Parameters
namean optional name
Returns
the CheckConstraint created

◆ createForeignKeyConstraint()

UMLForeignKeyConstraint * UMLEntity::createForeignKeyConstraint ( const QString &  name = QString())

Creates a Foreign Key Constraint for this Entity.

Parameters
namean optional name
Returns
the ForeignKeyConstraint created

◆ createUniqueConstraint()

UMLUniqueConstraint * UMLEntity::createUniqueConstraint ( const QString &  name = QString())

Creates a Unique Constraint for this Entity.

Parameters
namean optional name
Returns
the UniqueConstraint created
Todo:
check parameter

◆ entityAttributeAdded

void UMLEntity::entityAttributeAdded ( UMLClassifierListItem )
signal

◆ entityAttributeRemoved

void UMLEntity::entityAttributeRemoved ( UMLClassifierListItem )
signal

◆ entityAttributes()

int UMLEntity::entityAttributes ( )

Returns the number of entityAttributes for the class.

Returns
The number of entityAttributes for the class.

◆ entityConstraintAdded

void UMLEntity::entityConstraintAdded ( UMLClassifierListItem )
signal

◆ entityConstraintRemoved

void UMLEntity::entityConstraintRemoved ( UMLClassifierListItem )
signal

◆ getEntityAttributes()

UMLEntityAttributeList UMLEntity::getEntityAttributes ( ) const

Returns the Entity Attributes. Same as getFilteredList(UMLObject::ot_EntityAttribute).

◆ getFilteredList()

UMLClassifierListItemList UMLEntity::getFilteredList ( UMLObject::ObjectType  ot) const
virtual

Reimplementation of getFilteredList to support ot=UMLObject::ot_EntityConstraint.

Reimplemented from UMLClassifier.

◆ hasPrimaryKey()

bool UMLEntity::hasPrimaryKey ( ) const

Checks if This UMLEntity has a primary key set.

Returns
true if a Primary Key Exists for this UMLEntity

◆ isPrimaryKey()

bool UMLEntity::isPrimaryKey ( UMLUniqueConstraint uConstr) const

Checks if a given Unique Constraint is primary key of this entity

Parameters
uConstra Unique Constraint
Returns
bool true if passed parameter is a primary key of this entity

◆ load1()

bool UMLEntity::load1 ( QDomElement &  element)
protectedvirtual

Loads the <UML:Entity> element including its entityAttributes.

Reimplemented from UMLClassifier.

◆ makeChildObject()

UMLClassifierListItem * UMLEntity::makeChildObject ( const QString &  xmiTag)
virtual

Create a new ClassifierListObject (entityattribute) according to the given XMI tag. Returns NULL if the string given does not contain one of the tags <UML:EntityAttribute> Used by the clipboard for paste operation. Reimplemented from UMLClassifier for UMLEntity

Reimplemented from UMLClassifier.

◆ operator==()

bool UMLEntity::operator== ( const UMLEntity rhs) const

Overloaded '==' operator.

◆ removeConstraint()

bool UMLEntity::removeConstraint ( UMLEntityConstraint constr)

Removes an existing constraint from this UMLEntity. If the Constraint is a Primary Key, this Entity will no longer have a PrimaryKey.

Parameters
constrthe constraint to be removed
Returns
true if the constraint could be removed successfully

◆ removeEntityAttribute()

int UMLEntity::removeEntityAttribute ( UMLClassifierListItem att)

Removes an entityAttribute from the class.

Parameters
attThe entityAttribute to remove.
Returns
Count of the remaining entityAttributes after removal. Returns -1 if the given entityAttribute was not found.

◆ resolveRef()

bool UMLEntity::resolveRef ( )
virtual

Resolve the types referenced by our UMLEntityAttributes. Reimplements the method from UMLClassifier.

Reimplemented from UMLClassifier.

◆ saveToXMI1()

void UMLEntity::saveToXMI1 ( QDomDocument &  qDoc,
QDomElement &  qElement 
)
virtual

Creates the <UML:Entity> element including its entityliterals.

Reimplemented from UMLClassifier.

◆ setAsPrimaryKey()

bool UMLEntity::setAsPrimaryKey ( UMLUniqueConstraint uconstr)

Sets the UniqueConstraint passed as the Primary Key of this Entity If the UniqueConstraint exists, then it is made a primary key Else the UniqueConstraint is added and set as PrimaryKey

Parameters
uconstrThe Unique Constraint that is to be set as Primary Key
Returns
true if Primary key could be set successfully

◆ signalEntityAttributeRemoved()

void UMLEntity::signalEntityAttributeRemoved ( UMLClassifierListItem eattr)

Emit the entityAttributeRemoved signal.

◆ slotEntityAttributeRemoved

void UMLEntity::slotEntityAttributeRemoved ( UMLClassifierListItem cli)
privateslot

Slot for entity attribute removed.

◆ unsetPrimaryKey()

void UMLEntity::unsetPrimaryKey ( )

Unset a Primary Key Constraint if it exists, else does nothing This function will make the primary key into just another UniqueConstraint if it exists

Member Data Documentation

◆ m_PrimaryKey

UMLUniqueConstraint* UMLEntity::m_PrimaryKey
private

Primary Key of this Entity This is a pointer kept for easy access to the primary key, and to distinguish it from all other UniqueConstraints. It is also there in subordinates (inherited from UMLCanvasObject)


The documentation for this class was generated from the following files: