1 package org.apache.turbine.modules.navigations;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 // ECS Classes
58 import org.apache.ecs.ConcreteElement;
59 import org.apache.ecs.StringElement;
60
61 // Turbine Classes
62 import org.apache.turbine.services.freemarker.FreeMarkerService;
63 import org.apache.turbine.services.TurbineServices;
64 import org.apache.turbine.util.RunData;
65
66 // FreeMarker Stuff
67 import freemarker.template.SimpleHash;
68
69
70 /***
71 * Sample FreeMarker Navigation. Navigations which use FreeMarker
72 * templates can extend this screen and override the doBuild method.
73 * For templates which require no database content, this Navigation
74 * may be adequate. In other cases, Navigations can override the
75 * doBuildTemplate method to add more data to the context.
76 *
77 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
78 * @version $Id: BaseFreeMarkerNavigation.java,v 1.1.1.1 2001/08/16 05:08:34 jvanzyl Exp $
79 * @deprecated you should use velocity
80 */
81 public class BaseFreeMarkerNavigation extends TemplateNavigation
82 {
83 /***
84 * Method to be overidden by subclasses to include data in the
85 * context.
86 *
87 * @param data, the Rundata object
88 * @param context, the context where the extra data is added.
89 * @exception Exception, a generic exception.
90 */
91 protected void doBuildTemplate(RunData data, SimpleHash context)
92 throws Exception
93 {
94 }
95
96
97 /***
98 * Needs to be implemented to make TemplateNavigation like us.
99 * The actual method that you should override is the one with the
100 * context in the parameter list.
101 *
102 * @param data Turbine information.
103 * @exception Exception, a generic exception.
104 */
105 protected void doBuildTemplate( RunData data )
106 throws Exception
107 {
108 doBuildTemplate( data, getContext(data) );
109 }
110
111 /***
112 * Return the model needed by FreeMarker. This is where
113 * information needed by the template should be placed.
114 *
115 * @param data Turbine information.
116 * @return SimpleHash
117 */
118 protected SimpleHash getContext(RunData data)
119 {
120 // Attempt to get it from the TemplateInfo first. If it
121 // doesn't exist, create it and then stuff it into the
122 // TemplateInfo.
123 SimpleHash context = (SimpleHash)data.getTemplateInfo()
124 .getTemplateContext(FreeMarkerService.CONTEXT);
125 if (context == null)
126 {
127 FreeMarkerService fm = (FreeMarkerService)TurbineServices
128 .getInstance().getService(FreeMarkerService.SERVICE_NAME);
129 context = fm.getContext();
130 data.getTemplateInfo()
131 .setTemplateContext(FreeMarkerService.CONTEXT, context);
132 }
133 return context;
134 }
135
136 /***
137 * Build the template.
138 *
139 * @param data Turbine information.
140 * @return A ConcreteElement.
141 * @exception Exception, a generic exception.
142 */
143 public ConcreteElement buildTemplate(RunData data)
144 throws Exception
145 {
146 SimpleHash context = getContext(data);
147 String templateName = data.getTemplateInfo().getNavigationTemplate();
148 FreeMarkerService fm = (FreeMarkerService)
149 TurbineServices.getInstance()
150 .getService(FreeMarkerService.SERVICE_NAME);
151
152 StringElement output = new StringElement();
153 output.setFilterState(false);
154 output.addElement(
155 fm.handleRequest(context, "navigations/" + templateName, true));
156 return output;
157 }
158 }
This page was automatically generated by Maven