umbrello/umbrello

UMLUniqueConstraint Class Reference

#include <uniqueconstraint.h>

Inheritance diagram for UMLUniqueConstraint:

[legend]

List of all members.

Detailed Description

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

Sets up Unique entity constraint information.

Author:: Sharan Rao

See also:: UMLObject UMLClassifierListItem UMLEntityConstraint Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org

Definition at line 28 of file uniqueconstraint.h.


Public Member Functions
	UMLUniqueConstraint (UMLObject *parent, const QString &name, Uml::IDType id=Uml::id_None)
	UMLUniqueConstraint (UMLObject *parent)
bool	operator== (const UMLUniqueConstraint &rhs)
virtual	~UMLUniqueConstraint ()
virtual void	copyInto (UMLObject *lhs) const
virtual UMLObject *	clone () const
QString	toString (Uml::Signature_Type sig=Uml::st_NoSig)
QString	getFullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const
void	saveToXMI (QDomDocument &qDoc, QDomElement &qElement)
virtual bool	showPropertiesDialog (QWidget *parent)
bool	hasEntityAttribute (UMLEntityAttribute *attr)
bool	addEntityAttribute (UMLEntityAttribute *attr)
bool	removeEntityAttribute (UMLEntityAttribute *attr)
UMLEntityAttributeList	getEntityAttributeList () const
void	clearAttributeList ()
Protected Member Functions
bool	load (QDomElement &element)

Constructor & Destructor Documentation

UMLUniqueConstraint::UMLUniqueConstraint	(	UMLObject *	parent,
		const QString &	name,
		Uml::IDType	id = `Uml::id_None`
	)

Sets up a constraint.

Parameters:

	parent	The parent of this UMLUniqueConstraint.
	name	The name of this UMLUniqueConstraint.
	id	The unique id given to this UMLUniqueConstraint.

Definition at line 26 of file uniqueconstraint.cpp.

UMLUniqueConstraint::UMLUniqueConstraint ( UMLObject * parent )

Sets up a constraint.

Parameters:

parent

The parent of this UMLUniqueConstraint.

Definition at line 32 of file uniqueconstraint.cpp.

UMLUniqueConstraint::~UMLUniqueConstraint ( ) [virtual]

destructor.

Definition at line 47 of file uniqueconstraint.cpp.

Member Function Documentation

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

Overloaded '==' operator.

Definition at line 37 of file uniqueconstraint.cpp.

void UMLUniqueConstraint::copyInto ( UMLObject * lhs ) const [virtual]

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

Reimplemented from UMLEntityConstraint.

Definition at line 49 of file uniqueconstraint.cpp.

UMLObject * UMLUniqueConstraint::clone ( ) const [virtual]

Make a clone of the UMLUniqueConstraint.

Implements UMLEntityConstraint.

Definition at line 70 of file uniqueconstraint.cpp.

QString UMLUniqueConstraint::toString ( Uml::Signature_Type sig = Uml::st_NoSig ) [virtual]

Returns a string representation of the UMLUniqueConstraint.

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 77 of file uniqueconstraint.cpp.

QString UMLUniqueConstraint::getFullyQualifiedName	(	const QString &	separator = `QString()`,
		bool	includeRoot = `false`
	)			const `[virtual]`

Returns the fully qualified name, i.e.

all package prefixes and then m_Name.

Parameters:

	separator	The separator string to use (optional.) If not given then the separator is chosen according to the currently selected active programming language of import and code generation.
	includeRoot	Whether to prefix the root folder name to the FQN. See UMLDoc::getRootFolder(). Default: false.

Returns:: The fully qualified name of this UMLObject.

Reimplemented from UMLObject.

Definition at line 103 of file uniqueconstraint.cpp.

void UMLUniqueConstraint::saveToXMI	(	QDomDocument &	qDoc,
		QDomElement &	qElement
	)			`[virtual]`

Creates the <UML:UniqueConstraint> XMI element.

Implements UMLObject.

Definition at line 109 of file uniqueconstraint.cpp.

bool UMLUniqueConstraint::showPropertiesDialog ( QWidget * parent ) [virtual]

Display the properties configuration dialog for the attribute.

Implements UMLClassifierListItem.

Definition at line 126 of file uniqueconstraint.cpp.

bool UMLUniqueConstraint::hasEntityAttribute ( UMLEntityAttribute * attr )

Check if a entity attribute is present in m_entityAttributeList.

Parameters:

attr

The Entity Attribute to check for existence in list

Returns:: true if it exists in the list, else false

Definition at line 170 of file uniqueconstraint.cpp.

bool UMLUniqueConstraint::addEntityAttribute ( UMLEntityAttribute * attr )

Adds a UMLEntityAttribute to the list.

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

Parameters:

attr

The UMLEntityAttribute to add

Returns:: false if it failed to add , else true

Definition at line 182 of file uniqueconstraint.cpp.

bool UMLUniqueConstraint::removeEntityAttribute ( UMLEntityAttribute * attr )

Removes a UMLEntityAttribute from the list.

Parameters:

attr

The UMLEntityAttribute to remove from list

Returns:: false if it failed to remove the attribute from the list

Definition at line 212 of file uniqueconstraint.cpp.

UMLEntityAttributeList UMLUniqueConstraint::getEntityAttributeList ( ) const [inline]

Get the Entity Attributes List.

Definition at line 120 of file uniqueconstraint.h.

void UMLUniqueConstraint::clearAttributeList ( )

Clear the list of attributes contained in this UniqueConstraint.

Definition at line 250 of file uniqueconstraint.cpp.

bool UMLUniqueConstraint::load ( QDomElement & element ) [protected, virtual]

Loads the <UML:UniqueConstraint> XMI element.

Reimplemented from UMLObject.

Definition at line 131 of file uniqueconstraint.cpp.

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

umbrello/umbrello

UMLUniqueConstraint Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

umbrello/umbrello

kdesdk