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.jython;
054:
055: import org.python.core.PyException;
056: import org.python.core.PyObject;
057:
058: import freemarker.ext.util.ModelFactory;
059: import freemarker.template.ObjectWrapper;
060: import freemarker.template.TemplateCollectionModel;
061: import freemarker.template.TemplateHashModelEx;
062: import freemarker.template.TemplateModel;
063: import freemarker.template.TemplateModelException;
064:
065: /**
066: * Model for Jython dictionaries ({@link org.python.core.PyDictionary}
067: * and {@link org.python.core.PyStringMap}).
068: * Note that the basic {@link JythonModel} already provides access to the
069: * {@link PyObject#__finditem__(String)} method. This class only adds
070: * {@link TemplateHashModelEx} functionality in a somewhat skewed way. One
071: * could say it even violates TemplateHashModelEx semantics, as both the
072: * returned keys and values are only those from the item mapping, while the
073: * <code>get()</code> method works for attributes as well. However, in practice
074: * when you ask for <code>dict?keys</code> inside a template, you'll really
075: * want to retrieve only items, not attributes so this is considered OK.
076: * @version $Id: JythonHashModel.java,v 1.14 2003/11/12 21:53:40 ddekany Exp $
077: * @author Attila Szegedi
078: */
079: public class JythonHashModel extends JythonModel implements
080: TemplateHashModelEx {
081: private static final String KEYS = "keys";
082: private static final String KEYSET = "keySet";
083: private static final String VALUES = "values";
084:
085: static final ModelFactory FACTORY = new ModelFactory() {
086: public TemplateModel create(Object object, ObjectWrapper wrapper) {
087: return new JythonHashModel((PyObject) object,
088: (JythonWrapper) wrapper);
089: }
090: };
091:
092: public JythonHashModel(PyObject object, JythonWrapper wrapper) {
093: super (object, wrapper);
094: }
095:
096: /**
097: * Returns {@link PyObject#__len__()}.
098: */
099: public int size() throws TemplateModelException {
100: try {
101: return object.__len__();
102: } catch (PyException e) {
103: throw new TemplateModelException(e);
104: }
105: }
106:
107: /**
108: * Returns either <code>object.__findattr__("keys").__call__()</code>
109: * or <code>object.__findattr__("keySet").__call__()</code>.
110: */
111: public TemplateCollectionModel keys() throws TemplateModelException {
112: try {
113: PyObject method = object.__findattr__(KEYS);
114: if (method == null) {
115: method = object.__findattr__(KEYSET);
116: }
117: if (method != null) {
118: return (TemplateCollectionModel) wrapper.wrap(method
119: .__call__());
120: }
121: } catch (PyException e) {
122: throw new TemplateModelException(e);
123: }
124: throw new TemplateModelException(
125: "'?keys' is not supported as there is no 'keys' nor 'keySet' attribute on an instance of "
126: + object.__class__.__name__);
127: }
128:
129: /**
130: * Returns <code>object.__findattr__("values").__call__()</code>.
131: */
132: public TemplateCollectionModel values()
133: throws TemplateModelException {
134: try {
135: PyObject method = object.__findattr__(VALUES);
136: if (method != null) {
137: return (TemplateCollectionModel) wrapper.wrap(method
138: .__call__());
139: }
140: } catch (PyException e) {
141: throw new TemplateModelException(e);
142: }
143: throw new TemplateModelException(
144: "'?values' is not supported as there is no 'values' attribute on an instance of "
145: + object.__class__.__name__);
146: }
147: }
|