Changeset 12824

Timestamp:

2006-09-22T09:40:43+12:00 (18 years ago)

Author:

kjdon

Message:

changed option list form HashMap to ArrayList so they stay in order, added ArgumentOption class, which replaces ListOption from ArgumentControl

File:

• trunk/gli/src/org/greenstone/gatherer/cdm/Argument.java (modified) (10 diffs)

trunk/gli/src/org/greenstone/gatherer/cdm/Argument.java

@@ -42 +42 @@
 import org.greenstone.gatherer.metadata.MetadataTools;
 import org.greenstone.gatherer.util.StaticStrings;
+import org.greenstone.gatherer.util.Utility;
 import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
@@ -94 +95 @@
     private Element element;
     /** If the argument is of type ENUM then this map holds all the various options. Each entry is an <option value> -> <description> mapping. */
-    private HashMap list = null;
+    private ArrayList option_list = null;
     /** A default value for parameter-type arguments. May be a Perl pattern. */
     private String default_value = null;
@@ -117 +118 @@
     }
 
-    /** Method to add an element to the option list.
+    /** Method to add an element to the option_list.
      * @param name the name value of the option as a String
      * @param desc the description of this options as a String
@@ -126 +127 @@
         desc = "";
         }
-        if(list == null) {
-        list = new HashMap();
-        }
-        list.put(name, desc);
+        if(option_list == null) {
+        option_list = new ArrayList();
+        }
+        option_list.add(new ArgumentOption(name, desc));
     }
     }
@@ -154 +155 @@
     copy.setDefaultValue(default_value);
     copy.setDescription(description);
-    copy.setOptions(list);
+    copy.setOptions(option_list);
     copy.setOwner(owner);
     copy.setName(name);
@@ -188 +189 @@
     }
 
-    /** Method to retrieve the description of a certain list option value.
-     * @param key the String whose description we are searching for
-     * @return the description of the desired key as a String which may be empty if no such key exists
-     */
-    public String getDescription(String key) {
-    if(list.containsKey(key)) {
-        return (String)list.get(key);
-    }
-    return "";
-    }
-
     public Element getElement() {
     return element;
@@ -242 +232 @@
      * @return a HashMap containing <option value> -> <description> entries
      */
-    public HashMap getOptions() {
-    return list;
+    public ArrayList getOptions() {
+    return option_list;
     }
 
@@ -377 +367 @@
      * @param list the new options list as a HashMap
      */
-    public void setOptions(HashMap list) {
-    this.list = list;
+    public void setOptions(ArrayList list) {
+    this.option_list = list;
     }
 
@@ -416 +406 @@
     if(new_type.equalsIgnoreCase(StaticStrings.ENUM_STR)) {
         this.type = ENUM;
-        list = new HashMap();
+        option_list = new ArrayList();
     }
     else if(new_type.equalsIgnoreCase(StaticStrings.FLAG_STR)) {
@@ -626 +616 @@
     
     } // parseXML
+
+    public class ArgumentOption 
+    implements Comparable {
+    public String name;
+    public String description;
+    private String text; // cached version
+
+    public ArgumentOption(String name, String desc) {
+        this.name = name;
+        this.description = desc;
+    }
+    
+    public int compareTo(Object obj) {
+        return toString().compareTo(obj.toString());
+    }
+
+    public boolean equals(Object obj) {     
+        return (obj != null && compareTo(obj) == 0);
+    }
+    
+    public String toString() {
+        return name + " "+ StaticStrings.MINUS_CHARACTER + " "+ description;
+    }
+    
+    public String getToolTip() {
+        return Utility.formatHTMLWidth(name+": "+description, 80);
+    }
+    }
 }