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
|
/*****************************************************************************
* Copyright (c) 2009 CEA LIST.
*
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Yann TANGUY (CEA LIST) yann.tanguy@cea.fr - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.uml.tools.utils;
import java.util.Collection;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.gmf.runtime.emf.core.util.EMFCoreUtil;
import org.eclipse.osgi.util.NLS;
import org.eclipse.uml2.uml.NamedElement;
/**
* Utility class for <code>org.eclipse.uml2.uml.NamedElement</code><BR>
*/
public class NamedElementUtil {
public static final String COPY_OF = "CopyOf";
public static final String QUALIFIED_NAME_SEPARATOR = "::";
private final static String PUBLIC_STRING = "+";
private final static String PROTECTED_STRING = "#";
private final static String PRIVATE_STRING = "-";
private final static String PACKAGE_STRING = "~";
/**
* A helper method to calculate the max depth of an element
*
* @param the
* named element
* @return the maximum depth found in qualified name
*/
public static int getQualifiedNameMaxDepth(NamedElement namedElement) {
int d = 0;
String s = namedElement.getQualifiedName();
if(s == null) {
return 0;
}
int n = 0;
while((n = s.indexOf(QUALIFIED_NAME_SEPARATOR, n)) != -1) {
n += 2;
d++;
}
return d;
}
/**
* generate a default name for the eobject in parameter the format is :
* "eclassName"+"max(elementOfTheSameName in the container)" + 1
*
* @param newElement
* @return
*/
public static String getDefaultNameWithIncrement(EObject newElement) {
if(newElement.eContainer() != null) {
return getDefaultNameWithIncrement(newElement, newElement.eContainer().eContents());
}
return null;
}
/**
* generate a default name for the eobject in parameter the format is :
* "eclassName"+"max(elementOfTheSameName in the container)" + 1 the method checks already
* existing element in contents parameter
*
* @param newElement
*/
@SuppressWarnings("rawtypes")
public static String getDefaultNameWithIncrement(EObject newElement, Collection contents) {
return getDefaultNameWithIncrement("", newElement, contents);
}
@SuppressWarnings("rawtypes")
public static String getDefaultCopyNameWithIncrement(NamedElement namedElement, Collection contents) {
String newName = NLS.bind(COPY_OF + "_{0}_", namedElement.getName());
return NamedElementUtil.getDefaultNameWithIncrementFromBase(newName, contents);
}
@SuppressWarnings("rawtypes")
public static String getDefaultNameWithIncrement(String prefix, EObject newElement, Collection contents) {
if(prefix == null) {
prefix = "";
}
return getDefaultNameWithIncrementFromBase(prefix + newElement.eClass().getName(), contents);
}
@SuppressWarnings("rawtypes")
public static String getDefaultNameWithIncrementFromBase(String base, Collection contents) {
if(base.equalsIgnoreCase("property")) {
base = "Attribute";
}
int nextNumber = 1;
for(Object o : contents) {
if(o instanceof EObject) {
String name = EMFCoreUtil.getName((EObject)o);
if(name != null && name.startsWith(base)) {
String end = name.substring(base.length());
int nextNumberTmp = 1;
try {
nextNumberTmp = Integer.parseInt(end) + 1;
} catch (NumberFormatException ex) {
}
if(nextNumberTmp > nextNumber) {
nextNumber = nextNumberTmp;
}
}
}
}
return base + nextNumber;
}
/**
* Give the visibility of the {@link NamedElement} as a string, as defined in the UML2 standard.
*
* @return A String representing the visibility of the {@link NamedElement}. Possible values:
* <ul>
* <li>public: <code>"+"</code>
* <li>private: <code>"-"</code>
* <li>protected: <code>"#"</code>
* <li>package: <code>"~"</code>
* </ul>
*/
public static String getVisibilityAsSign(NamedElement element) {
String vKindValue = "";
switch(element.getVisibility().getValue()) {
case org.eclipse.uml2.uml.VisibilityKind.PUBLIC:
vKindValue = PUBLIC_STRING;
break;
case org.eclipse.uml2.uml.VisibilityKind.PRIVATE:
vKindValue = PRIVATE_STRING;
break;
case org.eclipse.uml2.uml.VisibilityKind.PACKAGE:
vKindValue = PACKAGE_STRING;
break;
case org.eclipse.uml2.uml.VisibilityKind.PROTECTED:
vKindValue = PROTECTED_STRING;
break;
}
return vKindValue;
}
/**
* Returns the name of an element, given its qualified name
*
* @param qualifiedName
* the qualified name of the element
* @return the name of the element. It shall never be <code>null</code>.
*/
public static String getNameFromQualifiedName(String qualifiedName) {
String name = qualifiedName.substring(qualifiedName.lastIndexOf(NamedElement.SEPARATOR) + NamedElement.SEPARATOR.length());
return (name != null) ? name : "";
}
/**
*
* @param childQualifiedName
* the qualifiedName of an element
* @return
* the qualified name of its parent
*/
public static String getParentQualifiedName(final String childQualifiedName) {
final String childName = getNameFromQualifiedName(childQualifiedName);
final String parentQualifiedName = childQualifiedName.substring(0, childQualifiedName.length() - (NamedElement.SEPARATOR.length() + childName.length()));
return (parentQualifiedName != null) ? parentQualifiedName : "";
}
public static String getName(NamedElement element) {
if(element.getName() != null) {
return element.getName();
} else {
return (NamedElementUtil.getDefaultNameWithIncrement(element));
}
}
}
|
