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
|
/*****************************************************************************
* Copyright (c) 2016 CEA LIST and others.
*
* 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:
* CEA LIST - Initial API and implementation
* Nicolas FAUVERGUE (ALL4TEC) nicolas.fauvergue@all4tec.net - Bug 496905
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.sequence.util;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.gef.GraphicalEditPart;
import org.eclipse.papyrus.infra.gmfdiag.common.editpolicies.IMaskManagedLabelEditPolicy;
import org.eclipse.papyrus.uml.diagram.common.helper.StereotypedElementLabelHelper;
import org.eclipse.papyrus.uml.diagram.sequence.edit.parts.LifelineNameEditPart;
import org.eclipse.papyrus.uml.internationalization.utils.utils.UMLLabelInternationalization;
import org.eclipse.papyrus.uml.tools.utils.UMLUtil;
import org.eclipse.papyrus.uml.tools.utils.ValueSpecificationUtil;
import org.eclipse.uml2.uml.ConnectableElement;
import org.eclipse.uml2.uml.Expression;
import org.eclipse.uml2.uml.Lifeline;
import org.eclipse.uml2.uml.LiteralSpecification;
import org.eclipse.uml2.uml.OpaqueExpression;
import org.eclipse.uml2.uml.TimeExpression;
import org.eclipse.uml2.uml.Type;
import org.eclipse.uml2.uml.ValueSpecification;
public class LifelineLabelHelper extends StereotypedElementLabelHelper {
public static final String SHOW_REPRESENT_NAME = "representsName";
public static final String SHOW_REPRESENT_SELECTOR = "representsSelector";
public static final String SHOW_REPRESENT_TYPE = "representsType";
public static final String SHOW_UNDEFINED_TYPE = "undefinedType";
public static final String SHOW_LIFELINE_NAME = "lifelineName";
public static final Collection<String> DEFAULT_LABEL_DISPLAY = Arrays.asList(SHOW_REPRESENT_NAME, SHOW_REPRESENT_SELECTOR, SHOW_REPRESENT_TYPE);
/**
* singelton instance
*/
private static LifelineLabelHelper labelHelper;
/**
* Returns the singleton instance of this class
*
* @return the singleton instance.
*/
public static LifelineLabelHelper getInstance() {
if (labelHelper == null) {
labelHelper = new LifelineLabelHelper();
}
return labelHelper;
}
/** Map for masks */
protected final Map<String, String> masks = new HashMap<>();
/**
* Creates a new Operation label helper.
*/
protected LifelineLabelHelper() {
// initialize the map
masks.put(SHOW_REPRESENT_NAME, "Show represent name");
masks.put(SHOW_REPRESENT_SELECTOR, "Show represent selector");
masks.put(SHOW_REPRESENT_TYPE, "Show represent type");
masks.put(SHOW_UNDEFINED_TYPE, "Always show undefined type");
masks.put(SHOW_LIFELINE_NAME, "Always show lifeline name");
}
/**
* Returns the map of masks used to display
*
* @return the map of masks used to display
*/
public Map<String, String> getMasks() {
return masks;
}
/**
* {@inheritDoc}
*/
@Override
public Lifeline getUMLElement(GraphicalEditPart editPart) {
return (Lifeline) UMLUtil.resolveUMLElement(editPart);
}
@Override
protected String elementLabel(GraphicalEditPart editPart) {
if (editPart instanceof LifelineNameEditPart) {
editPart = (GraphicalEditPart) editPart.getParent();
}
Collection<String> displayValue = DEFAULT_LABEL_DISPLAY;
IMaskManagedLabelEditPolicy policy = (IMaskManagedLabelEditPolicy) editPart.getEditPolicy(IMaskManagedLabelEditPolicy.MASK_MANAGED_LABEL_EDIT_POLICY);
if (policy != null) {
displayValue = policy.getCurrentDisplayValue();
}
return getCustomLabel(getUMLElement(editPart), displayValue);
}
private static final String UNAMED = "<Unnamed>";
private static final String UNDEFINED = "<Undefined>";
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=383722
private String getCustomLabel(Lifeline lifeline, Collection<String> displayValue) {
StringBuilder sb = new StringBuilder();
appendName(lifeline, displayValue, sb);
boolean displayType = displayValue.contains(SHOW_REPRESENT_TYPE);
if (lifeline.getRepresents() == null || displayValue.contains(LifelineLabelHelper.SHOW_LIFELINE_NAME)) {
displayType = false;
}
if (displayType) {
// handle represent type label
appendType(lifeline, displayValue, sb);
}
return sb.toString();
}
protected void appendName(Lifeline lifeline, Collection<String> displayValue, StringBuilder sb) {
ConnectableElement element = lifeline.getRepresents();
String lifelineName = UMLLabelInternationalization.getInstance().getLabel(lifeline);
if (element == null || displayValue.contains(SHOW_LIFELINE_NAME)) {
appendString(sb, lifelineName, UNAMED);
return;
} else {
// represents is not null
if (displayValue.contains(SHOW_REPRESENT_NAME)) {
appendString(sb,UMLLabelInternationalization.getInstance().getLabel( element), UNAMED);
boolean displaySelector = displayValue.contains(SHOW_REPRESENT_SELECTOR);
if (lifeline.getRepresents() == null || displayValue.contains(LifelineLabelHelper.SHOW_LIFELINE_NAME)) {
displaySelector = false;
}
if (displaySelector) {
ValueSpecification selector = lifeline.getSelector();
// Add the selector if it is a LiteralSpecification
if(selector instanceof LiteralSpecification) {
sb.append("[").append(ValueSpecificationUtil.getSpecificationValue(selector, true)).append("]");
}
// Add the selector if it is an Expression
if(selector instanceof Expression || selector instanceof OpaqueExpression || selector instanceof TimeExpression) {
String specificationValue = ValueSpecificationUtil.getSpecificationValue(selector, true);
if(specificationValue != null && specificationValue.length() > 0) {
sb.append("[").append(specificationValue).append("]");
}
}
}
}
// if neither <1> or <2> are checked, show lifeline name (or <unnamed> when the lifeline has no name)
else if (!displayValue.contains(SHOW_REPRESENT_TYPE)) {
appendString(sb, lifelineName, UNAMED);
}
}
}
protected void appendType(Lifeline lifeline, Collection<String> displayValue, StringBuilder sb) {
ConnectableElement element = lifeline.getRepresents();
if (element == null) {
return;
}
Type type = element.getType();
if (displayValue.contains(SHOW_REPRESENT_TYPE)) {
if (type == null) {
if (displayValue.contains(SHOW_UNDEFINED_TYPE)) {
sb.append(":").append(UNDEFINED);
}
} else {
appendString(sb.append(":"), UMLLabelInternationalization.getInstance().getLabel(type), UNAMED);
}
}
}
private void appendString(StringBuilder sb, String str, String defaultValue) {
if (str != null) {
sb.append(str);
} else {
sb.append(defaultValue);
}
}
}
|
