source: trunk/src/org/expeditee/gui/AttributeUtils.java@ 1460

Last change on this file since 1460 was 1430, checked in by bln4, 5 years ago

Fixed bug for when there are no surrogates left for a primary.
File size: 32.1 KB
Line 
1/**
2 * AttributeUtils.java
3 * Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19package org.expeditee.gui;
20
21import java.lang.reflect.Field;
22import java.lang.reflect.InvocationTargetException;
23import java.lang.reflect.Method;
24import java.util.HashMap;
25import java.util.LinkedList;
26import java.util.List;
27
28import org.expeditee.core.Colour;
29import org.expeditee.core.Font;
30import org.expeditee.core.Point;
31import org.expeditee.encryption.items.EncryptionPermissionTriple;
32import org.expeditee.io.Conversion;
33import org.expeditee.items.DotType;
34import org.expeditee.items.Item;
35import org.expeditee.items.Justification;
36import org.expeditee.items.PermissionTriple;
37import org.expeditee.items.Text;
38import org.expeditee.simple.IncorrectTypeException;
39
40/**
41 * This class provides the methods to extract and set attributes of Items and
42 * Frames. These methods are called when a user merges a text item with
43 * <code>Attribute: Value</code> pairs.
44 *
45 * @author jdm18
46 *
47 */
48public class AttributeUtils {
49
50 public static final class Attribute {
51 public final String displayName;
52 public final Method getter;
53 public final Method setter;
54
55 public Attribute(String displayName, Method getter, Method setter) {
56 this.displayName = displayName;
57 this.getter = getter;
58 this.setter = setter;
59 }
60 }
61
62 public static final class AttributeSet {
63
64 // the internal hashmap
65 private final HashMap<String, Attribute> map;
66 // a list of keys in the order they were added (used to make attribute extraction consistent)
67 public final List<String> keys;
68
69 public AttributeSet(int size) {
70 map = new HashMap<String, Attribute>(size);
71 keys = new LinkedList<String>();
72 }
73
74 public void put(String attributeName, Method getter, Method setter) {
75 if(map.containsKey(attributeName.toLowerCase())) {
76 System.err.println(this + " already contains key '" + attributeName + "', overwriting value!");
77 } else {
78 // we keep an ordered list of attributes for extraction
79 keys.add(attributeName.toLowerCase());
80 }
81 map.put(attributeName.toLowerCase(), new Attribute(attributeName, getter, setter));
82 }
83
84 // Create a second reference the the same Attribute, using a different name
85 // Does not modify the list of keys
86 public void alias(String alias, String name) {
87 if(map.containsKey(name.toLowerCase())) {
88 map.put(alias.toLowerCase(), map.get(name.toLowerCase()));
89 } else {
90 System.err.println("Cannot add alias '" + alias + "', because key '" + name + "' does not exist!");
91 }
92 }
93
94 public boolean containsKey(String key) {
95 return map.containsKey(key);
96 }
97
98 public Attribute get(String key) {
99 return map.get(key);
100 }
101 }
102
103 public static final AttributeSet _Attrib = new AttributeSet(128);
104 public static final AttributeSet _FrameAttrib = new AttributeSet(16);
105
106
107 // List of attributes which are ignored when extracting attributes
108 private static List<String> _IgnoreGet = null;
109 // List of attributes which are ignored when setting attributes,
110 // if multiple attributes are being set at once
111 private static List<String> _IgnoreSet = null;
112
113 /***************************************************************************
114 * List of method names to show in extraced lists even when they return null
115 * (Null is often used to indicate the default value is used)
116 **************************************************************************/
117 private static List<Method> _AllowNull = null;
118
119 // private static HashMap<String, String> _Abbreviations = null;
120
121 public static void ensureReady() {
122 if(_IgnoreSet == null) {
123 initLists();
124 }
125 }
126
127 /**
128 * Initialises the _Ignore and _AllowNull lists.
129 */
130 private static void initLists() {
131
132 try {
133
134 Class<?>[] pPoint = { Point.class };
135 Class<?>[] pString = { String.class };
136 Class<?>[] pInt = { int.class };
137 Class<?>[] pIntO = { Integer.class };
138 Class<?>[] pFloat = { float.class };
139 Class<?>[] pFloatO = { Float.class };
140 Class<?>[] pDouble = {double.class };
141 Class<?>[] pColor = { Colour.class };
142 Class<?>[] pBool = { boolean.class };
143 //Class[] pDouble = { double.class };
144 //Class[] pDoubleO = { Double.class };
145 Class<?>[] pArrow = { float.class, double.class, double.class };
146 Class<?>[] pList = { List.class };
147 Class<?>[] pIntArray = { int[].class };
148 Class<?>[] pJustification = { Justification.class };
149 Class<?>[] pPermission = { PermissionTriple.class };
150 Class<?>[] pDotType = { DotType.class };
151 Class<?>[] pEncPermission = { EncryptionPermissionTriple.class };
152
153 _IgnoreSet = new LinkedList<String>();
154 _IgnoreGet = new LinkedList<String>();
155 _AllowNull = new LinkedList<Method>();
156
157 // TODO load these in with reflection...
158 // Set the shortcuts with annotation tags on the methods
159 _IgnoreSet.add("date");
160 _IgnoreSet.add("datecreated");
161 _IgnoreSet.add("d");
162 _IgnoreSet.add("link");
163 _IgnoreSet.add("l");
164 _IgnoreSet.add("action");
165 _IgnoreSet.add("a");
166 _IgnoreSet.add("position");
167 _IgnoreSet.add("pos");
168 _IgnoreSet.add("p");
169 _IgnoreSet.add("x");
170 _IgnoreSet.add("y");
171
172 _IgnoreGet.add("x");
173 _IgnoreGet.add("y");
174 _IgnoreGet.add("text");
175 _IgnoreGet.add("gradientangle");
176
177 _AllowNull.add(Item.class.getMethod("getColor"));
178 _AllowNull.add(Item.class.getMethod("getBackgroundColor"));
179
180 _AllowNull.add(Frame.class.getMethod("getBackgroundColor"));
181 _AllowNull.add(Frame.class.getMethod("getForegroundColor"));
182
183 /*
184 * Populate the backing lists of attributes
185 */
186
187 // Frames
188 _FrameAttrib.put("Permission", Frame.class.getMethod("getPermission"),
189 Frame.class.getMethod("setPermission", pPermission));
190 _FrameAttrib.put("Owner", Frame.class.getMethod("getOwner"),
191 Frame.class.getMethod("setOwner", pString));
192 _FrameAttrib.put("DateCreated", Frame.class.getMethod("getDateCreated"),
193 null);
194 _FrameAttrib.put("LastModifyUser", Frame.class.getMethod("getLastModifyUser"),
195 null);
196 _FrameAttrib.put("LastModifyDate", Frame.class.getMethod("getLastModifyDate"),
197 null);
198 _FrameAttrib.put("ForegroundColor", Frame.class.getMethod("getForegroundColor"),
199 Frame.class.getMethod("setForegroundColor", pColor));
200 _FrameAttrib.put("BackgroundColor", Frame.class.getMethod("getBackgroundColor"),
201 Frame.class.getMethod("setBackgroundColor", pColor));
202 _FrameAttrib.put("EncryptionLabel", Frame.class.getMethod("getEncryptionLabel"),
203 Frame.class.getMethod("setEncryptionLabel", pString));
204 _FrameAttrib.put("EncPermission", Frame.class.getMethod("getEncryptionPermission"),
205 Frame.class.getMethod("setEncryptionPermission", pEncPermission));
206 _FrameAttrib.put("Group", Frame.class.getMethod("getGroup"),
207 Frame.class.getMethod("setGroup", pString));
208
209
210 // aliases for attribute setting
211 _FrameAttrib.alias("fgc", "foregroundcolor");
212 _FrameAttrib.alias("bgc", "backgroundcolor");
213 _FrameAttrib.alias("p", "permission");
214 _FrameAttrib.alias("enc", "encryptionlabel");
215 _FrameAttrib.alias("encp", "encpermission");
216 _FrameAttrib.alias("EncryptionPermission", "encpermission");
217
218
219 // Generic Items
220 _Attrib.put("DateCreated", Item.class.getMethod("getDateCreated"),
221 Item.class.getMethod("setDateCreated", pString));
222 _Attrib.put("Color", Item.class.getMethod("getColor"),
223 Item.class.getMethod("setColor", pColor));
224 _Attrib.put("BackgroundColor", Item.class.getMethod("getBackgroundColor"),
225 Item.class.getMethod("setBackgroundColor", pColor));
226 _Attrib.put("BorderColor", Item.class.getMethod("getBorderColor"),
227 Item.class.getMethod("setBorderColor", pColor));
228 _Attrib.put("AnchorLeft", Item.class.getMethod("getAnchorLeft"),
229 Item.class.getMethod("setAnchorLeft", pIntO));
230 _Attrib.put("AnchorRight", Item.class.getMethod("getAnchorRight"),
231 Item.class.getMethod("setAnchorRight", pIntO));
232 _Attrib.put("AnchorTop", Item.class.getMethod("getAnchorTop"),
233 Item.class.getMethod("setAnchorTop", pIntO));
234 _Attrib.put("AnchorBottom", Item.class.getMethod("getAnchorBottom"),
235 Item.class.getMethod("setAnchorBottom", pIntO));
236 _Attrib.put("Position", Item.class.getMethod("getPosition"),
237 Item.class.getMethod("setPosition", pPoint));
238 _Attrib.put("Link", Item.class.getMethod("getLink"),
239 Item.class.getMethod("setLink", pString));
240 _Attrib.put("AddToHistory", Item.class.getMethod("getLinkHistory"),
241 Item.class.getMethod("setLinkHistory", pBool));
242 _Attrib.put("Action", Item.class.getMethod("getAction"),
243 Item.class.getMethod("setActions", pList));
244 _Attrib.put("ActionMark", Item.class.getMethod("getActionMark"),
245 Item.class.getMethod("setActionMark", pBool));
246 _Attrib.put("ActionCursorEnter", Item.class.getMethod("getActionCursorEnter"),
247 Item.class.getMethod("setActionCursorEnter", pList));
248 _Attrib.put("ActionCursorLeave", Item.class.getMethod("getActionCursorLeave"),
249 Item.class.getMethod("setActionCursorLeave", pList));
250 _Attrib.put("ActionEnterFrame", Item.class.getMethod("getActionEnterFrame"),
251 Item.class.getMethod("setActionEnterFrame", pList));
252 _Attrib.put("ActionLeaveFrame", Item.class.getMethod("getActionLeaveFrame"),
253 Item.class.getMethod("setActionLeaveFrame", pList));
254 _Attrib.put("Data", Item.class.getMethod("getData"),
255 Item.class.getMethod("setData", pList));
256 _Attrib.put("Highlight", Item.class.getMethod("getHighlight"),
257 Item.class.getMethod("setHighlight", pBool));
258 _Attrib.put("FillColor", Item.class.getMethod("getFillColor"),
259 Item.class.getMethod("setFillColor", pColor));
260 _Attrib.put("GradientColor", Item.class.getMethod("getGradientColor"),
261 Item.class.getMethod("setGradientColor", pColor));
262 _Attrib.put("GradientAngle", Item.class.getMethod("getGradientAngle"),
263 Item.class.getMethod("setGradientAngle", pDouble));
264 _Attrib.put("FillPattern", Item.class.getMethod("getFillPattern"),
265 Item.class.getMethod("setFillPattern", pString));
266 _Attrib.put("Owner", Item.class.getMethod("getOwner"),
267 Item.class.getMethod("setOwner", pString));
268 _Attrib.put("LinkMark", Item.class.getMethod("getLinkMark"),
269 Item.class.getMethod("setLinkMark", pBool));
270 _Attrib.put("LinkFrameset", Item.class.getMethod("getLinkFrameset"),
271 Item.class.getMethod("setLinkFrameset", pString));
272 _Attrib.put("LinkTemplate", Item.class.getMethod("getLinkTemplate"),
273 Item.class.getMethod("setLinkTemplate", pString));
274 _Attrib.put("LinePattern", Item.class.getMethod("getLinePattern"),
275 Item.class.getMethod("setLinePattern", pIntArray));
276 _Attrib.put("Arrow", Item.class.getMethod("getArrow"),
277 Item.class.getMethod("setArrow", pArrow));
278 _Attrib.put("DotType", Item.class.getMethod("getDotType"),
279 Item.class.getMethod("setDotType", pDotType));
280 _Attrib.put("Filled", Item.class.getMethod("getFilled"),
281 Item.class.getMethod("setFilled", pBool));
282 _Attrib.put("Formula", Item.class.getMethod("getFormula"),
283 Item.class.getMethod("setFormula", pString));
284 _Attrib.put("Thickness", Item.class.getMethod("getThickness"),
285 Item.class.getMethod("setThickness", pFloat));
286// _Attrib.put("LineIDs", Item.class.getMethod("getLineIDs"),
287// Item.class.getMethod("setLineIDs", pString));
288// _Attrib.put("ConstraintIDs", Item.class.getMethod("getConstraintIDs"),
289// Item.class.getMethod("setConstraintIDs", pString));
290 _Attrib.put("Size", Item.class.getMethod("getSize"),
291 Item.class.getMethod("setSize", pFloat));
292 _Attrib.put("Save", Item.class.getMethod("getSave"),
293 Item.class.getMethod("setSave", pBool));
294 _Attrib.put("AutoStamp", Item.class.getMethod("getAutoStamp"),
295 Item.class.getMethod("setAutoStamp", pFloatO));
296 _Attrib.put("Width", Item.class.getMethod("getWidthToSave"),
297 Item.class.getMethod("setWidth", pIntO));
298 _Attrib.put("MinWidth", Item.class.getMethod("getMinWidthToSave"),
299 Item.class.getMethod("setMinWidth", pIntO));
300 _Attrib.put("X", null,
301 Item.class.getMethod("setX", pFloat));
302 _Attrib.put("Y", null,
303 Item.class.getMethod("setY", pFloat));
304 _Attrib.put("Tooltip", Item.class.getMethod("getTooltip"),
305 Item.class.getMethod("setTooltips", pList));
306 _Attrib.put("Permission", Item.class.getMethod("getPermission"),
307 Item.class.getMethod("setPermission", pPermission));
308 _Attrib.put("EncryptionLabel", Item.class.getMethod("getEncryptionLabel"),
309 Item.class.getMethod("setEncryptionLabel", pString));
310 _Attrib.put("ID", Item.class.getMethod("getID"),
311 Item.class.getMethod("setIDFail", pInt));
312
313 // Text Items
314 _Attrib.put("Family", Text.class.getMethod("getFamily"),
315 Text.class.getMethod("setFamily", pString));
316 _Attrib.put("FontStyle", Text.class.getMethod("getFontStyle"),
317 Text.class.getMethod("setFontStyle", pString));
318 _Attrib.put("Justification", Text.class.getMethod("getJustification"),
319 Text.class.getMethod("setJustification", pJustification));
320 _Attrib.put("AutoWrap", Text.class.getMethod("getAutoWrapToSave"),
321 Text.class.getMethod("setAutoWrap", pBool));
322
323 _Attrib.put("LineSpacing", Text.class.getMethod("getSpacing"),
324 Text.class.getMethod("setSpacing", pFloat));
325
326 _Attrib.put("LetterSpacing", Text.class.getMethod("getLetterSpacing"),
327 Text.class.getMethod("setLetterSpacing", pFloat));
328 _Attrib.put("Mask", Text.class.getMethod("getMask"),
329 Text.class.getMethod("setMask", pIntO));
330 _Attrib.put("Placeholder", Text.class.getMethod("getPlaceholder"),
331 Text.class.getMethod("setPlaceholder", pString));
332 _Attrib.put("SingleLineOnly", Text.class.getMethod("isSingleLineOnly"),
333 Text.class.getMethod("setSingleLineOnly", pBool));
334 _Attrib.put("TabIndex", Text.class.getMethod("getTabIndex"),
335 Text.class.getMethod("setTabIndex", pInt));
336 _Attrib.put("EnterClick", Item.class.getMethod("acceptsKeyboardEnter"),
337 Item.class.getMethod("setAcceptsEnter", pBool));
338
339 // Aliases for attribute setting
340 _Attrib.alias("pos", "position");
341 _Attrib.alias("p", "position");
342 _Attrib.alias("xy", "position");
343 _Attrib.alias("a", "action");
344 _Attrib.alias("d", "data");
345 _Attrib.alias("f", "formula");
346 _Attrib.alias("font", "family");
347 _Attrib.alias("s", "size");
348 _Attrib.alias("l", "link");
349 _Attrib.alias("at", "anchortop");
350 _Attrib.alias("ab", "anchorbottom");
351 _Attrib.alias("al", "anchorleft");
352 _Attrib.alias("ar", "anchorright");
353 _Attrib.alias("t", "thickness");
354 // _Attrib.alias("c", "color"); // breaks circle creation
355 _Attrib.alias("bgc", "backgroundcolor");
356 _Attrib.alias("bc", "bordercolor");
357 _Attrib.alias("fc", "fillcolor");
358 _Attrib.alias("gc", "gradientcolor");
359 _Attrib.alias("ga", "gradientangle");
360 _Attrib.alias("fp", "fillpattern");
361 _Attrib.alias("lm", "linkmark");
362 _Attrib.alias("am", "actionmark");
363 _Attrib.alias("dt", "dottype");
364 _Attrib.alias("fill", "filled");
365 _Attrib.alias("lp", "linepattern");
366 _Attrib.alias("lf", "linkframeset");
367 _Attrib.alias("lt", "linktemplate");
368 _Attrib.alias("face", "fontstyle");
369 _Attrib.alias("j", "justification");
370 _Attrib.alias("w", "width");
371 _Attrib.alias("mw", "minwidth");
372 _Attrib.alias("as", "autostamp");
373 } catch (SecurityException e) {
374 // TODO Auto-generated catch block
375 e.printStackTrace();
376 } catch (NoSuchMethodException e) {
377 // TODO Auto-generated catch block
378 e.printStackTrace();
379 }
380 }
381
382 /**
383 * Extracts a list of attributes from the given Item. Any method that
384 * starts with <code>get</code>, takes no arguments and is not found in
385 * the Ignore list will be run, All the attributes are then put into a Text
386 * Item of the form <Name>:<Value> If the value returned by the get method
387 * is null, then the attribute will not be included, unless the name of the
388 * method is found in the AllowNull list.
389 *
390 * @param toExtract
391 * The Object from which to extract the attributes
392 * @return A Text Item containing the extracted Attributes.
393 */
394 public static Item extractAttributes(Object toExtract) {
395
396 // System.out.println(toExtract);
397
398 if (toExtract == null) {
399 return null;
400 }
401
402 // Ensure the lists are populated
403 ensureReady();
404
405 AttributeSet attribSet = null;
406 if(toExtract instanceof Frame) {
407 attribSet = _FrameAttrib;
408 } else if(toExtract instanceof Item) {
409 attribSet = _Attrib;
410 } else {
411 throw new IncorrectTypeException("toExtract", "Item | Frame");
412 }
413
414 // StringBuffer to store all the extracted Attribute:Value pairs
415 StringBuffer attributes = new StringBuffer();
416
417 // iterate through the list of methods
418 for (String prop : attribSet.keys) {
419
420 Attribute a = attribSet.get(prop);
421 // Make sure the classes of the methods match the item
422 if (a != null && a.getter != null && a.getter.getDeclaringClass().isAssignableFrom(toExtract.getClass())) {
423 try {
424 String s = getValue(prop, a, toExtract, true);
425 if (s == null) {
426 continue;
427 }
428 // Append the attributes
429 attributes.append(a.displayName)
430 .append(AttributeValuePair.SEPARATOR_STRING)
431 .append(s).append('\n');
432 } catch (Exception e) {
433 // TODO Auto-generated catch block
434 e.printStackTrace();
435 }
436 }
437 }
438
439 // if no attributes were extracted
440 if (attributes.length() <= 0) {
441 return null;
442 }
443
444 while (attributes.charAt(attributes.length() - 1) == '\n') {
445 attributes.delete(attributes.length() - 1, attributes.length());
446 }
447
448 // create the text Item
449 Frame current = DisplayController.getCurrentFrame();
450 Item attribs = current.getStatsTextItem(attributes.toString());
451 return attribs;
452 }
453
454 /**
455 * Gets a string form of the value for a given item get method.
456 * @param method
457 * @param item
458 * @param ignore true if the attributes in the IGNORE list should be ignored
459 * @return
460 */
461 private static String getValue(String name, Attribute a, Object item, boolean ignore) {
462 // assert(method.getName().startsWith("get"));
463
464 Object o = null;
465 try {
466 o = a.getter.invoke(item, (Object[]) null);
467 } catch (IllegalArgumentException e) {
468 e.printStackTrace();
469 return null;
470 } catch (IllegalAccessException e) {
471 e.printStackTrace();
472 return null;
473 } catch (InvocationTargetException e) {
474 e.printStackTrace();
475 return null;
476 }
477
478 if (o == null) {
479 // methods that return null are only included if they
480 // are in the AllowNull list
481 if (_AllowNull.contains(a.getter)) {
482 if (name.equals("color")) {
483 o = "default";
484 } else if (name.equals("backgroundcolor")) {
485 o = "transparent";
486 } else if (name.equals("foregroundcolor")) {
487 o = "auto";
488 } else {
489 o = "";
490 }
491 } else {
492 return null;
493 }
494 }
495 // skip methods that are in the ignore lists
496 if (ignore && _IgnoreGet.contains(name)) {
497 return null;
498 }
499
500 if (o instanceof Integer) {
501 Integer i = (Integer) o;
502 if (i == Item.DEFAULT_INTEGER) {
503 return null;
504 }
505 if (a.getter.getName().endsWith("Justification")
506 && ((Justification) o).toString() != null) {
507 o = ((Justification) o).toString();
508 // -1 indicates default value
509 } else {
510 o = i;
511 }
512 } else if (o instanceof Float) {
513 if (((Float) o) < -0.0001)
514 {
515 return null;
516 // Null indicates default
517 // o = Math.round((Float) o);
518 }
519 } else if (o instanceof Double) {
520 // -1 indicates default value
521 if (((Double) o) < 0.0001) {
522 return null;
523 }
524 } else if (o instanceof Colour) {
525 // converts the color to the Expeditee code
526 o = Conversion.getExpediteeColorCode((Colour) o);
527 if (o == null) {
528 return null;
529 }
530 } else if (o instanceof Point) {
531 Point p = (Point) o;
532 o = Math.round(p.getX()) + " " + Math.round(p.getY());
533 } else if (o instanceof Font) {
534 Font f = (Font) o;
535
536 String s = f.getFamilyName() + "-";
537 if (f.isPlain()) {
538 s += "Plain";
539 }
540
541 if (f.isBold()) {
542 s += "Bold";
543 }
544
545 if (f.isItalic()) {
546 s += "Italic";
547 }
548
549 s += "-" + f.getSize();
550 o = s;
551 } else if (o instanceof Text) {
552 o = ((Text) o).getFirstLine();
553 } else if (o instanceof List) {
554 List list = (List) o;
555 StringBuffer sb = new StringBuffer();
556 for (Object ob : list) {
557 // TODO check that this works ok
558 if (sb.length() == 0) {
559 sb.append(ob);
560 } else {
561 sb.append('\n').append(a.displayName).append(AttributeValuePair.SEPARATOR_STRING).append(ob);
562 }
563 }
564 return sb.toString();
565 } else if (o instanceof int[]) {
566 StringBuffer sb = new StringBuffer();
567 int[] values = (int[]) o;
568 for (int i = 0; i < values.length; i++) {
569 sb.append(values[i]).append(' ');
570 }
571 sb.deleteCharAt(sb.length() - 1);
572 o = sb.toString();
573 } else if (o instanceof Boolean) {
574 try {
575 Class<?> parentClass = item.getClass();
576 Field defaultValueField = parentClass.getField(a.getter.getName() + "Default");
577 boolean defaultValue = defaultValueField.getBoolean(null);
578 if (defaultValue == (boolean) o) {
579 return null;
580 }
581 } catch (IllegalArgumentException e) {
582 e.printStackTrace();
583 } catch (SecurityException e) {
584 e.printStackTrace();
585 } catch (NoSuchFieldException e) {
586 // true is the default for boolean values when no other default is provided
587 if ((boolean) o) {
588 return null;
589 }
590 } catch (IllegalAccessException e) {
591 e.printStackTrace();
592 }
593 }
594 return o.toString();
595 }
596
597 /**
598 * Attempts to set the attribute in the given attribute: value pair. The
599 * value string should be formatted as follows:
600 * <code> Attribute: Value </code> Multiple values can be used if they are
601 * separated by spaces
602 *
603 * @param toSet
604 * The Item or Frame to set the attribute of
605 * @param attribs
606 * The Text item that contains the list of attributes to set
607 * @return True if the attribute(s) were sucessfully set, false otherwise
608 */
609 public static boolean setAttribute(Object toSet, Text attribs) {
610 return setAttribute(toSet, attribs, 1);
611 }
612
613 public static boolean setAttribute(Object toSet, Text attribs,
614 int minAttributeLength) {
615 // error checking
616 if (toSet == null || attribs == null) {
617 return false;
618 }
619
620 ensureReady();
621
622 AttributeSet attribSet = null;
623 if(toSet instanceof Frame) {
624 attribSet = _FrameAttrib;
625 } else if(toSet instanceof Item) {
626 attribSet = _Attrib;
627 } else {
628 throw new IncorrectTypeException("toExtract", "Item | Frame");
629 }
630
631 // if(attribs.isAnnotation())
632 // return false;
633
634 // get the list of attribute: value pairs
635 List<String> values = attribs.getTextList();
636 // if no pairs exist, we are done
637 if (values == null || values.size() == 0) {
638 return false;
639 }
640
641 // loop through all attribute: value pairs
642 for (int i = 0; i < values.size(); i++) {
643 AttributeValuePair avp = new AttributeValuePair(values.get(i),
644 false);
645
646 // If the first is not an attribute value pair then don't do
647 // attribute merging
648 if (!avp.hasAttribute()
649 || avp.getAttribute().length() < minAttributeLength) {
650 return false;
651 }
652
653 // check if the next string is another attribute to merge or a
654 // continuation
655 for (; i < values.size() - 1; i++) {
656 AttributeValuePair nextAvp = new AttributeValuePair(values
657 .get(i + 1), false);
658
659 // if the next String has a colon, then it may be another
660 // attribute
661 if (nextAvp.hasAttribute()) {
662 // if the attribute is the same as v, then it is a
663 // continuation
664 if (nextAvp.getAttribute().equals(avp.getAttribute())) {
665 // strip the attribute from next
666 avp.appendValue(nextAvp.getValue() + "\n");
667
668 // if the attribute is not the same, then it may be a
669 // new method
670 } else {
671 break;
672 }
673 }
674
675 // v.append("\n").append(next);
676 }
677
678 try {
679 if (!setAttribute(toSet, avp, values.size() > 1)) {
680
681 String stripped = avp.getAttribute();
682 if (!avp.hasPair()) {
683 // This happens when there is an attribute at the start
684 // Then a bunch of plain text
685 return false;
686 } else if (_IgnoreSet.contains(stripped)) {
687 return false;
688 } else {
689 Attribute a = attribSet.get(stripped);
690 if(a == null || a.setter == null) {
691 return false;
692 }
693 String types = "";
694 for (Class<?> c : a.setter.getParameterTypes()) {
695 types += c.getSimpleName() + " ";
696 }
697 MessageBay.warningMessage("Wrong arguments for: '"
698 + avp.getAttribute() + "' expecting "
699 + types.trim() + " found '" + avp.getValue() + "'");
700 }
701 }
702 } catch (AttributeException e) {
703 MessageBay.errorMessage(e.getMessage());
704 }
705 }
706
707 return true;
708 }
709
710 /**
711 * Sets a single attribute of a frame or item.
712 *
713 * @param toSet
714 * @param avp
715 * @param isAttributeList
716 * some properties are ignored when attribute list are injected
717 * into an item. These properties are ignored if this param is
718 * true
719 * @return
720 * @throws NoSuchAttributeException
721 */
722 private static boolean setAttribute(Object toSet, AttributeValuePair avp,
723 boolean isAttributeList) throws AttributeException {
724
725 assert (avp.hasAttribute());
726
727 // separate attribute and value from string
728 String attribute = avp.getAttribute().toLowerCase();
729
730 String value = avp.getValue();
731 assert (value != null);
732
733 AttributeSet attribSet = null;
734 if(toSet instanceof Frame) {
735 attribSet = _FrameAttrib;
736 } else if(toSet instanceof Item) {
737 attribSet = _Attrib;
738 } else {
739 throw new IncorrectTypeException("toExtract", "Item | Frame");
740 }
741
742 // Some properties are ignored when multiple attributes are being set on
743 // an item at the same time
744 if (isAttributeList && _IgnoreSet.contains(attribute)) {
745 // System.out.println("Attribute ignored: " + attribute);
746 return true;
747 }
748
749 // Separate multiple values if required
750
751 Attribute a = attribSet.get(attribute);
752 // if this is not the name of a method, it may be the name of an agent
753 if (a == null || a.setter == null) {
754 // System.out.println("Attrib not found for: " + attribute);
755 return false;
756 }
757
758 // if there are duplicate methods with the same name
759 List<Method> possibles = new LinkedList<Method>();
760 if (a.setter.getDeclaringClass().isInstance(toSet)) {
761 possibles.add(a.setter);
762 }
763 int i = 0;
764 while (attribSet.containsKey(attribute + i)) {
765 Method m = attribSet.get(attribute + i).setter;
766 if(m == null) {
767 break;
768 }
769 if (m.getDeclaringClass().isAssignableFrom(toSet.getClass())) {
770 possibles.add(m);
771 }
772 i++;
773 }
774
775 for (Method possible : possibles) {
776 Object current = invokeAttributeGetMethod(avp.getAttribute(), toSet);
777 // find the corresponding get method for this set method
778 // and get the current value of the attribute
779
780 try {
781 Object[] params = Conversion.Convert(possible, value, current);
782
783 try {
784 possible.invoke(toSet, params);
785 return true;
786 } catch (IllegalArgumentException e) {
787 // TODO Auto-generated catch block
788 e.printStackTrace();
789 } catch (IllegalAccessException e) {
790 // TODO Auto-generated catch block
791 e.printStackTrace();
792 } catch (InvocationTargetException e) {
793 MessageBay.displayMessage(toSet.getClass().getSimpleName()
794 + " type does not support that attribute.");
795 // e.printStackTrace();
796 }
797 } catch (NumberFormatException e) {
798
799 }
800 }
801
802 if(possibles.size() == 0){
803 if(invokeAttributeGetMethod(avp.getAttribute(), toSet) == null) {
804 throw new NoSuchAttributeException(avp.getAttribute(), toSet.getClass().getSimpleName());
805 }
806 throw new ReadOnlyAttributeException(avp.getAttribute(), toSet.getClass().getSimpleName());
807 }
808
809 return false;
810 }
811
812 private static Object invokeAttributeGetMethod(String name, Object toSet) {
813
814 AttributeSet attribSet = null;
815 if(toSet instanceof Frame) {
816 attribSet = _FrameAttrib;
817 } else if(toSet instanceof Item) {
818 attribSet = _Attrib;
819 } else {
820 throw new IncorrectTypeException("toExtract", "Item | Frame");
821 }
822
823 Attribute a = attribSet.get(name.toLowerCase());
824 if(a == null) {
825 return null;
826 }
827 try {
828 return a.getter.invoke(toSet);
829 } catch (Exception e) {
830 e.printStackTrace();
831 }
832 return null;
833 }
834
835 /**
836 * Replaces the current value for the text item with the new value.
837 *
838 * @param text
839 * the item whos value is to be changed
840 * @param newValue
841 * the new value for the item
842 */
843 public static void replaceValue(Text text, String newValue) {
844 assert (newValue != null);
845
846 AttributeValuePair avp = new AttributeValuePair(text.getText());
847
848 if (avp.getAttribute() == null) {
849 avp.setAttribute(avp.getValue());
850 }
851 avp.setValue(newValue);
852 text.setText(avp.toString());
853 }
854
855 public static String getAttribute(Item item, String attribute) {
856
857 // ensure the lists are populated
858 ensureReady();
859
860 // separate attribute and value from string
861 String lowerAttribute = attribute.trim().toLowerCase();
862
863 Attribute a = _Attrib.get(lowerAttribute);
864 if(a == null) {
865 MessageBay.errorMessage("Could no extract unknown attribute value: " + attribute);
866 return null;
867 }
868 return a.displayName + AttributeValuePair.SEPARATOR_STRING + getValue(lowerAttribute, a, item, false);
869 }
870}
Note: See TracBrowser for help on using the repository browser.