Changeset 36592 for main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/Dictionary.java

Timestamp:

2022-09-08T11:08:46+12:00 (20 months ago)

Author:

kjdon

Message:

modified Dictionary, so that if a lang fragment starts with [PENDING], then don't use it. This is to allow the addition of old strings which will help the translators, but which are too out of date to display in the interface. OTher classes use of Dictionary modified so that they go through getTextString, or createDictionaryAndGetString, thereby benifitting from the pending stuff

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/Dictionary.java (modified) (10 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/Dictionary.java

@@ -32 +32 @@
     /** The default servlet dictionary */
     public static final String core_servlet_dictionary_name = "core_servlet_dictionary";
-    
+  /** Fallback language */
+  protected static final String fallback_language = "en";
+  /** THe string to mark a value as awaiting translator input */
+  public static final String PENDING_STR = "[PENDING]";
     /** The locale of this dictionary. */
     protected Locale locale = null;
@@ -39 +42 @@
     protected String resource = null;
 
-    /**
+    /**
      * The ResourceBundle which contains the raw key-value mappings. Loaded from
      * a file named "resource_locale.properties
@@ -225 +228 @@
             // with the resource as UTF-8, and so not conversion is needed
             String initial = this.raw.getString(key);
-
             // if we haven't been given any args, don't bother looking for them
             if (args == null)
@@ -244 +246 @@
     public static String getTextString(String key, String lang, String[] args, String dictionary_name, Class class_obj, String stop_at_class, ClassLoader class_loader)
   {
-
       if (dictionary_name == null && class_obj == null) {
       // no dictionary or class was specified, just use the default
@@ -253 +254 @@
       if (dictionary_name != null)
       {
-      // just try the one specified dictionary
-      Dictionary dict = new Dictionary(dictionary_name, lang, class_loader);
-      String result = dict.get(key, args);
-      if (result == null)
-      { // not found
-          
-          //logger.debug("couldn't find key in dict, "+dictionary_name+" "+key);
-          //return "_" + key + "_"; // should we use this??
-          return null;
-      }
-      return result;
+        // just try the one specified dictionary
+        return createDictionaryAndGetString(dictionary_name, class_loader, key, lang, args);
       }
 
@@ -269 +261 @@
       String original_class_name = class_obj.getName();
       original_class_name = original_class_name.substring(original_class_name.lastIndexOf('.') + 1);
-      Dictionary dict = new Dictionary(original_class_name, lang, class_loader);
-      String result = dict.get(key, args);
+      String result = createDictionaryAndGetString(original_class_name, class_loader, key, lang, args);
       if (result != null)
       {
@@ -288 +279 @@
           break;
       }
-      dict = new Dictionary(class_name, lang, class_loader);
-      result = dict.get(key, args);
+          result = createDictionaryAndGetString(class_name, class_loader, key, lang, args);
       if (result != null) {
           return result;
@@ -297 +287 @@
 
       // if we got here, class names were no help, try the default dictionary
-      dict = new Dictionary(core_servlet_dictionary_name, lang, class_loader);
 
       // First we try the key qualified with the original class name
@@ -303 +292 @@
       // default properties file)
       String full_key = original_class_name+"."+key;
-      result = dict.get(full_key, args);
+      result = createDictionaryAndGetString(core_servlet_dictionary_name, class_loader, full_key, lang, args);
       if (result == null) {
-      result = dict.get(key, args);
+        // try the key by itself without class qualified prefix
+        result = createDictionaryAndGetString(core_servlet_dictionary_name, class_loader, key, lang, args);
       }
       return result;
@@ -311 +301 @@
   }
 
+  public static String createDictionaryAndGetString(String dictionary_name, ClassLoader class_loader, String key, String lang, String[] args) {
+    Dictionary dict = new Dictionary(dictionary_name, lang, class_loader);
+    String result = dict.get(key, args);
+    // if we have a pending flag, then try the base language
+    if (result != null && result.startsWith(PENDING_STR) && !lang.equals(fallback_language)) {
+      dict = new Dictionary(dictionary_name, fallback_language, class_loader);
+      result = dict.get(key, args);
+    }
+    return result;
+  }
+  
+
+ 
 }