org.apache.turbine.util.template
Class RelativeTemplateLink

java.lang.Object
  |
  +--org.apache.turbine.util.DynamicURI
        |
        +--org.apache.turbine.util.RelativeDynamicURI
              |
              +--org.apache.turbine.util.template.RelativeTemplateLink
All Implemented Interfaces:
ApplicationTool

public class RelativeTemplateLink
extends RelativeDynamicURI
implements ApplicationTool

A customized version of the RelativeDynamicURI to be used in Templates. Here's an example of its Velocity/WebMacro use:

$link.setPage("index.wm").addPathInfo("hello","world") This would return: /myapp/servlet/myapp/template/index.wm/hello/world

Version:
$Id: RelativeTemplateLink.java,v 1.1 2001/09/27 00:25:31 legassick Exp $
Author:
John D. McNally, see the authors of TemplateLink

Field Summary
private  java.lang.String template
          cache of the template name for getPage()
private static java.lang.String TEMPLATE_KEY
          the pathinfo key stored in the DynamicURI
 
Fields inherited from class org.apache.turbine.util.DynamicURI
data, hasPathInfo, hasQueryData, HTTP, HTTPS, PATH_INFO, pathInfo, QUERY_DATA, queryData, redirect, res, scriptName, sd, serverName, serverPort, serverScheme
 
Constructor Summary
RelativeTemplateLink()
          Default constructor
RelativeTemplateLink(RunData data)
          Constructor.
 
Method Summary
 java.lang.String getPage()
          Gets the template variable used by the Template Service.
 java.lang.String getURI()
          Returns the URI leaving the source intact.
 void init(java.lang.Object data)
          This will initialise a TemplateLink object that was constructed with the default constructor (ApplicationTool method).
 void refresh()
          Refresh method - does nothing
 RelativeTemplateLink setEncodeURLOff()
          This will turn off the execution of res.encodeURL() by making res == null.
 RelativeTemplateLink setPage(java.lang.String t)
          Sets the template variable used by the Template Service.
 java.lang.String toString()
          Returns the URI.
 
Methods inherited from class org.apache.turbine.util.RelativeDynamicURI
toString
 
Methods inherited from class org.apache.turbine.util.DynamicURI
add, add, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addPathInfo, addQueryData, addQueryData, addQueryData, addQueryData, addQueryData, addQueryData, getA, getScriptName, getServerData, getServerName, getServerPort, getServerScheme, init, init, init, remove, removePathInfo, removePathInfo, removeQueryData, removeQueryData, renderPathInfo, renderQueryString, setAction, setScreen, setScriptName, setSecure, setSecure, setServerData, setServerName, setServerPort, setServerScheme
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

TEMPLATE_KEY

private static final java.lang.String TEMPLATE_KEY
the pathinfo key stored in the DynamicURI

template

private java.lang.String template
cache of the template name for getPage()
Constructor Detail

RelativeTemplateLink

public RelativeTemplateLink()
Default constructor

The init method must be called before use.


RelativeTemplateLink

public RelativeTemplateLink(RunData data)
Constructor.
Parameters:
data - a Turbine RunData object.
Method Detail

init

public void init(java.lang.Object data)
This will initialise a TemplateLink object that was constructed with the default constructor (ApplicationTool method).
Specified by:
init in interface ApplicationTool
Parameters:
data - assumed to be a RunData object

refresh

public void refresh()
Refresh method - does nothing
Specified by:
refresh in interface ApplicationTool

setEncodeURLOff

public RelativeTemplateLink setEncodeURLOff()
This will turn off the execution of res.encodeURL() by making res == null. This is a hack for cases where you don't want to see the session information

setPage

public RelativeTemplateLink setPage(java.lang.String t)
Sets the template variable used by the Template Service.
Parameters:
t - A String with the template name.
Returns:
A TemplateLink.

getPage

public java.lang.String getPage()
Gets the template variable used by the Template Service. It is only available after setPage() has been called.
Returns:
The template name.

toString

public java.lang.String toString()
Returns the URI. After rendering the URI, it clears the pathInfo and QueryString portions of the DynamicURI.
Overrides:
toString in class RelativeDynamicURI
Returns:
A String with the URI in the form http://foo.com/Turbine/template/index.wm/hello/world

getURI

public java.lang.String getURI()
Returns the URI leaving the source intact. Wraps directly to the DynamicURI.toString method of the superclass (avoiding the local toString implementation).
Returns:
A String with the URI in the form http://foo.com/Turbine/template/index.wm/hello/world


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.