KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > ext > jython > JythonHashModel


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.jython;
54
55 import org.python.core.PyException;
56 import org.python.core.PyObject;
57
58 import freemarker.ext.util.ModelFactory;
59 import freemarker.template.ObjectWrapper;
60 import freemarker.template.TemplateCollectionModel;
61 import freemarker.template.TemplateHashModelEx;
62 import freemarker.template.TemplateModel;
63 import freemarker.template.TemplateModelException;
64
65 /**
66  * Model for Jython dictionaries ({@link org.python.core.PyDictionary}
67  * and {@link org.python.core.PyStringMap}).
68  * Note that the basic {@link JythonModel} already provides access to the
69  * {@link PyObject#__finditem__(String)} method. This class only adds
70  * {@link TemplateHashModelEx} functionality in a somewhat skewed way. One
71  * could say it even violates TemplateHashModelEx semantics, as both the
72  * returned keys and values are only those from the item mapping, while the
73  * <code>get()</code> method works for attributes as well. However, in practice
74  * when you ask for <code>dict?keys</code> inside a template, you'll really
75  * want to retrieve only items, not attributes so this is considered OK.
76  * @version $Id: JythonHashModel.java,v 1.14 2003/11/12 21:53:40 ddekany Exp $
77  * @author Attila Szegedi
78  */
79 public class JythonHashModel
80 extends
81     JythonModel
82 implements
83     TemplateHashModelEx
84 {
85     private static final String JavaDoc KEYS = "keys";
86     private static final String JavaDoc KEYSET = "keySet";
87     private static final String JavaDoc VALUES = "values";
88     
89     static final ModelFactory FACTORY =
90         new ModelFactory()
91         {
92             public TemplateModel create(Object JavaDoc object, ObjectWrapper wrapper)
93             {
94                 return new JythonHashModel((PyObject)object, (JythonWrapper)wrapper);
95             }
96         };
97         
98     public JythonHashModel(PyObject object, JythonWrapper wrapper)
99     {
100         super(object, wrapper);
101     }
102     
103     /**
104      * Returns {@link PyObject#__len__()}.
105      */
106     public int size() throws TemplateModelException
107     {
108         try
109         {
110             return object.__len__();
111         }
112         catch(PyException e)
113         {
114             throw new TemplateModelException(e);
115         }
116     }
117
118     /**
119      * Returns either <code>object.__findattr__("keys").__call__()</code>
120      * or <code>object.__findattr__("keySet").__call__()</code>.
121      */
122     public TemplateCollectionModel keys() throws TemplateModelException
123     {
124         try
125         {
126             PyObject method = object.__findattr__(KEYS);
127             if(method == null)
128             {
129                 method = object.__findattr__(KEYSET);
130             }
131             if(method != null)
132             {
133                 return (TemplateCollectionModel)wrapper.wrap(method.__call__());
134             }
135         }
136         catch(PyException e)
137         {
138             throw new TemplateModelException(e);
139         }
140         throw new TemplateModelException("'?keys' is not supported as there is no 'keys' nor 'keySet' attribute on an instance of " + object.__class__.__name__);
141     }
142
143     /**
144      * Returns <code>object.__findattr__("values").__call__()</code>.
145      */
146     public TemplateCollectionModel values() throws TemplateModelException
147     {
148         try
149         {
150             PyObject method = object.__findattr__(VALUES);
151             if(method != null)
152             {
153                 return (TemplateCollectionModel)wrapper.wrap(method.__call__());
154             }
155         }
156         catch(PyException e)
157         {
158             throw new TemplateModelException(e);
159         }
160         throw new TemplateModelException("'?values' is not supported as there is no 'values' attribute on an instance of " + object.__class__.__name__);
161     }
162 }
163
Popular Tags