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

Sets up Unique entity constraint information. More...

#include <uniqueconstraint.h>

Inheritance diagram for UMLUniqueConstraint:
UMLEntityConstraint UMLClassifierListItem UMLObject

Public Member Functions

 UMLUniqueConstraint (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 
 UMLUniqueConstraint (UMLObject *parent)
 
virtual ~UMLUniqueConstraint ()
 
bool operator== (const UMLUniqueConstraint &rhs) const
 
virtual void copyInto (UMLObject *lhs) const
 
virtual UMLObjectclone () const
 
QString toString (Uml::SignatureType::Enum sig=Uml::SignatureType::NoSig, bool withStereotype=false)
 
QString getFullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const
 
void saveToXMI1 (QDomDocument &qDoc, QDomElement &qElement)
 
virtual bool showPropertiesDialog (QWidget *parent=0)
 
bool hasEntityAttribute (UMLEntityAttribute *attr)
 
bool addEntityAttribute (UMLEntityAttribute *attr)
 
bool removeEntityAttribute (UMLEntityAttribute *attr)
 
UMLEntityAttributeList getEntityAttributeList () const
 
void clearAttributeList ()
 
- Public Member Functions inherited from UMLEntityConstraint
 UMLEntityConstraint (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 
 UMLEntityConstraint (UMLObject *parent)
 
bool operator== (const UMLEntityConstraint &rhs) const
 
virtual ~UMLEntityConstraint ()
 
- Public Member Functions inherited from UMLClassifierListItem
 UMLClassifierListItem (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 
 UMLClassifierListItem (UMLObject *parent)
 
virtual ~UMLClassifierListItem ()
 
virtual void setType (UMLObject *type)
 
UMLClassifiergetType () const
 
void setTypeName (const QString &type)
 
virtual QString getTypeName () 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
 
virtual void setBaseType (ObjectType ot)
 
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)
 
virtual void setNameCmd (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 resolveRef ()
 
virtual bool loadFromXMI1 (QDomElement &element)
 
bool loadStereotype (QDomElement &element)
 
void setStatic (bool bStatic)
 
bool isStatic () const
 
virtual bool acceptAssociationType (Uml::AssociationType::Enum)
 
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 Member Functions

void init ()
 

Private Attributes

UMLEntityAttributeList m_EntityAttributeList
 

Additional Inherited Members

- 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 ()
 
- Signals inherited from UMLObject
void modified ()
 
- 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 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

Sets up Unique entity constraint information.

This class is used to set up information for a unique entity constraint.

Author
Sharan Rao
See also
UMLObject UMLClassifierListItem UMLEntityConstraint 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

◆ UMLUniqueConstraint() [1/2]

UMLUniqueConstraint::UMLUniqueConstraint ( UMLObject parent,
const QString &  name,
Uml::ID::Type  id = Uml::ID::None 
)

Sets up a constraint.

Parameters
parentThe parent of this UMLUniqueConstraint.
nameThe name of this UMLUniqueConstraint.
idThe unique id given to this UMLUniqueConstraint.

◆ UMLUniqueConstraint() [2/2]

UMLUniqueConstraint::UMLUniqueConstraint ( UMLObject parent)
explicit

Sets up a constraint.

Parameters
parentThe parent of this UMLUniqueConstraint.

◆ ~UMLUniqueConstraint()

UMLUniqueConstraint::~UMLUniqueConstraint ( )
virtual

Destructor.

Member Function Documentation

◆ addEntityAttribute()

bool UMLUniqueConstraint::addEntityAttribute ( UMLEntityAttribute attr)

Adds a UMLEntityAttribute to the list. The UMLEntityAttribute should already exist and should belong to the parent UMLEntity.

Parameters
attrThe UMLEntityAttribute to add
Returns
false if it failed to add, else true

◆ clearAttributeList()

void UMLUniqueConstraint::clearAttributeList ( )

Clear the list of attributes contained in this UniqueConstraint

◆ clone()

UMLObject * UMLUniqueConstraint::clone ( ) const
virtual

Make a clone of the UMLUniqueConstraint.

Implements UMLEntityConstraint.

◆ copyInto()

void UMLUniqueConstraint::copyInto ( UMLObject lhs) const
virtual

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

Reimplemented from UMLEntityConstraint.

◆ getEntityAttributeList()

UMLEntityAttributeList UMLUniqueConstraint::getEntityAttributeList ( ) const

Get the Entity Attributes List.

◆ getFullyQualifiedName()

QString UMLUniqueConstraint::getFullyQualifiedName ( const QString &  separator = QString(),
bool  includeRoot = false 
) const

◆ hasEntityAttribute()

bool UMLUniqueConstraint::hasEntityAttribute ( UMLEntityAttribute attr)

Check if a entity attribute is present in m_entityAttributeList

Parameters
attrThe Entity Attribute to check for existence in list
Returns
true if it exists in the list, else false

◆ init()

void UMLUniqueConstraint::init ( )
private

◆ load1()

bool UMLUniqueConstraint::load1 ( QDomElement &  element)
protectedvirtual

Loads the <UML:UniqueConstraint> XMI element.

Reimplemented from UMLObject.

◆ operator==()

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

Overloaded '==' operator

◆ removeEntityAttribute()

bool UMLUniqueConstraint::removeEntityAttribute ( UMLEntityAttribute attr)

Removes a UMLEntityAttribute from the list

Parameters
attrThe UMLEntityAttribute to remove from list
Returns
false if it failed to remove the attribute from the list

◆ saveToXMI1()

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

Creates the <UML:UniqueConstraint> XMI element.

Reimplemented from UMLObject.

◆ showPropertiesDialog()

bool UMLUniqueConstraint::showPropertiesDialog ( QWidget *  parent = 0)
virtual

Display the properties configuration dialog for the attribute.

Reimplemented from UMLObject.

◆ toString()

QString UMLUniqueConstraint::toString ( Uml::SignatureType::Enum  sig = Uml::SignatureType::NoSig,
bool  withStereotype = false 
)
virtual

Returns a string representation of the UMLUniqueConstraint.

Parameters
sigIf true will show the attribute type and initial value.
Returns
Returns a string representation of the UMLAttribute.

Reimplemented from UMLClassifierListItem.

Member Data Documentation

◆ m_EntityAttributeList

UMLEntityAttributeList UMLUniqueConstraint::m_EntityAttributeList
private

The list of entity attributes that together make up the unique constraint.


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