KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > ext > beans > SimpleMapModel


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

52
53 package freemarker.ext.beans;
54
55 import java.util.List JavaDoc;
56 import java.util.Map JavaDoc;
57
58 import freemarker.ext.util.ModelFactory;
59 import freemarker.ext.util.WrapperTemplateModel;
60 import freemarker.core.CollectionAndSequence;
61 import freemarker.template.ObjectWrapper;
62 import freemarker.template.SimpleSequence;
63 import freemarker.template.TemplateCollectionModel;
64 import freemarker.template.TemplateHashModelEx;
65 import freemarker.template.TemplateMethodModelEx;
66 import freemarker.template.TemplateModel;
67 import freemarker.template.TemplateModelException;
68 import freemarker.template.WrappingTemplateModel;
69
70 /**
71  * Model used by {@link BeansWrapper} when <tt>simpleMapWrapper</tt>
72  * mode is enabled. Provides a simple hash model interface to the
73  * underlying map (does not copy like {@link freemarker.template.SimpleHash}),
74  * and a method interface to non-string keys.
75  * @author Chris Nokleberg
76  * @version $Id: SimpleMapModel.java,v 1.7 2004/01/06 17:06:42 szegedia Exp $
77  */

78 public class SimpleMapModel extends WrappingTemplateModel
79 implements TemplateHashModelEx, TemplateMethodModelEx, WrapperTemplateModel {
80     static final ModelFactory FACTORY =
81         new ModelFactory()
82         {
83             public TemplateModel create(Object JavaDoc object, ObjectWrapper wrapper)
84             {
85                 return new SimpleMapModel((Map JavaDoc)object, (BeansWrapper)wrapper);
86             }
87         };
88
89     private final Map JavaDoc map;
90     
91     public SimpleMapModel(Map JavaDoc map, BeansWrapper wrapper)
92     {
93         super(wrapper);
94         this.map = map;
95     }
96
97     public TemplateModel get(String JavaDoc key) throws TemplateModelException {
98         return wrap(map.get(key));
99     }
100     
101     public Object JavaDoc exec(List JavaDoc args) throws TemplateModelException {
102         Object JavaDoc key = ((BeansWrapper)getObjectWrapper()).unwrap((TemplateModel)args.get(0));
103         return wrap(map.get(key));
104     }
105
106     public boolean isEmpty() {
107         return map.isEmpty();
108     }
109
110     public int size() {
111         return map.size();
112     }
113
114     public TemplateCollectionModel keys() {
115         return new CollectionAndSequence(new SimpleSequence(map.keySet(), getObjectWrapper()));
116     }
117
118     public TemplateCollectionModel values() {
119         return new CollectionAndSequence(new SimpleSequence(map.values(), getObjectWrapper()));
120     }
121     
122     public Object JavaDoc getWrappedObject() {
123         return map;
124     }
125 }
126
Popular Tags