KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > util > SnippetRenderer


1 package org.tigris.scarab.util;
2
3 /* ================================================================
4  * Copyright (c) 2000 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by CollabNet (http://www.collab.net/)."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" name
28  * nor may "Tigris" appear in their names without prior written
29  * permission of CollabNet.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of CollabNet.
47  */
48
49 import org.apache.turbine.Turbine;
50 import org.apache.turbine.RunData;
51 import org.apache.turbine.modules.Module;
52 import org.apache.commons.logging.Log;
53 import org.apache.commons.logging.LogFactory;
54
55 /**
56  * Renders templates in the templates/snippets directory. Its primary
57  * use is within actions, if the messaging is more complex than a simple
58  * string. One cannot use the renderer that might be in the context as
59  * that renderer could output directly to the response, while the action
60  * message should not be sent until a later time.
61  *
62  * @author <a HREF="mailto:jmcnally@collab.net">John McNally</a>
63  */
64 public class SnippetRenderer
65     implements SkipFiltering
66 {
67     private static final Log LOG = LogFactory.getLog(SnippetRenderer.class);
68     private static final String JavaDoc SNIPPETS = "snippets";
69     /**
70      * RunData of the request this SnippetRenderer is for.
71      */
72     private RunData data;
73     private String JavaDoc template;
74
75     /**
76      * Construct a renderer for the given RunData.
77      */
78     public SnippetRenderer(RunData data, String JavaDoc template)
79     {
80         this.data = data;
81         this.template = template;
82     }
83
84     /**
85      * Render the given template. TemplateContext to use will be extracted from
86      * the RunData with which this SnippetRenderer was constructer.
87      *
88      * @param template name/path of template in the format expected by the
89      * appropriate template engine service
90      * @return Result of template merge
91      */
92     public String JavaDoc toString()
93     {
94         String JavaDoc result = null;
95         LOG.debug("Rendering snippet " + template);
96         try
97         {
98             result = Module.handleRequest(
99                 Module.getTemplateContext(data),
100                 Turbine.getResolver().getTemplate(SNIPPETS, template));
101         }
102         catch (Exception JavaDoc e)
103         {
104             LOG.error("Error rendering " + template + ". ", e);
105             result = "ERROR!";
106         }
107         return result;
108     }
109 }
110
Popular Tags