com.communote.server.core.template.velocity

Class NoteTemplateVelocityResourceLoader

java.lang.Object

org.apache.velocity.runtime.resource.loader.ResourceLoader

com.communote.server.core.template.velocity.NoteTemplateVelocityResourceLoader

All Implemented Interfaces:

EventListener<LocalizationChangedEvent>

public class NoteTemplateVelocityResourceLoader
extends org.apache.velocity.runtime.resource.loader.ResourceLoader
implements EventListener<LocalizationChangedEvent>

Resource loader for the Velocity engine that resolves the Velocity resource names into note templates managed by the NoteTemplateService

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static char	RESOURCE_NAME_PARTS_SEPARATOR Character that separates the parts templateId, locale and renderMode in the resource name.
static String	RESOURCE_NAME_PREFIX Prefix a resource name needs to have to be recognized as a resource that can be loaded by this class.

Fields inherited from class org.apache.velocity.runtime.resource.loader.ResourceLoader

className, isCachingOn, log, modificationCheckInterval, rsvc

Constructor Summary

Constructors

Constructor and Description
NoteTemplateVelocityResourceLoader()

Method Summary

Modifier and Type	Method and Description
long	getLastModified(org.apache.velocity.runtime.resource.Resource resource)
Class<LocalizationChangedEvent>	getObservedEvent() Defines the types of events about which this listener will be informed.
InputStream	getResourceStream(String resourceName)
void	handle(LocalizationChangedEvent event) Is called by the EventDispatcher when the observed event was fired.
void	init(org.apache.commons.collections.ExtendedProperties configuration)
boolean	isSourceModified(org.apache.velocity.runtime.resource.Resource resource)

Methods inherited from class org.apache.velocity.runtime.resource.loader.ResourceLoader

commonInit, getClassName, getModificationCheckInterval, isCachingOn, resourceExists, setCachingOn, setModificationCheckInterval

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_NAME_PREFIX

public static final String RESOURCE_NAME_PREFIX

Prefix a resource name needs to have to be recognized as a resource that can be loaded by this class.

See Also:

Constant Field Values

RESOURCE_NAME_PARTS_SEPARATOR

public static final char RESOURCE_NAME_PARTS_SEPARATOR

Character that separates the parts templateId, locale and renderMode in the resource name.

See Also:

Constant Field Values

Constructor Detail

NoteTemplateVelocityResourceLoader

public NoteTemplateVelocityResourceLoader()

Method Detail

getLastModified

public long getLastModified(org.apache.velocity.runtime.resource.Resource resource)

Specified by:

getLastModified in class org.apache.velocity.runtime.resource.loader.ResourceLoader

getObservedEvent

public Class<LocalizationChangedEvent> getObservedEvent()

Description copied from interface: EventListener

Defines the types of events about which this listener will be informed.

Specified by:

getObservedEvent in interface EventListener<LocalizationChangedEvent>

Returns:

the class of the observed event

getResourceStream

public InputStream getResourceStream(String resourceName)
                              throws org.apache.velocity.exception.ResourceNotFoundException

Specified by:

getResourceStream in class org.apache.velocity.runtime.resource.loader.ResourceLoader

Throws:

org.apache.velocity.exception.ResourceNotFoundException

handle

public void handle(LocalizationChangedEvent event)

Description copied from interface: EventListener

Is called by the EventDispatcher when the observed event was fired.

Specified by:

handle in interface EventListener<LocalizationChangedEvent>

Parameters:

event - the event that was fired

init

public void init(org.apache.commons.collections.ExtendedProperties configuration)

Specified by:

init in class org.apache.velocity.runtime.resource.loader.ResourceLoader

isSourceModified

public boolean isSourceModified(org.apache.velocity.runtime.resource.Resource resource)

Specified by:

isSourceModified in class org.apache.velocity.runtime.resource.loader.ResourceLoader