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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
|
/*
* Copyright 2000-2014 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.ui.declarative;
import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.io.Serializable;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.jsoup.nodes.Attribute;
import org.jsoup.nodes.Attributes;
import org.jsoup.nodes.Element;
import org.jsoup.nodes.Node;
import com.vaadin.data.util.converter.Converter;
import com.vaadin.shared.util.SharedUtil;
import com.vaadin.ui.Component;
/**
* Default attribute handler implementation used when parsing designs to
* component trees. Handles all the component attributes that do not require
* custom handling.
*
* @since 7.4
* @author Vaadin Ltd
*/
public class DesignAttributeHandler implements Serializable {
private static Logger getLogger() {
return Logger.getLogger(DesignAttributeHandler.class.getName());
}
private static Map<Class<?>, AttributeCacheEntry> cache = new ConcurrentHashMap<Class<?>, AttributeCacheEntry>();
// translates string <-> object
private static DesignFormatter FORMATTER = new DesignFormatter();
/**
* Returns the currently used formatter. All primitive types and all types
* needed by Vaadin components are handled by that formatter.
*
* @return An instance of the formatter.
*/
public static DesignFormatter getFormatter() {
return FORMATTER;
}
/**
* Clears the children and attributes of the given element
*
* @param design
* the element to be cleared
*/
public static void clearElement(Element design) {
Attributes attr = design.attributes();
for (Attribute a : attr.asList()) {
attr.remove(a.getKey());
}
List<Node> children = new ArrayList<Node>();
children.addAll(design.childNodes());
for (Node node : children) {
node.remove();
}
}
/**
* Assigns the specified design attribute to the given component.
*
* @param target
* the target to which the attribute should be set
* @param attribute
* the name of the attribute to be set
* @param value
* the string value of the attribute
* @return true on success
*/
public static boolean assignValue(Object target, String attribute,
String value) {
if (target == null || attribute == null || value == null) {
throw new IllegalArgumentException(
"Parameters with null value not allowed");
}
boolean success = false;
try {
Method setter = findSetterForAttribute(target.getClass(), attribute);
if (setter == null) {
// if we don't have the setter, there is no point in continuing
success = false;
} else {
// we have a value from design attributes, let's use that
Object param = getFormatter().parse(value,
setter.getParameterTypes()[0]);
setter.invoke(target, param);
success = true;
}
} catch (Exception e) {
getLogger().log(Level.WARNING,
"Failed to set attribute " + attribute, e);
}
if (!success) {
getLogger().info(
"property " + attribute
+ " ignored by default attribute handler");
}
return success;
}
/**
* Searches for supported setter and getter types from the specified class
* and returns the list of corresponding design attributes
*
* @param clazz
* the class scanned for setters
* @return the list of supported design attributes
*/
public static Collection<String> getSupportedAttributes(Class<?> clazz) {
resolveSupportedAttributes(clazz);
return cache.get(clazz).getAttributes();
}
/**
* Resolves the supported attributes and corresponding getters and setters
* for the class using introspection. After resolving, the information is
* cached internally by this class
*
* @param clazz
* the class to resolve the supported attributes for
*/
private static void resolveSupportedAttributes(Class<?> clazz) {
if (clazz == null) {
throw new IllegalArgumentException("The clazz can not be null");
}
if (cache.containsKey(clazz)) {
// NO-OP
return;
}
BeanInfo beanInfo;
try {
beanInfo = Introspector.getBeanInfo(clazz);
} catch (IntrospectionException e) {
throw new RuntimeException(
"Could not get supported attributes for class "
+ clazz.getName());
}
AttributeCacheEntry entry = new AttributeCacheEntry();
for (PropertyDescriptor descriptor : beanInfo.getPropertyDescriptors()) {
Method getter = descriptor.getReadMethod();
Method setter = descriptor.getWriteMethod();
if (getter != null && setter != null
&& getFormatter().canConvert(descriptor.getPropertyType())) {
String attribute = toAttributeName(descriptor.getName());
entry.addAttribute(attribute, getter, setter);
}
}
cache.put(clazz, entry);
}
/**
* Writes the specified attribute to the design if it differs from the
* default value got from the <code> defaultInstance <code>
*
* @param component
* the component used to get the attribute value
* @param attribute
* the key for the attribute
* @param attr
* the attribute list where the attribute will be written
* @param defaultInstance
* the default instance for comparing default values
*/
public static void writeAttribute(Component component, String attribute,
Attributes attr, Component defaultInstance) {
Method getter = findGetterForAttribute(component.getClass(), attribute);
if (getter == null) {
getLogger().warning(
"Could not find getter for attribute " + attribute);
} else {
try {
// compare the value with default value
Object value = getter.invoke(component);
Object defaultValue = getter.invoke(defaultInstance);
// if the values are not equal, write the data
if (!SharedUtil.equals(value, defaultValue)) {
String attributeValue = toAttributeValue(
getter.getReturnType(), value);
attr.put(attribute, attributeValue);
}
} catch (Exception e) {
getLogger()
.log(Level.SEVERE,
"Failed to invoke getter for attribute "
+ attribute, e);
}
}
}
/**
* Reads the given attribute from a set of attributes.
*
* @param attribute
* the attribute key
* @param attributes
* the set of attributes to read from
* @param outputType
* the output type for the attribute
* @return the attribute value or the default value if the attribute is not
* found
*/
public static <T> T readAttribute(String attribute, Attributes attributes,
Class<T> outputType) {
if (!getFormatter().canConvert(outputType)) {
throw new IllegalArgumentException("output type: "
+ outputType.getName() + " not supported");
}
if (!attributes.hasKey(attribute)) {
return null;
} else {
try {
String value = attributes.get(attribute);
return getFormatter().parse(value, outputType);
} catch (Exception e) {
throw new DesignException("Failed to read attribute "
+ attribute, e);
}
}
}
/**
* Writes the given attribute value to a set of attributes if it differs
* from the default attribute value.
*
* @param attribute
* the attribute key
* @param attributes
* the set of attributes where the new attribute is written
* @param value
* the attribute value
* @param defaultValue
* the default attribute value
* @param inputType
* the type of the input value
*/
public static <T> void writeAttribute(String attribute,
Attributes attributes, T value, T defaultValue, Class<T> inputType) {
if (!getFormatter().canConvert(inputType)) {
throw new IllegalArgumentException("input type: "
+ inputType.getName() + " not supported");
}
if (!SharedUtil.equals(value, defaultValue)) {
String attributeValue = toAttributeValue(inputType, value);
attributes.put(attribute, attributeValue);
}
}
/**
* Returns the design attribute name corresponding the given method name.
* For example given a method name <code>setPrimaryStyleName</code> the
* return value would be <code>primary-style-name</code>
*
* @param propertyName
* the property name returned by {@link IntroSpector}
* @return the design attribute name corresponding the given method name
*/
private static String toAttributeName(String propertyName) {
propertyName = removeSubsequentUppercase(propertyName);
String[] words = propertyName.split("(?<!^)(?=[A-Z])");
StringBuilder builder = new StringBuilder();
for (int i = 0; i < words.length; i++) {
if (builder.length() > 0) {
builder.append("-");
}
builder.append(words[i].toLowerCase());
}
return builder.toString();
}
/**
* Replaces subsequent UPPERCASE strings of length 2 or more followed either
* by another uppercase letter or an end of string. This is to generalise
* handling of method names like <tt>showISOWeekNumbers</tt>.
*
* @param param
* Input string.
* @return Input string with sequences of UPPERCASE turned into Normalcase.
*/
private static String removeSubsequentUppercase(String param) {
StringBuffer result = new StringBuffer();
// match all two-or-more caps letters lead by a non-uppercase letter
// followed by either a capital letter or string end
Pattern pattern = Pattern.compile("(^|[^A-Z])([A-Z]{2,})([A-Z]|$)");
Matcher matcher = pattern.matcher(param);
while (matcher.find()) {
String matched = matcher.group(2);
// if this is a beginning of the string, the whole matched group is
// written in lower case
if (matcher.group(1).isEmpty()) {
matcher.appendReplacement(result, matched.toLowerCase()
+ matcher.group(3));
// otherwise the first character of the group stays uppercase,
// while the others are lower case
} else {
matcher.appendReplacement(
result,
matcher.group(1) + matched.substring(0, 1)
+ matched.substring(1).toLowerCase()
+ matcher.group(3));
}
// in both cases the uppercase letter of the next word (or string's
// end) is added
// this implies there is at least one extra lowercase letter after
// it to be caught by the next call to find()
}
matcher.appendTail(result);
return result.toString();
}
/**
* Serializes the given value to valid design attribute representation
*
* @param sourceType
* the type of the value
* @param value
* the value to be serialized
* @return the given value as design attribute representation
*/
private static String toAttributeValue(Class<?> sourceType, Object value) {
if (value == null) {
// TODO: Handle corner case where sourceType is String and default
// value is not null. How to represent null value in attributes?
return "";
}
Converter<String, Object> converter = getFormatter().findConverterFor(
sourceType);
if (converter != null) {
return converter.convertToPresentation(value, String.class, null);
} else {
return value.toString();
}
}
/**
* Returns a setter that can be used for assigning the given design
* attribute to the class
*
* @param clazz
* the class that is scanned for setters
* @param attribute
* the design attribute to find setter for
* @return the setter method or null if not found
*/
private static Method findSetterForAttribute(Class<?> clazz,
String attribute) {
resolveSupportedAttributes(clazz);
return cache.get(clazz).getSetter(attribute);
}
/**
* Returns a getter that can be used for reading the given design attribute
* value from the class
*
* @param clazz
* the class that is scanned for getters
* @param attribute
* the design attribute to find getter for
* @return the getter method or null if not found
*/
private static Method findGetterForAttribute(Class<?> clazz,
String attribute) {
resolveSupportedAttributes(clazz);
return cache.get(clazz).getGetter(attribute);
}
/**
* Cache object for caching supported attributes and their getters and
* setters
*
* @author Vaadin Ltd
*/
private static class AttributeCacheEntry implements Serializable {
private Map<String, Method[]> accessMethods = new ConcurrentHashMap<String, Method[]>();
private void addAttribute(String attribute, Method getter, Method setter) {
Method[] methods = new Method[2];
methods[0] = getter;
methods[1] = setter;
accessMethods.put(attribute, methods);
}
private Collection<String> getAttributes() {
ArrayList<String> attributes = new ArrayList<String>();
attributes.addAll(accessMethods.keySet());
return attributes;
}
private Method getGetter(String attribute) {
Method[] methods = accessMethods.get(attribute);
return (methods != null && methods.length > 0) ? methods[0] : null;
}
private Method getSetter(String attribute) {
Method[] methods = accessMethods.get(attribute);
return (methods != null && methods.length > 1) ? methods[1] : null;
}
}
}
|