1 package org.apache.turbine.util.template;
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 org.apache.ecs.ConcreteElement;
58 import org.apache.turbine.modules.NavigationLoader;
59 import org.apache.turbine.services.TurbineServices;
60 import org.apache.turbine.services.template.TemplateService;
61 import org.apache.turbine.util.Log;
62 import org.apache.turbine.util.RunData;
63
64 /***
65 * Returns output of a Navigation module. An instance of this is
66 * placed in the WebMacro context by the WebMacroSiteLayout. This
67 * allows template authors to set the navigation template they'd like
68 * to place in their templates. Here's how it's used in a
69 * template:
70 *
71 * <p><code>
72 * $navigation.setTemplate("admin_navigation.wm")
73 * </code>
74 *
75 * @author <a href="mbryson@mont.mindspring.com">Dave Bryson</a>
76 * @version $Id: TemplateNavigation.java,v 1.2 2002/07/11 16:53:19 mpoeschl Exp $
77 */
78 public class TemplateNavigation
79 {
80 /* The RunData object. */
81 private RunData data;
82
83 /* The name of the navigation template. */
84 private String template;
85
86
87 /***
88 * Constructor
89 *
90 * @param data A Turbine RunData object.
91 */
92 public TemplateNavigation(RunData data)
93 {
94 this.data = data;
95 }
96
97 /***
98 * Set the template.
99 *
100 * @param template A String with the name of the navigation
101 * template.
102 * @return A TemplateNavigation (self).
103 */
104 public TemplateNavigation setTemplate(String template)
105 {
106 this.template = template;
107 return this;
108 }
109
110 /***
111 * Builds the output of the navigation template.
112 *
113 * @return A String.
114 */
115 public String toString()
116 {
117 data.getTemplateInfo().setNavigationTemplate(this.template);
118 String module = null;
119 String returnValue = null;
120 try
121 {
122 module = ((TemplateService) TurbineServices.getInstance()
123 .getService(TemplateService.SERVICE_NAME))
124 .getNavigationName(template);
125 ConcreteElement results = NavigationLoader.getInstance()
126 .eval(data, module);
127 returnValue = results.toString();
128 }
129 catch (Exception e)
130 {
131 String message = ("Error processing navigation template:"
132 + this.template + " using module: " + module);
133 Log.error(message, e);
134 returnValue = message;
135 }
136 return returnValue;
137 }
138 }
This page was automatically generated by Maven