fr.paris.lutece.portal.service.template

Class AbstractFreeMarkerTemplateService

java.lang.Object

fr.paris.lutece.portal.service.template.AbstractFreeMarkerTemplateService

All Implemented Interfaces:

IFreeMarkerTemplateService

public abstract class AbstractFreeMarkerTemplateService
extends Object
implements IFreeMarkerTemplateService

Template service based on the Freemarker template engine

Constructor Summary

Constructors

Constructor and Description
AbstractFreeMarkerTemplateService()

Method Summary

Modifier and Type	Method and Description
void	addAutoInclude(String strFile) Add an auto include file
void	addPluginMacros(String strFileName) Adds a macro file (like the main commons.html) brought by a plugin.
List<String>	getAutoIncludes() Get the list of auto includes files
void	init(String strTemplatePath) Initializes the service with the templates's path
void	init(String strTemplatePath, boolean bAcceptIncompatibleImprovements) Initializes the service with the templates's path
HtmlTemplate	loadTemplate(String strTemplateData, Locale locale, Object rootMap) Load a template from a String and process a model WARNING : This method must not be used in front office (no cache management available).
HtmlTemplate	loadTemplate(String strPath, String strTemplate) Load a template
HtmlTemplate	loadTemplate(String strPath, String strTemplate, Locale locale, Object rootMap) Load a template and process a model
void	removeAutoInclude(String strFile) Remove an auto include file
void	resetCache() Reset the cache
void	resetConfiguration() Clears the configuration cache
void	setSharedVariable(String name, Object obj) Add a shared variable into every template
void	setTemplateUpdateDelay(int nTemplateUpdateDelay) Set the template update delay

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.paris.lutece.portal.service.template.IFreeMarkerTemplateService

getAbsolutePathFromRelativePath, getDefaultPattern

Constructor Detail

AbstractFreeMarkerTemplateService

public AbstractFreeMarkerTemplateService()

Method Detail

setTemplateUpdateDelay

public void setTemplateUpdateDelay(int nTemplateUpdateDelay)

Set the template update delay

Specified by:

setTemplateUpdateDelay in interface IFreeMarkerTemplateService

Parameters:

nTemplateUpdateDelay - the template update delay

addPluginMacros

public void addPluginMacros(String strFileName)

Adds a macro file (like the main commons.html) brought by a plugin. This file will be included for every template (autoinclude).

Specified by:

addPluginMacros in interface IFreeMarkerTemplateService

Parameters:

strFileName - the filename

setSharedVariable

public void setSharedVariable(String name,
                              Object obj)

Add a shared variable into every template

Specified by:

setSharedVariable in interface IFreeMarkerTemplateService

Parameters:

name - name of the shared variable

obj - value

init

public void init(String strTemplatePath)

Initializes the service with the templates's path

Specified by:

init in interface IFreeMarkerTemplateService

Parameters:

strTemplatePath - The template path

init

public void init(String strTemplatePath,
                 boolean bAcceptIncompatibleImprovements)

Initializes the service with the templates's path

Specified by:

init in interface IFreeMarkerTemplateService

Parameters:

strTemplatePath - The template path

bAcceptIncompatibleImprovements - Use Freemarker new features or stay backward compatible

loadTemplate

public HtmlTemplate loadTemplate(String strPath,
                                 String strTemplate)

Load a template

Specified by:

loadTemplate in interface IFreeMarkerTemplateService

Parameters:

strPath - the root path

strTemplate - the path of the template from the root path

Returns:

the html template

loadTemplate

public HtmlTemplate loadTemplate(String strPath,
                                 String strTemplate,
                                 Locale locale,
                                 Object rootMap)

Load a template and process a model

Specified by:

loadTemplate in interface IFreeMarkerTemplateService

Parameters:

strPath - the root path

strTemplate - the path of the template from the root path

locale - The locale

rootMap - the model root

Returns:

the processed html template

loadTemplate

public HtmlTemplate loadTemplate(String strTemplateData,
                                 Locale locale,
                                 Object rootMap)

Load a template from a String and process a model WARNING : This method must not be used in front office (no cache management available).
Using Freemarker without cache is huge CPU consuming, only sue this method for dynamic templates

Specified by:

loadTemplate in interface IFreeMarkerTemplateService

Parameters:

strTemplateData - The template as a string

locale - The Locale

rootMap - the model root

Returns:

the processed html template

resetConfiguration

public void resetConfiguration()

Clears the configuration cache

Specified by:

resetConfiguration in interface IFreeMarkerTemplateService

resetCache

public void resetCache()

Reset the cache

Specified by:

resetCache in interface IFreeMarkerTemplateService

getAutoIncludes

public List<String> getAutoIncludes()

Get the list of auto includes files

Specified by:

getAutoIncludes in interface IFreeMarkerTemplateService

Returns:

The list or null if no configuration is available

addAutoInclude

public void addAutoInclude(String strFile)

Add an auto include file

Specified by:

addAutoInclude in interface IFreeMarkerTemplateService

Parameters:

strFile - The file to add

removeAutoInclude

public void removeAutoInclude(String strFile)

Remove an auto include file

Specified by:

removeAutoInclude in interface IFreeMarkerTemplateService

Parameters:

strFile - The file to remove