org.codehaus.groovy.grails.web.pages
Class GroovyPagesUriSupport

java.lang.Object
  org.codehaus.groovy.grails.web.pages.GroovyPagesUriSupport

All Implemented Interfaces:

GroovyPagesUriService

Direct Known Subclasses:

DefaultGroovyPagesUriService

public class GroovyPagesUriSupport
extends java.lang.Object
implements GroovyPagesUriService

Methods to establish template names, paths and so on.

Since:

1.2

Field Summary

static java.lang.String

PATH_TO_VIEWS

Fields inherited from interface org.codehaus.groovy.grails.web.pages.GroovyPagesUriService

BEAN_ID

Constructor Summary

GroovyPagesUriSupport()

Method Summary

void	clear()
java.lang.String	getAbsoluteTemplateURI(java.lang.String templateName) Used to resolve template names that are not relative to a controller.
java.lang.String	getAbsoluteViewURI(java.lang.String viewName) Obtains a view URI that is not relative to any given controller
java.lang.String	getDeployedAbsoluteViewURI(java.lang.String viewName) Obtains a view URI when deployed within the /WEB-INF/grails-app/views context
java.lang.String	getDeployedViewURI(java.lang.String controllerName, java.lang.String viewName) Obtains a view URI when deployed within the /WEB-INF/grails-app/views context
java.lang.String	getLogicalControllerName(groovy.lang.GroovyObject controller)
java.lang.String	getNoSuffixViewURI(groovy.lang.GroovyObject controller, java.lang.String viewName) Obtains a view URI of the given controller and view name without the suffix
java.lang.String	getNoSuffixViewURI(java.lang.String controllerName, java.lang.String viewName) Obtains a view URI of the given controller name and view name without the suffix
java.lang.String	getTemplateURI(groovy.lang.GroovyObject controller, java.lang.String templateName) Obtains a template URI for the given controller instance and template name
java.lang.String	getTemplateURI(java.lang.String controllerName, java.lang.String templateName) Obtains the URI to a template using the controller name and template name
java.lang.String	getViewURI(groovy.lang.GroovyObject controller, java.lang.String viewName) Obtains a view URI of the given controller and view name
java.lang.String	getViewURI(java.lang.String controllerName, java.lang.String viewName) Obtains a view URI of the given controller name and view name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH_TO_VIEWS

public static final java.lang.String PATH_TO_VIEWS

See Also:

Constant Field Values

Constructor Detail

GroovyPagesUriSupport

public GroovyPagesUriSupport()

Method Detail

getTemplateURI

public java.lang.String getTemplateURI(groovy.lang.GroovyObject controller,
                                       java.lang.String templateName)

Obtains a template URI for the given controller instance and template name

Specified by:

getTemplateURI in interface GroovyPagesUriService

Parameters:

controller - The controller instance

templateName - The template name

Returns:

The template URI

clear

public void clear()

Specified by:

clear in interface GroovyPagesUriService

getViewURI

public java.lang.String getViewURI(groovy.lang.GroovyObject controller,
                                   java.lang.String viewName)

Obtains a view URI of the given controller and view name

Parameters:

controller - The name of the controller

viewName - The name of the view

Returns:

The view URI

getNoSuffixViewURI

public java.lang.String getNoSuffixViewURI(groovy.lang.GroovyObject controller,
                                           java.lang.String viewName)

Obtains a view URI of the given controller and view name without the suffix

Specified by:

getNoSuffixViewURI in interface GroovyPagesUriService

Parameters:

controller - The name of the controller

viewName - The name of the view

Returns:

The view URI

getLogicalControllerName

public java.lang.String getLogicalControllerName(groovy.lang.GroovyObject controller)

getTemplateURI

public java.lang.String getTemplateURI(java.lang.String controllerName,
                                       java.lang.String templateName)

Obtains the URI to a template using the controller name and template name

Specified by:

getTemplateURI in interface GroovyPagesUriService

Parameters:

controllerName - The controller name

templateName - The template name

Returns:

The template URI

getAbsoluteTemplateURI

public java.lang.String getAbsoluteTemplateURI(java.lang.String templateName)

Used to resolve template names that are not relative to a controller.

Specified by:

getAbsoluteTemplateURI in interface GroovyPagesUriService

Parameters:

templateName - The template name normally beginning with /

Returns:

The template URI

getViewURI

public java.lang.String getViewURI(java.lang.String controllerName,
                                   java.lang.String viewName)

Obtains a view URI of the given controller name and view name

Specified by:

getViewURI in interface GroovyPagesUriService

Parameters:

controllerName - The name of the controller

viewName - The name of the view

Returns:

The view URI

getAbsoluteViewURI

public java.lang.String getAbsoluteViewURI(java.lang.String viewName)

Obtains a view URI that is not relative to any given controller

Specified by:

getAbsoluteViewURI in interface GroovyPagesUriService

Parameters:

viewName - The name of the view

Returns:

The view URI

getNoSuffixViewURI

public java.lang.String getNoSuffixViewURI(java.lang.String controllerName,
                                           java.lang.String viewName)

Obtains a view URI of the given controller name and view name without the suffix

Specified by:

getNoSuffixViewURI in interface GroovyPagesUriService

Parameters:

controllerName - The name of the controller

viewName - The name of the view

Returns:

The view URI

getDeployedViewURI

public java.lang.String getDeployedViewURI(java.lang.String controllerName,
                                           java.lang.String viewName)

Obtains a view URI when deployed within the /WEB-INF/grails-app/views context

Specified by:

getDeployedViewURI in interface GroovyPagesUriService

Parameters:

controllerName - The name of the controller

viewName - The name of the view

Returns:

The view URI

getDeployedAbsoluteViewURI

public java.lang.String getDeployedAbsoluteViewURI(java.lang.String viewName)

Obtains a view URI when deployed within the /WEB-INF/grails-app/views context

Specified by:

getDeployedAbsoluteViewURI in interface GroovyPagesUriService

Parameters:

viewName - The name of the view

Returns:

The view URI