1 /**
2 * This file Copyright (c) 2003-2011 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.templating.freemarker;
35
36 import freemarker.ext.beans.BeanModel;
37 import freemarker.ext.beans.BeansWrapper;
38 import freemarker.template.ObjectWrapper;
39 import freemarker.template.SimpleHash;
40 import freemarker.template.TemplateModel;
41 import freemarker.template.TemplateModelException;
42 import info.magnolia.module.templating.RenderableDefinition;
43 import info.magnolia.freemarker.models.MagnoliaModelFactory;
44
45 /**
46 * Make parameters directly available (as if they were properties of the definition itself).
47 * i.e, if the RenderableDefinitionModel doesn't have a 'foo' bean-property, one can still do
48 * ${def.foo} or ${def['foo']}, which would be the equivalent of ${def.parameters.foo}
49 *
50 * @author pbracher
51 * @version $Id$
52 */
53 public class RenderableDefinitionModel extends BeanModel {
54 /**
55 * A factory for the enclosing type.
56 */
57 public static final class Factory implements MagnoliaModelFactory {
58 public Class factoryFor() {
59 return RenderableDefinition.class;
60 }
61
62 public TemplateModel create(Object object, ObjectWrapper wrapper) {
63 // make parameters directly available (as if they were properties of the definition itself)
64 return new RenderableDefinitionModel((RenderableDefinition) object, (BeansWrapper) wrapper);
65 }
66 }
67
68 /**
69 * The hash model for the parameters.
70 */
71 private final SimpleHash paramHash;
72
73 RenderableDefinitionModel(RenderableDefinition definition, BeansWrapper wrapper) {
74 super(definition, wrapper);
75 paramHash = new SimpleHash(definition.getParameters(), wrapper);
76 }
77
78 /**
79 * Fall back on the parameters' hash model if no bean property has been found.
80 */
81 public TemplateModel get(String key) throws TemplateModelException {
82 TemplateModel templateModel = super.get(key);
83 if (templateModel == null) {
84 templateModel = paramHash.get(key);
85 }
86 return templateModel;
87 }
88 }