umbrello/umbrello
#include <foreignkeyconstraint.h>
Public Types | |
enum | UpdateDeleteAction { uda_NoAction = 0, uda_Restrict, uda_Cascade, uda_SetNull, uda_SetDefault } |
Public Types inherited from UMLObject | |
enum | ObjectType { ot_UMLObject = 100, ot_Actor, ot_UseCase, ot_Package, ot_Interface, ot_Datatype, ot_Enum, ot_Class, 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 } |
Signals | |
void | sigReferencedEntityChanged () |
Signals inherited from UMLObject | |
void | modified () |
Public Member Functions | |
UMLForeignKeyConstraint (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None) | |
UMLForeignKeyConstraint (UMLObject *parent) | |
virtual | ~UMLForeignKeyConstraint () |
bool | addEntityAttributePair (UMLEntityAttribute *pAttr, UMLEntityAttribute *rAttr) |
void | clearMappings () |
virtual UMLObject * | clone () const |
virtual void | copyInto (UMLObject *lhs) const |
UpdateDeleteAction | getDeleteAction () const |
QMap< UMLEntityAttribute *, UMLEntityAttribute * > | getEntityAttributePairs () |
UMLEntity * | getReferencedEntity () const |
UpdateDeleteAction | getUpdateAction () const |
bool | hasEntityAttributePair (UMLEntityAttribute *pAttr, UMLEntityAttribute *rAttr) const |
bool | operator== (const UMLForeignKeyConstraint &rhs) const |
bool | removeEntityAttributePair (UMLEntityAttribute *pAttr) |
bool | resolveRef () |
void | saveToXMI (QDomDocument &qDoc, QDomElement &qElement) |
void | setDeleteAction (UpdateDeleteAction uda) |
void | setReferencedEntity (UMLEntity *ent) |
void | setUpdateAction (UpdateDeleteAction uda) |
virtual bool | showPropertiesDialog (QWidget *parent) |
QString | toString (Uml::SignatureType::Enum sig=Uml::SignatureType::NoSig) |
Public Member Functions inherited from UMLEntityConstraint | |
UMLEntityConstraint (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None) | |
UMLEntityConstraint (UMLObject *parent) | |
virtual | ~UMLEntityConstraint () |
bool | operator== (const UMLEntityConstraint &rhs) const |
Public Member Functions inherited from UMLClassifierListItem | |
UMLClassifierListItem (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None) | |
UMLClassifierListItem (UMLObject *parent) | |
virtual | ~UMLClassifierListItem () |
UMLClassifier * | getType () const |
virtual QString | getTypeName () const |
virtual void | setType (UMLObject *type) |
void | setTypeName (const QString &type) |
Public Member Functions inherited from UMLObject | |
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 () |
virtual bool | acceptAssociationType (Uml::AssociationType::Enum) |
ObjectType | baseType () const |
QLatin1String | baseTypeStr () const |
QString | doc () const |
virtual QString | fullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const |
bool | hasDoc () const |
virtual Uml::ID::Type | id () const |
bool | isAbstract () const |
bool | isStatic () const |
virtual bool | loadFromXMI (QDomElement &element) |
bool | loadStereotype (QDomElement &element) |
QString | name () const |
bool | operator== (const UMLObject &rhs) const |
QString | package (const QString &separator=QString(), bool includeRoot=false) |
UMLPackageList | packages (bool includeRoot=false) const |
QDomElement | save (const QString &tag, QDomDocument &qDoc) |
QString | secondaryFallback () const |
QString | secondaryId () const |
void | setAbstract (bool bAbstract) |
virtual void | setBaseType (ObjectType ot) |
void | setDoc (const QString &d) |
virtual void | setID (Uml::ID::Type NewID) |
void | setInPaste (bool bInPaste=true) |
virtual void | setName (const QString &strName) |
void | setNameCmd (const QString &strName) |
void | setPackage (const QString &_name) |
void | setSecondaryFallback (const QString &id) |
void | setSecondaryId (const QString &id) |
void | setStatic (bool bStatic) |
void | setStereotype (const QString &_name) |
void | setStereotypeCmd (const QString &_name) |
bool | setUMLPackage (UMLPackage *pPkg) |
void | setUMLStereotype (UMLStereotype *stereo) |
void | setVisibility (Uml::Visibility::Enum visibility) |
void | setVisibilityCmd (Uml::Visibility::Enum visibility) |
virtual bool | showPropertiesPagedDialog (int page=0, bool assoc=false) |
QString | stereotype (bool includeAdornments=false) const |
UMLPackage * | umlPackage () |
const UMLStereotype * | umlStereotype () |
Uml::Visibility::Enum | visibility () const |
Protected Member Functions | |
bool | load (QDomElement &element) |
Protected Member Functions inherited from UMLObject | |
void | init () |
void | maybeSignalObjectCreated () |
Additional Inherited Members | |
Public Slots inherited from UMLObject | |
void | emitModified () |
Static Public Member Functions inherited from UMLObject | |
static QString | toString (ObjectType ot) |
Protected Attributes inherited from UMLObject | |
bool | m_bAbstract |
ObjectType | m_BaseType |
bool | m_bCreationWasSignalled |
bool | m_bInPaste |
bool | m_bStatic |
QString | m_Doc |
QString | m_name |
Uml::ID::Type | m_nId |
UMLObject * | m_pSecondary |
UMLStereotype * | m_pStereotype |
UMLPackage * | m_pUMLPackage |
QString | m_SecondaryFallback |
QString | m_SecondaryId |
Uml::Visibility::Enum | m_visibility |
Detailed Description
This class is used to set up information for a foreign key entity constraint.
Sets up Foreign Key entity constraint information.
- See also
- UMLObject UMLClassifierListItem UMLEntityConstraint Bugs and comments to umbre or llo- devel @kde .orghttp://bugs.kde.org
Definition at line 32 of file foreignkeyconstraint.h.
Member Enumeration Documentation
Update/Delete Action: Action to be taken on Update or Delete of a referenced attribute is either, No Action, Restrict, Cascade, Set NULL, Set Default.
Enumerator | |
---|---|
uda_NoAction | |
uda_Restrict | |
uda_Cascade | |
uda_SetNull | |
uda_SetDefault |
Definition at line 42 of file foreignkeyconstraint.h.
Constructor & Destructor Documentation
UMLForeignKeyConstraint::UMLForeignKeyConstraint | ( | UMLObject * | parent, |
const QString & | name, | ||
Uml::ID::Type | id = Uml::ID::None |
||
) |
Sets up a constraint.
- Parameters
-
parent The parent of this UMLForeignKeyConstraint. name The name of this UMLForeignKeyConstraint. id The unique id given to this UMLForeignKeyConstraint.
Definition at line 30 of file foreignkeyconstraint.cpp.
|
explicit |
Sets up a constraint.
- Parameters
-
parent The parent of this UMLForeignKeyConstraint.
Definition at line 41 of file foreignkeyconstraint.cpp.
|
virtual |
Destructor.
Definition at line 83 of file foreignkeyconstraint.cpp.
Member Function Documentation
bool UMLForeignKeyConstraint::addEntityAttributePair | ( | UMLEntityAttribute * | pAttr, |
UMLEntityAttribute * | rAttr | ||
) |
Adds the attribute pair to the attributeMap.
- Parameters
-
pAttr The Attribute of the Parent Entity rAttr The Attribute of the Referenced Entity
- Returns
- true if the attribute pair could be added successfully
Definition at line 184 of file foreignkeyconstraint.cpp.
void UMLForeignKeyConstraint::clearMappings | ( | ) |
Clears all mappings between local and referenced attributes.
Definition at line 366 of file foreignkeyconstraint.cpp.
|
virtual |
Make a clone of the UMLForeignKeyConstraint.
Implements UMLEntityConstraint.
Definition at line 108 of file foreignkeyconstraint.cpp.
|
virtual |
Copy the internal presentation of this object into the UMLForeignKeyConstraint object.
Reimplemented from UMLEntityConstraint.
Definition at line 91 of file foreignkeyconstraint.cpp.
UMLForeignKeyConstraint::UpdateDeleteAction UMLForeignKeyConstraint::getDeleteAction | ( | ) | const |
Get the Delete Action.
Definition at line 416 of file foreignkeyconstraint.cpp.
QMap< UMLEntityAttribute *, UMLEntityAttribute * > UMLForeignKeyConstraint::getEntityAttributePairs | ( | ) |
Retrieve all Pairs of Attributes.
Definition at line 408 of file foreignkeyconstraint.cpp.
UMLEntity * UMLForeignKeyConstraint::getReferencedEntity | ( | ) | const |
Get the Referenced Entity.
- Returns
- the UML entity object
Definition at line 349 of file foreignkeyconstraint.cpp.
UMLForeignKeyConstraint::UpdateDeleteAction UMLForeignKeyConstraint::getUpdateAction | ( | ) | const |
Get the Update Action.
Definition at line 424 of file foreignkeyconstraint.cpp.
bool UMLForeignKeyConstraint::hasEntityAttributePair | ( | UMLEntityAttribute * | pAttr, |
UMLEntityAttribute * | rAttr | ||
) | const |
Check if a attribute pair already exists.
- Parameters
-
pAttr The Attribute of the Parent Entity rAttr The Attribute of the Referenced Entity
- Returns
- true if the attribute pair could be found.
Definition at line 256 of file foreignkeyconstraint.cpp.
|
protectedvirtual |
Loads the <UML:ForeignKeyConstraint> XMI element.
Reimplemented from UMLObject.
Definition at line 270 of file foreignkeyconstraint.cpp.
bool UMLForeignKeyConstraint::operator== | ( | const UMLForeignKeyConstraint & | rhs | ) | const |
Overloaded '==' operator.
Definition at line 69 of file foreignkeyconstraint.cpp.
bool UMLForeignKeyConstraint::removeEntityAttributePair | ( | UMLEntityAttribute * | pAttr | ) |
Removes an Attribute pair.
- Parameters
-
pAttr The Attribute of the Parent Entity in the map. This attribute is the key of the map.
- Returns
- true of the attribute pair could be removed successfully
Definition at line 243 of file foreignkeyconstraint.cpp.
|
virtual |
Remimplementation from base classes Used to resolve forward references to referenced entities in xmi.
Reimplemented from UMLObject.
Definition at line 375 of file foreignkeyconstraint.cpp.
|
virtual |
Creates the <UML:ForeignKeyConstraint> XMI element.
Implements UMLObject.
Definition at line 146 of file foreignkeyconstraint.cpp.
void UMLForeignKeyConstraint::setDeleteAction | ( | UpdateDeleteAction | uda | ) |
Set the Delete Action to the specified UpdateDeleteAction.
Definition at line 432 of file foreignkeyconstraint.cpp.
void UMLForeignKeyConstraint::setReferencedEntity | ( | UMLEntity * | ent | ) |
Set the Referenced Entity.
- Parameters
-
ent The Entity to Reference
Definition at line 335 of file foreignkeyconstraint.cpp.
void UMLForeignKeyConstraint::setUpdateAction | ( | UpdateDeleteAction | uda | ) |
Set the Update Action to the specified UpdateDeleteAction.
Definition at line 440 of file foreignkeyconstraint.cpp.
|
virtual |
Display the properties configuration dialog for the attribute.
Implements UMLClassifierListItem.
Definition at line 172 of file foreignkeyconstraint.cpp.
|
signal |
|
virtual |
Returns a string representation of the UMLForeignKeyConstraint.
- Parameters
-
sig If true will show the attribute type and initial value.
- Returns
- Returns a string representation of the UMLAttribute.
Reimplemented from UMLClassifierListItem.
Definition at line 121 of file foreignkeyconstraint.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.