X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FMessageManager.java;h=2852364455f1f272da6b206b3d093c8064ec81b7;hb=915c9e36bbe05968b0b128667803387f322d9f29;hp=fcf2bfa4bf758ca36e9c16ffbc1dc08aaed535fa;hpb=04fa137fb5fba17c15133cb7b7d1b7706d99ea0d;p=jalview.git

diff --git a/src/jalview/util/MessageManager.java b/src/jalview/util/MessageManager.java
index fcf2bfa..2852364 100644
--- a/src/jalview/util/MessageManager.java
+++ b/src/jalview/util/MessageManager.java
@@ -1,67 +1,152 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.util;
 
 import java.text.MessageFormat;
+import java.util.HashSet;
 import java.util.Locale;
 import java.util.ResourceBundle;
-import java.util.logging.Level;
-import java.util.logging.Logger;
+import java.util.ResourceBundle.Control;
+import java.util.Set;
+
+import org.apache.log4j.Logger;
 
 /**
  * 
  * @author David Roldan Martinez
  * @author Thomas Abeel
  * 
- *
+ * 
  */
-public class MessageManager {
-
-	private static ResourceBundle rb;    
-		
-	private static Logger log=Logger.getLogger(MessageManager.class.getCanonicalName());
-	
-	private static Locale loc;
-	
-	
-	
-    static{
-      try {
-    	/* Localize Java dialogs */
-        loc = Locale.getDefault();
-    	// Locale.setDefault(loc);
-    	/* Getting messages for GV */
-    	log.info("Getting messages for lang: "+loc);
-        rb = ResourceBundle.getBundle("lang.Messages", loc);
-        if (log.isLoggable(Level.FINEST)) {
-          // this might take a while, so we only do it if it will be shown
-          log.finest("Language keys: "+rb.keySet());
-        }
-      } catch (Exception q) {
-        log.warning("Exception when initting Locale for i18n messages\n"+q.getMessage());
-        q.printStackTrace();
-      }
-      catch (Error v)
-      {
-        log.warning("Error when initting Locale for i18n messages\n"+v.getMessage());
-        v.printStackTrace();
-      }
-      
-     
+public class MessageManager
+{
+
+  // BH 2018 switched to org.apache.llog4j.Logger
+
+  private static ResourceBundle rb;
+
+  private static Logger log = Logger
+          .getLogger(MessageManager.class.getCanonicalName());
+
+  private static Locale loc;
+
+  private static Set<String> reportedMissing = new HashSet<>();
+
+  static
+  {
+    try
+    {
+      /* Localize Java dialogs */
+      loc = Locale.getDefault();
+      // Locale.setDefault(loc);
+      /* Getting messages for GV */
+      log.info("Getting messages for lang: " + loc);
+      Control control = Control.getControl(Control.FORMAT_PROPERTIES);
+      rb = ResourceBundle.getBundle("lang.Messages", loc, control);
+      // if (log.isLoggable(Level.FINEST))
+      // {
+      // // this might take a while, so we only do it if it will be shown
+      // log.info("Language keys: " + rb.keySet()); // was FINEST
+      // }
+    } catch (Exception q)
+    {
+      log.warn("Exception when initting Locale for i18n messages\n"
+              + q.getMessage());
+      q.printStackTrace();
+    } catch (Error v)
+    {
+      log.warn("Error when initting Locale for i18n messages\n"
+              + v.getMessage());
+      v.printStackTrace();
     }
-    
-    public static String getString(String key){
-    	String value = "[missing key] " + key;
-    	try{
-    		value = rb.getString(key);
-    	}catch(Exception e){
-    	  log.warning("I18N missing: "+loc+"\t"+key);
-    	}
-    	return value;
+
+  }
+
+  public static String getString(String key)
+  {
+    String value = "[missing key] " + key;
+    try
+    {
+      value = rb.getString(key);
+    } catch (Exception e)
+    {
+      String msg = "I18N missing: " + loc + "\t" + key;
+	  logWarning(key, msg);
     }
-    
-	public static Locale getLocale() {
-		return loc;
-	}
-	public static String formatMessage(String key, Object[] params){
-		return MessageFormat.format(rb.getString(key), params);
+    return value;
+  }
+
+  public static Locale getLocale()
+  {
+    return loc;
+  }
+
+  public static String formatMessage(String key, Object... params)
+  {
+    return MessageFormat.format(getString(key), params);
+  }
+
+  public static String formatMessage(String key, String[] params)
+  {
+    return MessageFormat.format(getString(key), (Object[]) params);
+  }
+
+  /**
+   * Looks up and returns a key given a root and a human-readable(ish) name that
+   * when combined might resolve to an i18n string. If the key doesn't resolve,
+   * then name is returned. Use this for programmatically constructed keys that
+   * have a human readable alternative used in the program (e.g. BLOSUM62 and
+   * label.score_blosum62).
+   * 
+   * @param keyroot
+   * @param name
+   * @return
+   */
+  public static String getStringOrReturn(String keyroot, String name)
+  {
+    String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
+    try
+    {
+      name = rb.getString(smkey);
+    } catch (Exception x)
+    {
+      String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
+		          + smkey;
+	  logWarning(smkey, msg);
+    }
+    return name;
+  }
+
+  /**
+   * Logs missing keys (each key once only per run)
+   * 
+   * @param key
+   * @param msg
+   */
+  private static void logWarning(String key, String msg) 
+  {
+	if (!reportedMissing.contains(key))
+	{
+      reportedMissing.add(key);
+	  log.info(msg);
 	}
+  }
 }