1 package org.apache.turbine.services.freemarker;
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 import freemarker.template.SimpleScalar;
58 import freemarker.template.TemplateMethodModel;
59 import freemarker.template.TemplateModel;
60 import freemarker.template.TemplateModelException;
61 import java.util.List;
62 import org.apache.turbine.util.RunData;
63
64 /***
65 * Returns output of a Navigation module. Extension of FreeMarker.
66 *
67 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
68 * @version $Id: NavigationModel.java,v 1.4 2002/07/11 16:53:28 mpoeschl Exp $
69 * @deprecated
70 */
71 public class NavigationModel
72 implements TemplateMethodModel
73 {
74 private RunData data;
75
76 /***
77 * Constructor
78 *
79 * @param data Turbine information.
80 */
81 public NavigationModel(RunData data)
82 {
83 this.data = data;
84 }
85
86 /***
87 * Method called by FreeMarker Template. A single argument which
88 * is the path to the navigation template is expected.
89 *
90 * @param args, A List of Strings passed from the template.
91 * @return A String representation of the Navigation contents.
92 * @exception TemplateModelException.
93 */
94 public TemplateModel exec(List args)
95 throws TemplateModelException
96 {
97 String template = (String)args.get(0);
98 data.getTemplateInfo().setNavigationTemplate(template);
99
100 String module = null;
101 String returnValue = null;
102
103 /*
104
105 try
106 {
107 module = ((TemplateService)TurbineServices.getInstance().getService(
108 TemplateService.SERVICE_NAME)).getNavigationName(template);
109 returnValue = Turbine.getModuleLoader()
110 .getModule(Turbine.NAVIGATIONS, module).evaluate(data); }
111 catch (Exception e)
112 {
113 String message = "Error processing navigation template:" +
114 template + " using module: " + module;
115 Log.error(message, e);
116 returnValue = message;
117 }
118
119 */
120
121 return new SimpleScalar(returnValue);
122
123 }
124
125 /***
126 * Required method in TemplateMethodModel, not implemented.
127 *
128 * @return Always false.
129 */
130 public boolean isEmpty()
131 {
132 return false;
133 }
134 }
This page was automatically generated by Maven