KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > tool > RelativeTemplateLink


1 package org.apache.turbine.tool;
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.turbine.DynamicURI;
58 import org.apache.turbine.RunData;
59 import org.apache.turbine.services.pull.ApplicationTool;
60
61 /**
62  * A customized version of the RelativeDynamicURI to be used in Templates.
63  * Here's an example of its Velocity/WebMacro use:
64  *
65  * <p><code>
66  * $link.setPage("index.wm").addPathInfo("hello","world")
67  * This would return: /myapp/servlet/myapp/template/index.wm/hello/world
68  * </code>
69  *
70  * @author <a HREF="jmcnally@collab.net">John D. McNally</a>
71  * @author see the authors of TemplateLink
72  * @version $Id: RelativeTemplateLink.java,v 1.1 2002/06/01 22:05:28 jvanzyl Exp $
73  */
74 public class RelativeTemplateLink
75     extends DynamicURI
76     implements ApplicationTool
77 {
78     /** the pathinfo key stored in the DynamicURI */
79     private static final String JavaDoc TEMPLATE_KEY = "template";
80     /** cache of the template name for getPage() */
81     private String JavaDoc template = null;
82
83     /**
84      * Default constructor
85      * <p>
86      * The init method must be called before use.
87      */
88     public RelativeTemplateLink()
89     {
90         setRelative(true);
91     }
92
93     /**
94      * Constructor.
95      *
96      * @param data a Turbine RunData object.
97      */
98     public RelativeTemplateLink(RunData data)
99     {
100         super(data);
101         setRelative(true);
102     }
103
104     /**
105      * This will initialise a TemplateLink object that was
106      * constructed with the default constructor (ApplicationTool
107      * method).
108      *
109      * @param data assumed to be a RunData object
110      */
111     public void init(Object JavaDoc data)
112     {
113         // we just blithely cast to RunData as if another object
114 // or null is passed in we'll throw an appropriate runtime
115 // exception.
116 super.init((RunData)data);
117     }
118
119     /**
120      * Refresh method - does nothing
121      */
122     public void refresh()
123     {
124         // empty
125 }
126
127     /**
128      * This will turn off the execution of res.encodeURL()
129      * by making res == null. This is a hack for cases
130      * where you don't want to see the session information
131      */
132     public RelativeTemplateLink setEncodeURLOff()
133     {
134         this.res = null;
135         return this;
136     }
137
138     /**
139      * Sets the template variable used by the Template Service.
140      *
141      * @param t A String with the template name.
142      * @return A TemplateLink.
143      */
144     public RelativeTemplateLink setPage(String JavaDoc t)
145     {
146         template = t;
147         addPathInfo(TEMPLATE_KEY,t);
148         return this;
149     }
150
151     /**
152      * Gets the template variable used by the Template Service.
153      * It is only available after setPage() has been called.
154      *
155      * @return The template name.
156      */
157     public String JavaDoc getPage()
158     {
159         return template;
160     }
161
162     /**
163      * Returns the URI. After rendering the URI, it clears the
164      * pathInfo and QueryString portions of the DynamicURI.
165      *
166      * @return A String with the URI in the form
167      * http://foo.com/Turbine/template/index.wm/hello/world
168      */
169     public String JavaDoc toString()
170     {
171         String JavaDoc output = super.toString();
172
173         // This was added to allow multilple $link variables in one
174 // template.
175 removePathInfo();
176         removeQueryData();
177
178         return output;
179     }
180
181     /**
182      * Returns the URI leaving the source intact. Wraps directly to the
183      * <code>DynamicURI.toString</code> method of the superclass
184      * (avoiding the local toString implementation).
185      *
186      * @return A String with the URI in the form
187      * http://foo.com/Turbine/template/index.wm/hello/world
188      */
189     public String JavaDoc getURI()
190     {
191         return super.toString();
192     }
193 }
194
Popular Tags