001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.ext.beans;
054:
055: import java.util.List;
056: import java.util.Map;
057: import java.util.Set;
058:
059: import freemarker.ext.util.ModelFactory;
060: import freemarker.template.ObjectWrapper;
061: import freemarker.template.TemplateMethodModelEx;
062: import freemarker.template.TemplateModel;
063: import freemarker.template.TemplateModelException;
064:
065: /**
066: * <p>A special case of {@link BeanModel} that adds implementation
067: * for {@link TemplateMethodModelEx} on map objects that is a shortcut for the
068: * <tt>Map.get()</tt> method. Note that if the passed argument itself is a
069: * reflection-wrapper model, then the map lookup will be performed using the
070: * wrapped object as the key. Note that you can call <tt>get()</tt> using the
071: * <tt>map.key</tt> syntax inherited from {@link BeanModel} as well,
072: * however in that case the key is always a string.</p>
073: * <p>The class itself does not implement the {@link freemarker.template.TemplateCollectionModel}.
074: * You can, however use <tt>map.entrySet()</tt>, <tt>map.keySet()</tt>, or
075: * <tt>map.values()</tt> to obtain {@link freemarker.template.TemplateCollectionModel} instances for
076: * various aspects of the map.</p>
077: * @author Attila Szegedi
078: * @version $Id: MapModel.java,v 1.26.2.3 2006/02/26 18:26:37 revusky Exp $
079: */
080: public class MapModel extends StringModel implements
081: TemplateMethodModelEx {
082: static final ModelFactory FACTORY = new ModelFactory() {
083: public TemplateModel create(Object object, ObjectWrapper wrapper) {
084: return new MapModel((Map) object, (BeansWrapper) wrapper);
085: }
086: };
087:
088: /**
089: * Creates a new model that wraps the specified map object.
090: * @param map the map object to wrap into a model.
091: * @param wrapper the {@link BeansWrapper} associated with this model.
092: * Every model has to have an associated {@link BeansWrapper} instance. The
093: * model gains many attributes from its wrapper, including the caching
094: * behavior, method exposure level, method-over-item shadowing policy etc.
095: */
096: public MapModel(Map map, BeansWrapper wrapper) {
097: super (map, wrapper);
098: }
099:
100: /**
101: * The first argument is used as a key to call the map's <tt>get</tt> method.
102: */
103: public Object exec(List arguments) throws TemplateModelException {
104: Object key = unwrap((TemplateModel) arguments.get(0));
105: return wrap(((Map) object).get(key));
106: }
107:
108: /**
109: * Overridden to invoke the generic get method by casting to Map instead of
110: * through reflection - should yield better performance.
111: */
112: protected TemplateModel invokeGenericGet(Map keyMap, Class clazz,
113: String key) throws TemplateModelException {
114: Map map = (Map) object;
115: Object val = map.get(key);
116: if (val == null && key.length() == 1) {
117: // just check for Character key if this is a single-character string
118: try {
119: val = map.get(new Character(key.charAt(0)));
120: } catch (Exception e) {
121: }
122: }
123: return wrap(val);
124: }
125:
126: public boolean isEmpty() {
127: return ((Map) object).isEmpty() && super .isEmpty();
128: }
129:
130: public int size() {
131: return keySet().size();
132: }
133:
134: protected Set keySet() {
135: Set set = super .keySet();
136: set.addAll(((Map) object).keySet());
137: return set;
138: }
139: }
|