org.apache.beehive.netui.core.urls
Class DefaultTemplatedURLFormatter

Object
  extended by DefaultTemplatedURLFormatter
All Implemented Interfaces:
TemplatedURLFormatter

public class DefaultTemplatedURLFormatter
extends Object
implements TemplatedURLFormatter

Default implementation of TemplatedURLFormatter for formatting URLs based on templates from a URL template config file.


Constructor Summary
DefaultTemplatedURLFormatter()
           
 
Method Summary
 String getTemplatedURL(ServletRequest request, MutableURI uri, String key, URIContext uriContext)
          Format the given URL using a URL template, if defined in a URL template config file.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultTemplatedURLFormatter

public DefaultTemplatedURLFormatter()
Method Detail

getTemplatedURL

public String getTemplatedURL(ServletRequest request,
                              MutableURI uri,
                              String key,
                              URIContext uriContext)
Format the given URL using a URL template, if defined in a URL template config file. The URIContext encapsulates some additional data needed to write out the string form. E.g. It defines if the "&" entity or the '&' character should be used to separate quary parameters.

Specified by:
getTemplatedURL in interface TemplatedURLFormatter
Parameters:
request - the current ServletRequest.
uri - the MutableURI to be formatted into a String.
key - key for the URL template type to use for formatting the URI
uriContext - data required to write out the string form.
Returns:
the URL as a String