src/main/java/freemarker/ext/beans/ResourceBundleModel.java - freemarker - Git at Google

 /*
  * Copyright (c) 2003 The Visigoth Software Society. All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
  *    any, must include the following acknowledgement:
  *       "This product includes software developed by the
  *        Visigoth Software Society (http://www.visigoths.org/)."
  *    Alternately, this acknowledgement may appear in the software itself,
  *    if and wherever such third-party acknowledgements normally appear.
  *
  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
  *    project contributors may be used to endorse or promote products derived
  *    from this software without prior written permission. For written
  *    permission, please contact visigoths@visigoths.org.
  *
  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
  *    nor may "FreeMarker" or "Visigoth" appear in their names
  *    without prior written permission of the Visigoth Software Society.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Visigoth Software Society. For more
  * information on the Visigoth Software Society, please see
  * http://www.visigoths.org/
  */

 package freemarker.ext.beans;

 import java.text.MessageFormat;
 import java.util.Enumeration;
 import java.util.Hashtable;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.MissingResourceException;
 import java.util.ResourceBundle;
 import java.util.Set;

 import freemarker.ext.util.ModelFactory;
 import freemarker.template.ObjectWrapper;
 import freemarker.template.TemplateMethodModelEx;
 import freemarker.template.TemplateModel;
 import freemarker.template.TemplateModelException;

 /**
  * <p>A hash model that wraps a resource bundle. Makes it convenient to store
  * localized content in the data model. It also acts as a method model that will
  * take a resource key and arbitrary number of arguments and will apply
  * {@link MessageFormat} with arguments on the string represented by the key.</p>
  *
  * <p>Typical usages:</p>
  * <ul>
  * <li><tt>bundle.resourceKey</tt> will retrieve the object from resource bundle
  * with key <tt>resourceKey</tt></li>
  * <li><tt>bundle("patternKey", arg1, arg2, arg3)</tt> will retrieve the string
  * from resource bundle with key <tt>patternKey</tt>, and will use it as a pattern
  * for MessageFormat with arguments arg1, arg2 and arg3</li>
  * </ul>
  * @author Attila Szegedi
  */
 public class ResourceBundleModel
     extends
     BeanModel
     implements
     TemplateMethodModelEx
 {
     static final ModelFactory FACTORY =
         new ModelFactory()
         {
             public TemplateModel create(Object object, ObjectWrapper wrapper)
             {
                 return new ResourceBundleModel((ResourceBundle)object, (BeansWrapper)wrapper);
             }
         };

     private Hashtable formats = null;

     public ResourceBundleModel(ResourceBundle bundle, BeansWrapper wrapper)
     {
         super(bundle, wrapper);
     }

     /**
      * Overridden to invoke the getObject method of the resource bundle.
      */
     protected TemplateModel invokeGenericGet(Map keyMap, Class clazz, String key)
     throws
     	TemplateModelException
     {
         try
         {
             return wrap(((ResourceBundle)object).getObject(key));
         }
         catch(MissingResourceException e)
         {
             throw new TemplateModelException("No such key: " + key);
         }
     }

     /**
      * Returns true if this bundle contains no objects.
      */
     public boolean isEmpty()
     {
         return !((ResourceBundle)object).getKeys().hasMoreElements() &&
             super.isEmpty();
     }

     public int size()
     {
         return keySet().size();
     }

     protected Set keySet()
     {
         Set set = super.keySet();
         Enumeration e = ((ResourceBundle)object).getKeys();
         while (e.hasMoreElements()) {
             set.add(e.nextElement());
         }
         return set;
     }

     /**
      * Takes first argument as a resource key, looks up a string in resource bundle
      * with this key, then applies a MessageFormat.format on the string with the
      * rest of the arguments. The created MessageFormats are cached for later reuse.
      */
     public Object exec(List arguments)
         throws
         TemplateModelException
     {
         // Must have at least one argument - the key
         if(arguments.size() < 1)
             throw new TemplateModelException("No message key was specified");
         // Read it
         Iterator it = arguments.iterator();
         String key = unwrap((TemplateModel)it.next()).toString();
         try
         {
             if(!it.hasNext())
             {
                 return wrap(((ResourceBundle)object).getObject(key));
             }

             // Copy remaining arguments into an Object[]
             int args = arguments.size() - 1;
             Object[] params = new Object[args];
             for(int i = 0; i < args; ++i)
                 params[i] = unwrap((TemplateModel)it.next());

             // Invoke format
             return new StringModel(format(key, params), wrapper);
         }
         catch(MissingResourceException e)
         {
             throw new TemplateModelException("No such key: " + key);
         }
         catch(Exception e)
         {
             throw new TemplateModelException(e.getMessage());
         }
     }

     /**
      * Provides direct access to caching format engine from code (instead of from script).
      */
     public String format(String key, Object[] params)
         throws
         MissingResourceException
     {
         // Check to see if we already have a cache for message formats
         // and construct it if we don't
         // NOTE: this block statement should be synchronized. However
         // concurrent creation of two caches will have no harmful
         // consequences, and we avoid a performance hit.
         /* synchronized(this) */
         {
             if(formats == null)
                 formats = new Hashtable();
         }

         MessageFormat format = null;
         // Check to see if we already have a requested MessageFormat cached
         // and construct it if we don't
         // NOTE: this block statement should be synchronized. However
         // concurrent creation of two formats will have no harmful
         // consequences, and we avoid a performance hit.
         /* synchronized(formats) */
         {
             format = (MessageFormat)formats.get(key);
             if(format == null)
             {
                 format = new MessageFormat(((ResourceBundle)object).getString(key));
                 format.setLocale(getBundle().getLocale());
                 formats.put(key, format);
             }
         }

         // Perform the formatting. We synchronize on it in case it
         // contains date formatting, which is not thread-safe.
         synchronized(format)
         {
             return format.format(params);
         }
     }

     public ResourceBundle getBundle()
     {
         return (ResourceBundle)object;
     }
 }
	/*
	* Copyright (c) 2003 The Visigoth Software Society. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution, if
	* any, must include the following acknowledgement:
	* "This product includes software developed by the
	* Visigoth Software Society (http://www.visigoths.org/)."
	* Alternately, this acknowledgement may appear in the software itself,
	* if and wherever such third-party acknowledgements normally appear.
	*
	* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
	* project contributors may be used to endorse or promote products derived
	* from this software without prior written permission. For written
	* permission, please contact visigoths@visigoths.org.
	*
	* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
	* nor may "FreeMarker" or "Visigoth" appear in their names
	* without prior written permission of the Visigoth Software Society.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Visigoth Software Society. For more
	* information on the Visigoth Software Society, please see
	* http://www.visigoths.org/
	*/

	package freemarker.ext.beans;

	import java.text.MessageFormat;
	import java.util.Enumeration;
	import java.util.Hashtable;
	import java.util.Iterator;
	import java.util.List;
	import java.util.Map;
	import java.util.MissingResourceException;
	import java.util.ResourceBundle;
	import java.util.Set;

	import freemarker.ext.util.ModelFactory;
	import freemarker.template.ObjectWrapper;
	import freemarker.template.TemplateMethodModelEx;
	import freemarker.template.TemplateModel;
	import freemarker.template.TemplateModelException;

	/**
	* <p>A hash model that wraps a resource bundle. Makes it convenient to store
	* localized content in the data model. It also acts as a method model that will
	* take a resource key and arbitrary number of arguments and will apply
	* {@link MessageFormat} with arguments on the string represented by the key.</p>
	*
	* <p>Typical usages:</p>
	* <ul>
	* <li><tt>bundle.resourceKey</tt> will retrieve the object from resource bundle
	* with key <tt>resourceKey</tt></li>
	* <li><tt>bundle("patternKey", arg1, arg2, arg3)</tt> will retrieve the string
	* from resource bundle with key <tt>patternKey</tt>, and will use it as a pattern
	* for MessageFormat with arguments arg1, arg2 and arg3</li>
	* </ul>
	* @author Attila Szegedi
	*/
	public class ResourceBundleModel
	extends
	BeanModel
	implements
	TemplateMethodModelEx
	{
	static final ModelFactory FACTORY =
	new ModelFactory()
	{
	public TemplateModel create(Object object, ObjectWrapper wrapper)
	{
	return new ResourceBundleModel((ResourceBundle)object, (BeansWrapper)wrapper);
	}
	};

	private Hashtable formats = null;

	public ResourceBundleModel(ResourceBundle bundle, BeansWrapper wrapper)
	{
	super(bundle, wrapper);
	}

	/**
	* Overridden to invoke the getObject method of the resource bundle.
	*/
	protected TemplateModel invokeGenericGet(Map keyMap, Class clazz, String key)
	throws
	TemplateModelException
	{
	try
	{
	return wrap(((ResourceBundle)object).getObject(key));
	}
	catch(MissingResourceException e)
	{
	throw new TemplateModelException("No such key: " + key);
	}
	}

	/**
	* Returns true if this bundle contains no objects.
	*/
	public boolean isEmpty()
	{
	return !((ResourceBundle)object).getKeys().hasMoreElements() &&
	super.isEmpty();
	}

	public int size()
	{
	return keySet().size();
	}

	protected Set keySet()
	{
	Set set = super.keySet();
	Enumeration e = ((ResourceBundle)object).getKeys();
	while (e.hasMoreElements()) {
	set.add(e.nextElement());
	}
	return set;
	}

	/**
	* Takes first argument as a resource key, looks up a string in resource bundle
	* with this key, then applies a MessageFormat.format on the string with the
	* rest of the arguments. The created MessageFormats are cached for later reuse.
	*/
	public Object exec(List arguments)
	throws
	TemplateModelException
	{
	// Must have at least one argument - the key
	if(arguments.size() < 1)
	throw new TemplateModelException("No message key was specified");
	// Read it
	Iterator it = arguments.iterator();
	String key = unwrap((TemplateModel)it.next()).toString();
	try
	{
	if(!it.hasNext())
	{
	return wrap(((ResourceBundle)object).getObject(key));
	}

	// Copy remaining arguments into an Object[]
	int args = arguments.size() - 1;
	Object[] params = new Object[args];
	for(int i = 0; i < args; ++i)
	params[i] = unwrap((TemplateModel)it.next());

	// Invoke format
	return new StringModel(format(key, params), wrapper);
	}
	catch(MissingResourceException e)
	{
	throw new TemplateModelException("No such key: " + key);
	}
	catch(Exception e)
	{
	throw new TemplateModelException(e.getMessage());
	}
	}

	/**
	* Provides direct access to caching format engine from code (instead of from script).
	*/
	public String format(String key, Object[] params)
	throws
	MissingResourceException
	{
	// Check to see if we already have a cache for message formats
	// and construct it if we don't
	// NOTE: this block statement should be synchronized. However
	// concurrent creation of two caches will have no harmful
	// consequences, and we avoid a performance hit.
	/* synchronized(this) */
	{
	if(formats == null)
	formats = new Hashtable();
	}

	MessageFormat format = null;
	// Check to see if we already have a requested MessageFormat cached
	// and construct it if we don't
	// NOTE: this block statement should be synchronized. However
	// concurrent creation of two formats will have no harmful
	// consequences, and we avoid a performance hit.
	/* synchronized(formats) */
	{
	format = (MessageFormat)formats.get(key);
	if(format == null)
	{
	format = new MessageFormat(((ResourceBundle)object).getString(key));
	format.setLocale(getBundle().getLocale());
	formats.put(key, format);
	}
	}

	// Perform the formatting. We synchronize on it in case it
	// contains date formatting, which is not thread-safe.
	synchronized(format)
	{
	return format.format(params);
	}
	}

	public ResourceBundle getBundle()
	{
	return (ResourceBundle)object;
	}
	}