1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/***************************************************************************
* *
* 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) 2004-2006 *
* Umbrello UML Modeller Authors <uml-devel@uml.sf.net> *
***************************************************************************/
/* This code generated by:
* Author : thomas
* Date : Thu Jun 19 2003
*/
#ifndef CLASSIFIERCODEDOCUMENT_H
#define CLASSIFIERCODEDOCUMENT_H
#include <tqmap.h>
#include <tqstring.h>
#include <tqptrlist.h>
#include "classifier.h"
#include "codeaccessormethod.h"
#include "codedocument.h"
#include "codeoperation.h"
#include "codeclassfield.h"
#include "codeclassfieldlist.h"
#include "umlassociationlist.h"
class UMLRole;
/**
* class ClassifierCodeDocument
* A CodeDocument which represents a UMLClassifier (e.g. a Class or Interface)
*/
class ClassifierCodeDocument : public CodeDocument
{
friend class HierarchicalCodeBlock;
Q_OBJECT
public:
// Constructors/Destructors
//
/**
* Empty Constructor
*/
ClassifierCodeDocument ( UMLClassifier * parent );
/**
* Empty Destructor
*/
virtual ~ClassifierCodeDocument ( );
/**
* Add a CodeClassField object to the m_classfieldVector List
*/
bool addCodeClassField ( CodeClassField * add_object );
/**
* Remove a CodeClassField object from m_classfieldVector List
*/
bool removeCodeClassField ( CodeClassField * remove_object );
/**
* Get the list of CodeClassField objects held by m_classfieldVector
* @return CodeClassFieldList list of CodeClassField objects held by
* m_classfieldVector
*/
CodeClassFieldList * getCodeClassFieldList ( );
// some Utility methods
/**
* Return if the parent classifier is an interface
*/
bool parentIsInterface();
/**
* Return if the parent classifier is a class
*/
bool parentIsClass();
/**
* Tell if one or more codeclassfields are derived from any kind of association.
*/
bool hasAssociationClassFields();
/**
* Tell if one or more codeclassfields are derived from attributes.
*/
bool hasAttributeClassFields();
/**
* Tell if any of the accessor classfields will be of lists of objects.
*/
bool hasObjectVectorClassFields();
/**
* Does this object have any classfields declared?
*/
bool hasClassFields();
/**
* Get a list of codeoperation objects held by this classifiercodedocument.
* @return TQPtrList<CodeOperation>
*/
TQPtrList<CodeOperation> getCodeOperations ( );
/** Get a list of codeclassifier objects held by this classifiercodedocument that meet the passed criteria.
* @return CodeClassFieldList
*/
CodeClassFieldList getSpecificClassFields (CodeClassField::ClassFieldType cfType);
/** Get a list of codeclassifier objects held by this classifiercodedocument that meet the passed criteria.
* @return CodeClassFieldList
*/
CodeClassFieldList getSpecificClassFields (CodeClassField::ClassFieldType cfType, bool isStatic);
/** Get a list of codeclassifier objects held by this classifiercodedocument that meet the passed criteria.
* @return CodeClassFieldList
*/
CodeClassFieldList getSpecificClassFields (CodeClassField::ClassFieldType cfType, Uml::Visibility visibility);
/** Get a list of codeclassifier objects held by this classifiercodedocument that meet the passed criteria.
* @return CodeClassFieldList
*/
CodeClassFieldList getSpecificClassFields (CodeClassField::ClassFieldType cfType, bool isStatic, Uml::Visibility visibility);
/** Using the parent object's UML ID, find the corresponding
* codeclassfield object in this classifiercodedocument. Returns
* NULL if no such codeclassfield object exists in this document.
*
* @param id ID of the parent object
* @param role_id 0 for role A of the asssociation
* 1 for role B of the asssociation
* -1 if this is an attribute.
*/
CodeClassField * findCodeClassFieldFromParentID (Uml::IDType id, int role_id = -1);
/**
* Get the value of m_parentclassifier
* @return the value of m_parentclassifier
*/
UMLClassifier * getParentClassifier ( );
// a utility method that allows user to easily add classfield methods to this document
void addCodeClassFieldMethods(CodeClassFieldList &list );
/**
* Utility method to appropriately populate the code classfields for this document.
*/
virtual void initCodeClassFields ( );
// cause this classifier code document to synchronize to current policy
virtual void synchronize();
/** Will add the code operation in the correct place in the document.
* @return bool which is true IF the code operation was added successfully
*/
virtual bool addCodeOperation (CodeOperation *opBlock) = 0;
/**
* Save the XMI representation of this object
*/
virtual void saveToXMI ( TQDomDocument & doc, TQDomElement & root );
/**
* load params from the appropriate XMI element node.
*/
virtual void loadFromXMI ( TQDomElement & root );
protected:
/**
* Load CodeClassFields from XMI element node.
*/
void loadClassFieldsFromXMI( TQDomElement & childElem);
/** set attributes of the node that represents this class
* in the XMI document.
*/
virtual void setAttributesOnNode ( TQDomDocument & doc, TQDomElement & blockElement);
/** set the class attributes of this object from
* the passed element node.
*/
virtual void setAttributesFromNode ( TQDomElement & element);
// find a specific textblock held by any code class field in this document
// by its tag
TextBlock * findCodeClassFieldTextBlockByTag (const TQString &tag);
// add the declaration text blocks for various classfields
void declareClassFields (CodeClassFieldList & list , CodeGenObjectWithTextBlocks * parent);
virtual void updateContent( ) = 0;
// force syncronization of child classfields to their parent objects
void syncClassFields( );
// IF the classifier object is modified, this will get called.
// @fixme We cannot make this virtual because the ClassifierCodeDocument
// constructor calls it.
void syncNamesToParent( );
private:
CodeClassFieldList m_classfieldVector;
UMLClassifier* m_parentclassifier;
// using the passed list, update our inventory of CodeClassFields which are
// based on UMLRoles (e.g. derived from associations with other classifiers).
void updateAssociationClassFields ( UMLAssociationList &assocList );
// update code operations in this document using the parent classifier
void updateOperations( );
/**
* Maps CodeClassFields to UMLObjects. Used to prevent re-adding a class
* field.
*/
TQMap<UMLObject *,CodeClassField *> m_classFieldMap;
/**
* Init from a UMLClassifier object.
* @param classifier
*/
void init ( UMLClassifier * classifier );
public slots:
/**
* Synchronize this document to the attributes/associations of the parent classifier.
*/
void addAttributeClassField(UMLClassifierListItem *at, bool syncToParentIfAdded = true);
void addAssociationClassField (UMLAssociation * assoc, bool syncToParentIfAdded = true);
void removeAttributeClassField(UMLClassifierListItem *at);
void removeAssociationClassField(UMLAssociation *assoc);
void addOperation (UMLClassifierListItem * obj);
void removeOperation (UMLClassifierListItem * obj);
void syncToParent( );
};
#endif // CLASSIFIERCODEDOCUMENT_H
|
