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
|
/*****************************************************************************
* Copyright (c) 2011 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:
*
* CEA LIST - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.uml.diagram.common.parser;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.papyrus.sysml.diagram.common.preferences.ILabelPreferenceConstants;
import org.eclipse.papyrus.uml.tools.utils.ValueSpecificationUtil;
import org.eclipse.uml2.uml.InstanceValue;
import org.eclipse.uml2.uml.Parameter;
import org.eclipse.uml2.uml.ParameterDirectionKind;
import org.eclipse.uml2.uml.UMLPackage;
import org.eclipse.uml2.uml.ValueSpecification;
/**
* Semantic Parser for {@link Parameter}
*/
public class ParameterLabelParser extends NamedElementLabelParser {
/** The String format for displaying a {@link Parameter} with direction */
protected static final String DIRECTION_FORMAT = "%s %s";
/** The String format for displaying a {@link Parameter} label with its name */
protected static final String NAME_FORMAT = "%s%s";
/** The String format for displaying a {@link Parameter} label with its type */
protected static final String TYPE_FORMAT = "%s: %s";
/** The String format for displaying a {@link Parameter} label with its multiplicity */
protected static final String MULTIPLICITY_FORMAT = "%s [%s..%s]";
/** The String format for displaying a {@link Parameter} label with its default value */
protected static final String DEFAULT_VALUE_FORMAT = "%s= %s";
/** The String format for displaying a {@link Parameter} label with its modifiers */
protected static final String MODIFIER_FORMAT = "%s{%s}";
/**
* {@inheritDoc}
*/
@Override
public String getPrintString(IAdaptable element, int flags) {
Collection<String> maskValues = getMaskValues(element);
if(maskValues.isEmpty()) {
return MaskedLabel;
}
String result = "";
EObject eObject = (EObject)element.getAdapter(EObject.class);
if(eObject != null && eObject instanceof Parameter) {
Parameter parameter = (Parameter)eObject;
// manage direction
if(maskValues.contains(ILabelPreferenceConstants.DISP_DIRECTION) || maskValues.contains(ILabelPreferenceConstants.DISP_PARAMETER_DIRECTION)) {
String direction;
switch(parameter.getDirection().getValue()) {
case ParameterDirectionKind.IN:
direction = "in";
break;
case ParameterDirectionKind.OUT:
direction = "out";
break;
case ParameterDirectionKind.INOUT:
direction = "inout";
break;
case ParameterDirectionKind.RETURN:
direction = "return";
break;
default:
direction = "in";
break;
}
result = String.format(DIRECTION_FORMAT, direction, result);
// manage name
if((maskValues.contains(ILabelPreferenceConstants.DISP_NAME) || maskValues.contains(ILabelPreferenceConstants.DISP_PARAMETER_NAME)) && (parameter.isSetName())) {
String name = parameter.getName();
result = String.format(NAME_FORMAT, result, name);
}
// manage type
if(maskValues.contains(ILabelPreferenceConstants.DISP_TYPE) || maskValues.contains(ILabelPreferenceConstants.DISP_PARAMETER_TYPE)) {
String type = "<Undefined>";
if(parameter.getType() != null) {
type = parameter.getType().getName();
}
// If type is undefined only show "<Undefined>" when explicitly asked.
if(maskValues.contains(ILabelPreferenceConstants.DISP_UNDEFINED_TYPE) || (!"<Undefined>".equals(type))) {
result = String.format(TYPE_FORMAT, result, type);
}
}
// manage multiplicity
String lower = (parameter.getLowerValue() != null) ? ValueSpecificationUtil.getSpecificationValue(parameter.getLowerValue()) : "1";
String upper = (parameter.getLowerValue() != null) ? ValueSpecificationUtil.getSpecificationValue(parameter.getUpperValue()) : "1";
if((maskValues.contains(ILabelPreferenceConstants.DISP_PARAMETER_MULTIPLICITY) || maskValues.contains(ILabelPreferenceConstants.DISP_MULTIPLICITY)) && !("1".equals(lower) && "1".equals(upper))) {
result = String.format(MULTIPLICITY_FORMAT, result, lower, upper);
}
// manage default value
if((maskValues.contains(ILabelPreferenceConstants.DISP_PARAMETER_DEFAULT) || maskValues.contains(ILabelPreferenceConstants.DISP_DEFAULT_VALUE)) && ((parameter.getDefaultValue() != null))) {
ValueSpecification valueSpecification = parameter.getDefaultValue();
if((valueSpecification instanceof InstanceValue && parameter.getType().equals(valueSpecification.getType())) || !(valueSpecification instanceof InstanceValue)) {
result = String.format(DEFAULT_VALUE_FORMAT, result, ValueSpecificationUtil.getSpecificationValue(valueSpecification));
}
}
// manage modifier
if(maskValues.contains(ILabelPreferenceConstants.DISP_PARAMETER_MODIFIERS) || maskValues.contains(ILabelPreferenceConstants.DISP_MODIFIERS)) {
StringBuffer sb = new StringBuffer();
if(parameter.isOrdered()) {
sb.append(sb.length() == 0 ? "ordered" : ", ordered");
}
if(parameter.isUnique()) {
sb.append(sb.length() == 0 ? "unique" : ", unique");
}
if(parameter.isStream()) {
sb.append(sb.length() == 0 ? "stream" : ", stream");
}
if(parameter.isException()) {
sb.append(sb.length() == 0 ? "exception" : ", exception");
}
if(sb.length() != 0) {
result = String.format(MODIFIER_FORMAT, result, sb.toString());
}
}
}
}
return result;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isAffectingEvent(Object event, int flags) {
if(event instanceof Notification) {
Object feature = ((Notification)event).getFeature();
if(feature instanceof EStructuralFeature) {
return UMLPackage.eINSTANCE.getTypedElement_Type().equals(feature) || UMLPackage.eINSTANCE.getParameter_Direction().equals(feature) || UMLPackage.eINSTANCE.getParameter_DefaultValue().equals(feature) || UMLPackage.eINSTANCE.getParameter_IsStream().equals(feature) || UMLPackage.eINSTANCE.getParameter_IsException().equals(feature) || UMLPackage.eINSTANCE.getMultiplicityElement_IsOrdered().equals(feature) || UMLPackage.eINSTANCE.getMultiplicityElement_IsUnique().equals(feature) || UMLPackage.eINSTANCE.getMultiplicityElement_LowerValue().equals(feature) || UMLPackage.eINSTANCE.getMultiplicityElement_UpperValue().equals(feature) || super.isAffectingEvent(event, flags);
}
}
return false;
}
/**
* {@inheritDoc}
*/
@Override
public List<EObject> getSemanticElementsBeingParsed(EObject element) {
List<EObject> semanticElementsBeingParsed = new ArrayList<EObject>();
if((element != null) && (element instanceof Parameter)) {
Parameter semElement = (Parameter)element;
semanticElementsBeingParsed.add(semElement);
if(semElement.getType() != null) {
semanticElementsBeingParsed.add(semElement.getType());
}
if(semElement.getDefaultValue() != null) {
semanticElementsBeingParsed.add(semElement.getDefaultValue());
}
if(semElement.getLowerValue() != null) {
semanticElementsBeingParsed.add(semElement.getLowerValue());
}
if(semElement.getUpperValue() != null) {
semanticElementsBeingParsed.add(semElement.getUpperValue());
}
}
return semanticElementsBeingParsed;
}
/**
* {@inheritDoc}
*/
@Override
public Map<String, String> getMasks() {
Map<String, String> masks = new HashMap<String, String>();
masks.put(ILabelPreferenceConstants.DISP_DIRECTION, "Direction");
masks.put(ILabelPreferenceConstants.DISP_NAME, "Name");
masks.put(ILabelPreferenceConstants.DISP_TYPE, "Type");
masks.put(ILabelPreferenceConstants.DISP_MULTIPLICITY, "Multiplicity");
masks.put(ILabelPreferenceConstants.DISP_DEFAULT_VALUE, "Default value");
masks.put(ILabelPreferenceConstants.DISP_MODIFIERS, "Modifiers");
return masks;
}
}
|
