com.communote.server.core.template

Class NoteTemplateService

java.lang.Object

com.communote.server.core.template.NoteTemplateService

@Service
public class NoteTemplateService
extends Object

This class provides services to support notes which have a predefined content that is based on a template.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTE_PROPERTY_KEY_TEMPLATE_ID Key of the NoteProperty that holds the template ID.
static String	NOTE_PROPERTY_KEY_TEMPLATE_PROPERTIES Key of the NoteProperty that holds the template properties.

Constructor Summary

Constructors

Constructor and Description
NoteTemplateService()

Method Summary

Modifier and Type	Method and Description
boolean	addDefinition(NoteTemplateDefinition definition) Add a template definition.
boolean	addTool(String toolKey, Object tool) Add a tool which should be accessible from within the template.
NoteTemplateDefinition	getDefinition(String templateId) Return the template definition for the given ID or null if there is none.
void	init() initialize required components
void	removeDefinition(String templateId) Remove a template definition.
void	removeTool(String toolKey) Remove a tool that was previously added via addTool(String, Object)
String	renderTemplate(String templateId, String templatePropertiesJSON, NoteRenderContext renderContext, boolean validateTemplateProperties) Render a template and returns the resulting string which can than be used as note content.

Methods inherited from class java.lang.Object

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

Field Detail

NOTE_PROPERTY_KEY_TEMPLATE_ID

public static final String NOTE_PROPERTY_KEY_TEMPLATE_ID

Key of the NoteProperty that holds the template ID.

See Also:

Constant Field Values

NOTE_PROPERTY_KEY_TEMPLATE_PROPERTIES

public static final String NOTE_PROPERTY_KEY_TEMPLATE_PROPERTIES

Key of the NoteProperty that holds the template properties.

See Also:

Constant Field Values

Constructor Detail

NoteTemplateService

public NoteTemplateService()

Method Detail

addDefinition

public boolean addDefinition(NoteTemplateDefinition definition)

Add a template definition. A definition is identified by its ID. If there is already a definition with that ID the new one will be ignored.

Parameters:

definition - the template definition to add

Returns:

whether the definition was added

addTool

public boolean addTool(String toolKey,
                       Object tool)

Add a tool which should be accessible from within the template. The tool can be any arbitrary object that provides some utility functions. It will be added to the velocity context under the provided key so that its methods are accessible like those of any other object in the context. Because the tool is shared between all invocations, it must be thread safe.

Parameters:

toolKey - the key under which the tool should be accessible. If there is already a tool for the key the new one will be ignored.

tool - the tool to add

Returns:

true if the tool was added, false otherwise

getDefinition

public NoteTemplateDefinition getDefinition(String templateId)

Return the template definition for the given ID or null if there is none.

Parameters:

templateId - the ID for which a definition should be returned

Returns:

the definition or null

init

@PostConstruct
public void init()

initialize required components

removeDefinition

public void removeDefinition(String templateId)

Remove a template definition.

Parameters:

templateId - the ID of the template definition to remove. In case there is no definition for the ID nothing will happen.

removeTool

public void removeTool(String toolKey)

Remove a tool that was previously added via addTool(String, Object)

Parameters:

toolKey - the key of the tool to remove. In case there is no tool for the key nothing will happen.

renderTemplate

public String renderTemplate(String templateId,
                             String templatePropertiesJSON,
                             NoteRenderContext renderContext,
                             boolean validateTemplateProperties)
                      throws NoteTemplateNotFoundException,
                             NoteTemplateRenderException

Render a template and returns the resulting string which can than be used as note content.

Parameters:

templateId - the ID of the template definition whose template should be rendered

templatePropertiesJSON - optional string in JSON which should be passed to the template engine and can contain any additional data the template might need. The string is converted into a nested map for easier processing within the template. The variable is called 'props'.

renderContext - the render context to use when getting the actual template from the template definition. The rendering context will also be put into the velocity context so it can be used in the template. The variable is called 'context'

validateTemplateProperties - whether to call the validator of the template definition to validate the template properties. In case the definition has no validator this argument is ignored.

Returns:

the rendered template

Throws:

NoteTemplateNotFoundException - in case there is no template definition for the given ID

NoteTemplateRenderException - in case of an error while rendering the template