com.communote.server.web.commons.view

Class TemplateManager

java.lang.Object

com.communote.server.web.commons.view.TemplateManager

Direct Known Subclasses:

VelocityTemplateManager

public class TemplateManager
extends Object

Class that manages templates which are identified by a name and have a file location.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
TemplateManager() Create a new instance

Method Summary

Modifier and Type	Method and Description
protected void	addCoreTemplates(Map<String,String> templateMapping) Add the core templates
String	getTemplate(String templateName) Return the location of the template file for a given template name
String[]	getTemplateNames()
void	registerTemplate(String providerId, String templateName, String templateLocation) Register a template.
void	unregisterTemplates(String providerId) Unregister all templates previously registered for a given provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateManager

public TemplateManager()

Create a new instance

Method Detail

addCoreTemplates

protected void addCoreTemplates(Map<String,String> templateMapping)

Add the core templates

Parameters:

templateMapping - a mapping from template key to template file where the templates should be added to

getTemplate

public String getTemplate(String templateName)

Return the location of the template file for a given template name

Parameters:

templateName - the name of the template to retrieve

Returns:

the location of the template file for a given template name or null if the template is not registered

getTemplateNames

public String[] getTemplateNames()

Returns:

all registered template names

registerTemplate

public void registerTemplate(String providerId,
                             String templateName,
                             String templateLocation)

Register a template. If there is already a template with the same name, it will be replaced.

Parameters:

providerId - ID that identifies the owner/provider of the template, this is usually the ID of a plugin.

templateName - the template name

templateLocation - the file location of the template. The location can be relative if the template rendering engine knows how to resolve the full path.

unregisterTemplates

public void unregisterTemplates(String providerId)

Unregister all templates previously registered for a given provider. If one of the templates replaced another template with the same name the replaced template will be accessible again.

Parameters:

providerId - ID that identifies the owner/provider of the templates