source/mir/misc/MessageMethodModel.java

   1 /*
   2  * Copyright (C) 2001, 2002  The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mir.misc;
  33
  34 import freemarker.template.SimpleScalar;
  35 import freemarker.template.TemplateMethodModel;
  36 import freemarker.template.TemplateModel;
  37 import org.apache.struts.util.MessageResources;
  38
  39 import java.util.List;
  40 import java.util.Locale;
  41
  42 /**
  43  * A FreeMarker <code>TemplateMethodModel</code> that provides access to a
  44  * Struts <code>MessageResources</code>, for use in Interantionalized templates.
  45  *
  46  * @author Kellan <kellan@protest.net>
  47  */
  48
  49 public class MessageMethodModel implements TemplateMethodModel {
  50
  51     /**
  52      * The perferred locale for this instance of MessageMethod.
  53      */
  54     private Locale locale;
  55
  56     /**
  57      * The MessageResources to query, a single instance shared for
  58      * the lifetime of servlet.
  59      */
  60     private MessageResources messages;
  61
  62
  63     /**
  64      * Construct a MessageMethod that uses the JVM's default locale.
  65      *
  66      * @param message The MessageResources object to query
  67      */
  68     public MessageMethodModel(MessageResources messages) {
  69         this(null, messages);
  70     }
  71
  72     /**
  73      * Construct a MessageMethod
  74      *
  75      * @param locale a Locale object, persumably initialized
  76      *               from users Accept-Language header field
  77      *
  78      * @param message The MessageResources object to query
  79      */
  80     public MessageMethodModel(Locale locale, MessageResources messages) {
  81         this.locale = locale;
  82         this.messages = messages;
  83     }
  84
  85
  86     /**
  87      * Takes the first argument as a resource key, then looks up
  88      * a string in the MessagesResources, based on that key, and the Locale
  89      *
  90      * TODO: error messages should be i18n :)
  91      *
  92      * @param arguments List passed in by FM, first arguement is a string used as the key
  93      *                  all subsequent arguments are used as described in MessageResources
  94      *                  (they are filled into the placehoders of the string being returned)
  95      */
  96     public TemplateModel exec(List arguments) {
  97         if (arguments != null) {
  98             String key = (String) arguments.get(0);
  99             arguments.remove(0);
 100             String mesg = messages.getMessage(locale, key, arguments.toArray());
 101
 102             if (mesg == null) {
 103                 return new SimpleScalar(errUnknownTag+key);
 104             }
 105             return new SimpleScalar(mesg);
 106         }
 107         else {
 108             return missingKeyScalar;
 109         }
 110     }
 111
 112     // i'm not real clear on how this is used - kellan :)
 113     public boolean isEmpty() {
 114         if (messages == null)
 115             return true;
 116         else
 117             return false;
 118     }
 119
 120     private static String errUnknownTag = "MESSAGE NOT FOUND: ";
 121     private static String missingKey = "MESSAGE CALL WITHOUT KEY";
 122     private static SimpleScalar missingKeyScalar =
 123             new SimpleScalar(missingKey);
 124 }